火山嵌入

class langchain_community.embeddings.volcengine.VolcanoEmbeddings

基础类：BaseModel, Embeddings

Volcengine Embeddings 嵌入模型。

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

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

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

param chunk_size: int = 100

当输入多个文本时的块大小

param client: Any [Required]

火山客户端

param host: str = 'maas-api.ml-platform-cn-beijing.volces.com'

主机 了解更多请访问 https://www.volcengine.com/docs/82379/1174746

param model: str = 'bge-large-zh'

模型名称 你可以从https://www.volcengine.com/docs/82379/1174746获取 目前，我们支持bge_large_zh

param region: str = 'cn-beijing'

区域 了解更多请访问 https://www.volcengine.com/docs/82379/1174746

param version: str = '1.0'

模型版本

param volcano_ak: str | None = None

火山访问密钥 了解更多信息，请访问: https://www.volcengine.com/docs/6459/76491#ak-sk

param volcano_sk: str | None = None

火山密钥 了解更多信息：https://www.volcengine.com/docs/6459/76491#ak-sk

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

使用AutoVOT算法嵌入一系列文本文档。

Parameters:

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

Returns:

输入列表中每个文档的嵌入列表。

每个嵌入表示为一个浮点值列表。

Return type:

列表[列表[浮点数]]

embed_query(text: str) → List[float]

嵌入查询文本。

Parameters:

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

Returns:

嵌入。

Return type:

列表[float]

classmethod validate_environment(values: Dict) → Dict

验证环境变量或配置文件中的volcano_ak和volcano_sk是否可用。

使用ak、sk、host、region初始化火山嵌入客户端

Parameters:

• values (Dict) – 包含配置信息的字典，必须包括

• volcano_sk (字段 的 volcano_ak 和)

Returns:

一个包含配置信息的字典。如果环境变量或配置文件中未提供volcano_ak和volcano_sk，则返回原始值；否则，返回包含volcano_ak和volcano_sk的值。

Raises:

• ValueError – 未找到volcengine包，请使用以下命令安装

• pip install volcengine –

Return type:

字典

使用VolcanoEmbeddings的示例

• Volc Engine