langchain_community.embeddings.zhipuai.ZhipuAIEmbeddings

class langchain_community.embeddings.zhipuai.ZhipuAIEmbeddings[source]

基础: BaseModelEmbeddings

ZhipuAI 嵌入模型集成。

配置

使用前,您应安装 zhipuai Python 包,并将环境变量 ZHIPU_API_KEY 设置为您的 API 密钥。

关于 ZhipuAi Embeddings 的更多说明,您可以访问 https://open.bigmodel.cn/dev/api#vector

pip install -U zhipuai
export ZHIPU_API_KEY="your-api-key"
关键初始化参数 —— 完成参数
model: 可选[str]

ZhipuAI 要使用的模型名称。

api_key: str

如果没有提供,则从环境变量 ZHIPU_API_KEY 中自动推断。

有关支持的初始化参数及其描述的完整列表,请参阅参数部分。

实例化

from langchain_community.embeddings import ZhipuAIEmbeddings

embed = ZhipuAIEmbeddings(
    model="embedding-2",
    # api_key="...",
)
嵌入单个文本
input_text = "The meaning of life is 42"
embed.embed_query(input_text)
[-0.003832892, 0.049372625, -0.035413884, -0.019301128, 0.0068899863, 0.01248398, -0.022153955, 0.006623926, 0.00778216, 0.009558191, ...]
嵌入多个文本
input_texts = ["This is a test query1.", "This is a test query2."]
embed.embed_documents(input_texts)
[
    [0.0083934665, 0.037985895, -0.06684559, -0.039616987, 0.015481004, -0.023952313, ...],
    [-0.02713102, -0.005470169, 0.032321047, 0.042484466, 0.023290444, 0.02170547, ...]
]

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

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

param api_key: str [Required]

如果没有提供,则从环境变量 ZHIPU_API_KEY 中自动推断。

param model: str = 'embedding-2'

模型名称

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

异步嵌入搜索文档。

参数

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

返回

嵌入列表。

返回类型

列表[列表[浮点数]]

async aembed_query(text: str) List[float]

异步嵌入查询文本。

参数

text (字符串) – 要嵌入的文本。

返回

嵌入。

返回类型

列表[浮点数]

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

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

参数

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

返回

输入列表中每个文档的嵌入列表。每个嵌入由浮点值列表表示。

返回类型

列表[列表[浮点数]]

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

使用AutoVOT算法嵌入文本。

参数

text (字符串) – 要嵌入的文本。

返回

输入文档的嵌入列表。

返回类型

列表[浮点数]