Class: OpenAI::Models::Responses::ResponseTextDeltaEvent

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

Defined Under Namespace

Classes: Logprob

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#content_index ⇒ Integer

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

Returns:

  • (Integer) 


11
 
# File 'lib/openai/models/responses/response_text_delta_event.rb', line 11

required :content_index, Integer

#delta ⇒ String

The text delta that was added.

Returns:

  • (String) 


17
 
# File 'lib/openai/models/responses/response_text_delta_event.rb', line 17

required :delta, String

#item_id ⇒ String

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

Returns:

  • (String) 


23
 
# File 'lib/openai/models/responses/response_text_delta_event.rb', line 23

required :item_id, String

#logprobs ⇒ Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::Logprob>

The log probabilities of the tokens in the delta.

Returns:



29
30
 
# File 'lib/openai/models/responses/response_text_delta_event.rb', line 29

required :logprobs,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseTextDeltaEvent::Logprob] }

#output_index ⇒ Integer

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

Returns:

  • (Integer) 


36
 
# File 'lib/openai/models/responses/response_text_delta_event.rb', line 36

required :output_index, Integer

#sequence_number ⇒ Integer

The sequence number for this event.

Returns:

  • (Integer) 


42
 
# File 'lib/openai/models/responses/response_text_delta_event.rb', line 42

required :sequence_number, Integer

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

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

Returns:

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


48
 
# File 'lib/openai/models/responses/response_text_delta_event.rb', line 48

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