Class: TrieveRubyClient::SearchWithinGroupData

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchWithinGroupData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 186

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#filters ⇒ Object

Returns the value of attribute filters.



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

def filters
  @filters
end

#get_total_pages ⇒ Object

Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms).



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

def get_total_pages
  @get_total_pages
end

#group_id ⇒ Object

Group specifies the group to search within. Results will only consist of chunks which are bookmarks within the specified group.



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

def group_id
  @group_id
end

#group_tracking_id ⇒ Object

Group_tracking_id specifies the group to search within by tracking id. Results will only consist of chunks which are bookmarks within the specified group. If both group_id and group_tracking_id are provided, group_id will be used.



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

def group_tracking_id
  @group_tracking_id
end

#highlight_delimiters ⇒ Object

Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to ["?", ",", ".", "!"]. These are the characters that will be used to split the chunk_html into splits for highlighting.



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

def highlight_delimiters
  @highlight_delimiters
end

#highlight_max_length ⇒ Object

Set highlight_max_length to control the maximum number of tokens (typically whitespace separated strings, but sometimes also word stems) which can be present within a single highlight. If not specified, this defaults to 8. This is useful to shorten large splits which may have low scores due to length compared to the query. Set to something very large like 100 to highlight entire splits.



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

def highlight_max_length
  @highlight_max_length
end

#highlight_max_num ⇒ Object

Set highlight_max_num to control the maximum number of highlights per chunk. If not specified, this defaults to 3. It may be less than 3 if no snippets score above the highlight_threshold.



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

def highlight_max_num
  @highlight_max_num
end

#highlight_results ⇒ Object

Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add ‘<b><mark>` tags to the chunk_html of the chunks to highlight matching splits and return the highlights on each scored chunk in the response.



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

def highlight_results
  @highlight_results
end

#highlight_threshold ⇒ Object

Set highlight_threshold to a lower or higher value to adjust the sensitivity of the highlights applied to the chunk html. If not specified, this defaults to 0.8. The range is 0.0 to 1.0.



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

def highlight_threshold
  @highlight_threshold
end

#highlight_window ⇒ Object

Set highlight_window to a number to control the amount of words that are returned around the matched phrases. If not specified, this defaults to 0. This is useful for when you want to show more context around the matched words. When specified, window/2 whitespace separated words are added before and after each highlight in the response’s highlights array. If an extended highlight overlaps with another highlight, the overlapping words are only included once.



45
46
47
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 45

def highlight_window
  @highlight_window
end

#location_bias ⇒ Object

Returns the value of attribute location_bias.



47
48
49
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 47

def location_bias
  @location_bias
end

#page ⇒ Object

The page of chunks to fetch. Page is 1-indexed.



50
51
52
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 50

def page
  @page
end

#page_size ⇒ Object

The page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.



53
54
55
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 53

def page_size
  @page_size
end

#query ⇒ Object

The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set.



56
57
58
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 56

def query
  @query
end

#recency_bias ⇒ Object

Recency Bias lets you determine how much of an effect the recency of chunks will have on the search results. If not specified, this defaults to 0.0.



59
60
61
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 59

def recency_bias
  @recency_bias
end

#score_threshold ⇒ Object

Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0.



62
63
64
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 62

def score_threshold
  @score_threshold
end

#search_type ⇒ Object

Returns the value of attribute search_type.



64
65
66
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 64

def search_type
  @search_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 (typicall 10-50ms). Default is false.



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

def slim_chunks
  @slim_chunks
end

#tag_weights ⇒ Object

Tag weights is a JSON object which can be used to boost the ranking of chunks with certain tags. This is useful for when you want to be able to bias towards chunks with a certain tag on the fly. The keys are the tag names and the values are the weights.



70
71
72
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 70

def tag_weights
  @tag_weights
end

#use_reranker ⇒ Object

If true, chunks will be reranked using scores from a cross encoder model. "hybrid" search will always use the reranker regardless of this setting.



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

def use_reranker
  @use_reranker
end

#use_weights ⇒ Object

Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true.



76
77
78
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 76

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



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 459

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



128
129
130
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 128

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'filters' => :'filters',
    :'get_total_pages' => :'get_total_pages',
    :'group_id' => :'group_id',
    :'group_tracking_id' => :'group_tracking_id',
    :'highlight_delimiters' => :'highlight_delimiters',
    :'highlight_max_length' => :'highlight_max_length',
    :'highlight_max_num' => :'highlight_max_num',
    :'highlight_results' => :'highlight_results',
    :'highlight_threshold' => :'highlight_threshold',
    :'highlight_window' => :'highlight_window',
    :'location_bias' => :'location_bias',
    :'page' => :'page',
    :'page_size' => :'page_size',
    :'query' => :'query',
    :'recency_bias' => :'recency_bias',
    :'score_threshold' => :'score_threshold',
    :'search_type' => :'search_type',
    :'slim_chunks' => :'slim_chunks',
    :'tag_weights' => :'tag_weights',
    :'use_reranker' => :'use_reranker',
    :'use_weights' => :'use_weights'
  }
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



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 435

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 160

def self.openapi_nullable
  Set.new([
    :'filters',
    :'get_total_pages',
    :'group_id',
    :'group_tracking_id',
    :'highlight_delimiters',
    :'highlight_max_length',
    :'highlight_max_num',
    :'highlight_results',
    :'highlight_threshold',
    :'highlight_window',
    :'location_bias',
    :'page',
    :'page_size',
    :'recency_bias',
    :'score_threshold',
    :'slim_chunks',
    :'tag_weights',
    :'use_reranker',
    :'use_weights'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'filters' => :'ChunkFilter',
    :'get_total_pages' => :'Boolean',
    :'group_id' => :'String',
    :'group_tracking_id' => :'String',
    :'highlight_delimiters' => :'Array<String>',
    :'highlight_max_length' => :'Integer',
    :'highlight_max_num' => :'Integer',
    :'highlight_results' => :'Boolean',
    :'highlight_threshold' => :'Float',
    :'highlight_window' => :'Integer',
    :'location_bias' => :'GeoInfoWithBias',
    :'page' => :'Integer',
    :'page_size' => :'Integer',
    :'query' => :'String',
    :'recency_bias' => :'Float',
    :'score_threshold' => :'Float',
    :'search_type' => :'SearchMethod',
    :'slim_chunks' => :'Boolean',
    :'tag_weights' => :'Hash<String, Float>',
    :'use_reranker' => :'Boolean',
    :'use_weights' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 394

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      filters == o.filters &&
      get_total_pages == o.get_total_pages &&
      group_id == o.group_id &&
      group_tracking_id == o.group_tracking_id &&
      highlight_delimiters == o.highlight_delimiters &&
      highlight_max_length == o.highlight_max_length &&
      highlight_max_num == o.highlight_max_num &&
      highlight_results == o.highlight_results &&
      highlight_threshold == o.highlight_threshold &&
      highlight_window == o.highlight_window &&
      location_bias == o.location_bias &&
      page == o.page &&
      page_size == o.page_size &&
      query == o.query &&
      recency_bias == o.recency_bias &&
      score_threshold == o.score_threshold &&
      search_type == o.search_type &&
      slim_chunks == o.slim_chunks &&
      tag_weights == o.tag_weights &&
      use_reranker == o.use_reranker &&
      use_weights == o.use_weights
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



530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 530

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


422
423
424
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 422

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



428
429
430
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 428

def hash
  [filters, get_total_pages, group_id, group_tracking_id, highlight_delimiters, highlight_max_length, highlight_max_num, highlight_results, highlight_threshold, highlight_window, location_bias, page, page_size, query, recency_bias, score_threshold, search_type, slim_chunks, tag_weights, use_reranker, use_weights].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@highlight_max_length.nil? && @highlight_max_length < 0
    invalid_properties.push('invalid value for "highlight_max_length", must be greater than or equal to 0.')
  end

  if !@highlight_max_num.nil? && @highlight_max_num < 0
    invalid_properties.push('invalid value for "highlight_max_num", must be greater than or equal to 0.')
  end

  if !@highlight_window.nil? && @highlight_window < 0
    invalid_properties.push('invalid value for "highlight_window", must be greater than or equal to 0.')
  end

  if !@page.nil? && @page < 0
    invalid_properties.push('invalid value for "page", must be greater than or equal to 0.')
  end

  if !@page_size.nil? && @page_size < 0
    invalid_properties.push('invalid value for "page_size", must be greater than or equal to 0.')
  end

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

  if @search_type.nil?
    invalid_properties.push('invalid value for "search_type", search_type cannot be nil.')
  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



506
507
508
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 506

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



512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 512

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



500
501
502
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 500

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



330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 330

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@highlight_max_length.nil? && @highlight_max_length < 0
  return false if !@highlight_max_num.nil? && @highlight_max_num < 0
  return false if !@highlight_window.nil? && @highlight_window < 0
  return false if !@page.nil? && @page < 0
  return false if !@page_size.nil? && @page_size < 0
  return false if @query.nil?
  return false if @search_type.nil?
  true
end