Class: OpenApiOpenAIClient::MessageContentImageFileObjectImageFile

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/message_content_image_file_object_image_file.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ MessageContentImageFileObjectImageFile

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 80

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::MessageContentImageFileObjectImageFile` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::MessageContentImageFileObjectImageFile`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'file_id')
    self.file_id = attributes[:'file_id']
  else
    self.file_id = nil
  end

  if attributes.key?(:'detail')
    self.detail = attributes[:'detail']
  else
    self.detail = 'auto'
  end
end

Instance Attribute Details

#detail ⇒ Object

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.



22
23
24
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 22

def detail
  @detail
end

#file_id ⇒ Object

The [File](/docs/api-reference/files) ID of the image in the message content. Set ‘purpose="vision"` when uploading the File if you need to later display the file content.



19
20
21
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 19

def file_id
  @file_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



55
56
57
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 55

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 60

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



47
48
49
50
51
52
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 47

def self.attribute_map
  {
    :'file_id' => :'file_id',
    :'detail' => :'detail'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 173

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



73
74
75
76
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 73

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 65

def self.openapi_types
  {
    :'file_id' => :'String',
    :'detail' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      file_id == o.file_id &&
      detail == o.detail
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


160
161
162
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 160

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



166
167
168
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 166

def hash
  [file_id, detail].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



109
110
111
112
113
114
115
116
117
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 109

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @file_id.nil?
    invalid_properties.push('invalid value for "file_id", file_id cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 195

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



121
122
123
124
125
126
127
 
# File 'lib/openapi_openai/models/message_content_image_file_object_image_file.rb', line 121

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @file_id.nil?
  detail_validator = EnumAttributeValidator.new('String', ["auto", "low", "high"])
  return false unless detail_validator.valid?(@detail)
  true
end