Skip to main content
已弃用此集成已弃用,将在未来版本中移除。请改用 GoogleGenerativeAIEmbeddings。请参阅完整的发布说明和迁移指南
本文将帮助您使用 LangChain 快速上手 Google Vertex AI 嵌入模型。有关 Google Vertex AI Embeddings 功能和配置选项的详细文档,请参阅 API 参考

概述

集成详情

设置

要访问 Google Vertex AI 嵌入模型,您需要:
  • 创建一个 Google Cloud 账户
  • 安装 langchain-google-vertexai 集成包。

凭证

前往 Google Cloud 注册并创建账户。完成后,设置 GOOGLE_APPLICATION_CREDENTIALS 环境变量: 更多信息请参阅: cloud.google.com/docs/authentication/application-default-credentials#GAC 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 嵌入集成位于 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="gemini-embedding-001")

索引与检索

嵌入模型通常用于检索增强生成(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
'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 参考