Skip to content

PromptVariant

Structure Class

PromptVariant dataclass

Bases: _SerdeShape

Contains details about a variant of the prompt.

Attributes

additional_model_request_fields class-attribute instance-attribute
additional_model_request_fields: Document | None = ...

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.

gen_ai_resource class-attribute instance-attribute
gen_ai_resource: PromptGenAiResource | None = ...

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

inference_configuration class-attribute instance-attribute
inference_configuration: PromptInferenceConfiguration | None = ...

Contains inference configurations for the prompt variant.

metadata class-attribute instance-attribute
metadata: list[PromptMetadataEntry] | None = ...

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 class-attribute instance-attribute
model_id: str | None = ...

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

name instance-attribute
name: str

The name of the prompt variant.

template_configuration instance-attribute
template_configuration: PromptTemplateConfiguration

Contains configurations for the prompt template.

template_type instance-attribute
template_type: str

The type of prompt template to use.