docs: add github links (#46)

averikitsch · web-flow · commit 54fbab5fd41e · 2024-03-07T12:46:47.000-08:00
diff --git a/docs/chat_message_history.ipynb b/docs/chat_message_history.ipynb
@@ -13,6 +13,8 @@
     "\n",
     "This notebook goes over how to use `Cloud SQL for MySQL` to store chat message history with the `MySQLChatMessageHistory` class.\n",
     "\n",
+    "Learn more about the package on [GitHub](https://github.com/googleapis/langchain-google-cloud-sql-mysql-python/).\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-mysql-python/blob/main/docs/chat_message_history.ipynb)"
    ]
   },
@@ -26,7 +28,9 @@
     "## Before You Begin\n",
     "\n",
     "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",
+    " * [Enable the Cloud SQL Admin API.](https://console.cloud.google.com/marketplace/product/google/sqladmin.googleapis.com)\n",
     " * [Create a Cloud SQL for MySQL instance](https://cloud.google.com/sql/docs/mysql/create-instance)\n",
     " * [Create a Cloud SQL database](https://cloud.google.com/sql/docs/mysql/create-manage-databases)\n",
     " * [Add an IAM database user to the database](https://cloud.google.com/sql/docs/mysql/add-manage-iam-users#creating-a-database-user) (Optional)"
@@ -144,30 +148,6 @@
     "!gcloud config set project {PROJECT_ID}"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "rEWWNoNnKOgq",
-   "metadata": {
-    "id": "rEWWNoNnKOgq"
-   },
-   "source": [
-    "### 💡 API Enablement\n",
-    "The `langchain-google-cloud-sql-mysql` package requires that you [enable the Cloud SQL Admin API](https://console.cloud.google.com/flows/enableapi?apiid=sqladmin.googleapis.com) in your Google Cloud Project."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "5utKIdq7KYi5",
-   "metadata": {
-    "id": "5utKIdq7KYi5"
-   },
-   "outputs": [],
-   "source": [
-    "# enable Cloud SQL Admin API\n",
-    "!gcloud services enable sqladmin.googleapis.com"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "f8f2830ee9ca1e01",
@@ -218,7 +198,7 @@
     "\n",
     "To create a `MySQLEngine` using `MySQLEngine.from_instance()` you need to provide only 4 things:\n",
     "\n",
-    "1.   `project_id` : Project ID of the Google Cloud Project where the Cloud SQL instance is located.\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",
     "1. `instance` : The name of the Cloud SQL instance.\n",
     "1. `database` : The name of the database to connect to on the Cloud SQL instance.\n",
@@ -230,6 +210,7 @@
     "* [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"
    ]
@@ -545,7 +526,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.11.5"
   }
  },
  "nbformat": 4,
diff --git a/docs/document_loader.ipynb b/docs/document_loader.ipynb
@@ -6,10 +6,12 @@
    "source": [
     "# Google Cloud SQL for MySQL\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",
+    "> [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/postgresql), 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 MySQL](https://cloud.google.com/sql/mysql) to [save, load and delete langchain documents](https://python.langchain.com/docs/modules/data_connection/document_loaders/) with `MySQLLoader` and `MySQLDocumentSaver`.\n",
     "\n",
+    "Learn more about the package on [GitHub](https://github.com/googleapis/langchain-google-cloud-sql-mysql-python/).\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-mysql-python/blob/main/docs/document_loader.ipynb)"
    ]
   },
@@ -20,7 +22,9 @@
     "## Before You Begin\n",
     "\n",
     "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",
+    "* [Enable the Cloud SQL Admin API.](https://console.cloud.google.com/marketplace/product/google/sqladmin.googleapis.com)\n",
     "* [Create a Cloud SQL for MySQL instance](https://cloud.google.com/sql/docs/mysql/create-instance)\n",
     "* [Create a Cloud SQL database](https://cloud.google.com/sql/docs/mysql/create-manage-databases)\n",
     "* [Add an IAM database user to the database](https://cloud.google.com/sql/docs/mysql/add-manage-iam-users#creating-a-database-user) (Optional)\n",
@@ -136,24 +140,6 @@
     "auth.authenticate_user()"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### API Enablement\n",
-    "The `langchain-google-cloud-sql-mysql` package requires that you [enable the Cloud SQL Admin API](https://console.cloud.google.com/flows/enableapi?apiid=sqladmin.googleapis.com) in your Google Cloud Project."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# enable Cloud SQL Admin API\n",
-    "!gcloud services enable sqladmin.googleapis.com"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -179,10 +165,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."
    ]
@@ -207,6 +195,7 @@
     "### Initialize a table\n",
     "\n",
     "Initialize a table of default schema via `MySQLEngine.init_document_table(<table_name>)`. Table Columns:\n",
+    "\n",
     "- page_content (type: text)\n",
     "- langchain_metadata (type: JSON)\n",
     "\n",
@@ -229,6 +218,7 @@
     "### Save documents\n",
     "\n",
     "Save langchain documents with `MySQLDocumentSaver.add_documents(<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."
    ]
@@ -241,8 +231,8 @@
    },
    "outputs": [],
    "source": [
-    "from langchain_google_cloud_sql_mysql import MySQLDocumentSaver\n",
     "from langchain_core.documents import Document\n",
+    "from langchain_google_cloud_sql_mysql import MySQLDocumentSaver\n",
     "\n",
     "test_docs = [\n",
     "    Document(\n",
@@ -274,6 +264,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."
    ]
@@ -345,6 +336,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]`"
    ]
@@ -402,7 +394,7 @@
     "            CREATE TABLE IF NOT EXISTS `{TABLE_NAME}`(\n",
     "                fruit_id INT AUTO_INCREMENT PRIMARY KEY,\n",
     "                fruit_name VARCHAR(100) NOT NULL,\n",
-    "                variety VARCHAR(50),  \n",
+    "                variety VARCHAR(50),\n",
     "                quantity_in_stock INT NOT NULL,\n",
     "                price_per_unit DECIMAL(6,2) NOT NULL,\n",
     "                organic TINYINT(1) NOT NULL\n",
@@ -449,6 +441,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",
@@ -487,12 +480,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",
@@ -532,6 +527,7 @@
    "metadata": {},
    "source": [
     "Save documents with `MySQLDocumentSaver.add_documents(<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",
@@ -585,6 +581,7 @@
     "We can also delete documents from table with customized metadata columns via `MySQLDocumentSaver.delete(<documents>)`. 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",
