Struct Message

pub struct Message { /* private fields */ }

A message in a conversation.

Contains a Role, text content, and optional attachments and annotations. Messages form the building blocks of conversations with AI language models.

Example

use ai_types::llm::{Message, Role};
use url::Url;

// Create messages using convenience constructors
let user_msg = Message::user("Hello, how are you?");
let system_msg = Message::system("You are a helpful assistant.");
let custom_msg = Message::new(Role::Assistant, "I'm doing well!".to_string());

// Add attachments to a message
let msg_with_attachment = Message::user("Check out this image")
    .with_attachment("https://example.com/image.jpg");

Implementations

impl Message

pub const fn role(&self) -> Role

Returns the message sender role.

pub const fn content(&self) -> &str

Returns the text content of the message.

pub const fn attachments(&self) -> &[Url]

Returns the attachment URLs associated with the message. URLs to external resources like images, documents, or other media that are referenced by this message.

pub const fn annotations(&self) -> &[Annotation]

Returns Message annotations. See Annotation for details.

Metadata annotations for URLs mentioned in the message content, providing additional context like titles and descriptions.

impl Message

pub const fn new(role: Role, content: String) -> Self

Creates a new message with the specified role and content.

Arguments

• role - The role of the message sender
• content - The text content of the message

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

Creates a new user message.

Arguments

• content - The text content of the message

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

Creates a new assistant message.

Arguments

• content - The text content of the message

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

Creates a new system message.

Arguments

• content - The text content of the message

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

Creates a new tool message.

Arguments

• content - The text content of the message

pub fn with_attachment<U: TryInto<Url, Error: Debug>>(self, url: U) -> Self

Adds an attachment URL to the message.

Arguments

• url - The URL to attach

Panics

Panics if the URL conversion fails.

pub fn with_attachments<U: TryInto<Url, Error: Debug>>( self, urls: impl IntoIterator<Item = U>, ) -> Self

Adds multiple attachment URLs to the message.

Arguments

• urls - An iterable of URLs to attach

Panics

Panics if any URL conversion fails.

Example

use ai_types::llm::Message;
use url::Url;

let urls = [
    "https://example.com",
    "https://example.org",
];
let message = Message::user("Check these links").with_attachments(urls);

pub fn with_annotation(self, annotation: Annotation) -> Self

Adds an annotation to the message.

Arguments

• annotation - The annotation to add

Example

use ai_types::llm::{Message, Annotation, UrlAnnotation};
use url::Url;

let url_annotation = UrlAnnotation::new(
    "https://example.com",
    "Example Site",
    "An example website",
    0,
    10,
);


let message = Message::user("Visit https://example.com")
    .with_annotation(Annotation::Url(url_annotation));

pub fn with_annotations( self, annotations: impl IntoIterator<Item = Annotation>, ) -> Self

Adds multiple annotations to the message.

Arguments

• annotations - An iterable of annotations to add

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.