Skip to content

KendraConfiguration

Used by
Source code in docs_src/capo_lex_model_building_service/types/kendra_configuration.py 
15
16
17
18
19
20
21
22
23
24
25
class KendraConfiguration(TypedDict, closed=True):
    kendra_index: (
        "capo_lex_model_building_service.types.kendra_index_arn.KendraIndexArn"
    )
    """<p>The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the <code>PutIntent</code> operation.</p>"""
    query_filter_string: NotRequired[
        "capo_lex_model_building_service.types.query_filter_string.QueryFilterString"
    ]
    """<p>A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see <a href="http://docs.aws.amazon.com/kendra/latest/dg/filtering.html">Filtering queries</a>.</p> <p>You can override this filter string with a new filter string at runtime.</p>"""
    role: "capo_lex_model_building_service.types.role_arn.roleArn"
    """<p>The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the <code>PutIntent</code> operation.</p>"""

kendra_index instance-attribute 

kendra_index: KendraIndexArn

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the PutIntent operation.

query_filter_string instance-attribute 

query_filter_string: NotRequired[QueryFilterString]

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

You can override this filter string with a new filter string at runtime.

role instance-attribute 

role: roleArn

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the PutIntent operation.