Skip to main content
Open In ColabOpen on GitHub

IBM watsonx.ai

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

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

概述​

集成详情​

提供商包
IBMlangchain-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

此外，您还可以将额外的密钥作为环境变量传递。

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/slate-125m-english-rtrvr",
    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/slate-125m-english-rtrvr",
    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/slate-125m-english-rtrvr",
    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'

直接使用​

在底层，向量存储和检索器实现正在调用 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参考。

这个页面有帮助吗？