Struct HumanMessagePromptTemplate 

pub struct HumanMessagePromptTemplate { /* private fields */ }

Struct HumanMessagePromptTemplate defines a template for creating human (user) messages. PromptTemplate is used to generate the message template.

Usage

let human_message_prompt = HumanMessagePromptTemplate::new(template_fstring!(
   "User says: {content}",
   "content",
));

Images

with_images names an input variable that holds images to attach to the message, so a chain or agent can take them like any other input:

let prompt = HumanMessagePromptTemplate::new(template_fstring!("{input}", "input"))
    .with_images("images");
chain.invoke(prompt_args! {
    "input" => "What is in this picture?",
    "images" => ["https://example.com/cat.png"],
}).await?;

Implementations

impl HumanMessagePromptTemplate

pub fn new(prompt: PromptTemplate) -> Self

pub fn with_images<S: Into<String>>(self, key: S) -> Self

Attaches the images found in the key input variable to the message.

The variable can be one image or a list of them. An image is either a string (an http(s) URL, a data: URL or bare base64 data) or an ImageContent object ({"image_url": "...", "detail": "low"}). A missing variable, null or an empty list means no images.

Trait Implementations

impl Clone for HumanMessagePromptTemplate

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl FormatPrompter for HumanMessagePromptTemplate

fn format_prompt( &self, input_variables: PromptArgs, ) -> Result<PromptValue, PromptError>

fn get_input_variables(&self) -> Vec<String>

fn format_prompt_async<'life0, 'async_trait>( &'life0 self, input_variables: PromptArgs, ) -> Pin<Box<dyn Future<Output = Result<PromptValue, PromptError>> + Send + 'async_trait>>

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

Formats the prompt, for prompts that need async work to do it (e.g. a FewShotPromptTemplate choosing examples by embedding similarity). Chains call this one. Defaults to format_prompt.

impl MessageFormatter for HumanMessagePromptTemplate

fn format_messages( &self, input_variables: PromptArgs, ) -> Result<Vec<Message>, PromptError>

fn input_variables(&self) -> Vec<String>

Returns a list of required input variable names for the template.