YandexGPTEmbeddings#

class langchain_community.embeddings.yandex.YandexGPTEmbeddings[source]#

基础类:BaseModel, Embeddings

YandexGPT 嵌入模型。

要使用,您应该已安装yandexcloud python包。

服务账户有两种认证选项 具有 ai.languageModels.user 角色:

  • 您可以在构造函数参数 iam_token 中指定令牌

或在环境变量 YC_IAM_TOKEN 中。 - 您可以在构造函数参数 api_key 中指定密钥 或在环境变量 YC_API_KEY 中。

要使用默认模型,请在参数folder_id或环境变量YC_FOLDER_ID中指定文件夹ID。

示例

from langchain_community.embeddings.yandex import YandexGPTEmbeddings
embeddings = YandexGPTEmbeddings(iam_token="t1.9eu...", folder_id=<folder-id>)

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

如果输入数据无法验证以形成有效模型,则引发 [ValidationError][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数,以允许 self 作为字段名称。

param api_key: SecretStr = ''#

用于服务账户的Yandex Cloud Api Key 具有ai.languageModels.user角色

param disable_request_logging: bool = False#

YandexGPT API 默认记录所有请求数据。 如果您提供个人数据或机密信息,请禁用日志记录。

param doc_model_name: str = 'text-search-doc'#

使用的文档模型名称。

param doc_model_uri: str = ''#

使用的文档模型URI。

param folder_id: str = ''#

Yandex Cloud 文件夹 ID

param grpc_metadata: Sequence [Required]#
param iam_token: SecretStr = ''#

Yandex Cloud IAM 服务账户令牌 具有 ai.languageModels.user 角色

param max_retries: int = 6#

生成时的最大重试次数。

param model_name: str = 'text-search-query' (alias 'query_model_name')#

查询要使用的模型名称。

param model_uri: str = '' (alias 'query_model_uri')#

查询要使用的模型URI。

param model_version: str = 'latest'#

使用的模型版本。

param sleep_interval: float = 0.0#

API请求之间的延迟

param url: str = 'llm.api.cloud.yandex.net:443'#

API的URL。

async aembed_documents(texts: list[str]) list[list[float]]#

异步嵌入搜索文档。

Parameters:

文本 (列表[字符串]) – 要嵌入的文本列表。

Returns:

嵌入列表。

Return type:

列表[列表[浮点数]]

async aembed_query(text: str) list[float]#

异步嵌入查询文本。

Parameters:

文本 (str) – 要嵌入的文本。

Returns:

嵌入。

Return type:

列表[浮点数]

embed_documents(texts: List[str]) List[List[float]][来源]#

使用YandexGPT嵌入模型嵌入文档。

Parameters:

文本 (列表[字符串]) – 要嵌入的文本列表。

Returns:

嵌入列表,每个文本对应一个。

Return type:

列表[列表[float]]

embed_query(text: str) List[float][source]#

使用YandexGPT嵌入模型嵌入查询。

Parameters:

文本 (str) – 要嵌入的文本。

Returns:

文本的嵌入。

Return type:

列表[float]

classmethod validate_environment(values: Dict) Dict[source]#

验证环境中是否存在iam令牌。

Parameters:

(字典)

Return type:

字典

使用 YandexGPTEmbeddings 的示例