跳到主要内容
Open In ColabOpen on GitHub

Google Vertex AI 嵌入

这将帮助您开始使用 LangChain 的 Google Vertex AI Embeddings 模型。有关 Google Vertex AI Embeddings 功能和配置选项的详细文档，请参阅API 参考。

概述​

集成详情​

提供商包
谷歌langchain-google-vertexai

设置​

要访问 Google Vertex AI Embeddings 模型，您需要：

  • 创建 Google Cloud 账户
  • 安装 langchain-google-vertexai 集成包。

凭证​

前往Google Cloud注册并创建账户。完成此操作后，设置 GOOGLE_APPLICATION_CREDENTIALS 环境变量

欲了解更多信息，请参阅

https://cloud.google.com/docs/authentication/application-default-credentials#GAC https://googleapis.dev/python/google-auth/latest/reference/google.auth.html#module-google.auth

可选：验证您的 Notebook 环境（仅限 Colab）

如果您在 Google Colab 上运行此 Notebook，请运行以下单元格以验证您的环境。

import sys

if "google.colab" in sys.modules:
    from google.colab import auth

    auth.authenticate_user()

设置 Google Cloud 项目信息并初始化 Vertex AI SDK

要开始使用 Vertex AI，您必须拥有一个现有的 Google Cloud 项目并启用 Vertex AI API。

了解更多关于设置项目和开发环境的信息。

PROJECT_ID = "[your-project-id]"  # @param {type:"string"}
LOCATION = "us-central1"  # @param {type:"string"}

import vertexai

vertexai.init(project=PROJECT_ID, location=LOCATION)

要启用模型调用的自动跟踪，请设置您的 LangSmith API 密钥

# os.environ["LANGSMITH_TRACING"] = "true"
# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")

安装​

LangChain Google Vertex AI Embeddings 集成位于 langchain-google-vertexai 包中

%pip install -qU langchain-google-vertexai

实例化​

现在我们可以实例化模型对象并生成嵌入

查看支持的模型列表

from langchain_google_vertexai import VertexAIEmbeddings

# Initialize the a specific Embeddings Model version
embeddings = VertexAIEmbeddings(model_name="text-embedding-004")
API 参考：VertexAIEmbeddings

索引和检索​

嵌入模型常用于检索增强生成 (RAG) 流程，既用于索引数据，也用于后续检索数据。有关更详细的说明，请参阅我们的RAG 教程。

下面，您将看到如何使用我们上面初始化的 embeddings 对象来索引和检索数据。在此示例中，我们将在 InMemoryVectorStore 中索引和检索一个示例文档。

# Create a vector store with a sample text
from langchain_core.vectorstores import InMemoryVectorStore

text = "LangChain is the framework for building context-aware reasoning applications"

vectorstore = InMemoryVectorStore.from_texts(
    [text],
    embedding=embeddings,
)

# Use the vectorstore as a retriever
retriever = vectorstore.as_retriever()

# Retrieve the most similar text
retrieved_documents = retriever.invoke("What is LangChain?")

# show the retrieved document's content
retrieved_documents[0].page_content
API 参考：InMemoryVectorStore
'LangChain is the framework for building context-aware reasoning applications'

直接用法​

在底层，向量存储和检索器实现分别调用 embeddings.embed_documents(...) 和 embeddings.embed_query(...)，以创建用于 from_texts 和检索 invoke 操作中文本的嵌入。

您可以直接调用这些方法来为自己的用例获取嵌入。

嵌入单个文本​

您可以使用 embed_query 嵌入单个文本或文档

single_vector = embeddings.embed_query(text)
print(str(single_vector)[:100])  # Show the first 100 characters of the vector
[-0.02831101417541504, 0.022063178941607475, -0.07454229146242142, 0.006448323838412762, 0.001955120

嵌入多个文本​

您可以使用 embed_documents 嵌入多个文本

text2 = (
    "LangGraph is a library for building stateful, multi-actor applications with LLMs"
)
two_vectors = embeddings.embed_documents([text, text2])
for vector in two_vectors:
    print(str(vector)[:100])  # Show the first 100 characters of the vector
[-0.01092718355357647, 0.01213780976831913, -0.05650627985596657, 0.006737854331731796, 0.0085973171
[0.010135706514120102, 0.01234869472682476, -0.07284046709537506, 0.00027134662377648056, 0.01546290

API 参考​

有关 Google Vertex AI Embeddings 功能和配置选项的详细文档，请参阅API 参考。