AmazonKendraRetriever()| Name | Type | Description |
|---|---|---|
index_id* | unknown | Kendra index id |
region_name* | unknown | The aws region e.g., |
credentials_profile_name* | unknown | 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 | No of results to return |
attribute_filter* | unknown | Additional filtering of results based on metadata See: https://docs.aws.amazon.com/kendra/latest/APIReference |
document_relevance_override_configurations* | unknown | 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 | |
client* | unknown | |
user_context* | unknown |
Amazon Kendra Index retriever.
Example:
.. code-block:: python
retriever = AmazonKendraRetriever( index_id="c0806df7-e76b-4bce-9b5c-d5582f6b1a03" )
generates the Document page_content allowing access to all result item attributes. By default, it uses the item's title and excerpt.
boto3 client for Kendra
Provides information about the user context See: https://docs.aws.amazon.com/kendra/latest/APIReference