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

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

Defined Under Namespace

Modules: Status

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(id: , result: , status: , type: :image_generation_call) ⇒ Object

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

An image generation request made by the model.

Parameters:

  • id (String) (defaults to: ) —

    The unique ID of the image generation call.

  • result (String, nil) (defaults to: ) —

    The generated image encoded in base64.

  • status (Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Status) (defaults to: ) —

    The status of the image generation call.

  • type (Symbol, :image_generation_call) (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 86

Instance Attribute Details

#id ⇒ String

The unique ID of the image generation call.

Returns:

  • (String) 


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

required :id, String

#result ⇒ String?

The generated image encoded in base64.

Returns:

  • (String, nil) 


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

required :result, String, nil?: true

#status ⇒ Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Status

The status of the image generation call.

Returns:



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

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

#type ⇒ Symbol, :image_generation_call

The type of the image generation call. Always ‘image_generation_call`.

Returns:

  • (Symbol, :image_generation_call) 


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

required :type, const: :image_generation_call