Struct Prompt 

pub struct Prompt { /* private fields */ }

Content of the user message sent in a run: text and media, in order.

Build it with Prompt::text and the with_* methods. Whether the model can read images or other media depends on the model; agentai does not check it, a model without vision support usually answers with an error.

Implementations

impl Prompt

pub fn new() -> Self

Creates an empty prompt.

pub fn text(text: impl Into<String>) -> Self

Creates a prompt with text.

pub fn with_text(self, text: impl Into<String>) -> Self

Adds text.

pub fn with_media(self, media: Media) -> Self

Adds an image, audio or other file.

pub fn with_image_url(self, url: impl Into<String>) -> Self

Adds an image the provider downloads from url. See Media::image_url.

pub fn with_image_bytes( self, content_type: impl Into<String>, bytes: impl AsRef<[u8]>, ) -> Self

Adds an image from its bytes, for example image/png. See Media::from_bytes.

pub fn parts(&self) -> &[Part]

Returns the parts of the prompt: Part::Text and Part::Media, in order.

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Self

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 Default for Prompt

fn default() -> Self

Returns the “default value” for a type.

impl From<Prompt> for Message

The user message sent to the model.

fn from(prompt: Prompt) -> Self

Converts to this type from the input type.

impl IntoPrompt for Prompt

fn into_prompt(self) -> Prompt

Converts the value into a prompt.

impl PartialEq for Prompt

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Prompt