Class: OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionDeltaEvent

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

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(event_id:, item_id:, content_index: nil, delta: nil, logprobs: nil, type: :"conversation.item.input_audio_transcription.delta") ⇒ Object

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

Returned when the text value of an input audio transcription content part is updated with incremental transcription results.

Parameters:

  • event_id (String) —

    The unique ID of the server event.

  • item_id (String) —

    The ID of the item containing the audio that is being transcribed.

  • content_index (Integer) (defaults to: nil) —

    The index of the content part in the item’s content array.

  • delta (String) (defaults to: nil) —

    The text delta.

  • logprobs (Array<OpenAI::Models::Realtime::LogProbProperties>, nil) (defaults to: nil) —

    The log probabilities of the transcription. These can be enabled by configuratin

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

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




# File 'lib/openai/models/realtime/conversation_item_input_audio_transcription_delta_event.rb', line 50

Instance Attribute Details

#content_index ⇒ Integer?

The index of the content part in the item’s content array.

Returns:

  • (Integer, nil) 


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

optional :content_index, Integer

#delta ⇒ String?

The text delta.

Returns:

  • (String, nil) 


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

optional :delta, String

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


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

required :event_id, String

#item_id ⇒ String

The ID of the item containing the audio that is being transcribed.

Returns:

  • (String) 


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

required :item_id, String

#logprobs ⇒ Array<OpenAI::Models::Realtime::LogProbProperties>?

The log probabilities of the transcription. These can be enabled by configurating the session with ‘“include”: [“item.input_audio_transcription.logprobs”]`. Each entry in the array corresponds a log probability of which token would be selected for this chunk of transcription. This can help to identify if it was possible there were multiple valid options for a given chunk of transcription.

Returns:



46
47
48
 
# File 'lib/openai/models/realtime/conversation_item_input_audio_transcription_delta_event.rb', line 46

optional :logprobs,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::LogProbProperties] },
nil?: true

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

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

Returns:

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


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

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