Class: OpenAI::Models::ImageEditPartialImageEvent

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

Defined Under Namespace

Modules: Background, OutputFormat, Quality, Size

Instance Attribute Summary collapse

Class Method 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, 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(b64_json: , background: , created_at: , output_format: , partial_image_index: , quality: , size: , type: :"image_edit.partial_image") ⇒ void

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

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

Parameters:




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

Instance Attribute Details

#b64_json ⇒ String

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

Returns:

  • (String) 


10
 
# File 'lib/openai/models/image_edit_partial_image_event.rb', line 10

required :b64_json, String

#background ⇒ Symbol, OpenAI::Models::ImageEditPartialImageEvent::Background

The background setting for the requested edited image.

Returns:



16
 
# File 'lib/openai/models/image_edit_partial_image_event.rb', line 16

required :background, enum: -> { OpenAI::ImageEditPartialImageEvent::Background }

#created_at ⇒ Integer

The Unix timestamp when the event was created.

Returns:

  • (Integer) 


22
 
# File 'lib/openai/models/image_edit_partial_image_event.rb', line 22

required :created_at, Integer

#output_format ⇒ Symbol, OpenAI::Models::ImageEditPartialImageEvent::OutputFormat

The output format for the requested edited image.

Returns:



28
 
# File 'lib/openai/models/image_edit_partial_image_event.rb', line 28

required :output_format, enum: -> { OpenAI::ImageEditPartialImageEvent::OutputFormat }

#partial_image_index ⇒ Integer

0-based index for the partial image (streaming).

Returns:

  • (Integer) 


34
 
# File 'lib/openai/models/image_edit_partial_image_event.rb', line 34

required :partial_image_index, Integer

#quality ⇒ Symbol, OpenAI::Models::ImageEditPartialImageEvent::Quality

The quality setting for the requested edited image.

Returns:



40
 
# File 'lib/openai/models/image_edit_partial_image_event.rb', line 40

required :quality, enum: -> { OpenAI::ImageEditPartialImageEvent::Quality }

#size ⇒ Symbol, OpenAI::Models::ImageEditPartialImageEvent::Size

The size of the requested edited image.

Returns:



46
 
# File 'lib/openai/models/image_edit_partial_image_event.rb', line 46

required :size, enum: -> { OpenAI::ImageEditPartialImageEvent::Size }

#type ⇒ Symbol, :"image_edit.partial_image"

The type of the event. Always image_edit.partial_image.

Returns:

  • (Symbol, :"image_edit.partial_image") 


52
 
# File 'lib/openai/models/image_edit_partial_image_event.rb', line 52

required :type, const: :"image_edit.partial_image"

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/image_edit_partial_image_event.rb', line 86