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

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::PromptVariant

Defined in:

gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb

Overview

Contains details about a variant of the prompt.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:gen_ai_resource, :metadata]

Instance Attribute Summary

• #additional_model_request_fields ⇒ Hash, ...

  Contains model-specific inference configurations that aren't in the inferenceConfiguration field.

• #gen_ai_resource ⇒ Types::PromptGenAiResource

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

• #inference_configuration ⇒ Types::PromptInferenceConfiguration

  Contains inference configurations for the prompt variant.

• #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.

• #model_id ⇒ String

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

• #name ⇒ String

  The name of the prompt variant.

• #template_configuration ⇒ Types::PromptTemplateConfiguration

  Contains configurations for the prompt template.

• #template_type ⇒ String

  The type of prompt template to use.

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.

Returns:

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

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6934

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

#gen_ai_resource ⇒ Types::PromptGenAiResource

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

Returns:

• (Types::PromptGenAiResource)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6934

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

#inference_configuration ⇒ Types::PromptInferenceConfiguration

Contains inference configurations for the prompt variant.

Returns:

• (Types::PromptInferenceConfiguration)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6934

class PromptVariant < Struct.new(
  :additional_model_request_fields,
  :gen_ai_resource,
  :inference_configuration,
  :metadata,
  :model_id,
  :name,
  :template_configuration,
  :template_type)
  SENSITIVE = [:gen_ai_resource, :metadata]
  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:

• (Array<Types::PromptMetadataEntry>)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6934

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

#model_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6934

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

#name ⇒ String

The name of the prompt variant.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6934

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

#template_configuration ⇒ Types::PromptTemplateConfiguration

Contains configurations for the prompt template.

Returns:

• (Types::PromptTemplateConfiguration)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6934

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

#template_type ⇒ String

The type of prompt template to use.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6934

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