这将帮助您开始使用 IBM watsonx.ai 嵌入模型 使用 LangChain。有关详细文档，请参阅 IBM watsonx.ai 功能和配置选项，请参阅 API 参考.

概述

集成详情

设置

要访问 IBM WatsonxAI 嵌入，您需要创建一个 IBM watsonx.ai 账户，获取 API 密钥或任何其他类型的凭证，并安装 @langchain/ibm 集成包。

凭证

前往 IBM Cloud 注册 IBM watsonx.ai 并生成 API 密钥或提供如下所示的其他身份验证形式。

IAM 身份验证

Bearer 令牌身份验证

IBM watsonx.ai 软件身份验证

将这些放置在您的环境变量中并初始化对象后，身份验证将自动进行。

身份验证也可以通过将这些值作为参数传递给新实例来完成。

IAM 身份验证

const props = {
  version: "YYYY-MM-DD",
  serviceUrl: "",
  projectId: "",
  watsonxAIAuthType: "iam",
  watsonxAIApikey: "",
};
const instance = new WatsonxEmbeddings(props);

Bearer 令牌身份验证

const props = {
  version: "YYYY-MM-DD",
  serviceUrl: "",
  projectId: "",
  watsonxAIAuthType: "bearertoken",
  watsonxAIBearerToken: "",
};
const instance = new WatsonxEmbeddings(props);

IBM watsonx.ai 软件身份验证

const props = {
  version: "YYYY-MM-DD",
  serviceUrl: "",
  projectId: "",
  watsonxAIAuthType: "cp4d",
  watsonxAIUsername: "",
  watsonxAIPassword: "",
  watsonxAIUrl: "<url>",
};
const instance = new WatsonxEmbeddings(props);

如果您想获取模型调用的自动化跟踪，还可以设置您的 LangSmith API 密钥，方法是取消注释以下内容：

# export LANGSMITH_TRACING="true"
# export LANGSMITH_API_KEY="your-api-key"

安装

LangChain IBM watsonx.ai 集成位于 @langchain/ibm package:

npm install @langchain/ibm @langchain/core

yarn add @langchain/ibm @langchain/core

pnpm add @langchain/ibm @langchain/core

实例化

现在我们可以实例化模型对象并嵌入文本：

const embeddings = new WatsonxEmbeddings({
  version: "YYYY-MM-DD",
  serviceUrl: process.env.API_URL,
  projectId: "",
  spaceId: "",
  model: "",
});

Note:

• - 您必须提供 spaceId or projectId 才能继续。
• - 根据已配置服务实例的区域，使用正确的 serviceUrl。

模型网关

const instance = new WatsonxEmbeddings({
  version: "YYYY-MM-DD",
  serviceUrl: process.env.API_URL,
  model: "",
  modelGateway: true,
});

索引和检索

嵌入模型常用于检索增强生成（RAG）流程，既作为数据索引的一部分，也用于后续检索。更多详细说明，请参阅 **学习** 标签页下的 RAG 教程.

下文查看如何使用我们上面初始化的 embeddings 对象对数据进行索引和检索。在此示例中，我们将使用演示 MemoryVectorStore.

// Create a vector store with a sample text


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

const vectorstore = await MemoryVectorStore.fromDocuments(
  [{ pageContent: text, metadata: {} }],
  embeddings,
);

// Use the vector store as a retriever that returns a single document
const retriever = vectorstore.asRetriever(1);

// Retrieve the most similar text
const retrievedDocuments = await retriever.invoke("What is LangChain?");

retrievedDocuments[0].pageContent;

LangChain is the framework for building context-aware reasoning applications

直接使用

在底层，向量存储和检索器的实现正在调用 embeddings.embedDocument(...) 和 embeddings.embedQuery(...) 为...创建文本的嵌入，用于 fromDocuments 以及检索器的 invoke 操作，分别。

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

嵌入单个文本

您可以使用 embedQuery为搜索嵌入查询。这会生成一个特定于查询的向量表示：

    const singleVector = await embeddings.embedQuery(text);
    singleVector.slice(0, 10);

[
   -0.017436018,  -0.01469498,
   -0.015685871, -0.013543149,
  -0.0011519607, -0.008123747,
    0.015286108, -0.023845721,
    -0.02454774,   0.07235078
]

嵌入多个文本

您可以使用 embedDocuments为索引嵌入多个文本。此方法使用的内部实现可能（但不必）与嵌入查询不同：

    const text2 = "LangGraph is a library for building stateful, multi-actor applications with LLMs";

    const vectors = await embeddings.embedDocuments([text, text2]);

    console.log(vectors[0].slice(0, 10));
    console.log(vectors[1].slice(0, 10));

[
  -0.017436024, -0.014695002,
   -0.01568589, -0.013543164,
  -0.001151976, -0.008123703,
   0.015286064, -0.023845702,
  -0.024547677,   0.07235076
]
[
     0.03278884, -0.017893745,
  -0.0027520044,  0.016506646,
    0.028271576,  -0.01284331,
    0.014344065, -0.007968607,
    -0.03899479,  0.039327156
]

API 参考

有关 __模块_名称__ 的所有功能和配置的详细文档，请参阅 API 参考： __api_ref_模块__