PromptTemplate

Struct PromptTemplate 

Source
pub struct PromptTemplate { /* private fields */ }
Expand description

A prompt template with variable placeholders.

Variables are denoted with double curly braces: {{variable_name}}

Implementations§

Source§

impl PromptTemplate

Source

pub fn new(template: impl Into<String>) -> Self

Create a new template, extracting variable placeholders.

§Example
let template = PromptTemplate::new("Hello, {{name}}!");
assert!(template.variables().contains("name"));
Source

pub fn variables(&self) -> &HashSet<String>

Get the set of required variables.

Source

pub fn has_variables(&self) -> bool

Check if this template has any variables.

Source

pub fn raw(&self) -> &str

Get the raw template string.

Source

pub fn render(&self, values: &HashMap<String, String>) -> Result<String>

Render the template with the given values.

§Errors

Returns an error if any required variable is missing from the values map.

§Example
let template = PromptTemplate::new("Hello, {{name}}!");
let mut values = HashMap::new();
values.insert("name".to_string(), "World".to_string());
assert_eq!(template.render(&values)?, "Hello, World!");
Source

pub fn render_with_defaults( &self, values: &HashMap<String, String>, defaults: &HashMap<String, String>, ) -> String

Render the template, using defaults for missing variables.

Variables not in values will be replaced with empty string or their value from defaults if provided.

Source

pub fn render_partial(&self, values: &HashMap<String, String>) -> String

Render keeping unmatched variables as-is.

Useful for partial template expansion.

Source

pub fn validate(&self, values: &HashMap<String, String>) -> Result<()>

Validate that all required variables are present.

Trait Implementations§

Source§

impl Clone for PromptTemplate

Source§

fn clone(&self) -> PromptTemplate

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PromptTemplate

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more