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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_text_done_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_indexInteger

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

Returns:

  • (Integer)


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

required :content_index, Integer

#item_idString

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

Returns:

  • (String)


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

required :item_id, String

#logprobsArray<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob>

The log probabilities of the tokens in the delta.



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

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

#output_indexInteger

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

Returns:

  • (Integer)


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

required :output_index, Integer

#sequence_numberInteger

The sequence number for this event.

Returns:

  • (Integer)


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

required :sequence_number, Integer

#textString

The text content that is finalized.

Returns:

  • (String)


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

required :text, String

#typeSymbol, :"response.output_text.done"

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

Returns:

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


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

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