Struct NdjsonStreamEvent 

pub struct NdjsonStreamEvent {
    pub event: NdjsonStreamEventEvent,
    pub model: Option<ModelId>,
    pub response_id: Option<String>,
    pub state_id: Option<Uuid>,
    pub stop_reason: Option<String>,
    pub text_delta: Option<String>,
    pub tool_call_delta: Option<ToolCallDelta>,
    pub tool_calls: Vec<ToolCall>,
    pub usage: Option<Usage>,
}

Events sent during streaming responses (application/x-ndjson). Each line is a JSON object with an “event” field indicating the type.

JSON schema

{
 "description": "Events sent during streaming responses (application/x-ndjson).\nEach line is a JSON object with an \"event\" field indicating the type.\n",
 "type": "object",
 "required": [
   "event"
 ],
 "properties": {
   "event": {
     "description": "Event type",
     "type": "string",
     "enum": [
       "message_start",
       "message_delta",
       "message_stop",
       "tool_use_start",
       "tool_use_delta",
       "tool_use_stop",
       "ping",
       "keepalive"
     ]
   },
   "model": {
     "$ref": "#/$defs/ModelId"
   },
   "response_id": {
     "description": "Response identifier (message_start)",
     "type": "string"
   },
   "state_id": {
     "type": "string",
     "format": "uuid"
   },
   "stop_reason": {
     "description": "Why generation stopped (message_stop)",
     "type": "string"
   },
   "text_delta": {
     "description": "Text content fragment (message_delta)",
     "type": "string"
   },
   "tool_call_delta": {
     "$ref": "#/$defs/ToolCallDelta"
   },
   "tool_calls": {
     "description": "Completed tool calls (tool_use_stop, message_stop)",
     "type": "array",
     "items": {
       "$ref": "#/$defs/ToolCall"
     }
   },
   "usage": {
     "$ref": "#/$defs/Usage"
   }
 }
}

Fields

event: NdjsonStreamEventEvent

Event type

model: Option<ModelId>

response_id: Option<String>

Response identifier (message_start)

state_id: Option<Uuid>

stop_reason: Option<String>

Why generation stopped (message_stop)

text_delta: Option<String>

Text content fragment (message_delta)

tool_call_delta: Option<ToolCallDelta>

tool_calls: Vec<ToolCall>

Completed tool calls (tool_use_stop, message_stop)

usage: Option<Usage>

Trait Implementations

impl Clone for NdjsonStreamEvent

fn clone(&self) -> NdjsonStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NdjsonStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NdjsonStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&NdjsonStreamEvent> for NdjsonStreamEvent

fn from(value: &NdjsonStreamEvent) -> Self

Converts to this type from the input type.

impl From<NdjsonStreamEvent> for ModelRelayApi

fn from(value: NdjsonStreamEvent) -> Self

Converts to this type from the input type.

impl PartialEq for NdjsonStreamEvent

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for NdjsonStreamEvent

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 NdjsonStreamEvent