Class: OpenAI::Models::Beta::BetaResponseTextDoneEvent

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

Defined Under Namespace

Classes: Agent, 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, 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, logprob: nil) ⇒ Object

Parameters:

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

    A possible text token.

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

    The log probability of this token.




# File 'lib/openai/models/beta/beta_response_text_done_event.rb', line 125

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseTextDoneEvent::Agent?

The agent that owns this multi-agent streaming event.

Parameters:

  • value (OpenAI::Beta::BetaResponseTextDoneEvent::Agent, nil)

Returns:



54
 
# File 'lib/openai/models/beta/beta_response_text_done_event.rb', line 54

optional :agent, -> { OpenAI::Beta::BetaResponseTextDoneEvent::Agent }, nil?: true

#content_index ⇒ Integer

The index of the content part that the text content is finalized.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


11
 
# File 'lib/openai/models/beta/beta_response_text_done_event.rb', line 11

required :content_index, Integer

#item_id ⇒ String

The ID of the output item that the text content is finalized.

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/openai/models/beta/beta_response_text_done_event.rb', line 17

required :item_id, String

#logprobs ⇒ Array<OpenAI::Models::Beta::BetaResponseTextDoneEvent::Logprob>

The log probabilities of the tokens in the delta.

Parameters:

  • value (::Array[OpenAI::Beta::BetaResponseTextDoneEvent::Logprob])

Returns:



23
24
 
# File 'lib/openai/models/beta/beta_response_text_done_event.rb', line 23

required :logprobs,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseTextDoneEvent::Logprob] }

#output_index ⇒ Integer

The index of the output item that the text content is finalized.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


30
 
# File 'lib/openai/models/beta/beta_response_text_done_event.rb', line 30

required :output_index, Integer

#sequence_number ⇒ Integer

The sequence number for this event.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


36
 
# File 'lib/openai/models/beta/beta_response_text_done_event.rb', line 36

required :sequence_number, Integer

#text ⇒ String

The text content that is finalized.

Parameters:

  • value (String)

Returns:

  • (String) 


42
 
# File 'lib/openai/models/beta/beta_response_text_done_event.rb', line 42

required :text, String

#type ⇒ Symbol, :"response.output_text.done"

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

Parameters:

  • value (:"response.output_text.done")

Returns:

  • (Symbol, :"response.output_text.done") 


48
 
# File 'lib/openai/models/beta/beta_response_text_done_event.rb', line 48

required :type, const: :"response.output_text.done"

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


46
 
# File 'sig/openai/models/beta/beta_response_text_done_event.rbs', line 46

def to_hash: -> {