AWSKendraRetriever

概述

Amazon Kendra 是亚马逊网络服务 (AWS) 提供的一种智能搜索服务。它利用先进的自然语言处理 (NLP) 和机器学习算法，为组织内各种数据源提供强大的搜索功能。Kendra 旨在帮助用户快速准确地找到所需信息，从而提高生产力和决策能力。

使用 Kendra，用户可以搜索各种内容类型，包括文档、常见问题解答、知识库、手册和网站。它支持多种语言，可以理解复杂的查询、同义词和上下文含义，从而提供高度相关的搜索结果。

这将帮助您开始使用 Amazon Kendra 检索器。有关所有 AWSKendraRetriever 功能和配置的详细文档，请访问 API 参考。

集成详细信息

检索器	来源	包
AWSKendraRetriever	各种 AWS 资源	@langchain/aws

设置

您需要一个 AWS 帐户和一个 Amazon Kendra 实例才能开始。有关更多信息，请参阅 AWS 的 教程。

如果您想从单个查询获得自动跟踪，也可以通过取消下面内容的注释来设置您的 LangSmith API 密钥

// process.env.LANGSMITH_API_KEY = "<YOUR API KEY HERE>";
// process.env.LANGSMITH_TRACING = "true";

安装

此检索器位于 @langchain/aws 包中

提示

有关安装集成包的一般说明，请参阅 此部分。

npm

npm i @langchain/aws

yarn

yarn add @langchain/aws

pnpm

pnpm add @langchain/aws

实例化

现在我们可以实例化检索器

import { AmazonKendraRetriever } from "@langchain/aws";

const retriever = new AmazonKendraRetriever({
  topK: 10,
  indexId: "YOUR_INDEX_ID",
  region: "us-east-2", // Your region
  clientOptions: {
    credentials: {
      accessKeyId: "YOUR_ACCESS_KEY_ID",
      secretAccessKey: "YOUR_SECRET_ACCESS_KEY",
    },
  },
});

用法

const query = "...";

await retriever.invoke(query);

在链中使用

与其他检索器一样，AWSKendraRetriever 可以通过 链 融入 LLM 应用程序。

我们需要一个 LLM 或聊天模型

选择您的聊天模型

OpenAI

安装依赖项

提示

查看 此部分有关安装集成包的一般说明.

npm

npm i @langchain/openai 

yarn

yarn add @langchain/openai 

pnpm

pnpm add @langchain/openai 

添加环境变量

OPENAI_API_KEY=your-api-key

实例化模型

import { ChatOpenAI } from "@langchain/openai";

const llm = new ChatOpenAI({
  model: "gpt-4o-mini",
  temperature: 0
});

Anthropic

安装依赖项

提示

查看 此部分有关安装集成包的一般说明.

npm

npm i @langchain/anthropic 

yarn

yarn add @langchain/anthropic 

pnpm

pnpm add @langchain/anthropic 

添加环境变量

ANTHROPIC_API_KEY=your-api-key

实例化模型

import { ChatAnthropic } from "@langchain/anthropic";

const llm = new ChatAnthropic({
  model: "claude-3-5-sonnet-20240620",
  temperature: 0
});

FireworksAI

安装依赖项

提示

查看 此部分有关安装集成包的一般说明.

npm

npm i @langchain/community 

yarn

yarn add @langchain/community 

pnpm

pnpm add @langchain/community 

添加环境变量

FIREWORKS_API_KEY=your-api-key

实例化模型

import { ChatFireworks } from "@langchain/community/chat_models/fireworks";

const llm = new ChatFireworks({
  model: "accounts/fireworks/models/llama-v3p1-70b-instruct",
  temperature: 0
});

MistralAI

安装依赖项

提示

查看 此部分有关安装集成包的一般说明.

npm

npm i @langchain/mistralai 

yarn

yarn add @langchain/mistralai 

pnpm

pnpm add @langchain/mistralai 

添加环境变量

MISTRAL_API_KEY=your-api-key

实例化模型

import { ChatMistralAI } from "@langchain/mistralai";

const llm = new ChatMistralAI({
  model: "mistral-large-latest",
  temperature: 0
});

Groq

安装依赖项

提示

查看 此部分有关安装集成包的一般说明.

npm

npm i @langchain/groq 

yarn

yarn add @langchain/groq 

pnpm

pnpm add @langchain/groq 

添加环境变量

GROQ_API_KEY=your-api-key

实例化模型

import { ChatGroq } from "@langchain/groq";

const llm = new ChatGroq({
  model: "mixtral-8x7b-32768",
  temperature: 0
});

VertexAI

安装依赖项

提示

查看 此部分有关安装集成包的一般说明.

npm

npm i @langchain/google-vertexai 

yarn

yarn add @langchain/google-vertexai 

pnpm

pnpm add @langchain/google-vertexai 

添加环境变量

GOOGLE_APPLICATION_CREDENTIALS=credentials.json

实例化模型

import { ChatVertexAI } from "@langchain/google-vertexai";

const llm = new ChatVertexAI({
  model: "gemini-1.5-flash",
  temperature: 0
});

import { ChatPromptTemplate } from "@langchain/core/prompts";
import {
  RunnablePassthrough,
  RunnableSequence,
} from "@langchain/core/runnables";
import { StringOutputParser } from "@langchain/core/output_parsers";

import type { Document } from "@langchain/core/documents";

const prompt = ChatPromptTemplate.fromTemplate(`
Answer the question based only on the context provided.

Context: {context}

Question: {question}`);

const formatDocs = (docs: Document[]) => {
  return docs.map((doc) => doc.pageContent).join("\n\n");
};

// See https://js.langchain.ac.cn/v0.2/docs/tutorials/rag
const ragChain = RunnableSequence.from([
  {
    context: retriever.pipe(formatDocs),
    question: new RunnablePassthrough(),
  },
  prompt,
  llm,
  new StringOutputParser(),
]);

await ragChain.invoke(query);

API 参考

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

相关

• 检索器 概念指南
• 检索器 操作指南