Struct StringTemplate

pub struct StringTemplate(/* private fields */);

A template for a prompt. This is a string that can be formatted with a set of parameters.

Examples

Using the default key

use llm_chain::prompt::StringTemplate;
use llm_chain::Parameters;
let template: StringTemplate = "Hello {{ text }}!".into();
let parameters: Parameters = "World".into();
assert_eq!(template.format(&parameters).unwrap(), "Hello World!");

Using a custom key

use llm_chain::prompt::StringTemplate;
use llm_chain::Parameters;
let template: StringTemplate = "Hello {{ name }}!".into();
let parameters: Parameters = vec![("name", "World")].into();
assert_eq!(template.format(&parameters).unwrap(), "Hello World!");

Tera

use llm_chain::prompt::StringTemplate;
use llm_chain::Parameters;
let template: StringTemplate = StringTemplate::tera("Hello {{name}}!");
let parameters: Parameters = vec![("name", "World")].into();
assert_eq!(template.format(&parameters).unwrap(), "Hello World!");

Implementations

impl StringTemplate

pub fn format( &self, parameters: &Parameters, ) -> Result<String, StringTemplateError>

Format the template with the given parameters.

pub fn static_string<K: Into<String>>(template: K) -> StringTemplate

Creates a non-dynmamic prompt template, useful for untrusted inputs.

pub fn tera<K: Into<String>>(template: K) -> StringTemplate

Creates a prompt template that uses the Tera templating engine. This is only available if the tera feature is enabled, which it is by default.

Examples

use llm_chain::prompt::StringTemplate;
use llm_chain::Parameters;
let template = StringTemplate::tera("Hello {{name}}!");
let parameters: Parameters = vec![("name", "World")].into();
assert_eq!(template.format(&parameters).unwrap(), "Hello World!");

pub fn from_file<K: AsRef<Path>>(path: K) -> Result<StringTemplate, Error>

Creates a prompt template from a file. The file should be a text file containing the template as a tera template.

Examples

use llm_chain::prompt::StringTemplate;
let template = StringTemplate::from_file("template.txt").unwrap();

pub fn combine(parts: Vec<StringTemplate>) -> StringTemplate

Combines two prompt templates into one. This is useful for creating a prompt template from multiple sources.

Examples

use llm_chain::prompt::StringTemplate;
use llm_chain::Parameters;
let template1 = StringTemplate::tera("Hello {{name}}");
let template2 = StringTemplate::tera("!");
let template3 = StringTemplate::combine(vec![template1, template2]);
let parameters: Parameters = vec![("name", "World")].into();
assert_eq!(template3.format(&parameters).unwrap(), "Hello World!");

Trait Implementations

impl Clone for StringTemplate

fn clone(&self) -> StringTemplate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringTemplate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StringTemplate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StringTemplate

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

Formats the value using the given formatter.

impl From<&str> for StringTemplate

fn from(template: &str) -> Self

Converts to this type from the input type.

impl Serialize for StringTemplate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.