IBM watsonx.ai

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

概述

集成详情

类	包	本地	Py 支持	包下载	包最新
WatsonxEmbeddings	@langchain/community	❌	✅

设置

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

凭据

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

IAM 身份验证

export WATSONX_AI_AUTH_TYPE=iam
export WATSONX_AI_APIKEY=<YOUR-APIKEY>

Bearer 令牌身份验证

export WATSONX_AI_AUTH_TYPE=bearertoken
export WATSONX_AI_BEARER_TOKEN=<YOUR-BEARER-TOKEN>

IBM watsonx.ai 软件身份验证

export WATSONX_AI_AUTH_TYPE=cp4d
export WATSONX_AI_USERNAME=<YOUR_USERNAME>
export WATSONX_AI_PASSWORD=<YOUR_PASSWORD>
export WATSONX_AI_URL=<URL>

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

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

IAM 身份验证

import { WatsonxEmbeddings } from "@langchain/community/embeddings/ibm";

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

Bearer 令牌身份验证

import { WatsonxEmbeddings } from "@langchain/community/embeddings/ibm";

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

IBM watsonx.ai 软件身份验证

import { WatsonxEmbeddings } from "@langchain/community/embeddings/ibm";

const props = {
  version: "YYYY-MM-DD",
  serviceUrl: "<SERVICE_URL>",
  projectId: "<PROJECT_ID>",
  watsonxAIAuthType: "cp4d",
  watsonxAIUsername: "<YOUR-USERNAME>",
  watsonxAIPassword: "<YOUR-PASSWORD>",
  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/community 包中

提示

请参阅此部分，了解有关安装集成包的通用说明。

npm

npm i @langchain/community @langchain/core

yarn

yarn add @langchain/community @langchain/core

pnpm

pnpm add @langchain/community @langchain/core

实例化

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

import { WatsonxEmbeddings } from "@langchain/community/embeddings/ibm";

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

注意

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

索引和检索

嵌入模型通常用于检索增强生成 (RAG) 流程中，既可以作为索引数据的一部分，也可以在以后检索数据。 有关更详细的说明，请参阅我们的 RAG 教程，位于使用外部知识教程下。

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

// Create a vector store with a sample text
import { MemoryVectorStore } from "langchain/vectorstores/memory";

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 参考

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

相关内容

• 嵌入模型概念指南
• 嵌入模型操作指南