Class: Aws::BedrockAgent::Types::PromptVariant

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-bedrockagent/types.rb

Overview

Contains details about a variant of the prompt.

See Also:

Constant Summary collapse

SENSITIVE = 
[:metadata, :gen_ai_resource]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_model_request_fields ⇒ Hash, ...

Contains model-specific inference configurations that aren’t in the ‘inferenceConfiguration` field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 8792

class PromptVariant < Struct.new(
  :name,
  :template_type,
  :template_configuration,
  :model_id,
  :inference_configuration,
  :metadata,
  :additional_model_request_fields,
  :gen_ai_resource)
  SENSITIVE = [:metadata, :gen_ai_resource]
  include Aws::Structure
end

#gen_ai_resource ⇒ Types::PromptGenAiResource

Specifies a generative AI resource with which to use the prompt.

Returns:



8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 8792

class PromptVariant < Struct.new(
  :name,
  :template_type,
  :template_configuration,
  :model_id,
  :inference_configuration,
  :metadata,
  :additional_model_request_fields,
  :gen_ai_resource)
  SENSITIVE = [:metadata, :gen_ai_resource]
  include Aws::Structure
end

#inference_configuration ⇒ Types::PromptInferenceConfiguration

Contains inference configurations for the prompt variant.

Returns:



8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 8792

class PromptVariant < Struct.new(
  :name,
  :template_type,
  :template_configuration,
  :model_id,
  :inference_configuration,
  :metadata,
  :additional_model_request_fields,
  :gen_ai_resource)
  SENSITIVE = [:metadata, :gen_ai_resource]
  include Aws::Structure
end

#metadata ⇒ Array<Types::PromptMetadataEntry>

An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.

Returns:



8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 8792

class PromptVariant < Struct.new(
  :name,
  :template_type,
  :template_configuration,
  :model_id,
  :inference_configuration,
  :metadata,
  :additional_model_request_fields,
  :gen_ai_resource)
  SENSITIVE = [:metadata, :gen_ai_resource]
  include Aws::Structure
end

#model_id ⇒ String

The unique identifier of the model or [inference profile] with which to run inference on the prompt.

[1]: docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html

Returns:

  • (String) 


8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 8792

class PromptVariant < Struct.new(
  :name,
  :template_type,
  :template_configuration,
  :model_id,
  :inference_configuration,
  :metadata,
  :additional_model_request_fields,
  :gen_ai_resource)
  SENSITIVE = [:metadata, :gen_ai_resource]
  include Aws::Structure
end

#name ⇒ String

The name of the prompt variant.

Returns:

  • (String) 


8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 8792

class PromptVariant < Struct.new(
  :name,
  :template_type,
  :template_configuration,
  :model_id,
  :inference_configuration,
  :metadata,
  :additional_model_request_fields,
  :gen_ai_resource)
  SENSITIVE = [:metadata, :gen_ai_resource]
  include Aws::Structure
end

#template_configuration ⇒ Types::PromptTemplateConfiguration

Contains configurations for the prompt template.

Returns:



8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 8792

class PromptVariant < Struct.new(
  :name,
  :template_type,
  :template_configuration,
  :model_id,
  :inference_configuration,
  :metadata,
  :additional_model_request_fields,
  :gen_ai_resource)
  SENSITIVE = [:metadata, :gen_ai_resource]
  include Aws::Structure
end

#template_type ⇒ String

The type of prompt template to use.

Returns:

  • (String) 


8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 8792

class PromptVariant < Struct.new(
  :name,
  :template_type,
  :template_configuration,
  :model_id,
  :inference_configuration,
  :metadata,
  :additional_model_request_fields,
  :gen_ai_resource)
  SENSITIVE = [:metadata, :gen_ai_resource]
  include Aws::Structure
end