Class: OpenAI::Models::Audio::TranscriptionTextDoneEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/audio/transcription_text_done_event.rb

Defined Under Namespace

Classes: Logprob, Usage

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, 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(token: nil, bytes: nil, logprob: nil) ⇒ void

Some parameter documentations has been truncated, see Logprob for more details.

Parameters:

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

    The token that was used to generate the log probability.

  • bytes (Array<Integer>) (defaults to: nil) —

    The bytes that were used to generate the log probability.

  • logprob (Float) (defaults to: nil) —

    The log probability of the token.




# File 'lib/openai/models/audio/transcription_text_done_event.rb', line 71

Instance Attribute Details

#logprobs ⇒ Array<OpenAI::Models::Audio::TranscriptionTextDoneEvent::Logprob>?

The log probabilities of the individual tokens in the transcription. Only included if you create a transcription with the include[] parameter set to logprobs.

Returns:



26
27
 
# File 'lib/openai/models/audio/transcription_text_done_event.rb', line 26

optional :logprobs,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Audio::TranscriptionTextDoneEvent::Logprob] }

#text ⇒ String

The text that was transcribed.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/audio/transcription_text_done_event.rb', line 11

required :text, String

#type ⇒ Symbol, :"transcript.text.done"

The type of the event. Always transcript.text.done.

Returns:

  • (Symbol, :"transcript.text.done") 


17
 
# File 'lib/openai/models/audio/transcription_text_done_event.rb', line 17

required :type, const: :"transcript.text.done"

#usage ⇒ OpenAI::Models::Audio::TranscriptionTextDoneEvent::Usage?

Usage statistics for models billed by token usage.

Returns:



33
 
# File 'lib/openai/models/audio/transcription_text_done_event.rb', line 33

optional :usage, -> { OpenAI::Audio::TranscriptionTextDoneEvent::Usage }