Class: AWSCDK::Bedrock::CfnFlow::KnowledgeBaseOrchestrationConfigurationProperty

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

Overview

Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(additional_model_request_fields: nil, inference_config: nil, performance_config: nil, prompt_template: nil) ⇒ KnowledgeBaseOrchestrationConfigurationProperty

Returns a new instance of KnowledgeBaseOrchestrationConfigurationProperty.

Parameters:



1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'bedrock/cfn_flow.rb', line 1733

def initialize(additional_model_request_fields: nil, inference_config: nil, performance_config: nil, prompt_template: nil)
  @additional_model_request_fields = additional_model_request_fields
  Jsii::Type.check_type(@additional_model_request_fields, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "additionalModelRequestFields") unless @additional_model_request_fields.nil?
  @inference_config = inference_config.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnFlow::PromptInferenceConfigurationProperty.new(**inference_config.transform_keys(&:to_sym)) : inference_config
  Jsii::Type.check_type(@inference_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkZsb3cuUHJvbXB0SW5mZXJlbmNlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "inferenceConfig") unless @inference_config.nil?
  @performance_config = performance_config.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnFlow::PerformanceConfigurationProperty.new(**performance_config.transform_keys(&:to_sym)) : performance_config
  Jsii::Type.check_type(@performance_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkZsb3cuUGVyZm9ybWFuY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "performanceConfig") unless @performance_config.nil?
  @prompt_template = prompt_template.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnFlow::KnowledgeBasePromptTemplateProperty.new(**prompt_template.transform_keys(&:to_sym)) : prompt_template
  Jsii::Type.check_type(@prompt_template, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkZsb3cuS25vd2xlZGdlQmFzZVByb21wdFRlbXBsYXRlUHJvcGVydHkifV19fQ==")), "promptTemplate") unless @prompt_template.nil?
end

Instance Attribute Details

#additional_model_request_fields ⇒ Object? (readonly)

The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.

Returns:

  • (Object, nil)

See Also:



1748
1749
1750
 
# File 'bedrock/cfn_flow.rb', line 1748

def additional_model_request_fields
  @additional_model_request_fields
end

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

Contains inference configurations for the prompt.

Returns:

See Also:



1753
1754
1755
 
# File 'bedrock/cfn_flow.rb', line 1753

def inference_config
  @inference_config
end

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

The performance configuration options for the knowledge base retrieval and generation process.

Returns:

See Also:



1758
1759
1760
 
# File 'bedrock/cfn_flow.rb', line 1758

def performance_config
  @performance_config
end

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

A custom prompt template for orchestrating the retrieval and generation process.

Returns:

See Also:



1763
1764
1765
 
# File 'bedrock/cfn_flow.rb', line 1763

def prompt_template
  @prompt_template
end

Class Method Details

.jsii_properties ⇒ Object 



1765
1766
1767
1768
1769
1770
1771
1772
 
# File 'bedrock/cfn_flow.rb', line 1765

def self.jsii_properties
  {
    :additional_model_request_fields => "additionalModelRequestFields",
    :inference_config => "inferenceConfig",
    :performance_config => "performanceConfig",
    :prompt_template => "promptTemplate",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
 
# File 'bedrock/cfn_flow.rb', line 1774

def to_jsii
  result = {}
  result.merge!({
    "additionalModelRequestFields" => @additional_model_request_fields,
    "inferenceConfig" => @inference_config,
    "performanceConfig" => @performance_config,
    "promptTemplate" => @prompt_template,
  })
  result.compact
end