From fb8e5cca5eff628af744f8583e7345762c0593ef Mon Sep 17 00:00:00 2001 From: Anubhav Dhawan Date: Fri, 6 Sep 2024 17:19:41 +0530 Subject: [PATCH] docs: Update sample python notebooks to reflect the support for custom schema. Specifying custom database schema names is now supported by all library methods. This commit highlights the same in the python notebooks. --- docs/chat_message_history.ipynb | 16 ++++++++++++++++ docs/document_loader.ipynb | 18 ++++++++++++++++++ docs/vector_store.ipynb | 17 +++++++++++++++++ samples/langchain_quick_start.ipynb | 18 ++++++++++++++++++ 4 files changed, 69 insertions(+) diff --git a/docs/chat_message_history.ipynb b/docs/chat_message_history.ipynb index 772fa68f..44bf9a13 100644 --- a/docs/chat_message_history.ipynb +++ b/docs/chat_message_history.ipynb @@ -206,6 +206,22 @@ "engine.init_chat_history_table(table_name=TABLE_NAME)" ] }, + { + "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", + "engine.init_chat_history_table(\n", + " table_name=TABLE_NAME,\n", + " schema_name=SCHEMA_NAME # Default: \"public\"\n", + ")" + ] + }, { "cell_type": "markdown", "metadata": {}, diff --git a/docs/document_loader.ipynb b/docs/document_loader.ipynb index 1cc2b868..0e639ed6 100644 --- a/docs/document_loader.ipynb +++ b/docs/document_loader.ipynb @@ -260,6 +260,24 @@ ")" ] }, + { + "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", + ")" + ] + }, { "cell_type": "markdown", "metadata": { diff --git a/docs/vector_store.ipynb b/docs/vector_store.ipynb index 8dc2ec0e..18213b25 100644 --- a/docs/vector_store.ipynb +++ b/docs/vector_store.ipynb @@ -281,6 +281,23 @@ ")" ] }, + { + "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", + " vector_size=768,\n", + " schema_name=SCHEMA_NAME, # Default: \"public\"\n", + ")" + ] + }, { "cell_type": "markdown", "metadata": {}, diff --git a/samples/langchain_quick_start.ipynb b/samples/langchain_quick_start.ipynb index 2f0d7739..e32d2765 100644 --- a/samples/langchain_quick_start.ipynb +++ b/samples/langchain_quick_start.ipynb @@ -738,6 +738,24 @@ ")" ] }, + { + "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", + "engine.init_vectorstore_table(\n", + " sample_vector_table_name,\n", + " schema_name=SCHEMA_NAME, # Default: \"public\"\n", + " \n", + " ...\n", + ")" + ] + }, { "cell_type": "markdown", "metadata": {