Class: OpenAI::Models::ImageGenCompletedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/image_gen_completed_event.rb,
sig/openai/models/image_gen_completed_event.rbs

Defined Under Namespace

Modules: Background, OutputFormat, Quality, Size Classes: Usage

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, 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:, quality:, size:, usage:, type: :"image_generation.completed") ⇒ Object

Parameters:

  • b64_json —

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

  • background —

    The background setting for the generated image.

  • created_at —

    The Unix timestamp when the event was created.

  • output_format —

    The output format for the generated image.

  • quality —

    The quality setting for the generated image.

  • size —

    The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.

  • usage —

    For the GPT image models only, the token usage information for the image generation.

  • type (defaults to: :"image_generation.completed") —

    The type of the event. Always image_generation.completed.




# File 'lib/openai/models/image_gen_completed_event.rb', line 55

Instance Attribute Details

#b64_json ⇒ String

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

Returns:

  • (String) 


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

required :b64_json, String

#background ⇒ OpenAI::Models::ImageGenCompletedEvent::background

The background setting for the generated image.

Returns:

  • (OpenAI::Models::ImageGenCompletedEvent::background) 


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

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

#created_at ⇒ Integer

The Unix timestamp when the event was created.

Returns:

  • (Integer) 


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

required :created_at, Integer

#output_format ⇒ OpenAI::Models::ImageGenCompletedEvent::output_format

The output format for the generated image.

Returns:

  • (OpenAI::Models::ImageGenCompletedEvent::output_format) 


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

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

#quality ⇒ OpenAI::Models::ImageGenCompletedEvent::quality

The quality setting for the generated image.

Returns:

  • (OpenAI::Models::ImageGenCompletedEvent::quality) 


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

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

#size ⇒ OpenAI::Models::ImageGenCompletedEvent::size

The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.

Returns:

  • (OpenAI::Models::ImageGenCompletedEvent::size) 


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

required :size, union: -> { OpenAI::ImageGenCompletedEvent::Size }

#type ⇒ :"image_generation.completed"

The type of the event. Always image_generation.completed.

Returns:

  • (:"image_generation.completed") 


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

required :type, const: :"image_generation.completed"

#usage ⇒ OpenAI::ImageGenCompletedEvent::Usage

For the GPT image models only, the token usage information for the image generation.

Returns:

  • (OpenAI::ImageGenCompletedEvent::Usage) 


53
 
# File 'lib/openai/models/image_gen_completed_event.rb', line 53

required :usage, -> { OpenAI::ImageGenCompletedEvent::Usage }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/image_gen_completed_event.rb', line 93

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


69
 
# File 'sig/openai/models/image_gen_completed_event.rbs', line 69

def to_hash: -> {