Class: AWSCDK::Bedrock::CfnKnowledgeBase::ManagedKnowledgeBaseConfigurationProperty

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 a managed 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, embedding_model_type: nil, server_side_encryption_configuration: nil) ⇒ ManagedKnowledgeBaseConfigurationProperty

Returns a new instance of ManagedKnowledgeBaseConfigurationProperty.

Parameters:



986
987
988
989
990
991
992
993
994
995
 
# File 'bedrock/cfn_knowledge_base.rb', line 986

def initialize(embedding_model_arn:, embedding_model_configuration: nil, embedding_model_type: nil, server_side_encryption_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?
  @embedding_model_type = embedding_model_type
  Jsii::Type.check_type(@embedding_model_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "embeddingModelType") unless @embedding_model_type.nil?
  @server_side_encryption_configuration = server_side_encryption_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::ManagedKnowledgeBaseServerSideEncryptionConfigurationProperty.new(**server_side_encryption_configuration.transform_keys(&:to_sym)) : server_side_encryption_configuration
  Jsii::Type.check_type(@server_side_encryption_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuTWFuYWdlZEtub3dsZWRnZUJhc2VTZXJ2ZXJTaWRlRW5jcnlwdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "serverSideEncryptionConfiguration") unless @server_side_encryption_configuration.nil?
end

Instance Attribute Details

#embedding_model_arn ⇒ String (readonly)

The ARN of the model used to create vector embeddings for the knowledge base.

Returns:

  • (String)

See Also:



1001
1002
1003
 
# File 'bedrock/cfn_knowledge_base.rb', line 1001

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:



1006
1007
1008
 
# File 'bedrock/cfn_knowledge_base.rb', line 1006

def embedding_model_configuration
  @embedding_model_configuration
end

#embedding_model_type ⇒ String? (readonly)

The type of embedding model to use for the managed knowledge base.

Returns:

  • (String, nil)

See Also:



1011
1012
1013
 
# File 'bedrock/cfn_knowledge_base.rb', line 1011

def embedding_model_type
  @embedding_model_type
end

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

Contains details about the server-side encryption for the managed knowledge base.

Returns:

See Also:



1016
1017
1018
 
# File 'bedrock/cfn_knowledge_base.rb', line 1016

def server_side_encryption_configuration
  @server_side_encryption_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'bedrock/cfn_knowledge_base.rb', line 1018

def self.jsii_properties
  {
    :embedding_model_arn => "embeddingModelArn",
    :embedding_model_configuration => "embeddingModelConfiguration",
    :embedding_model_type => "embeddingModelType",
    :server_side_encryption_configuration => "serverSideEncryptionConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'bedrock/cfn_knowledge_base.rb', line 1027

def to_jsii
  result = {}
  result.merge!({
    "embeddingModelArn" => @embedding_model_arn,
    "embeddingModelConfiguration" => @embedding_model_configuration,
    "embeddingModelType" => @embedding_model_type,
    "serverSideEncryptionConfiguration" => @server_side_encryption_configuration,
  })
  result.compact
end