Class: Algolia::Search::Hit

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

Overview

Search result. A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Hit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



58
59
60
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
 
# File 'lib/algolia/models/search/hit.rb', line 58

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Hit` initialize method"
  end

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

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

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

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

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

  # add extra attribute to additional_properties
  self.additional_properties ||= {}
  self.additional_properties.merge!(attributes.reject { |k, _| self.class.attribute_map.key?(k.to_sym) })
end

Instance Attribute Details

#_distinct_seq_id ⇒ Object

Returns the value of attribute _distinct_seq_id.



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

def _distinct_seq_id
  @_distinct_seq_id
end

#_highlight_result ⇒ Object

Surround words that match the query with HTML tags for highlighting.



16
17
18
 
# File 'lib/algolia/models/search/hit.rb', line 16

def _highlight_result
  @_highlight_result
end

#_ranking_info ⇒ Object

Returns the value of attribute _ranking_info.



21
22
23
 
# File 'lib/algolia/models/search/hit.rb', line 21

def _ranking_info
  @_ranking_info
end

#_snippet_result ⇒ Object

Snippets that show the context around a matching search query.



19
20
21
 
# File 'lib/algolia/models/search/hit.rb', line 19

def _snippet_result
  @_snippet_result
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



25
26
27
 
# File 'lib/algolia/models/search/hit.rb', line 25

def additional_properties
  @additional_properties
end

#algolia_object_id ⇒ Object

Unique record identifier.



13
14
15
 
# File 'lib/algolia/models/search/hit.rb', line 13

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



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

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

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
 
# File 'lib/algolia/models/search/hit.rb', line 28

def self.attribute_map
  {
    :algolia_object_id => :objectID,
    :_highlight_result => :_highlightResult,
    :_snippet_result => :_snippetResult,
    :_ranking_info => :_rankingInfo,
    :_distinct_seq_id => :_distinctSeqID
  }
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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/algolia/models/search/hit.rb', line 121

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

  # add extra attribute to transformed_hash
  transformed_hash.merge!(attributes.reject { |k, _| attribute_map.key?(k.to_sym) })
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



50
51
52
53
54
 
# File 'lib/algolia/models/search/hit.rb', line 50

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

.types_mapping ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
 
# File 'lib/algolia/models/search/hit.rb', line 39

def self.types_mapping
  {
    :algolia_object_id => :"String",
    :_highlight_result => :"Hash<String, HighlightResult>",
    :_snippet_result => :"Hash<String, SnippetResult>",
    :_ranking_info => :"RankingInfo",
    :_distinct_seq_id => :"Integer"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



96
97
98
99
100
101
102
103
104
 
# File 'lib/algolia/models/search/hit.rb', line 96

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    algolia_object_id == other.algolia_object_id &&
    _highlight_result == other._highlight_result &&
    _snippet_result == other._snippet_result &&
    _ranking_info == other._ranking_info &&
    _distinct_seq_id == other._distinct_seq_id
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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/algolia/models/search/hit.rb', line 234

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


108
109
110
 
# File 'lib/algolia/models/search/hit.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



114
115
116
 
# File 'lib/algolia/models/search/hit.rb', line 114

def hash
  [algolia_object_id, _highlight_result, _snippet_result, _ranking_info, _distinct_seq_id].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



200
201
202
 
# File 'lib/algolia/models/search/hit.rb', line 200

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/algolia/models/search/hit.rb', line 210

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

  # also add attributes from additional_properties to hash
  self.additional_properties&.each_pair do |k, v|
    hash[k.to_sym] = _to_hash(v)
  end

  hash
end

#to_json(*_args) ⇒ Object 



204
205
206
 
# File 'lib/algolia/models/search/hit.rb', line 204

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



194
195
196
 
# File 'lib/algolia/models/search/hit.rb', line 194

def to_s
  to_hash.to_s
end