View Source ExOpenAI.Components.RealtimeBetaClientEventResponseCancel (ex_openai.ex v2.0.0-beta2)

Send this event to cancel an in-progress response. The server will respond with a response.done event with a status of response.status=cancelled. If there is no response to cancel, the server will respond with an error.

Fields

  • :event_id - optional - String.t()
    Optional client-generated ID used to identify this event.

  • :response_id - optional - String.t()
    A specific response ID to cancel - if not provided, will cancel an in-progress response in the default conversation.

  • :type - required - :"response.cancel"
    The event type, must be response.cancel.
    Allowed values: "response.cancel"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.RealtimeBetaClientEventResponseCancel{
  event_id: String.t() | nil,
  response_id: String.t() | nil,
  type: :"response.cancel"
}