Stream Events¶
All stream events are dataclasses with a type field matching the SSE event name.
Use isinstance() checks to handle specific event types when iterating a ResponseStream.
All stream events are dataclasses with a type field matching the SSE event name.
Use isinstance() checks to handle specific event types when iterating a ResponseStream.
codex_open_client.ResponseCreatedEvent(response: Response, type: Literal['response.created'] = 'response.created')
dataclass
¶codex_open_client.ResponseInProgressEvent(response: Response, type: Literal['response.in_progress'] = 'response.in_progress')
dataclass
¶codex_open_client.ResponseCompletedEvent(response: Response, type: Literal['response.completed'] = 'response.completed')
dataclass
¶codex_open_client.ResponseFailedEvent(response: Response, type: Literal['response.failed'] = 'response.failed')
dataclass
¶codex_open_client.ResponseIncompleteEvent(response: Response, type: Literal['response.incomplete'] = 'response.incomplete')
dataclass
¶codex_open_client.ResponseOutputTextDeltaEvent(delta: str, content_index: int = 0, output_index: int = 0, type: Literal['response.output_text.delta'] = 'response.output_text.delta')
dataclass
¶codex_open_client.ResponseOutputTextDoneEvent(text: str, content_index: int = 0, output_index: int = 0, type: Literal['response.output_text.done'] = 'response.output_text.done')
dataclass
¶codex_open_client.ResponseOutputItemAddedEvent(item: OutputItem, output_index: int, type: Literal['response.output_item.added'] = 'response.output_item.added')
dataclass
¶codex_open_client.ResponseOutputItemDoneEvent(item: OutputItem, output_index: int, type: Literal['response.output_item.done'] = 'response.output_item.done')
dataclass
¶codex_open_client.ResponseFunctionCallArgumentsDeltaEvent(delta: str, output_index: int = 0, type: Literal['response.function_call_arguments.delta'] = 'response.function_call_arguments.delta')
dataclass
¶codex_open_client.ResponseFunctionCallArgumentsDoneEvent(arguments: str, output_index: int = 0, type: Literal['response.function_call_arguments.done'] = 'response.function_call_arguments.done')
dataclass
¶codex_open_client.ResponseReasoningSummaryTextDeltaEvent(delta: str, output_index: int = 0, type: Literal['response.reasoning_summary_text.delta'] = 'response.reasoning_summary_text.delta')
dataclass
¶codex_open_client.ResponseReasoningSummaryTextDoneEvent(text: str, output_index: int = 0, type: Literal['response.reasoning_summary_text.done'] = 'response.reasoning_summary_text.done')
dataclass
¶