Class: AWSCDK::Bedrock::CfnKnowledgeBase::KnowledgeBaseConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock/cfn_knowledge_base.rb

Overview

Configurations to apply to a knowledge base attached to the agent during query.

For more information, see Knowledge base retrieval configurations .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, kendra_knowledge_base_configuration: nil, managed_knowledge_base_configuration: nil, sql_knowledge_base_configuration: nil, vector_knowledge_base_configuration: nil) ⇒ KnowledgeBaseConfigurationProperty

Returns a new instance of KnowledgeBaseConfigurationProperty.

Parameters:



914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'bedrock/cfn_knowledge_base.rb', line 914

def initialize(type:, kendra_knowledge_base_configuration: nil, managed_knowledge_base_configuration: nil, sql_knowledge_base_configuration: nil, vector_knowledge_base_configuration: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @kendra_knowledge_base_configuration = kendra_knowledge_base_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::KendraKnowledgeBaseConfigurationProperty.new(**kendra_knowledge_base_configuration.transform_keys(&:to_sym)) : kendra_knowledge_base_configuration
  Jsii::Type.check_type(@kendra_knowledge_base_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuS2VuZHJhS25vd2xlZGdlQmFzZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "kendraKnowledgeBaseConfiguration") unless @kendra_knowledge_base_configuration.nil?
  @managed_knowledge_base_configuration = managed_knowledge_base_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::ManagedKnowledgeBaseConfigurationProperty.new(**managed_knowledge_base_configuration.transform_keys(&:to_sym)) : managed_knowledge_base_configuration
  Jsii::Type.check_type(@managed_knowledge_base_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuTWFuYWdlZEtub3dsZWRnZUJhc2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "managedKnowledgeBaseConfiguration") unless @managed_knowledge_base_configuration.nil?
  @sql_knowledge_base_configuration = sql_knowledge_base_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::SqlKnowledgeBaseConfigurationProperty.new(**sql_knowledge_base_configuration.transform_keys(&:to_sym)) : sql_knowledge_base_configuration
  Jsii::Type.check_type(@sql_knowledge_base_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuU3FsS25vd2xlZGdlQmFzZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "sqlKnowledgeBaseConfiguration") unless @sql_knowledge_base_configuration.nil?
  @vector_knowledge_base_configuration = vector_knowledge_base_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::VectorKnowledgeBaseConfigurationProperty.new(**vector_knowledge_base_configuration.transform_keys(&:to_sym)) : vector_knowledge_base_configuration
  Jsii::Type.check_type(@vector_knowledge_base_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuVmVjdG9yS25vd2xlZGdlQmFzZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "vectorKnowledgeBaseConfiguration") unless @vector_knowledge_base_configuration.nil?
end

Instance Attribute Details

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

Settings for an Amazon Kendra knowledge base.

Returns:

See Also:



936
937
938
 
# File 'bedrock/cfn_knowledge_base.rb', line 936

def kendra_knowledge_base_configuration
  @kendra_knowledge_base_configuration
end

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

Contains details about the model used to create vector embeddings for a managed knowledge base.

Returns:

See Also:



941
942
943
 
# File 'bedrock/cfn_knowledge_base.rb', line 941

def managed_knowledge_base_configuration
  @managed_knowledge_base_configuration
end

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

Specifies configurations for a knowledge base connected to an SQL database.

Returns:

See Also:



946
947
948
 
# File 'bedrock/cfn_knowledge_base.rb', line 946

def sql_knowledge_base_configuration
  @sql_knowledge_base_configuration
end

#type ⇒ String (readonly)

The type of data that the data source is converted into for the knowledge base.

Returns:

  • (String)

See Also:



931
932
933
 
# File 'bedrock/cfn_knowledge_base.rb', line 931

def type
  @type
end

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

Contains details about the model that's used to convert the data source into vector embeddings.

Returns:

See Also:



951
952
953
 
# File 'bedrock/cfn_knowledge_base.rb', line 951

def vector_knowledge_base_configuration
  @vector_knowledge_base_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



953
954
955
956
957
958
959
960
961
 
# File 'bedrock/cfn_knowledge_base.rb', line 953

def self.jsii_properties
  {
    :type => "type",
    :kendra_knowledge_base_configuration => "kendraKnowledgeBaseConfiguration",
    :managed_knowledge_base_configuration => "managedKnowledgeBaseConfiguration",
    :sql_knowledge_base_configuration => "sqlKnowledgeBaseConfiguration",
    :vector_knowledge_base_configuration => "vectorKnowledgeBaseConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



963
964
965
966
967
968
969
970
971
972
973
 
# File 'bedrock/cfn_knowledge_base.rb', line 963

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "kendraKnowledgeBaseConfiguration" => @kendra_knowledge_base_configuration,
    "managedKnowledgeBaseConfiguration" => @managed_knowledge_base_configuration,
    "sqlKnowledgeBaseConfiguration" => @sql_knowledge_base_configuration,
    "vectorKnowledgeBaseConfiguration" => @vector_knowledge_base_configuration,
  })
  result.compact
end