ZhipuAIEmbeddings

本文将引导您开始使用 LangChain 的 ZhipuAI embedding 模型。有关 ZhipuAIEmbeddings 的功能和配置选项的详细文档，请参阅 API 参考。

概览

集成详情

提供商	包
ZhipuAI	langchain-community

设置

要访问 ZhipuAI embedding 模型，您需要创建一个 ZhipuAI 账户，获取 API 密钥，并安装 zhipuai 集成包。

凭证

前往 https://bigmodel.cn/ 注册 ZhipuAI 并生成 API 密钥。完成后，设置 ZHIPUAI_API_KEY 环境变量：

import getpass
import os

if not os.getenv("ZHIPUAI_API_KEY"):
    os.environ["ZHIPUAI_API_KEY"] = getpass.getpass("Enter your ZhipuAI API key: ")

为了启用对模型调用的自动跟踪，请设置您的 LangSmith API 密钥：

# os.environ["LANGSMITH_TRACING"] = "true"
# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")

安装

LangChain ZhipuAI 集成位于 zhipuai 包中：

%pip install -qU zhipuai

Note: you may need to restart the kernel to use updated packages.

实例化

现在我们可以实例化我们的模型对象并生成聊天补全了：

from langchain_community.embeddings import ZhipuAIEmbeddings

embeddings = ZhipuAIEmbeddings(
    model="embedding-3",
    # With the `embedding-3` class
    # of models, you can specify the size
    # of the embeddings you want returned.
    # dimensions=1024
)

API Reference:ZhipuAIEmbeddings

索引和检索

嵌入模型通常用于检索增强生成（RAG）流程，既可以作为索引数据的一部分，也可以用于后续检索数据。有关更详细的说明，请参阅我们的 RAG 教程。

下文介绍了如何使用我们上面初始化的 embeddings 对象来索引和检索数据。在此示例中，我们将在 InMemoryVectorStore 中索引和检索一个示例文档。

# Create a vector store with a sample text
from langchain_core.vectorstores import InMemoryVectorStore

text = "LangChain is the framework for building context-aware reasoning applications"

vectorstore = InMemoryVectorStore.from_texts(
    [text],
    embedding=embeddings,
)

# Use the vectorstore as a retriever
retriever = vectorstore.as_retriever()

# Retrieve the most similar text
retrieved_documents = retriever.invoke("What is LangChain?")

# show the retrieved document's content
retrieved_documents[0].page_content

API Reference:InMemoryVectorStore

'LangChain is the framework for building context-aware reasoning applications'

直接使用

在底层，vectorstore 和 retriever 实现会分别调用 embeddings.embed_documents(...) 和 embeddings.embed_query(...) 来为 from_texts 和检索 invoke 操作中使用的文本创建嵌入。

您可以直接调用这些方法来为自己的用例获取嵌入。

嵌入单个文本

您可以使用 embed_query 来嵌入单个文本或文档：

single_vector = embeddings.embed_query(text)
print(str(single_vector)[:100])  # Show the first 100 characters of the vector

[-0.022979736, 0.007785797, 0.04598999, 0.012741089, -0.01689148, 0.008277893, 0.016464233, 0.009246

嵌入多个文本

您可以使用 embed_documents 来嵌入多个文本：

text2 = (
    "LangGraph is a library for building stateful, multi-actor applications with LLMs"
)
two_vectors = embeddings.embed_documents([text, text2])
for vector in two_vectors:
    print(str(vector)[:100])  # Show the first 100 characters of the vector

[-0.022979736, 0.007785797, 0.04598999, 0.012741089, -0.01689148, 0.008277893, 0.016464233, 0.009246
[-0.02330017, -0.013916016, 0.00022411346, 0.017196655, -0.034240723, 0.011131287, 0.011497498, -0.0

API 参考

有关 ZhipuAIEmbeddings 功能和配置选项的详细文档，请参阅 API 参考。

Related

• Embedding model conceptual guide
• Embedding model how-to guides