Class: OpenAI::Models::Audio::TranscriptionTextDeltaEvent::Logprob

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/audio/transcription_text_delta_event.rb,
sig/openai/models/audio/transcription_text_delta_event.rbs

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, #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(token: nil, bytes: nil, logprob: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Audio::TranscriptionTextDeltaEvent::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.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/openai/models/audio/transcription_text_delta_event.rb', line 54

class Logprob < OpenAI::Internal::Type::BaseModel
  # @!attribute token
  #   The token that was used to generate the log probability.
  #
  #   @return [String, nil]
  optional :token, String

  # @!attribute bytes
  #   The bytes that were used to generate the log probability.
  #
  #   @return [Array<Integer>, nil]
  optional :bytes, OpenAI::Internal::Type::ArrayOf[Integer]

  # @!attribute logprob
  #   The log probability of the token.
  #
  #   @return [Float, nil]
  optional :logprob, Float

  # @!method initialize(token: nil, bytes: nil, logprob: nil)
  #   Some parameter documentations has been truncated, see
  #   {OpenAI::Models::Audio::TranscriptionTextDeltaEvent::Logprob} for more details.
  #
  #   @param token [String] The token that was used to generate the log probability.
  #
  #   @param bytes [Array<Integer>] The bytes that were used to generate the log probability.
  #
  #   @param logprob [Float] The log probability of the token.
end

Instance Attribute Details

#bytes ⇒ Array<Integer>?

The bytes that were used to generate the log probability.

Parameters:

  • (::Array[Integer])

Returns:

  • (Array<Integer>, nil) 


65
 
# File 'lib/openai/models/audio/transcription_text_delta_event.rb', line 65

optional :bytes, OpenAI::Internal::Type::ArrayOf[Integer]

#logprob ⇒ Float?

The log probability of the token.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


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

optional :logprob, Float

#token ⇒ String?

The token that was used to generate the log probability.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :token, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


63
 
# File 'sig/openai/models/audio/transcription_text_delta_event.rbs', line 63

def to_hash: -> {