Skip to main content

KnownResponseStreamEvent

Enum KnownResponseStreamEvent 

Source
#[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

Fields

§sequence_number: Option<u64>
§extra: Extra
§

ResponseInProgress

Fields

§sequence_number: Option<u64>
§extra: Extra
§

ResponseCompleted

Fields

§sequence_number: Option<u64>
§extra: Extra
§

ResponseFailed

Fields

§sequence_number: Option<u64>
§extra: Extra
§

ResponseIncomplete

Fields

§sequence_number: Option<u64>
§extra: Extra
§

ResponseQueued

Fields

§sequence_number: Option<u64>
§extra: Extra
§

ResponseOutputItemAdded

Fields

§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseOutputItemDone

Fields

§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseContentPartAdded

Fields

§content_index: u32
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseContentPartDone

Fields

§content_index: u32
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseOutputTextDelta

Fields

§content_index: u32
§delta: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseOutputTextDone

Fields

§content_index: u32
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§text: String
§extra: Extra
§

ResponseOutputTextAnnotationAdded

Fields

§annotation: Value
§annotation_index: u32
§content_index: u32
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseFunctionCallArgumentsDelta

Fields

§delta: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseFunctionCallArgumentsDone

Fields

§arguments: String
§item_id: String
§name: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseCustomToolCallInputDelta

Fields

§delta: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseCustomToolCallInputDone

Fields

§input: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseRefusalDelta

Fields

§content_index: u32
§delta: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseRefusalDone

Fields

§content_index: u32
§item_id: String
§output_index: u32
§refusal: String
§sequence_number: Option<u64>
§extra: Extra
§

ResponseReasoningSummaryPartAdded

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§summary_index: u32
§extra: Extra
§

ResponseReasoningSummaryPartDone

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§summary_index: u32
§extra: Extra
§

ResponseReasoningSummaryTextDelta

Fields

§delta: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§summary_index: u32
§extra: Extra
§

ResponseReasoningSummaryTextDone

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§summary_index: u32
§text: String
§extra: Extra
§

ResponseReasoningTextDelta

Fields

§content_index: u32
§delta: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseReasoningTextDone

Fields

§content_index: u32
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§text: String
§extra: Extra
§

ResponseAudioDelta

Fields

§delta: String
§sequence_number: Option<u64>
§extra: Extra
§

ResponseAudioDone

Fields

§sequence_number: Option<u64>
§extra: Extra
§

ResponseAudioTranscriptDelta

Fields

§delta: String
§sequence_number: Option<u64>
§extra: Extra
§

ResponseAudioTranscriptDone

Fields

§sequence_number: Option<u64>
§extra: Extra
§

ResponseImageGenerationCallCompleted

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseImageGenerationCallGenerating

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseImageGenerationCallInProgress

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseImageGenerationCallPartialImage

Fields

§item_id: String
§output_index: u32
§partial_image_b64: String
§partial_image_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseFileSearchCallInProgress

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseFileSearchCallSearching

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseFileSearchCallCompleted

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseWebSearchCallInProgress

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseWebSearchCallSearching

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseWebSearchCallCompleted

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseCodeInterpreterCallInProgress

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseCodeInterpreterCallInterpreting

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseCodeInterpreterCallCompleted

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseCodeInterpreterCallCodeDelta

Fields

§delta: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseCodeInterpreterCallCodeDone

Fields

§code: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseMcpCallArgumentsDelta

Fields

§delta: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseMcpCallArgumentsDone

Fields

§arguments: String
§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseMcpCallInProgress

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseMcpCallCompleted

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseMcpCallFailed

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseMcpListToolsInProgress

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseMcpListToolsCompleted

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

ResponseMcpListToolsFailed

Fields

§item_id: String
§output_index: u32
§sequence_number: Option<u64>
§extra: Extra
§

Error

Fields

§code: String
§message: String
§param: String
§sequence_number: Option<u64>
§extra: Extra

Implementations§

Source§

impl KnownResponseStreamEvent

Source

pub fn event_type(&self) -> ResponseStreamEventTypeKnown

Typed event type of this variant, mirroring the serde type tag.

Source

pub fn event_name(&self) -> &'static str

SSE event name: the exact serde rename of this variant.

Trait Implementations§

Source§

impl Clone for KnownResponseStreamEvent

Source§

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)

Performs copy-assignment from source. Read more
Source§

impl Debug for KnownResponseStreamEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for KnownResponseStreamEvent

Source§

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

Source§

fn eq(&self, other: &KnownResponseStreamEvent) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for KnownResponseStreamEvent

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for KnownResponseStreamEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.