Class: OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rb

Defined Under Namespace

Classes: Error

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(content_index:, error:, event_id:, item_id:, type: :"conversation.item.input_audio_transcription.failed") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent for more details.

Returned when input audio transcription is configured, and a transcription request for a user message failed. These events are separate from other ‘error` events so that the client can identify the related Item.

Parameters:

  • content_index (Integer) —

    The index of the content part containing the audio.

  • error (OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error) —

    Details of the transcription error.

  • event_id (String) —

    The unique ID of the server event.

  • item_id (String) —

    The ID of the user message item.

  • type (Symbol, :"conversation.item.input_audio_transcription.failed") (defaults to: :"conversation.item.input_audio_transcription.failed") —

    The event type, must be




# File 'lib/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rb', line 37

Instance Attribute Details

#content_index ⇒ Integer

The index of the content part containing the audio.

Returns:

  • (Integer) 


11
 
# File 'lib/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rb', line 11

required :content_index, Integer

#error ⇒ OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error

Details of the transcription error.

Returns:



17
 
# File 'lib/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rb', line 17

required :error, -> { OpenAI::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error }

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


23
 
# File 'lib/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rb', line 23

required :event_id, String

#item_id ⇒ String

The ID of the user message item.

Returns:

  • (String) 


29
 
# File 'lib/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rb', line 29

required :item_id, String

#type ⇒ Symbol, :"conversation.item.input_audio_transcription.failed"

The event type, must be ‘conversation.item.input_audio_transcription.failed`.

Returns:

  • (Symbol, :"conversation.item.input_audio_transcription.failed") 


35
 
# File 'lib/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rb', line 35

required :type, const: :"conversation.item.input_audio_transcription.failed"