`langchain_google_genai嵌入式`.GoogleGenerativeAIEmbeddings¶

class langchain_google_genai.embeddings.GoogleGenerativeAIEmbeddings[源代码]¶

基类： BaseModel、Embeddings

Google 生成式 AI 嵌入.

使用方法：您必须具备以下条件之一

设置环境变量 GOOGLE_API_KEY` 并使用您的 API 密钥，或者

通过 ChatGoogle 构造函数使用 google_api_key 关键字参数传递您的 API 密钥。

示例

from langchain_google_genai import GoogleGenerativeAIEmbeddings

embeddings = GoogleGenerativeAIEmbeddings(model="models/embedding-001")
embeddings.embed_query("What's our Q1 revenue?")

通过解析和验证关键字参数中的输入数据来创建一个新的模型。

如果输入数据无法解析为有效的模型，将引发 ValidationError。

param client_options: Optional[Dict] = None¶: 传递给 Google API 客户端的客户端选项字典，例如 api_endpoint。

param credentials: Any = None¶: 在执行 API 调用时使用的默认自定义凭证（google.auth.credentials.Credentials）。如果没有提供，将从 GOOGLE_API_KEY 环境变量中确认凭证。

param google_api_key: Optional[SecretStr] = None¶

使用的 Google API 密钥。如果没有提供，将使用 GOOGLE_API_KEY 环境变量。

约束

类型 = 字符串
只写 = True
格式 = 密码

param model: str [必需]¶: 要使用的嵌入模型的名称。例如：models/embedding-001

param request_options: Optional[Dict] = None¶: 传递给 Google API 客户端的请求选项字典。例如：{‘timeout’: 10}

参数 task_type: 可选[str] = None¶: 任务类型。有效选项包括：task_type_unspecified, retrieval_query, retrieval_document, semantic_similarity, classification和 clustering

参数 transport: 可选[str] = None¶: 一个字符串，可选值包括：[rest，grpc，grpc_asyncio]

async aembed_documents(texts: List[str]) → List[List[float]]¶

异步嵌入搜索文档。

参数: texts (列表[str]) – 要嵌入的文本列表。
返回: 嵌入列表。
返回类型: 列表[列表[float]]

async aembed_query(text: str) → List[float]¶

异步嵌入文本查询。

参数: text (str) – 要嵌入的文本。
返回: 嵌入向量。
返回类型: 列表[float]

embed_documents(texts: List[str], *, batch_size: int = 100, task_type: Optional[str] = None, titles: Optional[List[str]] = None, output_dimensionality: Optional[int] = None) → List[List[float]][source]¶

将字符串列表嵌入。Google生成式AI当前将最大批量大小设置为100个字符串。

参数

texts (列表[str]) – 要嵌入的字符串列表。
batch_size (整数) – [整数] 发送到模型的嵌入的批量大小。
task_type (可选[str]) – 链接 (https://ai.google.dev/api/rest/v1/TaskType)
titles (可选[列表[str]]) – 为提供的文本提供的可选标题列表。
检索文档. (只有当TaskType适用时) –
output_dimensionality (可选[整数]) – 输出嵌入的可选降维。
https – //ai.google.dev/api/rest/v1/models/batchEmbedContents#EmbedContentRequest

返回

每个文本一个嵌入的嵌入列表。

返回类型

列表[列表[float]]

embed_query(text: str, task_type: Optional[str] = None, title: Optional[str] = None, output_dimensionality: Optional[int] = None) → List[float][源代码]¶

将文本嵌入。

参数

text (str) – 要嵌入的文本。
task_type (可选[str]) – 链接 (https://ai.google.dev/api/rest/v1/TaskType)
title (可选[str]) – 文本的可选标题。
检索文档. (只有当TaskType适用时) –
output_dimensionality (可选[整数]) – 输出嵌入的可选降维。
https – //ai.google.dev/api/rest/v1/models/batchEmbedContents#EmbedContentRequest

返回

文本的嵌入。

返回类型

列表[float]

使用GoogleGenerativeAIEmbeddings的示例¶

langchain_google_genai嵌入式.GoogleGenerativeAIEmbeddings¶

使用GoogleGenerativeAIEmbeddings的示例¶

`langchain_google_genai嵌入式`.GoogleGenerativeAIEmbeddings¶