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

Sent when a batch API request has been cancelled.

Fields

  • :created_at - required - integer()
    The Unix timestamp (in seconds) of when the batch API request was cancelled.

  • :data - required - {:%{}, [], [{{:required, [], [:id]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]}
    Event data payload.

  • :id - required - String.t()
    The unique ID of the event.

  • :object - optional - :event
    The object of the event. Always event.
    Allowed values: "event"

  • :type - required - :"batch.cancelled"
    The type of the event. Always batch.cancelled.
    Allowed values: "batch.cancelled"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.WebhookBatchCancelled{
  created_at: integer(),
  data: %{id: String.t()},
  id: String.t(),
  object: :event | nil,
  type: :"batch.cancelled"
}