以编程方式使用文档

概述

这将帮助您开始使用 Watsonx 文档压缩器。有关 Watsonx 文档压缩器所有功能和配置的详细文档，请参阅 API 参考.

集成详情

类包PY 支持下载量版本
WatsonxRerank@langchain/ibm✅!NPM - 下载量!NPM - 版本

设置

要访问 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 WatsonxRerank(props);

Bearer 令牌身份验证

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

IBM watsonx.ai 软件身份验证

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

如果您想从单个查询获取自动跟踪，您还可以设置您的 LangSmith API 密钥，只需取消下方注释：

// process.env.LANGSMITH_API_KEY = "";
// process.env.LANGSMITH_TRACING = "true";

安装

此文档压缩器位于 @langchain/ibm package:

npm install @langchain/ibm @langchain/core
yarn add @langchain/ibm @langchain/core
pnpm add @langchain/ibm @langchain/core

实例化

现在我们可以实例化我们的压缩器：

const watsonxRerank = new WatsonxRerank({
  version: "2024-05-31",
  serviceUrl: process.env.WATSONX_AI_SERVICE_URL,
  projectId: process.env.WATSONX_AI_PROJECT_ID,
  model: "cross-encoder/ms-marco-minilm-l-12-v2",
});

用法

首先，设置一个包含嵌入、分词器和向量存储的基本 RAG 摄取管道。我们将使用它来对与所选查询相关的文档进行重新排序：

const embeddings = new WatsonxEmbeddings({
 version: "YYYY-MM-DD",
 serviceUrl: process.env.API_URL,
 projectId: "",
 spaceId: "",
 model: "ibm/slate-125m-english-rtrvr",
});

const textSplitter = new CharacterTextSplitter({
  chunkSize: 400,
  chunkOverlap: 0,
});

const query = "What did the president say about Ketanji Brown Jackson";
const text = readFileSync("state_of_the_union.txt", "utf8");

const docs = await textSplitter.createDocuments([text]);
const vectorStore = await MemoryVectorStore.fromDocuments(docs, embeddings);
const vectorStoreRetriever = vectorStore.asRetriever();

const result = await vectorStoreRetriever.invoke(query);
console.log(result);
[
  Document {
    pageContent: 'And I did that 4 days ago, when I nominated Circuit Court of Appeals Judge Ketanji Brown Jackson. One of our nation’s top legal minds, who will continue Justice Breyer’s legacy of excellence.',
    metadata: { loc: [Object] },
    id: undefined
  },
  Document {
    pageContent: 'I spoke with their families and told them that we are forever in debt for their sacrifice, and we will carry on their mission to restore the trust and safety every community deserves. \n' +
      '\n' +
      'I’ve worked on these issues a long time. \n' +
      '\n' +
      'I know what works: Investing in crime preventionand community police officers who’ll walk the beat, who’ll know the neighborhood, and who can restore trust and safety.',
    metadata: { loc: [Object] },
    id: undefined
  },
  Document {
    pageContent: 'We are the only nation on Earth that has always turned every crisis we have faced into an opportunity. \n' +
      '\n' +
      'The only nation that can be defined by a single word: possibilities. \n' +
      '\n' +
      'So on this night, in our 245th year as a nation, I have come to report on the State of the Union. \n' +
      '\n' +
      'And my report is this: the State of the Union is strong—because you, the American people, are strong.',
    metadata: { loc: [Object] },
    id: undefined
  },
  Document {
    pageContent: 'And I’m taking robust action to make sure the pain of our sanctions  is targeted at Russia’s economy. And I will use every tool at our disposal to protect American businesses and consumers. \n' +
      '\n' +
      'Tonight, I can announce that the United States has worked with 30 other countries to release 60 Million barrels of oil from reserves around the world.',
    metadata: { loc: [Object] },
    id: undefined
  }
]

传递所选文档进行重新排序，并接收每个文档的特定分数

const reranker = new WatsonxRerank({
  version: "2024-05-31",
  serviceUrl: process.env.WATSONX_AI_SERVICE_URL,
  projectId: process.env.WATSONX_AI_PROJECT_ID,
  model: "cross-encoder/ms-marco-minilm-l-12-v2",
});
const compressed = await reranker.rerank(result, query);
console.log(compressed);
[
  { index: 0, relevanceScore: 0.726995587348938 },
  { index: 1, relevanceScore: 0.5758284330368042 },
  { index: 2, relevanceScore: 0.5479092597961426 },
  { index: 3, relevanceScore: 0.5468723773956299 }
]

或者，您可以返回带有结果的文档，为此请使用如下所示的 .compressDocuments() 方法。

const compressedWithResults = await reranker.compressDocuments(result, query);
console.log(compressedWithResults);
[
  Document {
    pageContent: 'And I did that 4 days ago, when I nominated Circuit Court of Appeals Judge Ketanji Brown Jackson. One of our nation’s top legal minds, who will continue Justice Breyer’s legacy of excellence.',
    metadata: { loc: [Object], relevanceScore: 0.726995587348938 },
    id: undefined
  },
  Document {
    pageContent: 'I spoke with their families and told them that we are forever in debt for their sacrifice, and we will carry on their mission to restore the trust and safety every community deserves. \n' +
      '\n' +
      'I’ve worked on these issues a long time. \n' +
      '\n' +
      'I know what works: Investing in crime preventionand community police officers who’ll walk the beat, who’ll know the neighborhood, and who can restore trust and safety.',
    metadata: { loc: [Object], relevanceScore: 0.5758284330368042 },
    id: undefined
  },
  Document {
    pageContent: 'We are the only nation on Earth that has always turned every crisis we have faced into an opportunity. \n' +
      '\n' +
      'The only nation that can be defined by a single word: possibilities. \n' +
      '\n' +
      'So on this night, in our 245th year as a nation, I have come to report on the State of the Union. \n' +
      '\n' +
      'And my report is this: the State of the Union is strong—because you, the American people, are strong.',
    metadata: { loc: [Object], relevanceScore: 0.5479092597961426 },
    id: undefined
  },
  Document {
    pageContent: 'And I’m taking robust action to make sure the pain of our sanctions  is targeted at Russia’s economy. And I will use every tool at our disposal to protect American businesses and consumers. \n' +
      '\n' +
      'Tonight, I can announce that the United States has worked with 30 other countries to release 60 Million barrels of oil from reserves around the world.',
    metadata: { loc: [Object], relevanceScore: 0.5468723773956299 },
    id: undefined
  }
]

API 参考

有关 Watsonx 文档压缩器所有功能和配置的详细文档，请参阅 API 参考.