Skip to content

PromptVariant

Source code in docs_src/capo_bedrock_agent/types/prompt_variant.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class PromptVariant(TypedDict, closed=True):
    name: "capo_bedrock_agent.types.prompt_variant_name.PromptVariantName"
    """<p>The name of the prompt variant.</p>"""
    template_type: "capo_bedrock_agent.types.prompt_template_type.PromptTemplateType"
    """<p>The type of prompt template to use.</p>"""
    template_configuration: "capo_bedrock_agent.types.prompt_template_configuration.PromptTemplateConfiguration"
    """<p>Contains configurations for the prompt template.</p>"""
    model_id: NotRequired[
        "capo_bedrock_agent.types.prompt_model_identifier.PromptModelIdentifier"
    ]
    """<p>The unique identifier of the model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> with which to run inference on the prompt.</p>"""
    inference_configuration: NotRequired[
        "capo_bedrock_agent.types.prompt_inference_configuration.PromptInferenceConfiguration"
    ]
    """<p>Contains inference configurations for the prompt variant.</p>"""
    metadata: NotRequired[
        "capo_bedrock_agent.types.prompt_metadata_list.PromptMetadataList"
    ]
    """<p>An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.</p>"""
    additional_model_request_fields: NotRequired["object"]
    """<p>Contains model-specific inference configurations that aren't in the <code>inferenceConfiguration</code> field. To see model-specific inference parameters, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference request parameters and response fields for foundation models</a>.</p>"""
    gen_ai_resource: NotRequired[
        "capo_bedrock_agent.types.prompt_gen_ai_resource.PromptGenAiResource"
    ]
    """<p>Specifies a generative AI resource with which to use the prompt.</p>"""

additional_model_request_fields instance-attribute 

additional_model_request_fields: NotRequired[object]

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: NotRequired[PromptGenAiResource]

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

inference_configuration instance-attribute 

inference_configuration: NotRequired[PromptInferenceConfiguration]

Contains inference configurations for the prompt variant.

metadata instance-attribute 

metadata: NotRequired[PromptMetadataList]

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: NotRequired[PromptModelIdentifier]

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

name instance-attribute 

name: PromptVariantName

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: PromptTemplateType

The type of prompt template to use.