Struct MessageStreamEvent

Source
pub struct MessageStreamEvent {}
Expand description

§on openapi.yaml

MessageStreamEvent:
  oneOf:
    - type: object
      properties:
        event:
          type: string
          enum:
            - thread.message.created
          x-stainless-const: true
        data:
          $ref: "#/components/schemas/MessageObject"
      required:
        - event
        - data
      description:
        Occurs when a [message](/docs/api-reference/messages/object) is
        created.
      x-oaiMeta:
        dataDescription: "`data` is a [message](/docs/api-reference/messages/object)"
    - type: object
      properties:
        event:
          type: string
          enum:
            - thread.message.in_progress
          x-stainless-const: true
        data:
          $ref: "#/components/schemas/MessageObject"
      required:
        - event
        - data
      description:
        Occurs when a [message](/docs/api-reference/messages/object) moves
        to an `in_progress` state.
      x-oaiMeta:
        dataDescription: "`data` is a [message](/docs/api-reference/messages/object)"
    - type: object
      properties:
        event:
          type: string
          enum:
            - thread.message.delta
          x-stainless-const: true
        data:
          $ref: "#/components/schemas/MessageDeltaObject"
      required:
        - event
        - data
      description: Occurs when parts of a
        [Message](/docs/api-reference/messages/object) are being streamed.
      x-oaiMeta:
        dataDescription: "`data` is a [message
          delta](/docs/api-reference/assistants-streaming/message-delta-obj\
          ect)"
    - type: object
      properties:
        event:
          type: string
          enum:
            - thread.message.completed
          x-stainless-const: true
        data:
          $ref: "#/components/schemas/MessageObject"
      required:
        - event
        - data
      description:
        Occurs when a [message](/docs/api-reference/messages/object) is
        completed.
      x-oaiMeta:
        dataDescription: "`data` is a [message](/docs/api-reference/messages/object)"
    - type: object
      properties:
        event:
          type: string
          enum:
            - thread.message.incomplete
          x-stainless-const: true
        data:
          $ref: "#/components/schemas/MessageObject"
      required:
        - event
        - data
      description:
        Occurs when a [message](/docs/api-reference/messages/object) ends
        before it is completed.
      x-oaiMeta:
        dataDescription: "`data` is a [message](/docs/api-reference/messages/object)"

Trait Implementations§

Source§

impl Debug for MessageStreamEvent

Source§

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

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

impl<'de> Deserialize<'de> for MessageStreamEvent

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 Serialize for MessageStreamEvent

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

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> 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, 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.
Source§

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