IBM watsonx.ai

WatsonxEmbeddings 是 IBM watsonx.ai 基础模型的封装器。

此示例展示了如何使用 LangChain 与 watsonx.ai 模型进行通信。

概览

集成详情

Provider	Package
IBM	langchain-ibm

设置

要访问 IBM watsonx.ai 模型，您需要创建一个 IBM watsonx.ai 帐户、获取 API 密钥，并安装 langchain-ibm 集成包。

凭证

此单元格定义了使用 watsonx Embeddings 所需的 WML 凭证。

操作： 提供 IBM Cloud 用户 API 密钥。有关详细信息，请参阅 文档。

import os
from getpass import getpass

watsonx_api_key = getpass()
os.environ["WATSONX_APIKEY"] = watsonx_api_key

您还可以将其他 Secret 作为环境变量传递。

import os

os.environ["WATSONX_URL"] = "your service instance url"
os.environ["WATSONX_TOKEN"] = "your token for accessing the CPD cluster"
os.environ["WATSONX_PASSWORD"] = "your password for accessing the CPD cluster"
os.environ["WATSONX_USERNAME"] = "your username for accessing the CPD cluster"
os.environ["WATSONX_INSTANCE_ID"] = "your instance_id for accessing the CPD cluster"

安装

LangChain IBM 集成位于 langchain-ibm 包中：

!pip install -qU langchain-ibm

实例化

你可能需要为不同的模型调整模型 parameters。

from ibm_watsonx_ai.metanames import EmbedTextParamsMetaNames

embed_params = {
    EmbedTextParamsMetaNames.TRUNCATE_INPUT_TOKENS: 3,
    EmbedTextParamsMetaNames.RETURN_OPTIONS: {"input_text": True},
}

初始化 WatsonxEmbeddings 类以使用先前设置的参数。

注意:

• 为 API 调用提供上下文，您必须添加 project_id 或 space_id。有关更多信息，请参阅 文档。
• 根据您配置的服务实例的区域，使用此处所述的其中一个 url 链接。

在此示例中，我们将使用 project_id 和达拉斯 url。

您需要指定 model_id 以供推理使用。

from langchain_ibm import WatsonxEmbeddings

watsonx_embedding = WatsonxEmbeddings(
    model_id="ibm/granite-embedding-107m-multilingual",
    url="https://us-south.ml.cloud.ibm.com",
    project_id="PASTE YOUR PROJECT_ID HERE",
    params=embed_params,
)

API Reference:WatsonxEmbeddings

或者，您也可以使用 Cloud Pak for Data 凭证。有关详细信息，请参阅文档。

watsonx_embedding = WatsonxEmbeddings(
    model_id="ibm/granite-embedding-107m-multilingual",
    url="PASTE YOUR URL HERE",
    username="PASTE YOUR USERNAME HERE",
    password="PASTE YOUR PASSWORD HERE",
    instance_id="openshift",
    version="4.8",
    project_id="PASTE YOUR PROJECT_ID HERE",
    params=embed_params,
)

对于某些要求，可以选择将 IBM 的 APIClient 对象传递给 WatsonxEmbeddings 类。

from ibm_watsonx_ai import APIClient

api_client = APIClient(...)

watsonx_embedding = WatsonxEmbeddings(
    model_id="ibm/granite-embedding-107m-multilingual",
    watsonx_client=api_client,
)

索引和检索

嵌入模型通常用于检索增强生成（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=watsonx_embedding,
)

# 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 来嵌入单个文本或文档：

text = "This is a test document."

query_result = watsonx_embedding.embed_query(text)
query_result[:5]

[0.009447193, -0.024981951, -0.026013248, -0.040483937, -0.05780445]

嵌入多个文本

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

texts = ["This is a content of the document", "This is another document"]

doc_result = watsonx_embedding.embed_documents(texts)
doc_result[0][:5]

[0.009447167, -0.024981938, -0.02601326, -0.04048393, -0.05780444]

API 参考

有关 WatsonxEmbeddings 所有功能和配置的详细文档，请访问API 参考。

Related

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