You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::LexModelBuildingService::Types::KendraConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::LexModelBuildingService::Types::KendraConfiguration
- Defined in:
- (unknown)
Overview
When passing KendraConfiguration as input to an Aws::Client method, you can use a vanilla Hash:
{
kendra_index: "KendraIndexArn", # required
query_filter_string: "QueryFilterString",
role: "roleArn", # required
}
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.
Returned by:
Instance Attribute Summary collapse
-
#kendra_index ⇒ String
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.
-
#query_filter_string ⇒ String
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query.
-
#role ⇒ String
The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index.
Instance Attribute Details
#kendra_index ⇒ String
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 ⇒ String
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 ⇒ String
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.