Class: TrieveRubyClient::SearchOverGroupsData

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchOverGroupsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
155
156
157
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 99

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

  if attributes.key?(:'group_size')
    self.group_size = attributes[:'group_size']
  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?(:'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
end

Instance Attribute Details

#filters ⇒ Object

Returns the value of attribute filters.



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

def filters
  @filters
end

#get_collisions ⇒ Object

Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true.



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

def get_collisions
  @get_collisions
end

#group_size ⇒ Object

Returns the value of attribute group_size.



23
24
25
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 23

def group_size
  @group_size
end

#highlight_delimiters ⇒ Object

Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to ["?", ",", ".", "!"].



26
27
28
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 26

def highlight_delimiters
  @highlight_delimiters
end

#highlight_results ⇒ Object

Set highlight_results to true to highlight the results. If not specified, this defaults to true.



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

def highlight_results
  @highlight_results
end

#page ⇒ Object

Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.



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

def page
  @page
end

#page_size ⇒ Object

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



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

def page_size
  @page_size
end

#query ⇒ Object

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.



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

def query
  @query
end

#score_threshold ⇒ Object

Set score_threshold to a float to filter out chunks with a score below the threshold.



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

def score_threshold
  @score_threshold
end

#search_type ⇒ Object

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.



44
45
46
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 44

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



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
319
320
321
322
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 285

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



63
64
65
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 63

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 47

def self.attribute_map
  {
    :'filters' => :'filters',
    :'get_collisions' => :'get_collisions',
    :'group_size' => :'group_size',
    :'highlight_delimiters' => :'highlight_delimiters',
    :'highlight_results' => :'highlight_results',
    :'page' => :'page',
    :'page_size' => :'page_size',
    :'query' => :'query',
    :'score_threshold' => :'score_threshold',
    :'search_type' => :'search_type'
  }
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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 261

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



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 84

def self.openapi_nullable
  Set.new([
    :'filters',
    :'get_collisions',
    :'group_size',
    :'highlight_delimiters',
    :'highlight_results',
    :'page',
    :'page_size',
    :'score_threshold',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 68

def self.openapi_types
  {
    :'filters' => :'ChunkFilter',
    :'get_collisions' => :'Boolean',
    :'group_size' => :'Integer',
    :'highlight_delimiters' => :'Array<String>',
    :'highlight_results' => :'Boolean',
    :'page' => :'Integer',
    :'page_size' => :'Integer',
    :'query' => :'String',
    :'score_threshold' => :'Float',
    :'search_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      filters == o.filters &&
      get_collisions == o.get_collisions &&
      group_size == o.group_size &&
      highlight_delimiters == o.highlight_delimiters &&
      highlight_results == o.highlight_results &&
      page == o.page &&
      page_size == o.page_size &&
      query == o.query &&
      score_threshold == o.score_threshold &&
      search_type == o.search_type
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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 356

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


248
249
250
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



254
255
256
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 254

def hash
  [filters, get_collisions, group_size, highlight_delimiters, highlight_results, page, page_size, query, score_threshold, search_type].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



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

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



332
333
334
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 332

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 338

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



326
327
328
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 326

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



189
190
191
192
193
194
195
196
197
 
# File 'lib/trieve_ruby_client/models/search_over_groups_data.rb', line 189

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@group_size.nil? && @group_size < 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