class

OpenAI::RealtimeResponseStatusDetails

Inherits JSON::Serializable < Reference < Object

Additional details about the status.

Constructors

new(pull : JSON::PullParser)
Source
new(type_value : RealtimeResponseStatusDetailsType | Nil = nil, reason : RealtimeResponseStatusDetailsReason | Nil = nil, error : RealtimeResponseStatusDetailsError | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

error

A description of the error that caused the response to fail, populated when the status is failed.

Source
error=(error : RealtimeResponseStatusDetailsError | Nil)

A description of the error that caused the response to fail, populated when the status is failed.

Source
reason

The reason the Response did not complete. For a cancelled Response, one of turn_detected (the server VAD detected a new start of speech) or client_cancelled (the client sent a cancel event). For an incomplete Response, one of max_output_tokens or content_filter (the server-side safety filter activated and cut off the response).

Source
reason=(reason : RealtimeResponseStatusDetailsReason | Nil)

The reason the Response did not complete. For a cancelled Response, one of turn_detected (the server VAD detected a new start of speech) or client_cancelled (the client sent a cancel event). For an incomplete Response, one of max_output_tokens or content_filter (the server-side safety filter activated and cut off the response).

Source
type_value

The type of error that caused the response to fail, corresponding with the status field (completed, cancelled, incomplete, failed).

Source
type_value=(type_value : RealtimeResponseStatusDetailsType | Nil)

The type of error that caused the response to fail, corresponding with the status field (completed, cancelled, incomplete, failed).

Source