Class: OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob::TopLogprob

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

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

Some parameter documentations has been truncated, see OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob for more details.

A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Less-negative (higher) logprob values indicate greater model confidence in that token choice.

Parameters:



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/openai/models/beta/beta_response_text_delta_event.rb', line 112

class TopLogprob < OpenAI::Internal::Type::BaseModel
  # @!attribute token
  #   A possible text token.
  #
  #   @return [String, nil]
  optional :token, String

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

  # @!method initialize(token: nil, logprob: nil)
  #   @param token [String] A possible text token.
  #
  #   @param logprob [Float] The log probability of this token.
end

Instance Attribute Details

#logprob ⇒ Float?

The log probability of this token.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


123
 
# File 'lib/openai/models/beta/beta_response_text_delta_event.rb', line 123

optional :logprob, Float

#token ⇒ String?

A possible text token.

Parameters:

  • (String)

Returns:

  • (String, nil) 


117
 
# File 'lib/openai/models/beta/beta_response_text_delta_event.rb', line 117

optional :token, String

Instance Method Details

#to_hash ⇒ { token: String, logprob: Float }

Returns:

  • ({ token: String, logprob: Float }) 


100
 
# File 'sig/openai/models/beta/beta_response_text_delta_event.rbs', line 100

def to_hash: -> { token: String, logprob: Float }