Class: OpenAI::Models::ImageGenCompletedEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::ImageGenCompletedEvent

Defined in:

lib/openai/models/image_gen_completed_event.rb

Defined Under Namespace

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

Instance Attribute Summary

• #b64_json ⇒ String

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

• #background ⇒ Symbol, OpenAI::Models::ImageGenCompletedEvent::Background

  The background setting for the generated image.

• #created_at ⇒ Integer

  The Unix timestamp when the event was created.

• #output_format ⇒ Symbol, OpenAI::Models::ImageGenCompletedEvent::OutputFormat

  The output format for the generated image.

• #quality ⇒ Symbol, OpenAI::Models::ImageGenCompletedEvent::Quality

  The quality setting for the generated image.

• #size ⇒ Symbol, OpenAI::Models::ImageGenCompletedEvent::Size

  The size of the generated image.

• #type ⇒ Symbol, :"image_generation.completed"

  The type of the event.

• #usage ⇒ OpenAI::Models::ImageGenCompletedEvent::Usage

  For gpt-image-1 only, the token usage information for the image generation.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(b64_json: , background: , created_at: , output_format: , quality: , size: , usage: , type: :"image_generation.completed") ⇒ void constructor

  Some parameter documentations has been truncated, see ImageGenCompletedEvent 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, 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") ⇒ void

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

Emitted when image generation has completed and the final image is available.

Parameters:

• b64_json (String) (defaults to: ) —

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

• background (Symbol, OpenAI::Models::ImageGenCompletedEvent::Background) (defaults to: ) —

  The background setting for the generated image.

• created_at (Integer) (defaults to: ) —

  The Unix timestamp when the event was created.

• output_format (Symbol, OpenAI::Models::ImageGenCompletedEvent::OutputFormat) (defaults to: ) —

  The output format for the generated image.

• quality (Symbol, OpenAI::Models::ImageGenCompletedEvent::Quality) (defaults to: ) —

  The quality setting for the generated image.

• size (Symbol, OpenAI::Models::ImageGenCompletedEvent::Size) (defaults to: ) —

  The size of the generated image.

• usage (OpenAI::Models::ImageGenCompletedEvent::Usage) (defaults to: ) —

  For gpt-image-1 only, the token usage information for the image generation.

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

  The type of the event. Always image_generation.completed.

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

Instance Attribute Details

#b64_json ⇒ String

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

Returns:

• (String)

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

required :b64_json, String

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

The background setting for the generated image.

Returns:

• (Symbol, OpenAI::Models::ImageGenCompletedEvent::Background)

# 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)

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

required :created_at, Integer

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

The output format for the generated image.

Returns:

• (Symbol, OpenAI::Models::ImageGenCompletedEvent::OutputFormat)

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

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

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

The quality setting for the generated image.

Returns:

• (Symbol, OpenAI::Models::ImageGenCompletedEvent::Quality)

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

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

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

The size of the generated image.

Returns:

• (Symbol, OpenAI::Models::ImageGenCompletedEvent::Size)

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

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

#type ⇒ Symbol, :"image_generation.completed"

The type of the event. Always image_generation.completed.

Returns:

• (Symbol, :"image_generation.completed")

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

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

#usage ⇒ OpenAI::Models::ImageGenCompletedEvent::Usage

For gpt-image-1 only, the token usage information for the image generation.

Returns:

• (OpenAI::Models::ImageGenCompletedEvent::Usage)

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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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