Class: Algolia::Search::Exhaustive

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/search/exhaustive.rb

Overview

Whether certain properties of the search response are calculated exhaustive (exact) or approximated.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Exhaustive

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/algolia/models/search/exhaustive.rb', line 61

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::Exhaustive` 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))
      raise(
        ArgumentError,
        "`#{k}` is not a valid attribute in `Algolia::Exhaustive`. 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?(:facets_count)
    self.facets_count = attributes[:facets_count]
  end

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

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

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

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

Instance Attribute Details

#facet_values ⇒ Object

The value is ‘false` if not all facet values are retrieved.



14
15
16
 
# File 'lib/algolia/models/search/exhaustive.rb', line 14

def facet_values
  @facet_values
end

#facets_count ⇒ Object

Whether the facet count is exhaustive (‘true`) or approximate (`false`). See the [related discussion](support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).



11
12
13
 
# File 'lib/algolia/models/search/exhaustive.rb', line 11

def facets_count
  @facets_count
end

#nb_hits ⇒ Object

Whether the ‘nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.



17
18
19
 
# File 'lib/algolia/models/search/exhaustive.rb', line 17

def nb_hits
  @nb_hits
end

#rules_match ⇒ Object

Rules matching exhaustivity. The value is ‘false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.



20
21
22
 
# File 'lib/algolia/models/search/exhaustive.rb', line 20

def rules_match
  @rules_match
end

#typo ⇒ Object

Whether the typo search was exhaustive (‘true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.



23
24
25
 
# File 'lib/algolia/models/search/exhaustive.rb', line 23

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



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
 
# File 'lib/algolia/models/search/exhaustive.rb', line 157

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
    # model
  else
    # models (e.g. Pet) or oneOf
    klass = Algolia::Search.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



37
38
39
 
# File 'lib/algolia/models/search/exhaustive.rb', line 37

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
 
# File 'lib/algolia/models/search/exhaustive.rb', line 26

def self.attribute_map
  {
    :facets_count => :facetsCount,
    :facet_values => :facetValues,
    :nb_hits => :nbHits,
    :rules_match => :rulesMatch,
    :typo => :typo
  }
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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/algolia/models/search/exhaustive.rb', line 130

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  types_mapping.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = 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.to_sym] = attributes[attribute_map[key]].map { |v|
          _deserialize(::Regexp.last_match(1), v)
        }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
    end
  end

  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



53
54
55
56
57
 
# File 'lib/algolia/models/search/exhaustive.rb', line 53

def self.openapi_nullable
  Set.new(
    []
  )
end

.types_mapping ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
 
# File 'lib/algolia/models/search/exhaustive.rb', line 42

def self.types_mapping
  {
    :facets_count => :"Boolean",
    :facet_values => :"Boolean",
    :nb_hits => :"Boolean",
    :rules_match => :"Boolean",
    :typo => :"Boolean"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



105
106
107
108
109
110
111
112
113
 
# File 'lib/algolia/models/search/exhaustive.rb', line 105

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    facets_count == other.facets_count &&
    facet_values == other.facet_values &&
    nb_hits == other.nb_hits &&
    rules_match == other.rules_match &&
    typo == other.typo
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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/algolia/models/search/exhaustive.rb', line 236

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?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


117
118
119
 
# File 'lib/algolia/models/search/exhaustive.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



123
124
125
 
# File 'lib/algolia/models/search/exhaustive.rb', line 123

def hash
  [facets_count, facet_values, nb_hits, rules_match, typo].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
 
# File 'lib/algolia/models/search/exhaustive.rb', line 207

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/algolia/models/search/exhaustive.rb', line 217

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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_json(*_args) ⇒ Object 



211
212
213
 
# File 'lib/algolia/models/search/exhaustive.rb', line 211

def to_json(*_args)
  to_hash.to_json
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



201
202
203
 
# File 'lib/algolia/models/search/exhaustive.rb', line 201

def to_s
  to_hash.to_s
end