Class: OpenAI::Models::Responses::ResponseInputImage

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

Defined Under Namespace

Modules: Detail

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(detail: , file_id: nil, image_url: nil, type: :input_image) ⇒ Object

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

An image input to the model. Learn about [image inputs](platform.openai.com/docs/guides/vision).

Parameters:

  • detail (Symbol, OpenAI::Models::Responses::ResponseInputImage::Detail) (defaults to: ) —

    The detail level of the image to be sent to the model. One of ‘high`, `low`, or

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

    The ID of the file to be sent to the model.

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

    The URL of the image to be sent to the model. A fully qualified URL or base64 en

  • type (Symbol, :input_image) (defaults to: :input_image) —

    The type of the input item. Always ‘input_image`.




# File 'lib/openai/models/responses/response_input_image.rb', line 33

Instance Attribute Details

#detail ⇒ Symbol, OpenAI::Models::Responses::ResponseInputImage::Detail

The detail level of the image to be sent to the model. One of ‘high`, `low`, or `auto`. Defaults to `auto`.

Returns:



12
 
# File 'lib/openai/models/responses/response_input_image.rb', line 12

required :detail, enum: -> { OpenAI::Responses::ResponseInputImage::Detail }

#file_id ⇒ String?

The ID of the file to be sent to the model.

Returns:

  • (String, nil) 


24
 
# File 'lib/openai/models/responses/response_input_image.rb', line 24

optional :file_id, String, nil?: true

#image_url ⇒ String?

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

Returns:

  • (String, nil) 


31
 
# File 'lib/openai/models/responses/response_input_image.rb', line 31

optional :image_url, String, nil?: true

#type ⇒ Symbol, :input_image

The type of the input item. Always ‘input_image`.

Returns:

  • (Symbol, :input_image) 


18
 
# File 'lib/openai/models/responses/response_input_image.rb', line 18

required :type, const: :input_image