Class: OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent

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

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, 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(item_id: , output_index: , partial_image_b64: , partial_image_index: , sequence_number: , type: :"response.image_generation_call.partial_image") ⇒ Object

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

Emitted when a partial image is available during image generation streaming.

Parameters:

  • item_id (String) (defaults to: ) —

    The unique identifier of the image generation item being processed.

  • output_index (Integer) (defaults to: ) —

    The index of the output item in the response’s output array.

  • partial_image_b64 (String) (defaults to: ) —

    Base64-encoded partial image data, suitable for rendering as an image.

  • partial_image_index (Integer) (defaults to: ) —

    0-based index for the partial image (backend is 1-based, but this is 0-based for

  • sequence_number (Integer) (defaults to: ) —

    The sequence number of the image generation item being processed.

  • type (Symbol, :"response.image_generation_call.partial_image") (defaults to: :"response.image_generation_call.partial_image") —

    The type of the event. Always ‘response.image_generation_call.partial_image’.




# File 'lib/openai/models/responses/response_image_gen_call_partial_image_event.rb', line 44

Instance Attribute Details

#item_id ⇒ String

The unique identifier of the image generation item being processed.

Returns:

  • (String) 


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

required :item_id, String

#output_index ⇒ Integer

The index of the output item in the response’s output array.

Returns:

  • (Integer) 


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

required :output_index, Integer

#partial_image_b64 ⇒ String

Base64-encoded partial image data, suitable for rendering as an image.

Returns:

  • (String) 


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

required :partial_image_b64, String

#partial_image_index ⇒ Integer

0-based index for the partial image (backend is 1-based, but this is 0-based for the user).

Returns:

  • (Integer) 


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

required :partial_image_index, Integer

#sequence_number ⇒ Integer

The sequence number of the image generation item being processed.

Returns:

  • (Integer) 


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

required :sequence_number, Integer

#type ⇒ Symbol, :"response.image_generation_call.partial_image"

The type of the event. Always ‘response.image_generation_call.partial_image’.

Returns:

  • (Symbol, :"response.image_generation_call.partial_image") 


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

required :type, const: :"response.image_generation_call.partial_image"