Skip to content

PromptVariantDict

Dictionary Type

PromptVariantDict

Bases: TypedDict

Dictionary form of PromptVariant.

Attributes

additional_model_request_fields 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 instance-attribute
gen_ai_resource: PromptGenAiResource | PromptGenAiResourceDict | None

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

inference_configuration instance-attribute

Contains inference configurations for the prompt variant.

metadata instance-attribute

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 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: Required[str]

The name of the prompt variant.

template_configuration instance-attribute

Contains configurations for the prompt template.

template_type instance-attribute
template_type: Required[str]

The type of prompt template to use.