Struct PromptTemplate

#[non_exhaustive]
pub struct PromptTemplate {
    pub text_prompt_template: Option<String>,
}

Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.

This data type is used in the following API operations:

• RetrieveAndGenerate request – in the filter field

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.

text_prompt_template: Option<String>

The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see the following resources:

• Knowledge base prompt templates

• Use XML tags with Anthropic Claude models

Implementations

impl PromptTemplate

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

The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see the following resources:

• Knowledge base prompt templates

• Use XML tags with Anthropic Claude models

impl PromptTemplate

pub fn builder() -> PromptTemplateBuilder

Creates a new builder-style object to manufacture PromptTemplate.

Trait Implementations

impl Clone for PromptTemplate

fn clone(&self) -> PromptTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptTemplate

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

Formats the value using the given formatter.

impl PartialEq for PromptTemplate

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

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

const 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 PromptTemplate