Class: TrieveRubyClient::UploadFileReqPayload

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UploadFileReqPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#base64_file ⇒ Object

Base64 encoded file. This is the standard base64url encoding.



19
20
21
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 19

def base64_file
  @base64_file
end

#create_chunks ⇒ Object

Create chunks is a boolean which determines whether or not to create chunks from the file. If false, you can manually chunk the file and send the chunks to the create_chunk endpoint with the file_id to associate chunks with the file. Meant mostly for advanced users.



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

def create_chunks
  @create_chunks
end

#description ⇒ Object

Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk.



25
26
27
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 25

def description
  @description
end

#file_name ⇒ Object

Name of the file being uploaded, including the extension.



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

def file_name
  @file_name
end

#group_tracking_id ⇒ Object

Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of ‘group_tracking_id|<index of chunk>`



31
32
33
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 31

def group_tracking_id
  @group_tracking_id
end

#link ⇒ Object

Link to the file. This can also be any string. This can be used to filter when searching for the file’s resulting chunks. The link value will not affect embedding creation.



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

def link
  @link
end

#metadata ⇒ Object

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. Will be passed down to the file’s chunks.



37
38
39
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 37

def metadata
  @metadata
end

#rebalance_chunks ⇒ Object

Rebalance chunks is an optional field which allows you to specify whether or not to rebalance the chunks created from the file. If not specified, the default true is used. If true, Trieve will evenly distribute remainder splits across chunks such that 66 splits with a ‘target_splits_per_chunk` of 20 will result in 3 chunks with 22 splits each.



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

def rebalance_chunks
  @rebalance_chunks
end

#split_delimiters ⇒ Object

Split delimiters is an optional field which allows you to specify the delimiters to use when splitting the file before chunking the text. If not specified, the default [.!?\n] are used to split into sentences. However, you may want to use spaces or other delimiters.



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

def split_delimiters
  @split_delimiters
end

#tag_set ⇒ Object

Tag set is a comma separated list of tags which will be passed down to the chunks made from the file. Tags are used to filter chunks when searching. HNSW indices are created for each tag such that there is no performance loss when filtering on them.



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

def tag_set
  @tag_set
end

#target_splits_per_chunk ⇒ Object

Target splits per chunk. This is an optional field which allows you to specify the number of splits you want per chunk. If not specified, the default 20 is used. However, you may want to use a different number.



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

def target_splits_per_chunk
  @target_splits_per_chunk
end

#time_stamp ⇒ Object

Time stamp should be an ISO 8601 combined date and time without timezone. Time_stamp is used for time window filtering and recency-biasing search results. Will be passed down to the file’s chunks.



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

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



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
311
312
313
314
315
316
317
318
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 281

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



73
74
75
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 55

def self.attribute_map
  {
    :'base64_file' => :'base64_file',
    :'create_chunks' => :'create_chunks',
    :'description' => :'description',
    :'file_name' => :'file_name',
    :'group_tracking_id' => :'group_tracking_id',
    :'link' => :'link',
    :'metadata' => :'metadata',
    :'rebalance_chunks' => :'rebalance_chunks',
    :'split_delimiters' => :'split_delimiters',
    :'tag_set' => :'tag_set',
    :'target_splits_per_chunk' => :'target_splits_per_chunk',
    :'time_stamp' => :'time_stamp'
  }
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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 257

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 96

def self.openapi_nullable
  Set.new([
    :'create_chunks',
    :'description',
    :'group_tracking_id',
    :'link',
    :'metadata',
    :'rebalance_chunks',
    :'split_delimiters',
    :'tag_set',
    :'target_splits_per_chunk',
    :'time_stamp'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 78

def self.openapi_types
  {
    :'base64_file' => :'String',
    :'create_chunks' => :'Boolean',
    :'description' => :'String',
    :'file_name' => :'String',
    :'group_tracking_id' => :'String',
    :'link' => :'String',
    :'metadata' => :'Object',
    :'rebalance_chunks' => :'Boolean',
    :'split_delimiters' => :'Array<String>',
    :'tag_set' => :'Array<String>',
    :'target_splits_per_chunk' => :'Integer',
    :'time_stamp' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      base64_file == o.base64_file &&
      create_chunks == o.create_chunks &&
      description == o.description &&
      file_name == o.file_name &&
      group_tracking_id == o.group_tracking_id &&
      link == o.link &&
      metadata == o.metadata &&
      rebalance_chunks == o.rebalance_chunks &&
      split_delimiters == o.split_delimiters &&
      tag_set == o.tag_set &&
      target_splits_per_chunk == o.target_splits_per_chunk &&
      time_stamp == o.time_stamp
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



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

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


244
245
246
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 250

def hash
  [base64_file, create_chunks, description, file_name, group_tracking_id, link, metadata, rebalance_chunks, split_delimiters, tag_set, target_splits_per_chunk, time_stamp].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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 185

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

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

  if !@target_splits_per_chunk.nil? && @target_splits_per_chunk < 0
    invalid_properties.push('invalid value for "target_splits_per_chunk", 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



328
329
330
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 328

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 334

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



322
323
324
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 322

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



205
206
207
208
209
210
211
 
# File 'lib/trieve_ruby_client/models/upload_file_req_payload.rb', line 205

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @base64_file.nil?
  return false if @file_name.nil?
  return false if !@target_splits_per_chunk.nil? && @target_splits_per_chunk < 0
  true
end