Class: OpenAI::Models::Audio::Transcription

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

Defined Under Namespace

Modules: Usage Classes: Logprob

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

Parameters:

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

    The token in the transcription.

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

    The bytes of the token.

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

    The log probability of the token.




# File 'lib/openai/models/audio/transcription.rb', line 59

Instance Attribute Details

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

The log probabilities of the tokens in the transcription. Only returned with the models gpt-4o-transcribe and gpt-4o-mini-transcribe if logprobs is added to the include array.

Returns:



19
 
# File 'lib/openai/models/audio/transcription.rb', line 19

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

#text ⇒ String

The transcribed text.

Returns:

  • (String) 


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

required :text, String

#usage ⇒ OpenAI::Models::Audio::Transcription::Usage::Tokens, ...

Token usage statistics for the request.

Returns:



25
 
# File 'lib/openai/models/audio/transcription.rb', line 25

optional :usage, union: -> { OpenAI::Audio::Transcription::Usage }