Skip to content

QnAKendraConfiguration

Source code in docs_src/capo_lex_models_v2/types/qn_a_kendra_configuration.py
class QnAKendraConfiguration(TypedDict, closed=True):
    kendra_index: "capo_lex_models_v2.types.kendra_index_arn.KendraIndexArn"
    """<p>The ARN of the Amazon Kendra index to use.</p>"""
    query_filter_string_enabled: "capo_lex_models_v2.types.boolean.Boolean"
    """<p>Specifies whether to enable an Amazon Kendra filter string or not.</p>"""
    query_filter_string: NotRequired[
        "capo_lex_models_v2.types.query_filter_string.QueryFilterString"
    ]
    """<p>Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering">Using document attributes to filter search results</a>.</p>"""
    exact_response: "capo_lex_models_v2.types.boolean.Boolean"
    """<p>Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html">Adding frequently asked questions (FAQs) to an index</a>.</p>"""

exact_response instance-attribute

exact_response: Boolean

Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.

kendra_index instance-attribute

kendra_index: KendraIndexArn

The ARN of the Amazon Kendra index to use.

query_filter_string instance-attribute

query_filter_string: NotRequired[QueryFilterString]

Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.

query_filter_string_enabled instance-attribute

query_filter_string_enabled: Boolean

Specifies whether to enable an Amazon Kendra filter string or not.