diff --git a/docs/docs/integrations/document_loaders/google_alloydb.ipynb b/docs/docs/integrations/document_loaders/google_alloydb.ipynb index de1955a696..1343503801 100644 --- a/docs/docs/integrations/document_loaders/google_alloydb.ipynb +++ b/docs/docs/integrations/document_loaders/google_alloydb.ipynb @@ -212,7 +212,7 @@ "\n", "One of the requirements and arguments to establish AlloyDB as a vector store is a `AlloyDBEngine` object. The `AlloyDBEngine` configures a connection pool to your AlloyDB database, enabling successful connections from your application and following industry best practices.\n", "\n", - "To create a `AlloyDBEngine` using `AlloyDBEngine.from_instance()` you need to provide only 4 things:\n", + "To create a `AlloyDBEngine` using `AlloyDBEngine.from_instance()` you need to provide only 5 things:\n", "\n", "1. `project_id` : Project ID of the Google Cloud Project where the AlloyDB instance is located.\n", "1. `region` : Region where the AlloyDB instance is located.\n", @@ -223,6 +223,7 @@ "By default, [IAM database authentication](https://cloud.google.com/alloydb/docs/connect-iam) will be used as the method of database authentication. This library uses the IAM principal belonging to the [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials) sourced from the environment.\n", "\n", "Optionally, [built-in database authentication](https://cloud.google.com/alloydb/docs/database-users/about) using a username and password to access the AlloyDB database can also be used. Just provide the optional `user` and `password` arguments to `AlloyDBEngine.from_instance()`:\n", + "\n", "* `user` : Database user to use for built-in database authentication and login\n", "* `password` : Database password to use for built-in database authentication and login.\n" ] diff --git a/docs/docs/integrations/document_loaders/google_bigtable.ipynb b/docs/docs/integrations/document_loaders/google_bigtable.ipynb index f6fb2005fd..fb28df8bd7 100644 --- a/docs/docs/integrations/document_loaders/google_bigtable.ipynb +++ b/docs/docs/integrations/document_loaders/google_bigtable.ipynb @@ -143,6 +143,7 @@ "### Using the saver\n", "\n", "Save langchain documents with `BigtableSaver.add_documents()`. To initialize `BigtableSaver` class you need to provide 2 things:\n", + "\n", "1. `instance_id` - An instance of Bigtable.\n", "1. `table_id` - The name of the table within the Bigtable to store langchain documents." ] @@ -194,6 +195,7 @@ "#### Load documents from table\n", "\n", "Load langchain documents with `BigtableLoader.load()` or `BigtableLoader.lazy_load()`. `lazy_load` returns a generator that only queries database during the iteration. To initialize `BigtableLoader` class you need to provide:\n", + "\n", "1. `instance_id` - An instance of Bigtable.\n", "1. `table_id` - The name of the table within the Bigtable to store langchain documents." ] @@ -254,6 +256,7 @@ "source": [ "### Limiting the returned rows\n", "There are two ways to limit the returned rows:\n", + "\n", "1. Using a [filter](https://cloud.google.com/python/docs/reference/bigtable/latest/row-filters)\n", "2. Using a [row_set](https://cloud.google.com/python/docs/reference/bigtable/latest/row-set#google.cloud.bigtable.row_set.RowSet)" ] diff --git a/docs/docs/integrations/document_loaders/google_cloud_sql_mssql.ipynb b/docs/docs/integrations/document_loaders/google_cloud_sql_mssql.ipynb index 22c405014d..d9f7a95d7a 100644 --- a/docs/docs/integrations/document_loaders/google_cloud_sql_mssql.ipynb +++ b/docs/docs/integrations/document_loaders/google_cloud_sql_mssql.ipynb @@ -4,11 +4,11 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# Google Cloud SQL for SQL server\n", + "# Google Cloud SQL for SQL Server\n", "\n", "> [Cloud SQL](https://cloud.google.com/sql) is a fully managed relational database service that offers high performance, seamless integration, and impressive scalability. It offers [MySQL](https://cloud.google.com/sql/mysql), [PostgreSQL](https://cloud.google.com/sql/postgres), and [SQL Server](https://cloud.google.com/sql/sqlserver) database engines. Extend your database application to build AI-powered experiences leveraging Cloud SQL's Langchain integrations.\n", "\n", - "This notebook goes over how to use [Cloud SQL for SQL server](https://cloud.google.com/sql/sqlserver) to [save, load and delete langchain documents](https://python.langchain.com/docs/modules/data_connection/document_loaders/) with `MSSQLLoader` and `MSSQLDocumentSaver`.\n", + "This notebook goes over how to use [Cloud SQL for SQL Server](https://cloud.google.com/sql/sqlserver) to [save, load and delete langchain documents](https://python.langchain.com/docs/modules/data_connection/document_loaders/) with `MSSQLLoader` and `MSSQLDocumentSaver`.\n", "\n", "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/googleapis/langchain-google-cloud-sql-mssql-python/blob/main/docs/document_loader.ipynb)" ] @@ -22,7 +22,7 @@ "To run this notebook, you will need to do the following:\n", "\n", "* [Create a Google Cloud Project](https://developers.google.com/workspace/guides/create-project)\n", - "* [Create a Cloud SQL for SQL server instance](https://cloud.google.com/sql/docs/sqlserver/create-instance)\n", + "* [Create a Cloud SQL for SQL Server instance](https://cloud.google.com/sql/docs/sqlserver/create-instance)\n", "* [Create a Cloud SQL database](https://cloud.google.com/sql/docs/mssql/create-manage-databases)\n", "* [Add an IAM database user to the database](https://cloud.google.com/sql/docs/sqlserver/add-manage-iam-users#creating-a-database-user) (Optional)\n", "\n", @@ -170,7 +170,7 @@ "\n", "Before saving or loading documents from MSSQL table, we need first configures a connection pool to Cloud SQL database. The `MSSQLEngine` configures a [SQLAlchemy connection pool](https://docs.sqlalchemy.org/en/20/core/pooling.html#module-sqlalchemy.pool) to your Cloud SQL database, enabling successful connections from your application and following industry best practices.\n", "\n", - "To create a `MSSQLEngine` using `MSSQLEngine.from_instance()` you need to provide only 4 things:\n", + "To create a `MSSQLEngine` using `MSSQLEngine.from_instance()` you need to provide only 6 things:\n", "\n", "1. `project_id` : Project ID of the Google Cloud Project where the Cloud SQL instance is located.\n", "1. `region` : Region where the Cloud SQL instance is located.\n", diff --git a/docs/docs/integrations/document_loaders/google_cloud_sql_mysql.ipynb b/docs/docs/integrations/document_loaders/google_cloud_sql_mysql.ipynb index 9b7361061b..bf469872b5 100644 --- a/docs/docs/integrations/document_loaders/google_cloud_sql_mysql.ipynb +++ b/docs/docs/integrations/document_loaders/google_cloud_sql_mysql.ipynb @@ -180,10 +180,12 @@ "By default, [IAM database authentication](https://cloud.google.com/sql/docs/mysql/iam-authentication#iam-db-auth) will be used as the method of database authentication. This library uses the IAM principal belonging to the [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials) sourced from the envionment.\n", "\n", "For more informatin on IAM database authentication please see:\n", + "\n", "* [Configure an instance for IAM database authentication](https://cloud.google.com/sql/docs/mysql/create-edit-iam-instances)\n", "* [Manage users with IAM database authentication](https://cloud.google.com/sql/docs/mysql/add-manage-iam-users)\n", "\n", "Optionally, [built-in database authentication](https://cloud.google.com/sql/docs/mysql/built-in-authentication) using a username and password to access the Cloud SQL database can also be used. Just provide the optional `user` and `password` arguments to `MySQLEngine.from_instance()`:\n", + "\n", "* `user` : Database user to use for built-in database authentication and login\n", "* `password` : Database password to use for built-in database authentication and login." ] @@ -208,6 +210,7 @@ "### Initialize a table\n", "\n", "Initialize a table of default schema via `MySQLEngine.init_document_table()`. Table Columns:\n", + "\n", "- page_content (type: text)\n", "- langchain_metadata (type: JSON)\n", "\n", @@ -230,6 +233,7 @@ "### Save documents\n", "\n", "Save langchain documents with `MySQLDocumentSaver.add_documents()`. To initialize `MySQLDocumentSaver` class you need to provide 2 things:\n", + "\n", "1. `engine` - An instance of a `MySQLEngine` engine.\n", "2. `table_name` - The name of the table within the Cloud SQL database to store langchain documents." ] @@ -275,6 +279,7 @@ "metadata": {}, "source": [ "Load langchain documents with `MySQLLoader.load()` or `MySQLLoader.lazy_load()`. `lazy_load` returns a generator that only queries database during the iteration. To initialize `MySQLLoader` class you need to provide:\n", + "\n", "1. `engine` - An instance of a `MySQLEngine` engine.\n", "2. `table_name` - The name of the table within the Cloud SQL database to store langchain documents." ] @@ -346,6 +351,7 @@ "For table with default schema (page_content, langchain_metadata), the deletion criteria is:\n", "\n", "A `row` should be deleted if there exists a `document` in the list, such that\n", + "\n", "- `document.page_content` equals `row[page_content]`\n", "- `document.metadata` equals `row[langchain_metadata]`" ] @@ -450,6 +456,7 @@ "metadata": {}, "source": [ "We can specify the content and metadata we want to load by setting the `content_columns` and `metadata_columns` when initializing the `MySQLLoader`.\n", + "\n", "1. `content_columns`: The columns to write into the `page_content` of the document.\n", "2. `metadata_columns`: The columns to write into the `metadata` of the document.\n", "\n", @@ -488,12 +495,14 @@ "metadata": {}, "source": [ "In order to save langchain document into table with customized metadata fields. We need first create such a table via `MySQLEngine.init_document_table()`, and specify the list of `metadata_columns` we want it to have. In this example, the created table will have table columns:\n", + "\n", "- description (type: text): for storing fruit description.\n", "- fruit_name (type text): for storing fruit name.\n", "- organic (type tinyint(1)): to tell if the fruit is organic.\n", "- other_metadata (type: JSON): for storing other metadata information of the fruit.\n", "\n", "We can use the following parameters with `MySQLEngine.init_document_table()` to create the table:\n", + "\n", "1. `table_name`: The name of the table within the Cloud SQL database to store langchain documents.\n", "2. `metadata_columns`: A list of `sqlalchemy.Column` indicating the list of metadata columns we need.\n", "3. `content_column`: The name of column to store `page_content` of langchain document. Default: `page_content`.\n", @@ -533,6 +542,7 @@ "metadata": {}, "source": [ "Save documents with `MySQLDocumentSaver.add_documents()`. As you can see in this example, \n", + "\n", "- `document.page_content` will be saved into `description` column.\n", "- `document.metadata.fruit_name` will be saved into `fruit_name` column.\n", "- `document.metadata.organic` will be saved into `organic` column.\n", @@ -586,6 +596,7 @@ "We can also delete documents from table with customized metadata columns via `MySQLDocumentSaver.delete()`. The deletion criteria is:\n", "\n", "A `row` should be deleted if there exists a `document` in the list, such that\n", + "\n", "- `document.page_content` equals `row[page_content]`\n", "- For every metadata field `k` in `document.metadata`\n", " - `document.metadata[k]` equals `row[k]` or `document.metadata[k]` equals `row[langchain_metadata][k]`\n", diff --git a/docs/docs/integrations/document_loaders/google_cloud_sql_pg.ipynb b/docs/docs/integrations/document_loaders/google_cloud_sql_pg.ipynb index d0da892144..672fec9606 100644 --- a/docs/docs/integrations/document_loaders/google_cloud_sql_pg.ipynb +++ b/docs/docs/integrations/document_loaders/google_cloud_sql_pg.ipynb @@ -221,6 +221,7 @@ "By default, [IAM database authentication](https://cloud.google.com/sql/docs/postgres/iam-authentication) will be used as the method of database authentication. This library uses the IAM principal belonging to the [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials) sourced from the environment.\n", "\n", "Optionally, [built-in database authentication](https://cloud.google.com/sql/docs/postgres/users) using a username and password to access the Cloud SQL database can also be used. Just provide the optional `user` and `password` arguments to `PostgreSQLEngine.from_instance()`:\n", + "\n", "* `user` : Database user to use for built-in database authentication and login\n", "* `password` : Database password to use for built-in database authentication and login.\n" ] diff --git a/docs/docs/integrations/document_loaders/google_datastore.ipynb b/docs/docs/integrations/document_loaders/google_datastore.ipynb index 71cc49cbf4..f486f0b84a 100644 --- a/docs/docs/integrations/document_loaders/google_datastore.ipynb +++ b/docs/docs/integrations/document_loaders/google_datastore.ipynb @@ -229,6 +229,7 @@ "metadata": {}, "source": [ "Load langchain documents with `DatastoreLoader.load()` or `Datastore.lazy_load()`. `lazy_load` returns a generator that only queries database during the iteration. To initialize `DatastoreLoader` class you need to provide:\n", + "\n", "1. `source` - An instance of a Query, CollectionGroup, DocumentReference or the single `\\`-delimited path to a Datastore collection`." ] }, diff --git a/docs/docs/integrations/document_loaders/google_firestore.ipynb b/docs/docs/integrations/document_loaders/google_firestore.ipynb index 6bc247ce7e..0dd446ad0b 100644 --- a/docs/docs/integrations/document_loaders/google_firestore.ipynb +++ b/docs/docs/integrations/document_loaders/google_firestore.ipynb @@ -231,6 +231,7 @@ "metadata": {}, "source": [ "Load langchain documents with `FirestoreLoader.load()` or `Firestore.lazy_load()`. `lazy_load` returns a generator that only queries database during the iteration. To initialize `FirestoreLoader` class you need to provide:\n", + "\n", "1. `source` - An instance of a Query, CollectionGroup, DocumentReference or the single `\\`-delimited path to a Firestore collection`." ] }, diff --git a/docs/docs/integrations/document_loaders/google_memorystore_redis.ipynb b/docs/docs/integrations/document_loaders/google_memorystore_redis.ipynb index 31548263cc..e01cc17d72 100644 --- a/docs/docs/integrations/document_loaders/google_memorystore_redis.ipynb +++ b/docs/docs/integrations/document_loaders/google_memorystore_redis.ipynb @@ -145,6 +145,7 @@ "### Save documents\n", "\n", "Save langchain documents with `MemorystoreDocumentSaver.add_documents()`. To initialize `MemorystoreDocumentSaver` class you need to provide 2 things:\n", + "\n", "1. `client` - A `redis.Redis` client object.\n", "1. `key_prefix` - A prefix for the keys to store Documents in Redis.\n", "\n", @@ -197,6 +198,7 @@ "Initialize a loader that loads all documents stored in the Memorystore for Redis instance with a specific prefix.\n", "\n", "Load langchain documents with `MemorystoreDocumentLoader.load()` or `MemorystoreDocumentLoader.lazy_load()`. `lazy_load` returns a generator that only queries database during the iteration. To initialize `MemorystoreDocumentLoader` class you need to provide:\n", + "\n", "1. `client` - A `redis.Redis` client object.\n", "1. `key_prefix` - A prefix for the keys to store Documents in Redis." ] diff --git a/docs/docs/integrations/document_loaders/google_spanner.ipynb b/docs/docs/integrations/document_loaders/google_spanner.ipynb index d9767e382f..69f3157abb 100644 --- a/docs/docs/integrations/document_loaders/google_spanner.ipynb +++ b/docs/docs/integrations/document_loaders/google_spanner.ipynb @@ -146,8 +146,9 @@ "### Save documents\n", "\n", "Save langchain documents with `SpannerDocumentSaver.add_documents()`. To initialize `SpannerDocumentSaver` class you need to provide 3 things:\n", + "\n", "1. `instance_id` - An instance of Spanner to load data from.\n", - "1. `DATABASE_ID,` - An instance of Spanner database to load data from.\n", + "1. `database_id` - An instance of Spanner database to load data from.\n", "1. `table_name` - The name of the table within the Spanner database to store langchain documents." ] }, @@ -199,8 +200,9 @@ "#### Load documents from table\n", "\n", "Load langchain documents with `SpannerLoader.load()` or `SpannerLoader.lazy_load()`. `lazy_load` returns a generator that only queries database during the iteration. To initialize `SpannerLoader` class you need to provide:\n", + "\n", "1. `instance_id` - An instance of Spanner to load data from.\n", - "1. `DATABASE_ID,` - An instance of Spanner database to load data from.\n", + "1. `database_id` - An instance of Spanner database to load data from.\n", "1. `query` - A query of the database dialect." ] }, diff --git a/docs/docs/integrations/memory/google_alloydb.ipynb b/docs/docs/integrations/memory/google_alloydb.ipynb index 22dd7eef3c..6d3a211d95 100644 --- a/docs/docs/integrations/memory/google_alloydb.ipynb +++ b/docs/docs/integrations/memory/google_alloydb.ipynb @@ -167,7 +167,7 @@ "\n", "One of the requirements and arguments to establish AlloyDB as a ChatMessageHistory memory store is a `AlloyDBEngine` object. The `AlloyDBEngine` configures a connection pool to your AlloyDB database, enabling successful connections from your application and following industry best practices.\n", "\n", - "To create a `AlloyDBEngine` using `AlloyDBEngine.from_instance()` you need to provide only 4 things:\n", + "To create a `AlloyDBEngine` using `AlloyDBEngine.from_instance()` you need to provide only 5 things:\n", "\n", "1. `project_id` : Project ID of the Google Cloud Project where the AlloyDB instance is located.\n", "1. `region` : Region where the AlloyDB instance is located.\n", @@ -178,6 +178,7 @@ "By default, [IAM database authentication](https://cloud.google.com/alloydb/docs/manage-iam-authn) will be used as the method of database authentication. This library uses the IAM principal belonging to the [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials) sourced from the envionment.\n", "\n", "Optionally, [built-in database authentication](https://cloud.google.com/alloydb/docs/database-users/about) using a username and password to access the AlloyDB database can also be used. Just provide the optional `user` and `password` arguments to `AlloyDBEngine.from_instance()`:\n", + "\n", "* `user` : Database user to use for built-in database authentication and login\n", "* `password` : Database password to use for built-in database authentication and login.\n" ] diff --git a/docs/docs/integrations/memory/google_cloud_sql_mysql.ipynb b/docs/docs/integrations/memory/google_cloud_sql_mysql.ipynb index 6b30f5b30b..e7d64fd91f 100644 --- a/docs/docs/integrations/memory/google_cloud_sql_mysql.ipynb +++ b/docs/docs/integrations/memory/google_cloud_sql_mysql.ipynb @@ -227,10 +227,12 @@ "By default, [IAM database authentication](https://cloud.google.com/sql/docs/mysql/iam-authentication#iam-db-auth) will be used as the method of database authentication. This library uses the IAM principal belonging to the [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials) sourced from the envionment.\n", "\n", "For more informatin on IAM database authentication please see:\n", + "\n", "* [Configure an instance for IAM database authentication](https://cloud.google.com/sql/docs/mysql/create-edit-iam-instances)\n", "* [Manage users with IAM database authentication](https://cloud.google.com/sql/docs/mysql/add-manage-iam-users)\n", "\n", "Optionally, [built-in database authentication](https://cloud.google.com/sql/docs/mysql/built-in-authentication) using a username and password to access the Cloud SQL database can also be used. Just provide the optional `user` and `password` arguments to `MySQLEngine.from_instance()`:\n", + "\n", "* `user` : Database user to use for built-in database authentication and login\n", "* `password` : Database password to use for built-in database authentication and login.\n" ] diff --git a/docs/docs/integrations/memory/google_cloud_sql_pg.ipynb b/docs/docs/integrations/memory/google_cloud_sql_pg.ipynb index 0cc8e133a8..57676a4b46 100644 --- a/docs/docs/integrations/memory/google_cloud_sql_pg.ipynb +++ b/docs/docs/integrations/memory/google_cloud_sql_pg.ipynb @@ -211,7 +211,7 @@ "id": "QuQigs4UoFQ2" }, "source": [ - "### PosdtgreSQLEngine Connection Pool\n", + "### PostgreSQLEngine Connection Pool\n", "\n", "One of the requirements and arguments to establish Cloud SQL as a ChatMessageHistory memory store is a `PostgreSQLEngine` object. The `PostgreSQLEngine` configures a connection pool to your Cloud SQL database, enabling successful connections from your application and following industry best practices.\n", "\n", @@ -225,10 +225,12 @@ "By default, [IAM database authentication](https://cloud.google.com/sql/docs/postgres/iam-authentication#iam-db-auth) will be used as the method of database authentication. This library uses the IAM principal belonging to the [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials) sourced from the envionment.\n", "\n", "For more informatin on IAM database authentication please see:\n", + "\n", "* [Configure an instance for IAM database authentication](https://cloud.google.com/sql/docs/postgres/create-edit-iam-instances)\n", "* [Manage users with IAM database authentication](https://cloud.google.com/sql/docs/postgres/add-manage-iam-users)\n", "\n", "Optionally, [built-in database authentication](https://cloud.google.com/sql/docs/postgres/built-in-authentication) using a username and password to access the Cloud SQL database can also be used. Just provide the optional `user` and `password` arguments to `PostgreSQLEngine.from_instance()`:\n", + "\n", "* `user` : Database user to use for built-in database authentication and login\n", "* `password` : Database password to use for built-in database authentication and login.\n" ] diff --git a/docs/docs/integrations/vectorstores/google_alloydb.ipynb b/docs/docs/integrations/vectorstores/google_alloydb.ipynb index f13417004f..c467a3aa95 100644 --- a/docs/docs/integrations/vectorstores/google_alloydb.ipynb +++ b/docs/docs/integrations/vectorstores/google_alloydb.ipynb @@ -224,6 +224,7 @@ "By default, [IAM database authentication](https://cloud.google.com/alloydb/docs/connect-iam) will be used as the method of database authentication. This library uses the IAM principal belonging to the [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials) sourced from the environment.\n", "\n", "Optionally, [built-in database authentication](https://cloud.google.com/alloydb/docs/database-users/about) using a username and password to access the AlloyDB database can also be used. Just provide the optional `user` and `password` arguments to `AlloyDBEngine.from_instance()`:\n", + "\n", "* `user` : Database user to use for built-in database authentication and login\n", "* `password` : Database password to use for built-in database authentication and login.\n" ] diff --git a/docs/docs/integrations/vectorstores/google_cloud_sql_pg.ipynb b/docs/docs/integrations/vectorstores/google_cloud_sql_pg.ipynb index 509b1b985a..404a348c05 100644 --- a/docs/docs/integrations/vectorstores/google_cloud_sql_pg.ipynb +++ b/docs/docs/integrations/vectorstores/google_cloud_sql_pg.ipynb @@ -222,10 +222,12 @@ "By default, [IAM database authentication](https://cloud.google.com/sql/docs/postgres/iam-authentication#iam-db-auth) will be used as the method of database authentication. This library uses the IAM principal belonging to the [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials) sourced from the envionment.\n", "\n", "For more informatin on IAM database authentication please see:\n", + "\n", "* [Configure an instance for IAM database authentication](https://cloud.google.com/sql/docs/postgres/create-edit-iam-instances)\n", "* [Manage users with IAM database authentication](https://cloud.google.com/sql/docs/postgres/add-manage-iam-users)\n", "\n", "Optionally, [built-in database authentication](https://cloud.google.com/sql/docs/postgres/built-in-authentication) using a username and password to access the Cloud SQL database can also be used. Just provide the optional `user` and `password` arguments to `PostgreSQLEngine.from_instance()`:\n", + "\n", "* `user` : Database user to use for built-in database authentication and login\n", "* `password` : Database password to use for built-in database authentication and login.\n" ]