assistant_stream_event

Classes:

Name	Description
ErrorEvent
ThreadCreated
ThreadMessageCompleted
ThreadMessageCreated
ThreadMessageDelta
ThreadMessageInProgress
ThreadMessageIncomplete
ThreadRunCancelled
ThreadRunCancelling
ThreadRunCompleted
ThreadRunCreated
ThreadRunExpired
ThreadRunFailed
ThreadRunInProgress
ThreadRunQueued
ThreadRunRequiresAction
ThreadRunStepCancelled
ThreadRunStepCompleted
ThreadRunStepCreated
ThreadRunStepDelta
ThreadRunStepExpired
ThreadRunStepFailed
ThreadRunStepInProgress

Attributes:

Name	Type	Description
AssistantStreamEvent

AssistantStreamEvent module-attribute

AssistantStreamEvent = Union[
    ThreadCreated,
    ThreadRunCreated,
    ThreadRunQueued,
    ThreadRunInProgress,
    ThreadRunRequiresAction,
    ThreadRunCompleted,
    ThreadRunFailed,
    ThreadRunCancelling,
    ThreadRunCancelled,
    ThreadRunExpired,
    ThreadRunStepCreated,
    ThreadRunStepInProgress,
    ThreadRunStepDelta,
    ThreadRunStepCompleted,
    ThreadRunStepFailed,
    ThreadRunStepCancelled,
    ThreadRunStepExpired,
    ThreadMessageCreated,
    ThreadMessageInProgress,
    ThreadMessageDelta,
    ThreadMessageCompleted,
    ThreadMessageIncomplete,
    ErrorEvent,
]

ErrorEvent

Attributes:

Name	Type	Description
data	ErrorObject
event	Literal['error']

data instance-attribute

data: ErrorObject

event instance-attribute

event: Literal['error']

ThreadCreated

Attributes:

Name	Type	Description
data	Thread	Represents a thread that contains
event	Literal['thread.created']

data instance-attribute

data: Thread

Represents a thread that contains messages.

event instance-attribute

event: Literal['thread.created']

ThreadMessageCompleted

Attributes:

Name	Type	Description
data	Message	Represents a message within a
event	Literal['thread.message.completed']

data instance-attribute

data: Message

Represents a message within a thread.

event instance-attribute

event: Literal['thread.message.completed']

ThreadMessageCreated

Attributes:

Name	Type	Description
data	Message	Represents a message within a
event	Literal['thread.message.created']

data instance-attribute

data: Message

Represents a message within a thread.

event instance-attribute

event: Literal['thread.message.created']

ThreadMessageDelta

Attributes:

Name	Type	Description
data	MessageDeltaEvent	Represents a message delta i.e.
event	Literal['thread.message.delta']

data instance-attribute

data: MessageDeltaEvent

Represents a message delta i.e.

any changed fields on a message during streaming.

event instance-attribute

event: Literal['thread.message.delta']

ThreadMessageInProgress

Attributes:

Name	Type	Description
data	Message	Represents a message within a
event	Literal['thread.message.in_progress']

data instance-attribute

data: Message

Represents a message within a thread.

event instance-attribute

event: Literal['thread.message.in_progress']

ThreadMessageIncomplete

Attributes:

Name	Type	Description
data	Message	Represents a message within a
event	Literal['thread.message.incomplete']

data instance-attribute

data: Message

Represents a message within a thread.

event instance-attribute

event: Literal['thread.message.incomplete']

ThreadRunCancelled

Attributes:

Name	Type	Description
data	Run	Represents an execution run on a
event	Literal['thread.run.cancelled']

data instance-attribute

data: Run

Represents an execution run on a thread.

event instance-attribute

event: Literal['thread.run.cancelled']

ThreadRunCancelling

Attributes:

Name	Type	Description
data	Run	Represents an execution run on a
event	Literal['thread.run.cancelling']

data instance-attribute

data: Run

Represents an execution run on a thread.

event instance-attribute

event: Literal['thread.run.cancelling']

ThreadRunCompleted

Attributes:

Name	Type	Description
data	Run	Represents an execution run on a
event	Literal['thread.run.completed']

data instance-attribute

data: Run

Represents an execution run on a thread.

event instance-attribute

event: Literal['thread.run.completed']

ThreadRunCreated

Attributes:

Name	Type	Description
data	Run	Represents an execution run on a
event	Literal['thread.run.created']

data instance-attribute

data: Run

Represents an execution run on a thread.

event instance-attribute

event: Literal['thread.run.created']

ThreadRunExpired

Attributes:

Name	Type	Description
data	Run	Represents an execution run on a
event	Literal['thread.run.expired']

data instance-attribute

data: Run

Represents an execution run on a thread.

event instance-attribute

event: Literal['thread.run.expired']

ThreadRunFailed

Attributes:

Name	Type	Description
data	Run	Represents an execution run on a
event	Literal['thread.run.failed']

data instance-attribute

data: Run

Represents an execution run on a thread.

event instance-attribute

event: Literal['thread.run.failed']

ThreadRunInProgress

Attributes:

Name	Type	Description
data	Run	Represents an execution run on a
event	Literal['thread.run.in_progress']

data instance-attribute

data: Run

Represents an execution run on a thread.

event instance-attribute

event: Literal['thread.run.in_progress']

ThreadRunQueued

Attributes:

Name	Type	Description
data	Run	Represents an execution run on a
event	Literal['thread.run.queued']

data instance-attribute

data: Run

Represents an execution run on a thread.

event instance-attribute

event: Literal['thread.run.queued']

ThreadRunRequiresAction

Attributes:

Name	Type	Description
data	Run	Represents an execution run on a
event	Literal['thread.run.requires_action']

data instance-attribute

data: Run

Represents an execution run on a thread.

event instance-attribute

event: Literal['thread.run.requires_action']

ThreadRunStepCancelled

Attributes:

Name	Type	Description
data	RunStep	Represents a step in execution of a run.
event	Literal['thread.run.step.cancelled']

data instance-attribute

data: RunStep

Represents a step in execution of a run.

event instance-attribute

event: Literal['thread.run.step.cancelled']

ThreadRunStepCompleted

Attributes:

Name	Type	Description
data	RunStep	Represents a step in execution of a run.
event	Literal['thread.run.step.completed']

data instance-attribute

data: RunStep

Represents a step in execution of a run.

event instance-attribute

event: Literal['thread.run.step.completed']

ThreadRunStepCreated

Attributes:

Name	Type	Description
data	RunStep	Represents a step in execution of a run.
event	Literal['thread.run.step.created']

data instance-attribute

data: RunStep

Represents a step in execution of a run.

event instance-attribute

event: Literal['thread.run.step.created']

ThreadRunStepDelta

Attributes:

Name	Type	Description
data	RunStepDeltaEvent	Represents a run step delta i.e.
event	Literal['thread.run.step.delta']

data instance-attribute

data: RunStepDeltaEvent

Represents a run step delta i.e.

any changed fields on a run step during streaming.

event instance-attribute

event: Literal['thread.run.step.delta']

ThreadRunStepExpired

Attributes:

Name	Type	Description
data	RunStep	Represents a step in execution of a run.
event	Literal['thread.run.step.expired']

data instance-attribute

data: RunStep

Represents a step in execution of a run.

event instance-attribute

event: Literal['thread.run.step.expired']

ThreadRunStepFailed

Attributes:

Name	Type	Description
data	RunStep	Represents a step in execution of a run.
event	Literal['thread.run.step.failed']

data instance-attribute

data: RunStep

Represents a step in execution of a run.

event instance-attribute

event: Literal['thread.run.step.failed']

ThreadRunStepInProgress

Attributes:

Name	Type	Description
data	RunStep	Represents a step in execution of a run.
event	Literal['thread.run.step.in_progress']

data instance-attribute

data: RunStep

Represents a step in execution of a run.

event instance-attribute

event: Literal['thread.run.step.in_progress']