GoogleGenerativeAIEmbeddings 集成

集成Google Gemini API嵌入模型，使用LangChain Python。

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

概述

gemini-embedding-2-preview 通过 Google GenAI SDK 的 embed_content() API 本地支持文本、图像、视频、音频和 PDF 输入。然而，LangChain 的 Embeddings 接口（embed_query / embed_documents）目前仅接受文本输入。LangChain 中的多模态嵌入支持计划在未来版本中推出。对于当前的多模态用例，请直接使用 Google GenAI SDK。

集成细节

设置

要访问 Google Gemini 嵌入模型，您需要创建一个 Google Cloud 项目，启用生成式语言 API，获取 API 密钥，并安装 langchain-google-genai 集成包。

凭证

前往 Google AI Studio 注册并生成 API 密钥。有关更多详细信息，请参阅 Gemini API 密钥文档。完成此操作后，设置 GOOGLE_API_KEY 环境变量：

import getpass
import os

if not os.getenv("GOOGLE_API_KEY"):
    os.environ["GOOGLE_API_KEY"] = getpass.getpass("Enter your Google API key: ")

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

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

安装

LangChain Google Generative AI 集成位于 langchain-google-genai 包中：

pip install -qU langchain-google-genai

实例化

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

from langchain_google_genai import GoogleGenerativeAIEmbeddings

embeddings = GoogleGenerativeAIEmbeddings(model="gemini-embedding-2-preview")
vector = embeddings.embed_query("hello, world!")
vector[:5]

[-0.024917153641581535,
 0.012005362659692764,
 -0.003886754624545574,
 -0.05774897709488869,
 0.0020742062479257584]

降低维度

gemini-embedding-2-preview 通过 Matryoshka Representation Learning (MRL) 支持灵活的输出维度。您可以降低维度以优化存储和延迟：

embeddings = GoogleGenerativeAIEmbeddings(
    model="gemini-embedding-2-preview",
    output_dimensionality=768,  # Suggested: 768, 1536, or 3072 (default)
)
vector = embeddings.embed_query("hello, world!")
len(vector)

768

批处理

您也可以一次嵌入多个字符串以提高处理速度：

vectors = embeddings.embed_documents(
    [
        "Today is Monday",
        "Today is Tuesday",
        "Today is April Fools day",
    ]
)
len(vectors), len(vectors[0])

(3, 768)

索引和检索

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

任务类型

GoogleGenerativeAIEmbeddings 可选地支持一个 task_type，目前必须为以下之一：

• SEMANTIC_SIMILARITY：用于生成针对文本相似性评估优化的嵌入。
• CLASSIFICATION：用于生成针对根据预设标签对文本进行分类优化的嵌入。
• CLUSTERING：用于生成针对基于文本相似性进行聚类的嵌入。
• RETRIEVAL_DOCUMENT、RETRIEVAL_QUERY、QUESTION_ANSWERING 和 FACT_VERIFICATION：用于生成针对文档搜索或信息检索优化的嵌入。
• CODE_RETRIEVAL_QUERY：用于根据自然语言查询检索代码块，例如排序数组或反转链表。代码块的嵌入使用 RETRIEVAL_DOCUMENT 计算。

默认情况下，我们在 embed_documents 方法中使用 RETRIEVAL_DOCUMENT，在 embed_query 方法中使用 RETRIEVAL_QUERY。如果您提供任务类型，我们将使用该类型为所有方法。

pip install -qU matplotlib scikit-learn

from langchain_google_genai import GoogleGenerativeAIEmbeddings
from sklearn.metrics.pairwise import cosine_similarity

query_embeddings = GoogleGenerativeAIEmbeddings(
    model="gemini-embedding-2-preview", task_type="RETRIEVAL_QUERY"
)
doc_embeddings = GoogleGenerativeAIEmbeddings(
    model="gemini-embedding-2-preview", task_type="RETRIEVAL_DOCUMENT"
)

q_embed = query_embeddings.embed_query("What is the capital of France?")
d_embed = doc_embeddings.embed_documents(
    ["The capital of France is Paris.", "Philipp likes to eat pizza."]
)

for i, d in enumerate(d_embed):
    print(f"Document {i + 1}:")
    print(f"Cosine similarity with query: {cosine_similarity([q_embed], [d])[0][0]}")
    print("---")

Document 1:
Cosine similarity with query: 0.7892893360164779
---
Document 2:
Cosine similarity with query: 0.5438283285204146
---

其他配置

您可以将以下参数传递给 GoogleGenerativeAIEmbeddings 来自定义 SDK 的行为：

• base_url：API 客户端的自定义基本 URL（例如，自定义端点）
• output_dimensionality：降低返回嵌入的维度（例如，output_dimensionality=256）
• request_options：请求选项字典（例如，{"timeout": 10}）
• additional_headers：要在 API 请求中包含的附加 HTTP 标头
• client_args：要传递给底层 HTTP 客户端的附加参数

---

API 参考

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

---

官方原文：src/oss/python/integrations/embeddings/google_generative_ai.mdx · 非官方翻译，译文由 AI 生成，以英文原文为准。