pub enum ResponseStreamEvent {
Show 21 variants
Created {
id: String,
model: String,
status: String,
created_at: i64,
request_context: Option<ResponseRequestContext>,
},
InProgress {
id: String,
model: String,
status: String,
created_at: i64,
request_context: Option<ResponseRequestContext>,
},
OutputItemAdded {
output_index: u32,
item_id: String,
item_type: String,
role: Option<String>,
call_id: Option<String>,
name: Option<String>,
},
ContentPartAdded {
item_id: String,
output_index: u32,
content_index: u32,
part_type: String,
},
OutputTextDelta {
item_id: String,
output_index: u32,
content_index: u32,
delta: String,
},
OutputTextDone {
item_id: String,
output_index: u32,
content_index: u32,
text: String,
},
ContentPartDone {
item_id: String,
output_index: u32,
content_index: u32,
part_type: String,
text: String,
},
OutputItemDone {
output_index: u32,
item_id: String,
item_type: String,
role: Option<String>,
call_id: Option<String>,
name: Option<String>,
arguments: Option<String>,
text: Option<String>,
refusal: Option<String>,
summary: Option<Vec<ReasoningSummaryPart>>,
},
ReasoningAdded {
output_index: u32,
item_id: String,
},
ReasoningDelta {
item_id: String,
output_index: u32,
content_index: u32,
delta: String,
},
ReasoningTextDone {
item_id: String,
output_index: u32,
content_index: u32,
text: String,
},
ReasoningSummaryTextDelta {
item_id: String,
output_index: u32,
content_index: u32,
delta: String,
},
ReasoningSummaryTextDone {
item_id: String,
output_index: u32,
content_index: u32,
text: String,
},
FunctionCallArgumentsDelta {
output_index: u32,
item_id: String,
call_id: Option<String>,
delta: String,
},
FunctionCallArgumentsDone {
output_index: u32,
item_id: String,
call_id: String,
arguments: String,
},
Completed {
response: Box<ResponseObject>,
},
Error {
id: Option<String>,
error_type: String,
message: String,
code: Option<String>,
},
Failed {
id: String,
model: String,
status: String,
created_at: i64,
},
Incomplete {
id: String,
model: String,
status: String,
created_at: i64,
reason: Option<String>,
},
RefusalDelta {
item_id: String,
output_index: u32,
content_index: u32,
delta: String,
},
RefusalDone {
item_id: String,
output_index: u32,
content_index: u32,
refusal: String,
},
}Expand description
SSE event types for Responses API streaming.
Variants§
Created
Initial response created event.
Fields
§
request_context: Option<ResponseRequestContext>InProgress
Response is in progress.
Fields
§
request_context: Option<ResponseRequestContext>OutputItemAdded
Output item was added.
Fields
ContentPartAdded
Content part was added.
OutputTextDelta
Output text delta (content chunk).
OutputTextDone
Output text done.
ContentPartDone
Content part done.
OutputItemDone
Output item done.
Fields
§
summary: Option<Vec<ReasoningSummaryPart>>ReasoningAdded
Reasoning output item added.
ReasoningDelta
Reasoning text delta.
ReasoningTextDone
Reasoning text done.
ReasoningSummaryTextDelta
Reasoning summary text delta.
ReasoningSummaryTextDone
Reasoning summary text done.
FunctionCallArgumentsDelta
Function call arguments delta.
FunctionCallArgumentsDone
Function call arguments done.
Completed
Response completed with final object.
Fields
§
response: Box<ResponseObject>Error
Response error event.
Failed
Response failed event.
Incomplete
Response incomplete event.
RefusalDelta
Refusal content delta.
RefusalDone
Refusal content done.
Trait Implementations§
Source§impl Clone for ResponseStreamEvent
impl Clone for ResponseStreamEvent
Source§fn clone(&self) -> ResponseStreamEvent
fn clone(&self) -> ResponseStreamEvent
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 moreAuto Trait Implementations§
impl Freeze for ResponseStreamEvent
impl RefUnwindSafe for ResponseStreamEvent
impl Send for ResponseStreamEvent
impl Sync for ResponseStreamEvent
impl Unpin for ResponseStreamEvent
impl UnsafeUnpin for ResponseStreamEvent
impl UnwindSafe for ResponseStreamEvent
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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