Skip to main content

ModelChunk

Enum ModelChunk 

Source
pub enum ModelChunk {
    TextDelta {
        msg_id: String,
        delta: String,
    },
    ThinkingDelta {
        thinking_id: String,
        delta: String,
        signature: Option<String>,
    },
    ToolCallStart {
        id: String,
        name: String,
    },
    ToolCallInputDelta {
        id: String,
        delta: String,
    },
    ToolCallEnd {
        id: String,
        input: Option<Value>,
    },
    Done {
        stop_reason: String,
        usage: Option<HarnessUsage>,
    },
}
Expand description

One token-level event from the model. The harness loop consumes a Stream<ModelChunk> and forwards TextDelta straight through as HarnessInternalEvent::AssistantTextChunk so callers see live generation; tool-call chunks are accumulated internally and only emitted once ToolCallEnd lands so the harness can dispatch the call with a complete serde_json::Value input.

Provider-agnostic: OpenAiCompatibleModelClient translates from OpenAI’s chat-completions SSE shape, and the future Anthropic client will project Messages-API events into the same enum. ScriptedModelClient synthesizes whichever sequence its scripted ModelResponse would have implied.

Variants§

§

TextDelta

Fields

§msg_id: String
§delta: String
§

ThinkingDelta

Fields

§thinking_id: String
§delta: String
§signature: Option<String>

Provider-emitted signature (Anthropic extended thinking) that MUST be round-tripped to history verbatim, otherwise some providers reject the next turn. None for OpenAI today.

§

ToolCallStart

First chunk of a tool call. The harness records (id, name) and starts buffering ToolCallInputDeltas under this id.

Fields

§name: String
§

ToolCallInputDelta

Streaming JSON arguments for a previously-announced tool call. OpenAI emits these as a string that, when concatenated, is valid JSON. Harness accumulates these into a single string per id, then parses on ToolCallEnd.

Fields

§delta: String
§

ToolCallEnd

Tool call finalised. input is the parsed JSON value if the provider sent the full object on this chunk (Anthropic), or a placeholder if the harness still needs to parse the accumulated ToolCallInputDelta buffer (OpenAI). Either way the harness treats input as authoritative when present.

Fields

§input: Option<Value>
§

Done

Final chunk. usage carries the provider’s reported token count for this call (None if the gateway elides it).

Fields

§stop_reason: String

Trait Implementations§

Source§

impl Clone for ModelChunk

Source§

fn clone(&self) -> ModelChunk

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 ModelChunk

Source§

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

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

impl PartialEq for ModelChunk

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ModelChunk

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