Class: OpenAI::Models::Beta::Threads::ImageFile

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/threads/image_file.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, 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(file_id: , detail: nil) ⇒ void

Some parameter documentations has been truncated, see OpenAI::Models::Beta::Threads::ImageFile for more details.

Parameters:




# File 'lib/openai/models/beta/threads/image_file.rb', line 23

Instance Attribute Details

#detail ⇒ Symbol, ...

Specifies the detail level of the image if specified by the user. low uses fewer tokens, you can opt in to high resolution using high.

Returns:



21
 
# File 'lib/openai/models/beta/threads/image_file.rb', line 21

optional :detail, enum: -> { OpenAI::Beta::Threads::ImageFile::Detail }

#file_id ⇒ String

The File ID of the image in the message content. Set purpose="vision" when uploading the File if you need to later display the file content.

Returns:

  • (String) 


14
 
# File 'lib/openai/models/beta/threads/image_file.rb', line 14

required :file_id, String