UnifiedMessage

Struct UnifiedMessage 

Source
pub struct UnifiedMessage {
    pub role: MessageRole,
    pub content: MessageContent,
    pub attributes: MessageAttributes,
    pub timestamp: DateTime<Utc>,
}
Expand description

A provider-agnostic message for LLM interactions.

This is the core type of multi-llm. UnifiedMessage works across all supported providers (OpenAI, Anthropic, Ollama, LM Studio) and provides built-in support for caching hints and priority-based ordering.

§Creating Messages

Use the convenience constructors for common cases:

use multi_llm::UnifiedMessage;

// Simple messages
let user = UnifiedMessage::user("What's the weather?");
let system = UnifiedMessage::system("You are a helpful assistant.");
let assistant = UnifiedMessage::assistant("The weather is sunny.");

// Semantic messages with caching defaults
let instruction = UnifiedMessage::system_instruction(
    "You are a weather bot.".to_string(),
    Some("weather-system-v1".to_string())
);

§Caching

For Anthropic prompt caching (90% cost savings), use the builder methods:

use multi_llm::UnifiedMessage;

// 5-minute cache (good for development/testing)
let cached = UnifiedMessage::system("Large context...")
    .with_ephemeral_cache();

// 1-hour cache (good for production)
let long_cached = UnifiedMessage::system("Large context...")
    .with_extended_cache();

§Tool Calling

For function calling workflows:

use multi_llm::UnifiedMessage;

// Assistant requests a tool call
let tool_request = UnifiedMessage::tool_call(
    "call_abc123".to_string(),
    "get_weather".to_string(),
    serde_json::json!({"city": "London"})
);

// Send the tool result back
let tool_response = UnifiedMessage::tool_result(
    "call_abc123".to_string(),
    "Sunny, 22°C".to_string(),
    false  // not an error
);

Fields§

§role: MessageRole

Role of this message (system, user, assistant, or tool).

§content: MessageContent

Content of this message.

§attributes: MessageAttributes

Attributes controlling caching, priority, and metadata.

§timestamp: DateTime<Utc>

Timestamp for secondary ordering (after priority).

When messages have equal priority, they’re sorted by timestamp.

Implementations§

Source§

impl UnifiedMessage

Source

pub fn new(role: MessageRole, content: MessageContent) -> Self

Create a new message with default attributes

Source

pub fn with_attributes( role: MessageRole, content: MessageContent, attributes: MessageAttributes, ) -> Self

Create a new message with custom attributes

Source

pub fn system_instruction(content: String, cache_key: Option<String>) -> Self

Create a system instruction message (cacheable, high priority)

Source

pub fn tool_definition(content: String, cache_key: Option<String>) -> Self

Create a tool definition message (cacheable, high priority)

Source

pub fn context(content: String, cache_key: Option<String>) -> Self

Create a context message (cacheable, medium priority)

Source

pub fn history(role: MessageRole, content: String) -> Self

Create a history message (cacheable, lower priority)

Source

pub fn current_user(content: String) -> Self

Create a current user message (not cacheable, lowest priority)

Source

pub fn tool_call(id: String, name: String, arguments: Value) -> Self

Create a tool call message

Source

pub fn tool_result( tool_call_id: String, content: String, is_error: bool, ) -> Self

Create a tool result message

Source

pub fn simple(role: MessageRole, content: impl Into<String>) -> Self

Create a simple text message

Source

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

Create a simple user message

Source

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

Create a simple assistant message

Source

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

Create a simple system message

Source

pub fn with_ephemeral_cache(self) -> Self

Mark this message for ephemeral caching (5-minute TTL)

Source

pub fn with_extended_cache(self) -> Self

Mark this message for extended caching (1-hour TTL)

Trait Implementations§

Source§

impl Clone for UnifiedMessage

Source§

fn clone(&self) -> UnifiedMessage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UnifiedMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for UnifiedMessage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for UnifiedMessage

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for UnifiedMessage

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for UnifiedMessage

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,