Class: OpenApiOpenAIClient::MessageContentTextAnnotationsFilePathObject

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

Overview

A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file.

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 = {}) ⇒ MessageContentTextAnnotationsFilePathObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 93

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::MessageContentTextAnnotationsFilePathObject` 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::MessageContentTextAnnotationsFilePathObject`. 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?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

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

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

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

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

Instance Attribute Details

#end_index ⇒ Object

Returns the value of attribute end_index.



29
30
31
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 29

def end_index
  @end_index
end

#file_path ⇒ Object

Returns the value of attribute file_path.



25
26
27
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 25

def file_path
  @file_path
end

#start_index ⇒ Object

Returns the value of attribute start_index.



27
28
29
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 27

def start_index
  @start_index
end

#text ⇒ Object

The text in the message content that needs to be replaced.



23
24
25
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 23

def text
  @text
end

#type ⇒ Object

Always file_path.



20
21
22
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 20

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



65
66
67
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 65

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 70

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 54

def self.attribute_map
  {
    :'type' => :'type',
    :'text' => :'text',
    :'file_path' => :'file_path',
    :'start_index' => :'start_index',
    :'end_index' => :'end_index'
  }
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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 275

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



86
87
88
89
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 75

def self.openapi_types
  {
    :'type' => :'String',
    :'text' => :'String',
    :'file_path' => :'MessageContentTextAnnotationsFilePathObjectFilePath',
    :'start_index' => :'Integer',
    :'end_index' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



250
251
252
253
254
255
256
257
258
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 250

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      text == o.text &&
      file_path == o.file_path &&
      start_index == o.start_index &&
      end_index == o.end_index
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


262
263
264
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



268
269
270
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 268

def hash
  [type, text, file_path, start_index, end_index].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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 140

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

  if @text.nil?
    invalid_properties.push('invalid value for "text", text cannot be nil.')
  end

  if @file_path.nil?
    invalid_properties.push('invalid value for "file_path", file_path cannot be nil.')
  end

  if @start_index.nil?
    invalid_properties.push('invalid value for "start_index", start_index cannot be nil.')
  end

  if @start_index < 0
    invalid_properties.push('invalid value for "start_index", must be greater than or equal to 0.')
  end

  if @end_index.nil?
    invalid_properties.push('invalid value for "end_index", end_index cannot be nil.')
  end

  if @end_index < 0
    invalid_properties.push('invalid value for "end_index", must be greater than or equal to 0.')
  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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 297

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



176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_path_object.rb', line 176

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["file_path"])
  return false unless type_validator.valid?(@type)
  return false if @text.nil?
  return false if @file_path.nil?
  return false if @start_index.nil?
  return false if @start_index < 0
  return false if @end_index.nil?
  return false if @end_index < 0
  true
end