#[non_exhaustive]pub enum KnownResponseStreamEvent {
Show 53 variants
ResponseCreated {
response: Box<ResponseObject>,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseInProgress {
response: Box<ResponseObject>,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseCompleted {
response: Box<ResponseObject>,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseFailed {
response: Box<ResponseObject>,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseIncomplete {
response: Box<ResponseObject>,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseQueued {
response: Box<ResponseObject>,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseOutputItemAdded {
item: Box<ResponseOutputItem>,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseOutputItemDone {
item: Box<ResponseOutputItem>,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseContentPartAdded {
content_index: u32,
item_id: String,
output_index: u32,
part: ResponseContentPart,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseContentPartDone {
content_index: u32,
item_id: String,
output_index: u32,
part: ResponseContentPart,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseOutputTextDelta {
content_index: u32,
delta: String,
item_id: String,
logprobs: Option<Vec<StreamTokenLogprob>>,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseOutputTextDone {
content_index: u32,
item_id: String,
logprobs: Option<Vec<StreamTokenLogprob>>,
output_index: u32,
sequence_number: Option<u64>,
text: String,
extra: Extra,
},
ResponseOutputTextAnnotationAdded {
annotation: Value,
annotation_index: u32,
content_index: u32,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseFunctionCallArgumentsDelta {
delta: String,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseFunctionCallArgumentsDone {
arguments: String,
item_id: String,
name: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseCustomToolCallInputDelta {
delta: String,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseCustomToolCallInputDone {
input: String,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseRefusalDelta {
content_index: u32,
delta: String,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseRefusalDone {
content_index: u32,
item_id: String,
output_index: u32,
refusal: String,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseReasoningSummaryPartAdded {
item_id: String,
output_index: u32,
part: ResponseReasoningSummaryPart,
sequence_number: Option<u64>,
summary_index: u32,
extra: Extra,
},
ResponseReasoningSummaryPartDone {
item_id: String,
output_index: u32,
part: ResponseReasoningSummaryPart,
sequence_number: Option<u64>,
summary_index: u32,
extra: Extra,
},
ResponseReasoningSummaryTextDelta {
delta: String,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
summary_index: u32,
extra: Extra,
},
ResponseReasoningSummaryTextDone {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
summary_index: u32,
text: String,
extra: Extra,
},
ResponseReasoningTextDelta {
content_index: u32,
delta: String,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseReasoningTextDone {
content_index: u32,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
text: String,
extra: Extra,
},
ResponseAudioDelta {
delta: String,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseAudioDone {
sequence_number: Option<u64>,
extra: Extra,
},
ResponseAudioTranscriptDelta {
delta: String,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseAudioTranscriptDone {
sequence_number: Option<u64>,
extra: Extra,
},
ResponseImageGenerationCallCompleted {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseImageGenerationCallGenerating {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseImageGenerationCallInProgress {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseImageGenerationCallPartialImage {
item_id: String,
output_index: u32,
partial_image_b64: String,
partial_image_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseFileSearchCallInProgress {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseFileSearchCallSearching {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseFileSearchCallCompleted {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseWebSearchCallInProgress {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseWebSearchCallSearching {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseWebSearchCallCompleted {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseCodeInterpreterCallInProgress {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseCodeInterpreterCallInterpreting {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseCodeInterpreterCallCompleted {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseCodeInterpreterCallCodeDelta {
delta: String,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseCodeInterpreterCallCodeDone {
code: String,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseMcpCallArgumentsDelta {
delta: String,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseMcpCallArgumentsDone {
arguments: String,
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseMcpCallInProgress {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseMcpCallCompleted {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseMcpCallFailed {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseMcpListToolsInProgress {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseMcpListToolsCompleted {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
ResponseMcpListToolsFailed {
item_id: String,
output_index: u32,
sequence_number: Option<u64>,
extra: Extra,
},
Error {
code: String,
message: String,
param: String,
sequence_number: Option<u64>,
extra: Extra,
},
}Variants (Non-exhaustive)§
This enum is marked as 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.
ResponseCreated
ResponseInProgress
ResponseCompleted
ResponseFailed
ResponseIncomplete
ResponseQueued
ResponseOutputItemAdded
ResponseOutputItemDone
ResponseContentPartAdded
Fields
§
part: ResponseContentPartResponseContentPartDone
Fields
§
part: ResponseContentPartResponseOutputTextDelta
Fields
§
logprobs: Option<Vec<StreamTokenLogprob>>ResponseOutputTextDone
Fields
§
logprobs: Option<Vec<StreamTokenLogprob>>ResponseOutputTextAnnotationAdded
Fields
ResponseFunctionCallArgumentsDelta
ResponseFunctionCallArgumentsDone
Fields
ResponseCustomToolCallInputDelta
ResponseCustomToolCallInputDone
ResponseRefusalDelta
Fields
ResponseRefusalDone
Fields
ResponseReasoningSummaryPartAdded
Fields
ResponseReasoningSummaryPartDone
Fields
ResponseReasoningSummaryTextDelta
Fields
ResponseReasoningSummaryTextDone
Fields
ResponseReasoningTextDelta
Fields
ResponseReasoningTextDone
Fields
ResponseAudioDelta
ResponseAudioDone
ResponseAudioTranscriptDelta
ResponseAudioTranscriptDone
ResponseImageGenerationCallCompleted
ResponseImageGenerationCallGenerating
ResponseImageGenerationCallInProgress
ResponseImageGenerationCallPartialImage
Fields
ResponseFileSearchCallInProgress
ResponseFileSearchCallSearching
ResponseFileSearchCallCompleted
ResponseWebSearchCallInProgress
ResponseWebSearchCallSearching
ResponseWebSearchCallCompleted
ResponseCodeInterpreterCallInProgress
ResponseCodeInterpreterCallInterpreting
ResponseCodeInterpreterCallCompleted
ResponseCodeInterpreterCallCodeDelta
ResponseCodeInterpreterCallCodeDone
ResponseMcpCallArgumentsDelta
ResponseMcpCallArgumentsDone
Fields
ResponseMcpCallInProgress
ResponseMcpCallCompleted
ResponseMcpCallFailed
ResponseMcpListToolsInProgress
ResponseMcpListToolsCompleted
ResponseMcpListToolsFailed
Error
Implementations§
Source§impl KnownResponseStreamEvent
impl KnownResponseStreamEvent
Sourcepub fn event_type(&self) -> ResponseStreamEventTypeKnown
pub fn event_type(&self) -> ResponseStreamEventTypeKnown
Typed event type of this variant, mirroring the serde type tag.
Sourcepub fn event_name(&self) -> &'static str
pub fn event_name(&self) -> &'static str
SSE event name: the exact serde rename of this variant.
Trait Implementations§
Source§impl Clone for KnownResponseStreamEvent
impl Clone for KnownResponseStreamEvent
Source§fn clone(&self) -> KnownResponseStreamEvent
fn clone(&self) -> KnownResponseStreamEvent
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for KnownResponseStreamEvent
impl Debug for KnownResponseStreamEvent
Source§impl<'de> Deserialize<'de> for KnownResponseStreamEvent
impl<'de> Deserialize<'de> for KnownResponseStreamEvent
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl PartialEq for KnownResponseStreamEvent
impl PartialEq for KnownResponseStreamEvent
Source§impl Serialize for KnownResponseStreamEvent
impl Serialize for KnownResponseStreamEvent
impl StructuralPartialEq for KnownResponseStreamEvent
Auto Trait Implementations§
impl Freeze for KnownResponseStreamEvent
impl RefUnwindSafe for KnownResponseStreamEvent
impl Send for KnownResponseStreamEvent
impl Sync for KnownResponseStreamEvent
impl Unpin for KnownResponseStreamEvent
impl UnsafeUnpin for KnownResponseStreamEvent
impl UnwindSafe for KnownResponseStreamEvent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more