Google Cloud SQL for PostgreSQL
Cloud SQL 是一項全代管的關聯式資料庫服務,提供高效能、無縫整合和出色的擴充性。它提供 PostgreSQL、PostgreSQL 和 SQL Server 資料庫引擎。擴展您的資料庫應用程式,利用 Cloud SQL 的 Langchain 整合功能建置 AI 驅動的體驗。
本筆記本介紹如何使用 Cloud SQL for PostgreSQL
,透過 PostgresVectorStore
類別儲存向量嵌入。
在 GitHub 上了解有關套件的更多資訊。
開始之前
若要執行此筆記本,您需要執行以下操作
🦜🔗 程式庫安裝
安裝整合程式庫 langchain-google-cloud-sql-pg
和嵌入服務的程式庫 langchain-google-vertexai
。
%pip install --upgrade --quiet langchain-google-cloud-sql-pg langchain-google-vertexai
僅限 Colab:取消註解以下儲存格以重新啟動核心,或使用按鈕重新啟動核心。對於 Vertex AI Workbench,您可以使用頂部的按鈕重新啟動終端機。
# # Automatically restart kernel after installs so that your environment can access the new packages
# import IPython
# app = IPython.Application.instance()
# app.kernel.do_shutdown(True)
🔐 驗證
以登入此筆記本的 IAM 使用者身分驗證 Google Cloud,以便存取您的 Google Cloud 專案。
- 如果您使用 Colab 執行此筆記本,請使用以下儲存格並繼續。
- 如果您使用 Vertex AI Workbench,請查看 此處 的設定說明。
from google.colab import auth
auth.authenticate_user()
☁ 設定您的 Google Cloud 專案
設定您的 Google Cloud 專案,以便您可以利用此筆記本中的 Google Cloud 資源。
如果您不知道您的專案 ID,請嘗試以下操作
- 執行
gcloud config list
。 - 執行
gcloud projects list
。 - 請參閱支援頁面:尋找專案 ID。
# @markdown Please fill in the value below with your Google Cloud project ID and then run the cell.
PROJECT_ID = "my-project-id" # @param {type:"string"}
# Set the project id
!gcloud config set project {PROJECT_ID}
基本用法
設定 Cloud SQL 資料庫值
在 Cloud SQL 執行個體頁面中尋找您的資料庫值。
# @title Set Your Values Here { display-mode: "form" }
REGION = "us-central1" # @param {type: "string"}
INSTANCE = "my-pg-instance" # @param {type: "string"}
DATABASE = "my-database" # @param {type: "string"}
TABLE_NAME = "vector_store" # @param {type: "string"}
PostgresEngine 連線池
將 Cloud SQL 建立為向量儲存區的需求和引數之一是 PostgresEngine
物件。PostgresEngine
設定與 Cloud SQL 資料庫的連線池,從而實現應用程式的成功連線,並遵循業界最佳實務。
若要使用 PostgresEngine.from_instance()
建立 PostgresEngine
,您只需要提供 4 個項目
project_id
:Cloud SQL 執行個體所在的 Google Cloud 專案的專案 ID。region
:Cloud SQL 執行個體所在的區域。instance
:Cloud SQL 執行個體的名稱。database
:要連線到 Cloud SQL 執行個體上的資料庫名稱。
預設情況下,IAM 資料庫驗證將用作資料庫驗證方法。此程式庫使用屬於從環境取得的 應用程式預設憑證 (ADC) 的 IAM 主體。
如需有關 IAM 資料庫驗證的更多資訊,請參閱
或者,也可以使用使用使用者名稱和密碼的 內建資料庫驗證 來存取 Cloud SQL 資料庫。只需將選用的 user
和 password
引數提供給 PostgresEngine.from_instance()
user
:用於內建資料庫驗證和登入的資料庫使用者password
:用於內建資料庫驗證和登入的資料庫密碼。
「注意:本教學課程示範非同步介面。所有非同步方法都有對應的同步方法。」
from langchain_google_cloud_sql_pg import PostgresEngine
engine = await PostgresEngine.afrom_instance(
project_id=PROJECT_ID, region=REGION, instance=INSTANCE, database=DATABASE
)
初始化資料表
PostgresVectorStore
類別需要資料庫資料表。PostgresEngine
引擎有一個輔助方法 init_vectorstore_table()
,可用於建立具有適當結構描述的資料表。
from langchain_google_cloud_sql_pg import PostgresEngine
await engine.ainit_vectorstore_table(
table_name=TABLE_NAME,
vector_size=768, # Vector size for VertexAI model(textembedding-gecko@latest)
)
建立嵌入類別執行個體
您可以使用任何 LangChain 嵌入模型。您可能需要啟用 Vertex AI API 才能使用 VertexAIEmbeddings
。我們建議為生產環境設定嵌入模型的版本,請參閱有關 文字嵌入模型 的更多資訊。
# enable Vertex AI API
!gcloud services enable aiplatform.googleapis.com
from langchain_google_vertexai import VertexAIEmbeddings
embedding = VertexAIEmbeddings(
model_name="textembedding-gecko@latest", project=PROJECT_ID
)
初始化預設 PostgresVectorStore
from langchain_google_cloud_sql_pg import PostgresVectorStore
store = await PostgresVectorStore.create( # Use .create() to initialize an async vector store
engine=engine,
table_name=TABLE_NAME,
embedding_service=embedding,
)
新增文字
import uuid
all_texts = ["Apples and oranges", "Cars and airplanes", "Pineapple", "Train", "Banana"]
metadatas = [{"len": len(t)} for t in all_texts]
ids = [str(uuid.uuid4()) for _ in all_texts]
await store.aadd_texts(all_texts, metadatas=metadatas, ids=ids)
刪除文字
await store.adelete([ids[1]])
搜尋文件
query = "I'd like a fruit."
docs = await store.asimilarity_search(query)
print(docs)
透過向量搜尋文件
query_vector = embedding.embed_query(query)
docs = await store.asimilarity_search_by_vector(query_vector, k=2)
print(docs)
新增索引
透過套用向量索引來加速向量搜尋查詢。了解更多關於向量索引的資訊。
from langchain_google_cloud_sql_pg.indexes import IVFFlatIndex
index = IVFFlatIndex()
await store.aapply_vector_index(index)
重新建立索引
await store.areindex() # Re-index using default index name
移除索引
await store.aadrop_vector_index() # Delete index using default name
建立自訂向量儲存區
向量儲存區可以利用關聯式資料來篩選相似性搜尋。
建立包含自訂 metadata 欄位的表格。
from langchain_google_cloud_sql_pg import Column
# Set table name
TABLE_NAME = "vectorstore_custom"
await engine.ainit_vectorstore_table(
table_name=TABLE_NAME,
vector_size=768, # VertexAI model: textembedding-gecko@latest
metadata_columns=[Column("len", "INTEGER")],
)
# Initialize PostgresVectorStore
custom_store = await PostgresVectorStore.create(
engine=engine,
table_name=TABLE_NAME,
embedding_service=embedding,
metadata_columns=["len"],
# Connect to a existing VectorStore by customizing the table schema:
# id_column="uuid",
# content_column="documents",
# embedding_column="vectors",
)
使用 metadata 篩選器搜尋文件
import uuid
# Add texts to the Vector Store
all_texts = ["Apples and oranges", "Cars and airplanes", "Pineapple", "Train", "Banana"]
metadatas = [{"len": len(t)} for t in all_texts]
ids = [str(uuid.uuid4()) for _ in all_texts]
await store.aadd_texts(all_texts, metadatas=metadatas, ids=ids)
# Use filter on search
docs = await custom_store.asimilarity_search_by_vector(query_vector, filter="len >= 6")
print(docs)