Struct Prompt

pub struct Prompt { /* private fields */ }

A Prompt can be used with large language models to prompt.

Implementations

impl Prompt

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

Extend the swiftide repository with another Tera instance.

You can use this to add your own templates, functions and partials.

Panics

Panics if the RWLock is poisoned.

Errors

Errors if the Tera instance cannot be extended.

pub fn from_compiled_template(name: impl Into<String>) -> Prompt

Create a new prompt from a compiled template that is present in the Tera repository

pub fn with_node(self, node: &Node) -> Self

Adds an ingestion::Node to the context of the Prompt

pub fn with_context(self, new_context: impl Into<Context>) -> Self

Adds anything that implements Intotera::Context, like Serialize to the Prompt

pub fn with_context_value(self, key: &str, value: impl Into<Value>) -> Self

Adds a key-value pair to the context of the Prompt

pub fn render(&self) -> Result<String>

Renders a prompt

If no context is provided, the prompt will be rendered as is.

Errors

See Template::render

Panics

Panics if the RWLock is poisoned.

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Prompt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prompt

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

Formats the value using the given formatter.

impl Estimatable for &Prompt

fn for_estimate<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Cow<'_, str>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn additional_tokens(&self) -> usize

Optionally return extra tokens that should be added to the estimate.

impl From<&str> for Prompt

fn from(prompt: &str) -> Self

Converts to this type from the input type.

impl From<String> for Prompt

fn from(prompt: String) -> Self

Converts to this type from the input type.