Class: TrieveRubyClient::UpdateChunkReqPayload

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateChunkReqPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
188
189
190
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
220
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 136

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

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

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

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

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

  if attributes.key?(:'group_ids')
    if (value = attributes[:'group_ids']).is_a?(Array)
      self.group_ids = value
    end
  end

  if attributes.key?(:'group_tracking_ids')
    if (value = attributes[:'group_tracking_ids']).is_a?(Array)
      self.group_tracking_ids = value
    end
  end

  if attributes.key?(:'image_urls')
    if (value = attributes[:'image_urls']).is_a?(Array)
      self.image_urls = value
    end
  end

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

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

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

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

  if attributes.key?(:'tag_set')
    if (value = attributes[:'tag_set']).is_a?(Array)
      self.tag_set = value
    end
  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?(:'weight')
    self.weight = attributes[:'weight']
  end
end

Instance Attribute Details

#boost_phrase ⇒ Object

Returns the value of attribute boost_phrase.



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

def boost_phrase
  @boost_phrase
end

#chunk_html ⇒ Object

HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used.



21
22
23
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 21

def chunk_html
  @chunk_html
end

#chunk_id ⇒ Object

Id of the chunk you want to update. You can provide either the chunk_id or the tracking_id. If both are provided, the chunk_id will be used.



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

def chunk_id
  @chunk_id
end

#convert_html_to_text ⇒ Object

Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.



27
28
29
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 27

def convert_html_to_text
  @convert_html_to_text
end

#distance_phrase ⇒ Object

Returns the value of attribute distance_phrase.



29
30
31
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 29

def distance_phrase
  @distance_phrase
end

#group_ids ⇒ Object

Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request.



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

def group_ids
  @group_ids
end

#group_tracking_ids ⇒ Object

Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request.



35
36
37
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 35

def group_tracking_ids
  @group_tracking_ids
end

#image_urls ⇒ Object

Image urls are a list of urls to images that are associated with the chunk. This is useful for when you want to associate images with a chunk. If no image_urls are provided, the existing image_urls will be used.



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

def image_urls
  @image_urls
end

#link ⇒ Object

Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used.



41
42
43
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 41

def link
  @link
end

#location ⇒ Object

Returns the value of attribute location.



43
44
45
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 43

def location
  @location
end

#metadata ⇒ Object

The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used.



46
47
48
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 46

def metadata
  @metadata
end

#num_value ⇒ Object

Num value is an arbitrary numerical value that can be used to filter chunks. This is useful for when you want to filter chunks by numerical value. If no num_value is provided, the existing num_value will be used.



49
50
51
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 49

def num_value
  @num_value
end

#tag_set ⇒ Object

Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them. If no tag_set is provided, the existing tag_set will be used.



52
53
54
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 52

def tag_set
  @tag_set
end

#time_stamp ⇒ Object

Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. If no time_stamp is provided, the existing time_stamp will be used.



55
56
57
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 55

def time_stamp
  @time_stamp
end

#tracking_id ⇒ Object

Tracking_id of the chunk you want to update. This is required to match an existing chunk.



58
59
60
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 58

def tracking_id
  @tracking_id
end

#weight ⇒ Object

Weight is a float which can be used to bias search results. This is useful for when you want to bias search results for a chunk. The magnitude only matters relative to other chunks in the chunk’s dataset dataset. If no weight is provided, the existing weight will be used.



61
62
63
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 61

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



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
332
333
334
335
336
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 299

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_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 64

def self.attribute_map
  {
    :'boost_phrase' => :'boost_phrase',
    :'chunk_html' => :'chunk_html',
    :'chunk_id' => :'chunk_id',
    :'convert_html_to_text' => :'convert_html_to_text',
    :'distance_phrase' => :'distance_phrase',
    :'group_ids' => :'group_ids',
    :'group_tracking_ids' => :'group_tracking_ids',
    :'image_urls' => :'image_urls',
    :'link' => :'link',
    :'location' => :'location',
    :'metadata' => :'metadata',
    :'num_value' => :'num_value',
    :'tag_set' => :'tag_set',
    :'time_stamp' => :'time_stamp',
    :'tracking_id' => :'tracking_id',
    :'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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 113

def self.openapi_nullable
  Set.new([
    :'boost_phrase',
    :'chunk_html',
    :'chunk_id',
    :'convert_html_to_text',
    :'distance_phrase',
    :'group_ids',
    :'group_tracking_ids',
    :'image_urls',
    :'link',
    :'location',
    :'metadata',
    :'num_value',
    :'tag_set',
    :'time_stamp',
    :'tracking_id',
    :'weight'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 91

def self.openapi_types
  {
    :'boost_phrase' => :'BoostPhrase',
    :'chunk_html' => :'String',
    :'chunk_id' => :'String',
    :'convert_html_to_text' => :'Boolean',
    :'distance_phrase' => :'DistancePhrase',
    :'group_ids' => :'Array<String>',
    :'group_tracking_ids' => :'Array<String>',
    :'image_urls' => :'Array<String>',
    :'link' => :'String',
    :'location' => :'GeoInfo',
    :'metadata' => :'Object',
    :'num_value' => :'Float',
    :'tag_set' => :'Array<String>',
    :'time_stamp' => :'String',
    :'tracking_id' => :'String',
    :'weight' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      boost_phrase == o.boost_phrase &&
      chunk_html == o.chunk_html &&
      chunk_id == o.chunk_id &&
      convert_html_to_text == o.convert_html_to_text &&
      distance_phrase == o.distance_phrase &&
      group_ids == o.group_ids &&
      group_tracking_ids == o.group_tracking_ids &&
      image_urls == o.image_urls &&
      link == o.link &&
      location == o.location &&
      metadata == o.metadata &&
      num_value == o.num_value &&
      tag_set == o.tag_set &&
      time_stamp == o.time_stamp &&
      tracking_id == o.tracking_id &&
      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



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 370

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


262
263
264
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.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/trieve_ruby_client/models/update_chunk_req_payload.rb', line 268

def hash
  [boost_phrase, chunk_html, chunk_id, convert_html_to_text, distance_phrase, group_ids, group_tracking_ids, image_urls, link, location, metadata, num_value, tag_set, time_stamp, tracking_id, weight].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



224
225
226
227
228
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 224

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



346
347
348
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 346

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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 352

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



340
341
342
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 340

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



232
233
234
235
 
# File 'lib/trieve_ruby_client/models/update_chunk_req_payload.rb', line 232

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end