Class: OpenApiOpenAIClient::MessageContentTextAnnotationsFileCitationObject

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

Overview

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "retrieval" tool to search files.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MessageContentTextAnnotationsFileCitationObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
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
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 88

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

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::MessageContentTextAnnotationsFileCitationObject`. Please check the name to make sure it's valid. List of attributes: " + self.class.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_citation')
    self.file_citation = attributes[:'file_citation']
  else
    self.file_citation = 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_citation_object.rb', line 29

def end_index
  @end_index
end

#file_citation ⇒ Object

Returns the value of attribute file_citation.



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

def file_citation
  @file_citation
end

#start_index ⇒ Object

Returns the value of attribute start_index.



27
28
29
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_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_citation_object.rb', line 23

def text
  @text
end

#type ⇒ Object

Always ‘file_citation`.



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

def type
  @type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 273

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OpenApiOpenAIClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  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_citation_object.rb', line 54

def self.attribute_map
  {
    :'type' => :'type',
    :'text' => :'text',
    :'file_citation' => :'file_citation',
    :'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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 249

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



81
82
83
84
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 70

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 224

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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 344

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


236
237
238
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



242
243
244
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 242

def hash
  [type, text, file_citation, 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



134
135
136
137
138
139
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
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 134

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_citation.nil?
    invalid_properties.push('invalid value for "file_citation", file_citation 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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



320
321
322
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 320

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 326

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



314
315
316
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 314

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/openapi_openai/models/message_content_text_annotations_file_citation_object.rb', line 170

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["file_citation"])
  return false unless type_validator.valid?(@type)
  return false if @text.nil?
  return false if @file_citation.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