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

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

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, 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(content_index:, delta:, item_id:, logprobs:, output_index:, sequence_number:, agent: nil, type: :"response.output_text.delta") ⇒ Object

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

Emitted when there is an additional text delta.

Parameters:

  • content_index (Integer) —

    The index of the content part that the text delta was added to.

  • delta (String) —

    The text delta that was added.

  • item_id (String) —

    The ID of the output item that the text delta was added to.

  • logprobs (Array<OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob>) —

    The log probabilities of the tokens in the delta.

  • output_index (Integer) —

    The index of the output item that the text delta was added to.

  • sequence_number (Integer) —

    The sequence number for this event.

  • agent (OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Agent, nil) (defaults to: nil) —

    The agent that owns this multi-agent streaming event.

  • type (Symbol, :"response.output_text.delta") (defaults to: :"response.output_text.delta") —

    The type of the event. Always response.output_text.delta.



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
125
126
127
128
129
130
 
# File 'lib/openai/models/beta/beta_response_text_delta_event.rb', line 78

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 probabilities of up to 20 of the most likely tokens.
  #
  #   @return [Array<OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob::TopLogprob>, nil]
  optional :top_logprobs,
           -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseTextDeltaEvent::Logprob::TopLogprob] }

  # @!method initialize(token:, logprob:, top_logprobs: nil)
  #   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.
  #
  #   @param token [String] A possible text token.
  #
  #   @param logprob [Float] The log probability of this token.
  #
  #   @param top_logprobs [Array<OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob::TopLogprob>] The log probabilities of up to 20 of the 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.

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :logprob, Float

#token ⇒ String

A possible text token.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :token, String

#top_logprobs ⇒ Array<OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob::TopLogprob>?

The log probabilities of up to 20 of the most likely tokens.

Returns:



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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {