Class: OpenAI::Models::Beta::Threads::ImageFileDeltaBlock

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/threads/image_file_delta_block.rb

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(index: , image_file: nil, type: :image_file) ⇒ Object

References an image [File](platform.openai.com/docs/api-reference/files) in the content of a message.

Parameters:

  • index (Integer) (defaults to: ) —

    The index of the content part in the message.

  • image_file (OpenAI::Models::Beta::Threads::ImageFileDelta) (defaults to: nil)
  • type (Symbol, :image_file) (defaults to: :image_file) —

    Always ‘image_file`.




# File 'lib/openai/models/beta/threads/image_file_delta_block.rb', line 25

Instance Attribute Details

#image_file ⇒ OpenAI::Models::Beta::Threads::ImageFileDelta?

Returns:



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

optional :image_file, -> { OpenAI::Beta::Threads::ImageFileDelta }

#index ⇒ Integer

The index of the content part in the message.

Returns:

  • (Integer) 


12
 
# File 'lib/openai/models/beta/threads/image_file_delta_block.rb', line 12

required :index, Integer

#type ⇒ Symbol, :image_file

Always ‘image_file`.

Returns:

  • (Symbol, :image_file) 


18
 
# File 'lib/openai/models/beta/threads/image_file_delta_block.rb', line 18

required :type, const: :image_file