Class: TrieveRubyClient::RecommendChunksRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecommendChunksRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 96

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#filters ⇒ Object

Returns the value of attribute filters.



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

def filters
  @filters
end

#limit ⇒ Object

The number of chunks to return. This is the number of chunks which will be returned in the response. The default is 10.



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

def limit
  @limit
end

#negative_chunk_ids ⇒ Object

The ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks.



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

def negative_chunk_ids
  @negative_chunk_ids
end

#negative_tracking_ids ⇒ Object

The tracking_ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks.



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

def negative_tracking_ids
  @negative_tracking_ids
end

#positive_chunk_ids ⇒ Object

The ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks.



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

def positive_chunk_ids
  @positive_chunk_ids
end

#positive_tracking_ids ⇒ Object

The tracking_ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks.



33
34
35
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 33

def positive_tracking_ids
  @positive_tracking_ids
end

#recommend_type ⇒ Object

The type of recommendation to make. This lets you choose whether to recommend based off of ‘semantic` or `fulltext` similarity. The default is `semantic`.



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

def recommend_type
  @recommend_type
end

#slim_chunks ⇒ Object

Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.



39
40
41
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 39

def slim_chunks
  @slim_chunks
end

#strategy ⇒ Object

Strategy to use for recommendations, either "average_vector" or "best_score". The default is "average_vector". The "average_vector" strategy will construct a single average vector from the positive and negative samples then use it to perform a pseudo-search. The "best_score" strategy is more advanced and navigates the HNSW with a heuristic of picking edges where the point is closer to the positive samples than it is the negatives.



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

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 239

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



60
61
62
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 45

def self.attribute_map
  {
    :'filters' => :'filters',
    :'limit' => :'limit',
    :'negative_chunk_ids' => :'negative_chunk_ids',
    :'negative_tracking_ids' => :'negative_tracking_ids',
    :'positive_chunk_ids' => :'positive_chunk_ids',
    :'positive_tracking_ids' => :'positive_tracking_ids',
    :'recommend_type' => :'recommend_type',
    :'slim_chunks' => :'slim_chunks',
    :'strategy' => :'strategy'
  }
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 215

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



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

def self.openapi_nullable
  Set.new([
    :'filters',
    :'limit',
    :'negative_chunk_ids',
    :'negative_tracking_ids',
    :'positive_chunk_ids',
    :'positive_tracking_ids',
    :'recommend_type',
    :'slim_chunks',
    :'strategy'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 65

def self.openapi_types
  {
    :'filters' => :'ChunkFilter',
    :'limit' => :'Integer',
    :'negative_chunk_ids' => :'Array<String>',
    :'negative_tracking_ids' => :'Array<String>',
    :'positive_chunk_ids' => :'Array<String>',
    :'positive_tracking_ids' => :'Array<String>',
    :'recommend_type' => :'String',
    :'slim_chunks' => :'Boolean',
    :'strategy' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      filters == o.filters &&
      limit == o.limit &&
      negative_chunk_ids == o.negative_chunk_ids &&
      negative_tracking_ids == o.negative_tracking_ids &&
      positive_chunk_ids == o.positive_chunk_ids &&
      positive_tracking_ids == o.positive_tracking_ids &&
      recommend_type == o.recommend_type &&
      slim_chunks == o.slim_chunks &&
      strategy == o.strategy
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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 310

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


202
203
204
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



208
209
210
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 208

def hash
  [filters, limit, negative_chunk_ids, negative_tracking_ids, positive_chunk_ids, positive_tracking_ids, recommend_type, slim_chunks, strategy].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



156
157
158
159
160
161
162
163
164
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 156

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@limit.nil? && @limit < 0
    invalid_properties.push('invalid value for "limit", 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



286
287
288
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 286

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 292

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



280
281
282
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 280

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



168
169
170
171
172
 
# File 'lib/trieve_ruby_client/models/recommend_chunks_request.rb', line 168

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