ZhipuAIEmbeddings#

class langchain_community.embeddings.zhipuai.ZhipuAIEmbeddings[source]#

基础类:BaseModel, Embeddings

智谱AI嵌入模型集成。

设置:

要使用,您应该安装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"
Key init args — completion params:
model: Optional[str]

使用的ZhipuAI模型名称。

api_key: str

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

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

实例化:

from langchain_community.embeddings import ZhipuAIEmbeddings

embed = ZhipuAIEmbeddings(
    model="embedding-2",
    # api_key="...",
)
Embed single text:
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, ...]
Embed multiple text:
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][pydantic_core.ValidationError]。

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

param api_key: str [Required]#

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

param dimensions: int | None = None#

生成的输出嵌入应具有的维度数。

仅在embedding-3及更高版本的模型中支持。

param model: str = 'embedding-2'#

模型名称

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]][source]#

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

Parameters:

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

Returns:

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

Return type:

列表[列表[float]]

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

使用AutoVOT算法嵌入文本。

Parameters:

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

Returns:

输入文档的嵌入列表。

Return type:

列表[float]