Cloud SQL for MySQL for LangChain

image image image

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.

  2. Enable billing for your project.

  3. Enable the Google Cloud SQL Admin API.

  4. Setup Authentication.

Supported Cloud SQL Maintenance Versions

This LangChain integration is only supported for Cloud SQL maintenance versions between MYSQL_8_0_36.R20240401.03_00 and MYSQL_8_0_36.R20241208.01_00

Installation

Install this library in a virtualenv using pip. virtualenv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.

With virtualenv, it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

Supported Python Versions

Python >= 3.9

Mac/Linux

pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install langchain-google-cloud-sql-mysql

Windows

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install langchain-google-cloud-sql-mysql

Vector Store Usage

Use a vector store to store embedded data and perform vector search.

from langchain_google_cloud_sql_mysql import MySQLEngine, MySQLVectorStore
from langchain_google_vertexai import VertexAIEmbeddings

engine = MySQLEngine.from_instance("project-id", "region", "my-instance", "my-database")
engine.init_vectorstore_table(
    table_name="my-table-name",
    vector_size=768
)
vectorstore = MySQLVectorStore(
    engine,
    embedding_service=VertexAIEmbeddings(model_name="textembedding-gecko@003"),
    table_name="my-table-name"
)

See the full Vector Store tutorial.

Document Loader Usage

Use a document loader to load data as LangChain Documents.

from langchain_google_cloud_sql_mysql import MySQLEngine, MySQLLoader

engine = MySQLEngine.from_instance("project-id", "region", "my-instance", "my-database")
loader = MySQLLoader(
    engine,
    table_name="my-table-name"
)
docs = loader.lazy_load()

See the full Document Loader tutorial.

Chat Message History Usage

Use ChatMessageHistory to store messages and provide conversation history to LLMs.

from langchain_google_cloud_sql_mysql import MySQLChatMessageHistory, MySQLEngine

engine = MySQLEngine.from_instance("project-id", "region", "my-instance", "my-database")
history = MySQLChatMessageHistory(
    engine,
    table_name="my-message-store",
    session_id="my-session-id"
)

See the full Chat Message History tutorial.

Contributions

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

License

Apache 2.0 - See LICENSE for more information.

Disclaimer

This is not an officially supported Google product.