Class: Aws::LexModelBuildingService::Types::KendraConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


2532
2533
2534
2535
2536
2537
2538
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2532

class KendraConfiguration < Struct.new(
  :kendra_index,
  :query_filter_string,
  :role)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


2532
2533
2534
2535
2536
2537
2538
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2532

class KendraConfiguration < Struct.new(
  :kendra_index,
  :query_filter_string,
  :role)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


2532
2533
2534
2535
2536
2537
2538
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2532

class KendraConfiguration < Struct.new(
  :kendra_index,
  :query_filter_string,
  :role)
  SENSITIVE = []
  include Aws::Structure
end