Struct Prompt

pub struct Prompt<'a>(/* private fields */);

A prompt which is passed to the model for inference. Usually it is one text item, but it could also be a combination of several modalities like images and text.

Implementations

impl<'a> Prompt<'a>

pub fn from_text(text: impl Into<Cow<'a, str>>) -> Self

Create a prompt from a single text item.

pub fn from_vec(items: Vec<Modality<'a>>) -> Self

Create a multimodal prompt from a list of individual items with any modality.

pub fn borrow(&'a self) -> Prompt<'a>

Allows you to borrow the contents of the prompt without allocating a new one.

pub fn join_consecutive_text_items(&mut self, separator: &str)

When constructing prompts programatically, it can be beneficial to append several text items in a prompt. For example, if doing a fewshot prompt as the first item, and user input as a second item.

However, because of how tokenization works, having each item tokenized separately can sometimes have strange side effects (tokenizing two partial strings does not necessarily produce the same tokens as tokenizing the strings joined together).

This method will take an existing prompt and merge any consecutive prompt items by a given separator. You can use an empty string for the separator if you want to just concatenate them.

Trait Implementations

impl<'a> Clone for Prompt<'a>

fn clone(&self) -> Prompt<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Prompt<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Prompt<'a>

fn eq(&self, other: &Prompt<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for Prompt<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for Prompt<'a>

impl<'a> StructuralPartialEq for Prompt<'a>