Class: AWSCDK::Lex::CfnBot::KendraConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lex/cfn_bot.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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(kendra_index:, query_filter_string: nil, query_filter_string_enabled: nil) ⇒ KendraConfigurationProperty

Returns a new instance of KendraConfigurationProperty.

Parameters:

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

  • query_filter_string (String, nil) (defaults to: nil) —

    A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.

  • query_filter_string_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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



3764
3765
3766
3767
3768
3769
3770
3771
 
# File 'lex/cfn_bot.rb', line 3764

def initialize(kendra_index:, query_filter_string: nil, query_filter_string_enabled: nil)
  @kendra_index = kendra_index
  Jsii::Type.check_type(@kendra_index, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kendraIndex")
  @query_filter_string = query_filter_string
  Jsii::Type.check_type(@query_filter_string, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryFilterString") unless @query_filter_string.nil?
  @query_filter_string_enabled = query_filter_string_enabled
  Jsii::Type.check_type(@query_filter_string_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "queryFilterStringEnabled") unless @query_filter_string_enabled.nil?
end

Instance Attribute Details

#kendra_index ⇒ String (readonly)

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)

See Also:



3777
3778
3779
 
# File 'lex/cfn_bot.rb', line 3777

def kendra_index
  @kendra_index
end

#query_filter_string ⇒ String? (readonly)

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, nil)

See Also:



3784
3785
3786
 
# File 'lex/cfn_bot.rb', line 3784

def query_filter_string
  @query_filter_string
end

#query_filter_string_enabled ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



3789
3790
3791
 
# File 'lex/cfn_bot.rb', line 3789

def query_filter_string_enabled
  @query_filter_string_enabled
end

Class Method Details

.jsii_properties ⇒ Object 



3791
3792
3793
3794
3795
3796
3797
 
# File 'lex/cfn_bot.rb', line 3791

def self.jsii_properties
  {
    :kendra_index => "kendraIndex",
    :query_filter_string => "queryFilterString",
    :query_filter_string_enabled => "queryFilterStringEnabled",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3799
3800
3801
3802
3803
3804
3805
3806
3807
 
# File 'lex/cfn_bot.rb', line 3799

def to_jsii
  result = {}
  result.merge!({
    "kendraIndex" => @kendra_index,
    "queryFilterString" => @query_filter_string,
    "queryFilterStringEnabled" => @query_filter_string_enabled,
  })
  result.compact
end