Skip to main content

AssistantMessage

Struct AssistantMessage 

Source
#[non_exhaustive]
pub struct AssistantMessage { pub content: Vec<AssistantContent>, pub origin: Option<Origin>, pub stop: Option<StopReason>, }
Expand description

One assistant turn.

content holds one block per provider output item, in the order the provider produced them. origin names the wire, provider and model that produced the turn; a hand-built turn has none and always replays from its canonical fields.

Fields (Non-exhaustive)§

This struct is marked as 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.
§content: Vec<AssistantContent>

The blocks, in provider order.

§origin: Option<Origin>

Who produced the turn.

§stop: Option<StopReason>

How the turn ended.

Implementations§

Source§

impl AssistantMessage

Source

pub fn new(content: Vec<AssistantContent>) -> AssistantMessage

A hand-built turn of content: no origin or stop.

Source

pub fn rolled_back( origin: Option<Origin>, content: Vec<AssistantContent>, ) -> AssistantMessage

The turn a runtime rolls back over: what arrived of a reply from origin, stopped to call tools, since the runtime answers its calls. content keeps only the provider items its fold kept.

Source

pub fn aborted( origin: Option<Origin>, content: Vec<AssistantContent>, reason: impl Into<String>, ) -> AssistantMessage

The turn a run stopped before the reply ended: kept in history as no answer, replayed as its text alone.

Source

pub fn with_content(self, content: Vec<AssistantContent>) -> AssistantMessage

This turn holding content in place of its blocks.

Source

pub fn with_origin(self, origin: impl Into<Option<Origin>>) -> AssistantMessage

This turn with origin as who produced it.

Source

pub fn with_stop(self, stop: impl Into<Option<StopReason>>) -> AssistantMessage

This turn with stop as how it ended.

Source

pub fn tool_calls(&self) -> impl Iterator<Item = &ToolCall>

The tool calls, in order.

Source

pub fn text(&self) -> String

The text parts, concatenated.

Source

pub fn is_empty_turn(&self) -> bool

Whether this generated turn is empty: every part is blank (AssistantContent::is_blank, the rule replay drops parts by). An empty turn must not enter history.

Trait Implementations§

Source§

impl Clone for AssistantMessage

Source§

fn clone(&self) -> AssistantMessage

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AssistantMessage

Source§

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

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

impl Default for AssistantMessage

Source§

fn default() -> AssistantMessage

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AssistantMessage

Source§

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

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

impl From<AssistantMessage> for Message

Source§

fn from(message: AssistantMessage) -> Message

Converts to this type from the input type.
Source§

impl PartialEq for AssistantMessage

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for AssistantMessage

Source§

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

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

impl StructuralPartialEq for AssistantMessage

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> IntoToolOutput for T
where T: Serialize + 'static,

Source§

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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