Struct PromptVariant 

#[non_exhaustive]
pub struct PromptVariant {
    pub name: String,
    pub template_type: PromptTemplateType,
    pub template_configuration: Option<PromptTemplateConfiguration>,
    pub model_id: Option<String>,
    pub inference_configuration: Option<PromptInferenceConfiguration>,
    pub metadata: Option<Vec<PromptMetadataEntry>>,
    pub additional_model_request_fields: Option<Document>,
    pub gen_ai_resource: Option<PromptGenAiResource>,
}

Contains details about a variant of the prompt.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the prompt variant.

template_type: PromptTemplateType

The type of prompt template to use.

template_configuration: Option<PromptTemplateConfiguration>

Contains configurations for the prompt template.

model_id: Option<String>

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

inference_configuration: Option<PromptInferenceConfiguration>

Contains inference configurations for the prompt variant.

metadata: Option<Vec<PromptMetadataEntry>>

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

additional_model_request_fields: Option<Document>

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: Option<PromptGenAiResource>

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

Implementations

impl PromptVariant

pub fn name(&self) -> &str

The name of the prompt variant.

pub fn template_type(&self) -> &PromptTemplateType

The type of prompt template to use.

pub fn template_configuration(&self) -> Option<&PromptTemplateConfiguration>

Contains configurations for the prompt template.

pub fn model_id(&self) -> Option<&str>

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

pub fn inference_configuration(&self) -> Option<&PromptInferenceConfiguration>

Contains inference configurations for the prompt variant.

pub fn metadata(&self) -> &[PromptMetadataEntry]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metadata.is_none().

pub fn additional_model_request_fields(&self) -> Option<&Document>

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.

pub fn gen_ai_resource(&self) -> Option<&PromptGenAiResource>

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

impl PromptVariant

pub fn builder() -> PromptVariantBuilder

Creates a new builder-style object to manufacture PromptVariant.

Trait Implementations

impl Clone for PromptVariant

fn clone(&self) -> PromptVariant

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PromptVariant

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PromptVariant

fn eq(&self, other: &PromptVariant) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PromptVariant