Class: AWSCDK::Bedrock::CfnKnowledgeBase::VectorKnowledgeBaseConfigurationProperty

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

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(embedding_model_arn:, embedding_model_configuration: nil, supplemental_data_storage_configuration: nil) ⇒ VectorKnowledgeBaseConfigurationProperty

Returns a new instance of VectorKnowledgeBaseConfigurationProperty.

Parameters:



2772
2773
2774
2775
2776
2777
2778
2779
 
# File 'bedrock/cfn_knowledge_base.rb', line 2772

def initialize(embedding_model_arn:, embedding_model_configuration: nil, supplemental_data_storage_configuration: nil)
  @embedding_model_arn = embedding_model_arn
  Jsii::Type.check_type(@embedding_model_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "embeddingModelArn")
  @embedding_model_configuration = embedding_model_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::EmbeddingModelConfigurationProperty.new(**embedding_model_configuration.transform_keys(&:to_sym)) : embedding_model_configuration
  Jsii::Type.check_type(@embedding_model_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuRW1iZWRkaW5nTW9kZWxDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "embeddingModelConfiguration") unless @embedding_model_configuration.nil?
  @supplemental_data_storage_configuration = supplemental_data_storage_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::SupplementalDataStorageConfigurationProperty.new(**supplemental_data_storage_configuration.transform_keys(&:to_sym)) : supplemental_data_storage_configuration
  Jsii::Type.check_type(@supplemental_data_storage_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuU3VwcGxlbWVudGFsRGF0YVN0b3JhZ2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "supplementalDataStorageConfiguration") unless @supplemental_data_storage_configuration.nil?
end

Instance Attribute Details

#embedding_model_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

Returns:

  • (String)

See Also:



2785
2786
2787
 
# File 'bedrock/cfn_knowledge_base.rb', line 2785

def embedding_model_arn
  @embedding_model_arn
end

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

The embeddings model configuration details for the vector model used in Knowledge Base.

Returns:

See Also:



2790
2791
2792
 
# File 'bedrock/cfn_knowledge_base.rb', line 2790

def embedding_model_configuration
  @embedding_model_configuration
end

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

If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents.

These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .

Returns:

See Also:



2797
2798
2799
 
# File 'bedrock/cfn_knowledge_base.rb', line 2797

def supplemental_data_storage_configuration
  @supplemental_data_storage_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



2799
2800
2801
2802
2803
2804
2805
 
# File 'bedrock/cfn_knowledge_base.rb', line 2799

def self.jsii_properties
  {
    :embedding_model_arn => "embeddingModelArn",
    :embedding_model_configuration => "embeddingModelConfiguration",
    :supplemental_data_storage_configuration => "supplementalDataStorageConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2807
2808
2809
2810
2811
2812
2813
2814
2815
 
# File 'bedrock/cfn_knowledge_base.rb', line 2807

def to_jsii
  result = {}
  result.merge!({
    "embeddingModelArn" => @embedding_model_arn,
    "embeddingModelConfiguration" => @embedding_model_configuration,
    "supplementalDataStorageConfiguration" => @supplemental_data_storage_configuration,
  })
  result.compact
end