Enum AssistantContent 

#[non_exhaustive]
pub enum AssistantContent {
    Text(Text),
    ToolCall(ToolCall),
    Reasoning(Reasoning),
    Image(Image),
    Opaque(Opaque),
}

One block of an assistant turn: one provider output item. Deserialization requires the lowercase type tag.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text(Text)

Answer text.

ToolCall(ToolCall)

A tool call requested by the assistant.

Reasoning(Reasoning)

Reasoning the model showed.

Image(Image)

An image the assistant produced.

Opaque(Opaque)

A provider item with no canonical meaning.

Implementations

impl AssistantContent

pub fn replay(&self, target: &dyn ReplayTarget, ids: &WireIds) -> Replay<'_>

What target’s encoder sends for this block, with call ids spelled by ids. Encoders read provider items only through this.

impl AssistantContent

pub fn canonical(&self) -> Self

This block without its provider item: what a different provider can use, and what its fingerprint covers.

pub fn is_answer(&self) -> bool

Whether the block answers the user: text that is not blank, a call or an image. Reasoning and provider-only items are not an answer.

pub fn is_blank(&self) -> bool

Whether the block has nothing to send, so replay drops it: blank text or reasoning, and redacted reasoning, without a provider item that is still current (with one, its identity pairs it with what follows, and pi replays it whatever its text), and an opaque item that does not replay.

pub fn fingerprint(&self) -> Fingerprint

The fingerprint of the block’s canonical fields, through a fixed, versioned projection rather than the block’s serde layout, so a field added to a canonical type never stales stored items. A rig-issued call id counts as one placeholder: rig issues a fresh id each time it decodes a call the provider sent without one.

pub fn with_native(self, item: Value) -> Self

The provider item this block was decoded from, held for its current canonical form. An Opaque block has no separate item.

pub fn native_item(&self) -> Option<&Value>

The provider item, while the block is still what it was decoded from. An edited block has none: encoders rebuild it.

impl AssistantContent

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

Creates assistant text content.

pub fn image_base64( data: impl Into<String>, media_type: Option<ImageMediaType>, detail: Option<ImageDetail>, ) -> Self

Creates assistant image content from base64-encoded data.

pub fn tool_call( id: impl Into<String>, name: ToolName, arguments: Value, ) -> Self

Creates a tool call from a provider-issued ID, name, and arguments. Rig issues an id when id is empty.

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

Creates reasoning text with no provider item.

Trait Implementations

impl Clone for AssistantContent

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 AssistantContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AssistantContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AssistantContent> for Message

fn from(content: AssistantContent) -> Self

Converts to this type from the input type.

impl From<String> for AssistantContent

fn from(text: String) -> Self

Converts to this type from the input type.

impl PartialEq for AssistantContent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AssistantContent

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 AssistantContent