Class: AWSCDK::Lex::CfnBot::BedrockKnowledgeStoreConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lex/cfn_bot.rb

Overview

Contains details about the configuration of a Amazon Bedrock knowledge base.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bedrock_knowledge_base_arn: nil, bkb_exact_response_fields: nil, exact_response: nil) ⇒ BedrockKnowledgeStoreConfigurationProperty

Returns a new instance of BedrockKnowledgeStoreConfigurationProperty.

Parameters:

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

    The base ARN of the knowledge base used.

  • bkb_exact_response_fields (AWSCDK::IResolvable, AWSCDK::Lex::CfnBot::BKBExactResponseFieldsProperty, nil) (defaults to: nil)
  • exact_response (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.



1179
1180
1181
1182
1183
1184
1185
1186
 
# File 'lex/cfn_bot.rb', line 1179

def initialize(bedrock_knowledge_base_arn: nil, bkb_exact_response_fields: nil, exact_response: nil)
  @bedrock_knowledge_base_arn = bedrock_knowledge_base_arn
  Jsii::Type.check_type(@bedrock_knowledge_base_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bedrockKnowledgeBaseArn") unless @bedrock_knowledge_base_arn.nil?
  @bkb_exact_response_fields = bkb_exact_response_fields.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::BKBExactResponseFieldsProperty.new(**bkb_exact_response_fields.transform_keys(&:to_sym)) : bkb_exact_response_fields
  Jsii::Type.check_type(@bkb_exact_response_fields, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkJLQkV4YWN0UmVzcG9uc2VGaWVsZHNQcm9wZXJ0eSJ9XX19")), "bkbExactResponseFields") unless @bkb_exact_response_fields.nil?
  @exact_response = exact_response
  Jsii::Type.check_type(@exact_response, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "exactResponse") unless @exact_response.nil?
end

Instance Attribute Details

#bedrock_knowledge_base_arn ⇒ String? (readonly)

The base ARN of the knowledge base used.

Returns:

  • (String, nil)

See Also:



1192
1193
1194
 
# File 'lex/cfn_bot.rb', line 1192

def bedrock_knowledge_base_arn
  @bedrock_knowledge_base_arn
end

#bkb_exact_response_fields ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



1195
1196
1197
 
# File 'lex/cfn_bot.rb', line 1195

def bkb_exact_response_fields
  @bkb_exact_response_fields
end

#exact_response ⇒ Boolean, ... (readonly)

Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.

Returns:

See Also:



1200
1201
1202
 
# File 'lex/cfn_bot.rb', line 1200

def exact_response
  @exact_response
end

Class Method Details

.jsii_properties ⇒ Object 



1202
1203
1204
1205
1206
1207
1208
 
# File 'lex/cfn_bot.rb', line 1202

def self.jsii_properties
  {
    :bedrock_knowledge_base_arn => "bedrockKnowledgeBaseArn",
    :bkb_exact_response_fields => "bkbExactResponseFields",
    :exact_response => "exactResponse",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'lex/cfn_bot.rb', line 1210

def to_jsii
  result = {}
  result.merge!({
    "bedrockKnowledgeBaseArn" => @bedrock_knowledge_base_arn,
    "bkbExactResponseFields" => @bkb_exact_response_fields,
    "exactResponse" => @exact_response,
  })
  result.compact
end