Class: TrieveRubyClient::ChunkMetadataWithFileData

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChunkMetadataWithFileData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 107

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

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

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

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

  if attributes.key?(:'file_name')
    self.file_name = attributes[:'file_name']
  end

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

  if attributes.key?(:'link')
    self.link = attributes[:'link']
  end

  if attributes.key?(:'metadata')
    self. = attributes[:'metadata']
  end

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

  if attributes.key?(:'tag_set')
    self.tag_set = attributes[:'tag_set']
  end

  if attributes.key?(:'time_stamp')
    self.time_stamp = attributes[:'time_stamp']
  end

  if attributes.key?(:'tracking_id')
    self.tracking_id = attributes[:'tracking_id']
  end

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

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

Instance Attribute Details

#chunk_htmlObject

Returns the value of attribute chunk_html.



18
19
20
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 18

def chunk_html
  @chunk_html
end

#contentObject

Returns the value of attribute content.



20
21
22
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 20

def content
  @content
end

#created_atObject

Returns the value of attribute created_at.



22
23
24
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 22

def created_at
  @created_at
end

#file_idObject

Returns the value of attribute file_id.



24
25
26
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 24

def file_id
  @file_id
end

#file_nameObject

Returns the value of attribute file_name.



26
27
28
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 26

def file_name
  @file_name
end

#idObject

Returns the value of attribute id.



28
29
30
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 28

def id
  @id
end

Returns the value of attribute link.



30
31
32
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 30

def link
  @link
end

#metadataObject

Returns the value of attribute metadata.



32
33
34
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 32

def 
  @metadata
end

#qdrant_point_idObject

Returns the value of attribute qdrant_point_id.



34
35
36
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 34

def qdrant_point_id
  @qdrant_point_id
end

#tag_setObject

Returns the value of attribute tag_set.



36
37
38
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 36

def tag_set
  @tag_set
end

#time_stampObject

Returns the value of attribute time_stamp.



38
39
40
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 38

def time_stamp
  @time_stamp
end

#tracking_idObject

Returns the value of attribute tracking_id.



40
41
42
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 40

def tracking_id
  @tracking_id
end

#updated_atObject

Returns the value of attribute updated_at.



42
43
44
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 42

def updated_at
  @updated_at
end

#weightObject

Returns the value of attribute weight.



44
45
46
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 44

def weight
  @weight
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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 294

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 = TrieveRubyClient.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_attributesObject

Returns all the JSON keys this model knows about



67
68
69
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 47

def self.attribute_map
  {
    :'chunk_html' => :'chunk_html',
    :'content' => :'content',
    :'created_at' => :'created_at',
    :'file_id' => :'file_id',
    :'file_name' => :'file_name',
    :'id' => :'id',
    :'link' => :'link',
    :'metadata' => :'metadata',
    :'qdrant_point_id' => :'qdrant_point_id',
    :'tag_set' => :'tag_set',
    :'time_stamp' => :'time_stamp',
    :'tracking_id' => :'tracking_id',
    :'updated_at' => :'updated_at',
    :'weight' => :'weight'
  }
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 270

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_nullableObject

List of attributes with nullable: true



92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 92

def self.openapi_nullable
  Set.new([
    :'chunk_html',
    :'file_id',
    :'file_name',
    :'link',
    :'metadata',
    :'tag_set',
    :'time_stamp',
    :'tracking_id',
  ])
end

.openapi_typesObject

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 72

def self.openapi_types
  {
    :'chunk_html' => :'String',
    :'content' => :'String',
    :'created_at' => :'Time',
    :'file_id' => :'String',
    :'file_name' => :'String',
    :'id' => :'String',
    :'link' => :'String',
    :'metadata' => :'Object',
    :'qdrant_point_id' => :'String',
    :'tag_set' => :'String',
    :'time_stamp' => :'Time',
    :'tracking_id' => :'String',
    :'updated_at' => :'Time',
    :'weight' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      chunk_html == o.chunk_html &&
      content == o.content &&
      created_at == o.created_at &&
      file_id == o.file_id &&
      file_name == o.file_name &&
      id == o.id &&
      link == o.link &&
       == o. &&
      qdrant_point_id == o.qdrant_point_id &&
      tag_set == o.tag_set &&
      time_stamp == o.time_stamp &&
      tracking_id == o.tracking_id &&
      updated_at == o.updated_at &&
      weight == o.weight
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



365
366
367
368
369
370
371
372
373
374
375
376
377
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 365

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


257
258
259
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 257

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



263
264
265
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 263

def hash
  [chunk_html, content, created_at, file_id, file_name, id, link, , qdrant_point_id, tag_set, time_stamp, tracking_id, updated_at, weight].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 191

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



341
342
343
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 341

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



347
348
349
350
351
352
353
354
355
356
357
358
359
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 347

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



335
336
337
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 335

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



223
224
225
226
227
228
229
230
231
232
# File 'lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb', line 223

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @content.nil?
  return false if @created_at.nil?
  return false if @id.nil?
  return false if @qdrant_point_id.nil?
  return false if @updated_at.nil?
  return false if @weight.nil?
  true
end