Class: Aws::LexModelsV2::Types::KendraConfiguration

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

Overview

Note:

When making an API call, you may pass KendraConfiguration data as a hash:

{
  kendra_index: "KendraIndexArn", # required
  query_filter_string_enabled: false,
  query_filter_string: "QueryFilterString",
}

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.

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.

Returns:

  • (String) 


6321
6322
6323
6324
6325
6326
6327
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6321

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

#query_filter_string ⇒ String

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

Returns:

  • (String) 


6321
6322
6323
6324
6325
6326
6327
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6321

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

#query_filter_string_enabled ⇒ Boolean

Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

Returns:

  • (Boolean) 


6321
6322
6323
6324
6325
6326
6327
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6321

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