langchain_community.embeddings.yandex.YandexGPTEmbeddings

class langchain_community.embeddings.yandex.YandexGPTEmbeddings

Bases: BaseModel, Embeddings

YandexGPT嵌入模型。

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

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

• 您可以在构造函数参数`iam_token`中指定令牌，也可以在环境变量`YC_IAM_TOKEN`中指定。

• 您可以在构造函数参数`api_key`中指定密钥，也可以在环境变量`YC_API_KEY`中指定。

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

示例：

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

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param api_key: pydantic.types.SecretStr = ''

Yandex云服务帐户的API密钥 具有`ai.languageModels.user`角色

Constraints

• type = string

• writeOnly = True

• format = password

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云文件夹ID

param iam_token: pydantic.types.SecretStr = ''

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

Constraints

• type = string

• writeOnly = True

• format = password

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

Asynchronous 嵌入搜索文档。

Parameters

texts (List[str]) –

Return type

List[List[float]]

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

Asynchronous 嵌入查询文本。

Parameters

text (str) –

Return type

List[float]

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

Parameters

• _fields_set (Optional[SetStr]) –

• values (Any) –

Return type

Model

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

• include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to include in new model

• exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to exclude from new model, as with values this takes precedence over include

• update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

• deep (bool) – set to True to make a deep copy of the model

• self (Model) –

Returns

new model instance

Return type

Model

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters

• include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

• exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

• by_alias (bool) –

• skip_defaults (Optional[bool]) –

• exclude_unset (bool) –

• exclude_defaults (bool) –

• exclude_none (bool) –

Return type

DictStrAny

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

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

参数：

texts：要嵌入的文本列表。

返回：

每个文本的嵌入列表。

Parameters

texts (List[str]) –

Return type

List[List[float]]

embed_query(text: str) → List[float]

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

参数：

text: 要嵌入的文本。

返回：

文本的嵌入。

Parameters

text (str) –

Return type

List[float]

classmethod from_orm(obj: Any) → Model

Parameters

obj (Any) –

Return type

Model

json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Parameters

• include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

• exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

• by_alias (bool) –

• skip_defaults (Optional[bool]) –

• exclude_unset (bool) –

• exclude_defaults (bool) –

• exclude_none (bool) –

• encoder (Optional[Callable[[Any], Any]]) –

• models_as_dict (bool) –

• dumps_kwargs (Any) –

Return type

unicode

classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model

Parameters

• path (Union[str, Path]) –

• content_type (unicode) –

• encoding (unicode) –

• proto (Protocol) –

• allow_pickle (bool) –

Return type

Model

classmethod parse_obj(obj: Any) → Model

Parameters

obj (Any) –

Return type

Model

classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model

Parameters

• b (Union[str, bytes]) –

• content_type (unicode) –

• encoding (unicode) –

• proto (Protocol) –

• allow_pickle (bool) –

Return type

Model

classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny

Parameters

• by_alias (bool) –

• ref_template (unicode) –

Return type

DictStrAny

classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode

Parameters

• by_alias (bool) –

• ref_template (unicode) –

• dumps_kwargs (Any) –

Return type

unicode

classmethod update_forward_refs(**localns: Any) → None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Parameters

localns (Any) –

Return type

None

classmethod validate(value: Any) → Model

Parameters

value (Any) –

Return type

Model

Examples using YandexGPTEmbeddings

• yandex.md