Struct Media 

#[non_exhaustive]
pub struct Media {
    pub content_type: String,
    pub source: MediaSource,
    pub name: Option<String>,
}

An image, audio or other file in a message.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content_type: String

MIME type, for example image/png.

source: MediaSource

Where the bytes are.

name: Option<String>

File name, if known.

Implementations

impl Media

pub fn new(content_type: impl Into<String>, source: MediaSource) -> Self

Creates media from its MIME type and source.

pub fn from_url(content_type: impl Into<String>, url: impl Into<String>) -> Self

Creates media the provider downloads from url. Not every provider accepts URLs; use Media::from_bytes when yours does not.

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

Creates an image the provider downloads from url. The MIME type is guessed from the file extension (png, jpg, jpeg, gif, webp); other URLs are sent as image/jpeg. Use Media::from_url to set it yourself.

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

Creates media from its bytes, for example an image read from a file. The bytes are sent base64 encoded inside the request.

pub fn from_base64( content_type: impl Into<String>, data: impl Into<String>, ) -> Self

Creates media from bytes that are already base64 encoded.

pub fn with_name(self, name: impl Into<String>) -> Self

Sets the file name. Some providers show it to the model.

pub fn is_image(&self) -> bool

Returns true when the MIME type is an image type.

pub fn byte_len(&self) -> Option<usize>

Size of the media in bytes. None for a URL or invalid base64.

pub async fn bytes(&self, client: &dyn HttpClient) -> Result<Vec<u8>, HttpError>

Returns the bytes of the media: decoded base64, or downloaded from its URL with client.

Trait Implementations

impl Clone for Media

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 Media

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Media

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Media> for ToolOutput

fn from(media: Media) -> Self

Converts to this type from the input type.

impl IntoPrompt for Media

fn into_prompt(self) -> Prompt

Converts the value into a prompt.

impl PartialEq for Media

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Media

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Media