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

Returned when an error occurs, which could be a client problem or a server problem. Most errors are recoverable and the session will stay open, we recommend to implementors to monitor and log error messages by default.

Fields

  • :error - required - {:%{}, [], [{{:optional, [], [:code]}, {:|, [], [{{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}, {:any, [], []}]}}, {{:optional, [], [:event_id]}, {:|, [], [{{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}, {:any, [], []}]}}, {{:required, [], [:message]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:optional, [], [:param]}, {:|, [], [{{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}, {:any, [], []}]}}, {{:required, [], [:type]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]}
    Details of the error.

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

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

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.RealtimeBetaServerEventError{
  error: %{
    optional(:code) => String.t() | any(),
    optional(:event_id) => String.t() | any(),
    :message => String.t(),
    optional(:param) => String.t() | any(),
    type: String.t()
  },
  event_id: String.t(),
  type: :error
}