Class: OpenAI::Models::Responses::ResponseRefusalDoneEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ResponseRefusalDoneEvent

Defined in:

lib/openai/models/responses/response_refusal_done_event.rb

Instance Attribute Summary

• #content_index ⇒ Integer

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

• #item_id ⇒ String

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

• #output_index ⇒ Integer

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

• #refusal ⇒ String

  The refusal text that is finalized.

• #sequence_number ⇒ Integer

  The sequence number of this event.

• #type ⇒ Symbol, :"response.refusal.done"

  The type of the event.

Instance Method Summary

• #initialize(content_index: , item_id: , output_index: , refusal: , sequence_number: , type: :"response.refusal.done") ⇒ Object constructor

  Some parameter documentations has been truncated, see ResponseRefusalDoneEvent for more details.

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, 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: , output_index: , refusal: , sequence_number: , type: :"response.refusal.done") ⇒ Object

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

Emitted when refusal text is finalized.

Parameters:

• content_index (Integer) (defaults to: ) —

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

• item_id (String) (defaults to: ) —

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

• output_index (Integer) (defaults to: ) —

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

• refusal (String) (defaults to: ) —

  The refusal text that is finalized.

• sequence_number (Integer) (defaults to: ) —

  The sequence number of this event.

• type (Symbol, :"response.refusal.done") (defaults to: :"response.refusal.done") —

  The type of the event. Always ‘response.refusal.done`.

# File 'lib/openai/models/responses/response_refusal_done_event.rb', line 43

Instance Attribute Details

#content_index ⇒ Integer

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

Returns:

• (Integer)

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

required :content_index, Integer

#item_id ⇒ String

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

Returns:

• (String)

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

required :item_id, String

#output_index ⇒ Integer

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

Returns:

• (Integer)

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

required :output_index, Integer

#refusal ⇒ String

The refusal text that is finalized.

Returns:

• (String)

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

required :refusal, String

#sequence_number ⇒ Integer

The sequence number of this event.

Returns:

• (Integer)

# File 'lib/openai/models/responses/response_refusal_done_event.rb', line 35

required :sequence_number, Integer

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

The type of the event. Always ‘response.refusal.done`.

Returns:

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

# File 'lib/openai/models/responses/response_refusal_done_event.rb', line 41

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