Class: OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_text_done_event.rb

Defined Under Namespace

Classes: TopLogprob

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(content_index: , item_id: , logprobs: , output_index: , sequence_number: , text: , type: :"response.output_text.done") ⇒ void

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseTextDoneEvent for more details.

Emitted when text content is finalized.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/openai/models/responses/response_text_done_event.rb', line 70

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

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

  # @!attribute top_logprobs
  #   The log probability of the top 20 most likely tokens.
  #
  #   @return [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob::TopLogprob>, nil]
  optional :top_logprobs,
           -> {
             OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDoneEvent::Logprob::TopLogprob]
           }

  # @!method initialize(token:, logprob:, top_logprobs: nil)
  #   Some parameter documentations has been truncated, see
  #   {OpenAI::Models::Responses::ResponseTextDoneEvent::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.
  #
  #   @param token [String] A possible text token.
  #
  #   @param logprob [Float] The log probability of this token.
  #
  #   @param top_logprobs [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob::TopLogprob>] The log probability of the top 20 most likely tokens.

  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
end

Instance Attribute Details

#logprob ⇒ Float

The log probability of this token.



81
 
# File 'lib/openai/models/responses/response_text_done_event.rb', line 81

required :logprob, Float

#token ⇒ String

A possible text token.



75
 
# File 'lib/openai/models/responses/response_text_done_event.rb', line 75

required :token, String

#top_logprobs ⇒ Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob::TopLogprob>?

The log probability of the top 20 most likely tokens.



87
88
89
90
 
# File 'lib/openai/models/responses/response_text_done_event.rb', line 87

optional :top_logprobs,
-> {
  OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDoneEvent::Logprob::TopLogprob]
}