Skip to main content

ChatCompletionAccumulator

Struct ChatCompletionAccumulator 

Source
pub struct ChatCompletionAccumulator { /* private fields */ }
Expand description

Assembles streamed ChatCompletionChunks into complete messages.

All choices are accumulated, keyed by their chunk index; the accessors and ChatCompletionAccumulator::into_message default to choice 0 (the only choice unless the request set n > 1).

Fragment semantics follow the official SDKs: content / refusal / tool call arguments concatenate; role, tool call id / type / name and function_call.name are overwritten whenever a fragment carries them; finish_reason and usage are kept from the last chunk that provided them.

Implementations§

Source§

impl ChatCompletionAccumulator

Source

pub fn new() -> Self

Creates an empty accumulator.

Source

pub fn push(&mut self, chunk: &ChatCompletionChunk)

Merges one chunk into the accumulated state.

Source

pub fn content(&self) -> &str

The accumulated text content of choice 0, empty before any content chunk arrives.

Source

pub fn reasoning_content(&self) -> &str

The accumulated reasoning_content of choice 0 (thinking models).

Source

pub fn reasoning(&self) -> &str

The accumulated reasoning of choice 0.

vLLM streams the chain of thought under reasoning instead of reasoning_content, so against a vLLM backend Self::reasoning_content stays empty and this accessor carries the accumulated thought.

Source

pub fn finish_reason(&self) -> Option<&FinishReason>

The finish_reason of choice 0, once a chunk carries it.

Source

pub fn usage(&self) -> Option<&CompletionUsage>

The token usage, once a chunk carries it (the final chunk when the request set stream_options: {"include_usage": true}).

Source

pub fn function_call(&self) -> Option<&AccumulatedFunctionCall>

The deprecated function_call of choice 0, assembled from its fragments, if the model used the legacy path.

Source

pub fn into_message(self) -> ChatCompletionMessage

Consumes the accumulator, producing the assembled message of choice 0. An accumulator that never saw a choice-0 chunk yields an empty assistant message.

Source

pub fn into_messages(self) -> BTreeMap<u32, ChatCompletionMessage>

Consumes the accumulator, producing every assembled message keyed by its choice index.

Trait Implementations§

Source§

impl Clone for ChatCompletionAccumulator

Source§

fn clone(&self) -> Self

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 ChatCompletionAccumulator

Source§

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

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

impl Default for ChatCompletionAccumulator

Source§

fn default() -> Self

Returns the “default value” for a type. 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.

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: Sized + 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: Sized + 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 = !

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