Skip to main content

Message

Struct Message 

Source
pub struct Message {
    pub role: String,
    pub name: Option<String>,
    pub content: Option<String>,
    pub tool_calls: Option<Vec<ToolCall>>,
    pub tool_call_id: Option<String>,
    pub image_base64: Option<String>,
}
Expand description

One message in an OpenAI Chat Completions conversation. Spec: https://platform.openai.com/docs/api-reference/chat/create#chat/create-messages

One struct, four roles (system / user / assistant / tool); each role uses a different subset of the optional fields. skip_serializing_if on every Option prunes irrelevant fields at serialization, so the wire JSON for each role only carries what OpenAI expects:

system → role + content user → role + content (+ optional name for multi-user) assistant → role + content (may be null when only tool_calls are emitted) + optional tool_calls[] tool → role + content + tool_call_id (must match an id in the preceding assistant.tool_calls)

We use a flat struct with optional fields rather than a tagged enum because the planner does a lot of generic Vec manipulation (trim, sanitize, sliding-window slicing) that’s awkward to express through match on every access. Type-safety for “tool messages must have tool_call_id” is delegated to runtime checks (history::sanitize_for_vlm) and the OpenAI server’s own validation.

image_base64 is a robonix-side simplification, NOT part of the OpenAI wire format. Callers set it on a user message; build_openai_messages in this file repackages content + image into OpenAI’s multimodal content array ([{type:"text",...}, {type:"image_url",...}]) at request time.

Fields§

§role: String

“system” / “user” / “assistant” / “tool”. Determines which other fields are meaningful; OpenAI rejects mismatched combinations.

§name: Option<String>

Optional sender name. Used by user/assistant for multi-user disambiguation; rare in practice. Robonix doesn’t set it today.

§content: Option<String>

Message text. Always present except on assistant messages whose only output is tool calls (then None / null on the wire).

§tool_calls: Option<Vec<ToolCall>>

Tool calls the LLM decided to make. Present only on assistant messages. Each entry carries id + function.{name, arguments}; the corresponding tool message links back via tool_call_id.

§tool_call_id: Option<String>

Correlates a tool result back to the assistant.tool_calls[].id that produced it. Required on tool messages; absent on others.

§image_base64: Option<String>

Inline image attached to a user message (base64-encoded JPEG bytes). Robonix-only field; rewritten into OpenAI’s multimodal content array at serialize time by build_openai_messages.

Implementations§

Source§

impl Message

Source

pub fn system(content: &str) -> Self

Source

pub fn user(content: &str) -> Self

Source

pub fn user_with_image(content: &str, image_base64: String) -> Self

Source

pub fn assistant(content: &str) -> Self

Source

pub fn tool_result(id: &str, content: &str) -> Self

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

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<'de> Deserialize<'de> for Message

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 Serialize for Message

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

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.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

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

§

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
§

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

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>,