Class: TrieveRubyClient::SearchWithinGroupData

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

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



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
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 124

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_results')
    self.highlight_results = attributes[:'highlight_results']
  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?(:'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 ["?", ",", ".", "!"].



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

def highlight_delimiters
  @highlight_delimiters
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 sub-sentences.



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

def highlight_results
  @highlight_results
end

#page ⇒ Object

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



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

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.



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

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.



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

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.



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

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.



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

def score_threshold
  @score_threshold
end

#search_type ⇒ Object

Search_type can be either "semantic", "fulltext", or "hybrid". "hybrid" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. "semantic" will pull in one page (10 chunks) of the nearest cosine distant vectors. "fulltext" will pull in one page (10 chunks) of full-text results based on SPLADE.



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

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.



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

def slim_chunks
  @slim_chunks
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.



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

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 315

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



80
81
82
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 60

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_results' => :'highlight_results',
    :'page' => :'page',
    :'page_size' => :'page_size',
    :'query' => :'query',
    :'recency_bias' => :'recency_bias',
    :'score_threshold' => :'score_threshold',
    :'search_type' => :'search_type',
    :'slim_chunks' => :'slim_chunks',
    :'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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 291

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 105

def self.openapi_nullable
  Set.new([
    :'filters',
    :'get_total_pages',
    :'group_id',
    :'group_tracking_id',
    :'highlight_delimiters',
    :'highlight_results',
    :'page',
    :'page_size',
    :'recency_bias',
    :'score_threshold',
    :'slim_chunks',
    :'use_weights'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 85

def self.openapi_types
  {
    :'filters' => :'ChunkFilter',
    :'get_total_pages' => :'Boolean',
    :'group_id' => :'String',
    :'group_tracking_id' => :'String',
    :'highlight_delimiters' => :'Array<String>',
    :'highlight_results' => :'Boolean',
    :'page' => :'Integer',
    :'page_size' => :'Integer',
    :'query' => :'String',
    :'recency_bias' => :'Float',
    :'score_threshold' => :'Float',
    :'search_type' => :'String',
    :'slim_chunks' => :'Boolean',
    :'use_weights' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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_results == o.highlight_results &&
      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 &&
      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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 386

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


278
279
280
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



284
285
286
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 284

def hash
  [filters, get_total_pages, group_id, group_tracking_id, highlight_delimiters, highlight_results, page, page_size, query, recency_bias, score_threshold, search_type, slim_chunks, 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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 202

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



362
363
364
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 362

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 368

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



356
357
358
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 356

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



226
227
228
229
230
231
232
233
 
# File 'lib/trieve_ruby_client/models/search_within_group_data.rb', line 226

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  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