diff --git a/docs/chat_message_history.ipynb b/docs/chat_message_history.ipynb index e9493dee..02e6f04f 100644 --- a/docs/chat_message_history.ipynb +++ b/docs/chat_message_history.ipynb @@ -287,6 +287,24 @@ "engine.init_chat_history_table(table_name=TABLE_NAME)" ] }, + { + "cell_type": "markdown", + "id": "345b76b8", + "metadata": {}, + "source": [ + "#### Optional Tip: 💡\n", + "You can also specify a schema name by passing `schema_name` wherever you pass `table_name`. Eg:\n", + "\n", + "```python\n", + "SCHEMA_NAME=\"my_schema\"\n", + "\n", + "engine.init_chat_history_table(\n", + " table_name=TABLE_NAME,\n", + " schema_name=SCHEMA_NAME # Default: \"public\"\n", + ")\n", + "```" + ] + }, { "cell_type": "markdown", "id": "zSYQTYf3UfOi", @@ -300,7 +318,8 @@ "\n", "1. `engine` - An instance of a `PostgresEngine` engine.\n", "1. `session_id` - A unique identifier string that specifies an id for the session.\n", - "1. `table_name` : The name of the table within the Cloud SQL database to store the chat message history." + "1. `table_name` : The name of the table within the Cloud SQL database to store the chat message history.\n", + "1. `schema_name` : The name of the database schema containing the chat message history table." ] }, { @@ -315,7 +334,10 @@ "from langchain_google_cloud_sql_pg import PostgresChatMessageHistory\n", "\n", "history = PostgresChatMessageHistory.create_sync(\n", - " engine, session_id=\"test_session\", table_name=TABLE_NAME\n", + " engine,\n", + " session_id=\"test_session\",\n", + " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", ")\n", "history.add_user_message(\"hi!\")\n", "history.add_ai_message(\"whats up?\")" @@ -456,6 +478,7 @@ " engine,\n", " session_id=session_id,\n", " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", " ),\n", " input_messages_key=\"question\",\n", " history_messages_key=\"history\",\n", diff --git a/docs/document_loader.ipynb b/docs/document_loader.ipynb index 84db4ae4..7be30a9b 100644 --- a/docs/document_loader.ipynb +++ b/docs/document_loader.ipynb @@ -257,6 +257,25 @@ ")" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "#### Optional Tip: 💡\n", + "You can also specify a schema name by passing `schema_name` wherever you pass `table_name`. Eg:\n", + "\n", + "```python\n", + "SCHEMA_NAME=\"my_schema\"\n", + "\n", + "await engine.ainit_document_table(\n", + " table_name=TABLE_NAME,\n", + " schema_name=SCHEMA_NAME # Default: \"public\"\n", + " \n", + " ...\n", + ")\n", + "```" + ] + }, { "cell_type": "markdown", "metadata": { @@ -277,7 +296,11 @@ "from langchain_google_cloud_sql_pg import PostgresLoader\n", "\n", "# Creating a basic PostgreSQL object\n", - "loader = await PostgresLoader.create(engine, table_name=TABLE_NAME)" + "loader = await PostgresLoader.create(\n", + " engine,\n", + " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", + ")" ] }, { @@ -304,7 +327,11 @@ "from langchain_google_cloud_sql_pg import PostgresLoader\n", "\n", "# Creating a basic PostgresLoader object\n", - "loader = await PostgresLoader.create(engine, table_name=TABLE_NAME)\n", + "loader = await PostgresLoader.create(\n", + " engine,\n", + " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", + ")\n", "\n", "docs = await loader.aload()\n", "print(docs)" @@ -328,6 +355,7 @@ "loader = await PostgresLoader.create(\n", " engine,\n", " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", " content_columns=[\"product_name\"], # Optional\n", " metadata_columns=[\"id\"], # Optional\n", ")\n", @@ -356,6 +384,7 @@ "loader = await PostgresLoader.create(\n", " engine,\n", " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", " content_columns=[\"product_name\", \"description\"],\n", " format=\"YAML\",\n", ")\n", @@ -383,6 +412,7 @@ "saver = await PostgresDocumentSaver.create(\n", " engine,\n", " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", " content_column=\"product_name\",\n", " metadata_columns=[\"description\", \"content\"],\n", " metadata_json_column=\"metadata\",\n", @@ -427,7 +457,7 @@ "metadata": {}, "source": [ "### Load the documents with PostgresLoader\n", - "PostgresLoader can be used with `TABLE_NAME` to query and load the whole table." + "PostgresLoader can be used with `TABLE_NAME` (and optionally `SCHEMA_NAME`) to query and load the whole table." ] }, { @@ -436,7 +466,11 @@ "metadata": {}, "outputs": [], "source": [ - "loader = await PostgresLoader.create(engine, table_name=TABLE_NAME)\n", + "loader = await PostgresLoader.create(\n", + " engine,\n", + " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", + ")\n", "docs = await loader.aload()\n", "\n", "print(docs)" diff --git a/docs/vector_store.ipynb b/docs/vector_store.ipynb index 60839763..a253b3a6 100644 --- a/docs/vector_store.ipynb +++ b/docs/vector_store.ipynb @@ -258,6 +258,25 @@ ")" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "#### Optional Tip: 💡\n", + "You can also specify a schema name by passing `schema_name` wherever you pass `table_name`. Eg:\n", + "\n", + "```python\n", + "SCHEMA_NAME=\"my_schema\"\n", + "\n", + "await engine.ainit_vectorstore_table(\n", + " table_name=TABLE_NAME,\n", + " schema_name=SCHEMA_NAME, # Default: \"public\"\n", + " \n", + " ...\n", + ")\n", + "```" + ] + }, { "cell_type": "markdown", "metadata": {}, @@ -322,6 +341,7 @@ "store = await PostgresVectorStore.create( # Use .create() to initialize an async vector store\n", " engine=engine,\n", " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", " embedding_service=embedding,\n", ")" ] @@ -365,6 +385,7 @@ " ids=ids,\n", " engine=engine,\n", " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", " embedding_service=embedding,\n", ")" ] @@ -515,9 +536,11 @@ "\n", "# Set table name\n", "TABLE_NAME = \"vectorstore_custom\"\n", + "# SCHEMA_NAME = \"my_schema\"\n", "\n", "await engine.ainit_vectorstore_table(\n", " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", " vector_size=768, # VertexAI model: textembedding-gecko@latest\n", " metadata_columns=[Column(\"len\", \"INTEGER\")],\n", ")\n", @@ -527,6 +550,7 @@ "custom_store = await PostgresVectorStore.create(\n", " engine=engine,\n", " table_name=TABLE_NAME,\n", + " # schema_name=SCHEMA_NAME,\n", " embedding_service=embedding,\n", " metadata_columns=[\"len\"],\n", " # Connect to a existing VectorStore by customizing the table schema:\n",