Enum swiftide_core::prompt::PromptTemplate

pub enum PromptTemplate {
    CompiledTemplate(String),
    String(String),
    Static(&'static str),
}

A PromptTemplate defines a template for a prompt

Variants

CompiledTemplate(String)

String(String)

Static(&'static str)

Implementations

impl PromptTemplate

pub fn from_compiled_template_name(name: impl Into<String>) -> PromptTemplate

Creates a reference to a template already stored in the repository

pub fn from_string(template: impl Into<String>) -> PromptTemplate

pub async fn extend(tera: &Tera) -> Result<()>

Extends the prompt repository with a custom tera::Tera instance.

If you have your own prompt templates or want to add other functionality, you can extend the repository with your own tera::Tera instance.

WARN: Do not use this inside a pipeline or any form of load, as it will lock the repository

Errors

Errors if the repository could not be extended

pub async fn try_compiled_from_str( template: impl AsRef<str> + Send + 'static, ) -> Result<PromptTemplate>

Compiles a template from a string and returns a PromptTemplate with a reference to the string.

WARN: Do not use this inside a pipeline or any form of load, as it will lock the repository

Errors

Errors if the template fails to compile

pub async fn render(&self, context: &Option<Context>) -> Result<String>

Renders a template with an optional tera::Context

Errors

• Template cannot be found
• One-off template has errors
• Context is missing that is required by the template

pub fn to_prompt(&self) -> Prompt

Builds a Prompt from a template with an empty context

Trait Implementations

impl Clone for PromptTemplate

fn clone(&self) -> PromptTemplate

Returns a copy of the value.

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 From<&'static str> for PromptTemplate

fn from(template: &'static str) -> Self

Converts to this type from the input type.

impl From<String> for PromptTemplate

fn from(template: String) -> Self

Converts to this type from the input type.