Enum AssistantStreamEvent

#[non_exhaustive]
pub enum AssistantStreamEvent {
    TreadCreated(ThreadObject),
    ThreadRunCreated(RunObject),
    ThreadRunQueued(RunObject),
    ThreadRunInProgress(RunObject),
    ThreadRunRequiresAction(RunObject),
    ThreadRunCompleted(RunObject),
    ThreadRunIncomplete(RunObject),
    ThreadRunFailed(RunObject),
    ThreadRunCancelling(RunObject),
    ThreadRunCancelled(RunObject),
    ThreadRunExpired(RunObject),
    ThreadRunStepCreated(RunStepObject),
    ThreadRunStepInProgress(RunStepObject),
    ThreadRunStepDelta(RunStepDeltaObject),
    ThreadRunStepCompleted(RunStepObject),
    ThreadRunStepFailed(RunStepObject),
    ThreadRunStepCancelled(RunStepObject),
    ThreadRunStepExpired(RunStepObject),
    ThreadMessageCreated(MessageObject),
    ThreadMessageInProgress(MessageObject),
    ThreadMessageDelta(MessageDeltaObject),
    ThreadMessageCompleted(MessageObject),
    ThreadMessageIncomplete(MessageObject),
    ErrorEvent(ApiError),
    Done(String),
}

Represents an event emitted when streaming a Run.

Each event in a server-sent events stream has an event and data property:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

We emit events whenever a new object is created, transitions to a new state, or is being streamed in parts (deltas). For example, we emit thread.run.created when a new run is created, thread.run.completed when a run completes, and so on. When an Assistant chooses to create a message during a run, we emit a thread.message.created event, a thread.message.in_progress event, many thread.message.delta events, and finally a thread.message.completed event.

We may add additional events over time, so we recommend handling unknown events gracefully in your code. See the Assistants API quickstart to learn how to integrate the Assistants API with streaming.

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.

TreadCreated(ThreadObject)

Occurs when a new thread is created.

ThreadRunCreated(RunObject)

Occurs when a new run is created.

ThreadRunQueued(RunObject)

Occurs when a run moves to a queued status.

ThreadRunInProgress(RunObject)

Occurs when a run moves to an in_progress status.

ThreadRunRequiresAction(RunObject)

Occurs when a run moves to a requires_action status.

ThreadRunCompleted(RunObject)

Occurs when a run is completed.

ThreadRunIncomplete(RunObject)

Occurs when a run ends with status incomplete.

ThreadRunFailed(RunObject)

Occurs when a run fails.

ThreadRunCancelling(RunObject)

Occurs when a run moves to a cancelling status.

ThreadRunCancelled(RunObject)

Occurs when a run is cancelled.

ThreadRunExpired(RunObject)

Occurs when a run expires.

ThreadRunStepCreated(RunStepObject)

Occurs when a run step is created.

ThreadRunStepInProgress(RunStepObject)

Occurs when a run step moves to an in_progress state.

ThreadRunStepDelta(RunStepDeltaObject)

Occurs when parts of a run step are being streamed.

ThreadRunStepCompleted(RunStepObject)

Occurs when a run step is completed.

ThreadRunStepFailed(RunStepObject)

Occurs when a run step fails.

ThreadRunStepCancelled(RunStepObject)

Occurs when a run step is cancelled.

ThreadRunStepExpired(RunStepObject)

Occurs when a run step expires.

ThreadMessageCreated(MessageObject)

Occurs when a message is created.

ThreadMessageInProgress(MessageObject)

Occurs when a message moves to an in_progress state.

ThreadMessageDelta(MessageDeltaObject)

Occurs when parts of a Message are being streamed.

ThreadMessageCompleted(MessageObject)

Occurs when a message is completed.

ThreadMessageIncomplete(MessageObject)

Occurs when a message ends before it is completed.

ErrorEvent(ApiError)

Occurs when an error occurs. This can happen due to an internal server error or a timeout.

Done(String)

Occurs when a stream ends.

Trait Implementations

impl Clone for AssistantStreamEvent

fn clone(&self) -> AssistantStreamEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssistantStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AssistantStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl TryFrom<Event> for AssistantStreamEvent

type Error = OpenAIError

The type returned in the event of a conversion error.

fn try_from(value: Event) -> Result<Self, Self::Error>

Performs the conversion.