Struct MessageContent

pub struct MessageContent {
    pub type_name: String,
    pub text: Option<String>,
    pub image_url: Option<String>,
}

Represents the content of a message, which can be either text or an image.

This structure is used to encapsulate different types of message content that can be sent to or received from AI models. It supports both text-based content and image content (either as URLs or base64-encoded data).

Fields

• type_name - The type of content (“input_text” for text, “input_image” for images)
• text - Optional text content when the message contains text
• image_url - Optional image URL or base64-encoded image data when the message contains an image

Example

use openai_tools::common::MessageContent;

// Create text content
let text_content = MessageContent::from_text("Hello, world!".to_string());

// Create image content from URL
// let image_content = MessageContent::from_image_url("https://example.com/image.jpg".to_string());

// Create image content from file
// let file_content = MessageContent::from_image_file("path/to/image.jpg".to_string());

Fields

type_name: String

text: Option<String>

image_url: Option<String>

Implementations

impl MessageContent

pub fn from_text(text: String) -> Self

Creates a new MessageContent containing text.

This constructor creates a message content instance specifically for text-based messages. The content type is automatically set to “input_text” and the image_url field is set to None.

Arguments

• text - The text content to include in the message

Returns

A new MessageContent instance configured for text content.

Example

use openai_tools::common::MessageContent;

let content = MessageContent::from_text("Hello, AI assistant!".to_string());
assert_eq!(content.type_name, "input_text");
assert_eq!(content.text, Some("Hello, AI assistant!".to_string()));
assert_eq!(content.image_url, None);

pub fn from_image_url(image_url: String) -> Self

Creates a new MessageContent containing an image from a URL.

This constructor creates a message content instance for image-based messages using an existing image URL. The content type is automatically set to “input_image” and the text field is set to None.

Arguments

• image_url - The URL or base64-encoded data URI of the image

Returns

A new MessageContent instance configured for image content.

Example

use openai_tools::common::MessageContent;

let content = MessageContent::from_image_url("https://example.com/image.jpg".to_string());
assert_eq!(content.type_name, "input_image");
assert_eq!(content.text, None);
assert_eq!(content.image_url, Some("https://example.com/image.jpg".to_string()));

pub fn from_image_file(file_path: String) -> Self

Creates a new MessageContent containing an image loaded from a file.

This constructor reads an image file from the local filesystem, encodes it as base64, and creates a data URI suitable for use with AI models. The content type is automatically set to “input_image” and the text field is set to None.

Arguments

• file_path - The path to the image file to load

Returns

A new MessageContent instance configured for image content with base64-encoded data.

Supported Formats

• PNG (.png)
• JPEG (.jpg, .jpeg)
• GIF (.gif)

Trait Implementations

impl Clone for MessageContent

fn clone(&self) -> MessageContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageContent

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

Formats the value using the given formatter.

impl Default for MessageContent

fn default() -> MessageContent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessageContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MessageContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.