Struct SessionMessage 

#[non_exhaustive]
pub struct SessionMessage {
    pub message_id: MessageId,
    pub sender_session_id: MaybeUndefined<SessionId>,
    pub recipient_session_id: MaybeUndefined<SessionId>,
    pub sender_message_id: MaybeUndefined<MessageId>,
    pub recipient_message_id: MaybeUndefined<MessageId>,
    pub content: MaybeUndefined<Vec<ContentBlock>>,
    pub meta: MaybeUndefined<Meta>,
}

Available on crate feature unstable_protocol_v2 only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

An upsert for an inter-session 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.

message_id: MessageId

Identifier of this message within the enclosing session’s transcript.

sender_session_id: MaybeUndefined<SessionId>

The sending session.

Omitted leaves the stored value unchanged; null clears it; a value replaces it.

recipient_session_id: MaybeUndefined<SessionId>

The receiving session.

Omitted leaves the stored value unchanged; null clears it; a value replaces it.

sender_message_id: MaybeUndefined<MessageId>

On an incoming view, the messageId of the same message’s outgoing view in the sender’s transcript.

Omitted leaves the stored value unchanged; null clears it; a value replaces it. It can arrive after the message starts streaming.

recipient_message_id: MaybeUndefined<MessageId>

On an outgoing view, the messageId of the same message’s incoming view in the recipient’s transcript.

Omitted leaves the stored value unchanged; null clears it; a value replaces it. It can arrive after the message starts streaming.

content: MaybeUndefined<Vec<ContentBlock>>

Omitted leaves content unchanged; null clears it; a concrete array replaces the whole content collection.

meta: MaybeUndefined<Meta>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Omitted leaves the stored metadata unchanged; null clears it. An object patches the stored metadata by top-level key: keys it omits are unchanged, a key set to null is removed, and any other value replaces that key’s stored value without merging nested objects. Beyond this patch rule, implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Metadata Patches

Implementations

impl SessionMessage

pub fn new(message_id: impl Into<MessageId>) -> Self

Available on crate feature unstable_subagents only.

Builds a message upsert with its transcript-local ID.

pub fn sender_session_id( self, sender_session_id: impl IntoMaybeUndefined<SessionId>, ) -> Self

Available on crate feature unstable_subagents only.

Sets, clears, or leaves unchanged the sending session.

pub fn recipient_session_id( self, recipient_session_id: impl IntoMaybeUndefined<SessionId>, ) -> Self

Available on crate feature unstable_subagents only.

Sets, clears, or leaves unchanged the receiving session.

pub fn sender_message_id( self, sender_message_id: impl IntoMaybeUndefined<MessageId>, ) -> Self

Available on crate feature unstable_subagents only.

Links an incoming view to the outgoing view’s message ID in the sender’s transcript.

pub fn recipient_message_id( self, recipient_message_id: impl IntoMaybeUndefined<MessageId>, ) -> Self

Available on crate feature unstable_subagents only.

Links an outgoing view to the incoming view’s message ID in the recipient’s transcript.

pub fn content( self, content: impl IntoMaybeUndefined<Vec<ContentBlock>>, ) -> Self

Available on crate feature unstable_subagents only.

Replaces, clears, or leaves unchanged the message content.

pub fn meta(self, meta: impl IntoMaybeUndefined<Meta>) -> Self

Available on crate feature unstable_subagents only.

Patches, clears, or leaves unchanged message metadata.

A concrete object patches stored metadata by top-level key; see apply_meta_update.

Trait Implementations

impl Clone for SessionMessage

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 SessionMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SessionMessage

impl JsonSchema for SessionMessage

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for SessionMessage

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SessionMessage

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 SessionMessage