langchain_community.embeddings.yandex.YandexGPTEmbeddings

class langchain_community.embeddings.yandex.YandexGPTEmbeddings[source]

基类:BaseModelEmbeddings

YandexGPT Embeddings模型。

使用前,您应安装yandexcloud Python包。

对于具有ai.languageModels.user角色的服务帐户有两种身份验证选项

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

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

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

示例

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

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

如果输入数据无法解析为有效模型,则抛出ValidationError

参数 api_key: SecretStr= ''

用于具有角色的服务帐户的Yandex Cloud Api Key

约束
  • 类型 = 字符串

  • 只写 = True

  • 格式 = 密码

参数 disable_request_logging: bool = False

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

参数 doc_model_name: str = 'text-search-doc'

要使用的文档模型名称。

参数 doc_model_uri: str = ''

要使用的文档模型uri。

参数 folder_id: str = ''

Yandex Cloud文件夹ID

param iam_token: SecretStr = ''

Yandex Cloud IAM token for service account with the ai.languageModels.user role

约束
  • 类型 = 字符串

  • 只写 = True

  • 格式 = 密码

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]]

异步嵌入文档搜索。

参数

texts (List[str]) – 要嵌入的文本列表。

返回

嵌入列表。

返回类型

List[List[float]]

async aembed_query(text: str) List[float]

异步文本嵌入查询。

参数

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

返回

嵌入。

返回类型

List[float]

embed_documents(texts: List[str]) List[List[float]][source]

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

参数

texts (List[str]) – 要嵌入的文本列表。

返回

每个文本的嵌入列表。

返回类型

List[List[float]]

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

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

参数

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

返回

文本的嵌入。

返回类型

List[float]

使用YandexGPTEmbeddings的示例