Class: OpenAI::Models::Responses::ResponseItem::ImageGenerationCall

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

Defined Under Namespace

Modules: Action, Background, OutputFormat, Quality, Size, Status

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(id:, result:, status:, action: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call) ⇒ Object

Parameters:

  • id —

    The unique ID of the image generation call.

  • result —

    The generated image encoded in base64.

  • status —

    The status of the image generation call.

  • action (defaults to: nil) —

    The action used for image generation.

  • background (defaults to: nil) —

    The background setting used for generation.

  • output_format (defaults to: nil) —

    The output format used for generation.

  • quality (defaults to: nil) —

    The quality of the image generated by the image generation tool call. One of low, medium, high, xhigh, max, or auto.

  • revised_prompt (defaults to: nil) —

    The prompt that was used after any model prompt rewriting.

  • size (defaults to: nil) —

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

  • type (defaults to: :image_generation_call) —

    The type of the image generation call. Always image_generation_call.




# File 'lib/openai/models/responses/response_item.rb', line 351

Instance Attribute Details

#action ⇒ OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::action?

The action used for image generation.

Returns:

  • (OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::action, nil) 


298
299
300
301
302
303
304
 
# File 'lib/openai/models/responses/response_item.rb', line 298

optional(
  :action,
  enum: -> {
    OpenAI::Responses::ResponseItem::ImageGenerationCall::Action
  },
  nil?: true
)

#background ⇒ OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::background?

The background setting used for generation.

Returns:

  • (OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::background, nil) 


310
311
312
313
314
 
# File 'lib/openai/models/responses/response_item.rb', line 310

optional(
  :background,
  enum: -> { OpenAI::Responses::ResponseItem::ImageGenerationCall::Background },
  nil?: true
)

#id ⇒ String

The unique ID of the image generation call.

Returns:

  • (String) 


274
 
# File 'lib/openai/models/responses/response_item.rb', line 274

required :id, String

#output_format ⇒ OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::output_format?

The output format used for generation.

Returns:

  • (OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::output_format, nil) 


320
321
322
323
324
 
# File 'lib/openai/models/responses/response_item.rb', line 320

optional(
  :output_format,
  enum: -> { OpenAI::Responses::ResponseItem::ImageGenerationCall::OutputFormat },
  nil?: true
)

#quality ⇒ OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::quality?

The quality of the image generated by the image generation tool call. One of low, medium, high, xhigh, max, or auto.

Returns:

  • (OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::quality, nil) 


331
332
333
334
335
336
337
 
# File 'lib/openai/models/responses/response_item.rb', line 331

optional(
  :quality,
  enum: -> {
    OpenAI::Responses::ResponseItem::ImageGenerationCall::Quality
  },
  nil?: true
)

#result ⇒ String?

The generated image encoded in base64.

Returns:

  • (String, nil) 


280
 
# File 'lib/openai/models/responses/response_item.rb', line 280

required :result, String, nil?: true

#revised_prompt ⇒ String?

The prompt that was used after any model prompt rewriting.

Returns:

  • (String, nil) 


343
 
# File 'lib/openai/models/responses/response_item.rb', line 343

optional :revised_prompt, String, nil?: true

#size ⇒ OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::size?

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

Returns:

  • (OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::size, nil) 


349
 
# File 'lib/openai/models/responses/response_item.rb', line 349

optional :size, union: -> { OpenAI::Responses::ResponseItem::ImageGenerationCall::Size }, nil?: true

#status ⇒ OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::status

The status of the image generation call.

Returns:

  • (OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::status) 


286
 
# File 'lib/openai/models/responses/response_item.rb', line 286

required :status, enum: -> { OpenAI::Responses::ResponseItem::ImageGenerationCall::Status }

#type ⇒ :image_generation_call

The type of the image generation call. Always image_generation_call.

Returns:

  • (:image_generation_call) 


292
 
# File 'lib/openai/models/responses/response_item.rb', line 292

required :type, const: :image_generation_call

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/responses/response_item.rb', line 396

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


303
 
# File 'sig/openai/models/responses/response_item.rbs', line 303

def to_hash: -> {