AWSKendraRetriever integration

Overview

Amazon Kendra is an intelligent search service provided by Amazon Web Services (AWS). It utilizes advanced natural language processing (NLP) and machine learning algorithms to enable powerful search capabilities across various data sources within an organization. Kendra is designed to help users find the information they need quickly and accurately, improving productivity and decision-making.

With Kendra, users can search across a wide range of content types, including documents, FAQs, knowledge bases, manuals, and websites. It supports multiple languages and can understand complex queries, synonyms, and contextual meanings to provide highly relevant search results.

This will help you getting started with AWSKendraRetriever retrieval. For detailed documentation of all AWSKendraRetriever features and configurations head to the API reference.

Integration details

Setup

You'll need an AWS account and an Amazon Kendra instance to get started. See this tutorial from AWS for more information.

If you want to get automated tracing from individual queries, you can also set your LangSmith API key by uncommenting below:

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

Installation

This retriever lives in the @langchain/aws package:

npm install @langchain/aws @langchain/core

yarn add @langchain/aws @langchain/core

pnpm add @langchain/aws @langchain/core

Instantiation

Now we can instantiate our retriever:

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",
    },
  },
});

Usage

const query = "..."

await retriever.invoke(query);

API reference

For detailed documentation of all AmazonKendraRetriever features and configurations head to the API reference.