/AWS1/CL_LXBKENDRACONF¶
Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance. For more information, see AMAZON.KendraSearchIntent.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_kendraindex TYPE /AWS1/LXBKENDRAINDEXARN /AWS1/LXBKENDRAINDEXARN¶
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
PutIntentoperation.
iv_role TYPE /AWS1/LXBROLEARN /AWS1/LXBROLEARN¶
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
PutIntentoperation.
Optional arguments:¶
iv_queryfilterstring TYPE /AWS1/LXBQUERYFILTERSTRING /AWS1/LXBQUERYFILTERSTRING¶
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.
Queryable Attributes¶
kendraIndex¶
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
PutIntentoperation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KENDRAINDEX() |
Getter for KENDRAINDEX, with configurable default |
ASK_KENDRAINDEX() |
Getter for KENDRAINDEX w/ exceptions if field has no value |
HAS_KENDRAINDEX() |
Determine if KENDRAINDEX has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUERYFILTERSTRING() |
Getter for QUERYFILTERSTRING, with configurable default |
ASK_QUERYFILTERSTRING() |
Getter for QUERYFILTERSTRING w/ exceptions if field has no v |
HAS_QUERYFILTERSTRING() |
Determine if QUERYFILTERSTRING has a value |
role¶
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
PutIntentoperation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLE() |
Getter for ROLE, with configurable default |
ASK_ROLE() |
Getter for ROLE w/ exceptions if field has no value |
HAS_ROLE() |
Determine if ROLE has a value |