# AmazonKendraRetriever

> **Class** in `langchain_community`

📖 [View in docs](https://reference.langchain.com/python/langchain-community/retrievers/kendra/AmazonKendraRetriever)

`Amazon Kendra Index` retriever.

## Signature

```python
AmazonKendraRetriever()
```

## Description

**Example:**

.. code-block:: python

retriever = AmazonKendraRetriever(
    index_id="c0806df7-e76b-4bce-9b5c-d5582f6b1a03"
)

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `index_id` | `unknown` | Yes | Kendra index id |
| `region_name` | `unknown` | Yes | The aws region e.g., `us-west-2`. Fallsback to AWS_DEFAULT_REGION env variable or region specified in ~/.aws/config. |
| `credentials_profile_name` | `unknown` | Yes | The name of the profile in the ~/.aws/credentials or ~/.aws/config files, which has either access keys or role information specified. If not specified, the default credential profile or, if on an EC2 instance, credentials from IMDS will be used. |
| `top_k` | `unknown` | Yes | No of results to return |
| `attribute_filter` | `unknown` | Yes | Additional filtering of results based on metadata See: https://docs.aws.amazon.com/kendra/latest/APIReference |
| `document_relevance_override_configurations` | `unknown` | Yes | Overrides relevance tuning configurations of fields/attributes set at the index level See: https://docs.aws.amazon.com/kendra/latest/APIReference |
| `page_content_formatter` | `unknown` | Yes | generates the Document page_content allowing access to all result item attributes. By default, it uses the item's title and excerpt. |
| `client` | `unknown` | Yes | boto3 client for Kendra |
| `user_context` | `unknown` | Yes | Provides information about the user context See: https://docs.aws.amazon.com/kendra/latest/APIReference |

## Extends

- `BaseRetriever`

## Properties

- `index_id`
- `region_name`
- `credentials_profile_name`
- `top_k`
- `attribute_filter`
- `document_relevance_override_configurations`
- `page_content_formatter`
- `client`
- `user_context`
- `min_score_confidence`

## Methods

- [`validate_top_k()`](https://reference.langchain.com/python/langchain-community/retrievers/kendra/AmazonKendraRetriever/validate_top_k)
- [`create_client()`](https://reference.langchain.com/python/langchain-community/retrievers/kendra/AmazonKendraRetriever/create_client)

## ⚠️ Deprecated

Deprecated since version 0.3.16.

---

[View source on GitHub](https://github.com/langchain-ai/langchain-community/blob/d5ea8358933260ad48dd31f7f8076555c7b4885a/libs/community/langchain_community/retrievers/kendra.py#L325)