Class: Algolia::Search::SearchResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/algolia/models/search/search_response.rb', line 207

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:hits)
    if (value = attributes[:hits]).is_a?(Array)
      self.hits = value
    end
  else
    self.hits = nil
  end

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

  if attributes.key?(:params)
    self.params = attributes[:params]
  else
    self.params = nil
  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

#_automatic_insights ⇒ Object

Whether automatic events collection is enabled for the application.



84
85
86
 
# File 'lib/algolia/models/search/search_response.rb', line 84

def _automatic_insights
  @_automatic_insights
end

#ab_test_id ⇒ Object

A/B test ID. This is only included in the response for indices that are part of an A/B test.



12
13
14
 
# File 'lib/algolia/models/search/search_response.rb', line 12

def ab_test_id
  @ab_test_id
end

#ab_test_variant_id ⇒ Object

Variant ID. This is only included in the response for indices that are part of an A/B test.



15
16
17
 
# File 'lib/algolia/models/search/search_response.rb', line 15

def ab_test_variant_id
  @ab_test_variant_id
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



107
108
109
 
# File 'lib/algolia/models/search/search_response.rb', line 107

def additional_properties
  @additional_properties
end

#applied_rules ⇒ Object

Rules applied to the query.



26
27
28
 
# File 'lib/algolia/models/search/search_response.rb', line 26

def applied_rules
  @applied_rules
end

#around_lat_lng ⇒ Object

Computed geographical location.



18
19
20
 
# File 'lib/algolia/models/search/search_response.rb', line 18

def around_lat_lng
  @around_lat_lng
end

#automatic_radius ⇒ Object

Distance from a central coordinate provided by ‘aroundLatLng`.



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

def automatic_radius
  @automatic_radius
end

#exhaustive ⇒ Object

Returns the value of attribute exhaustive.



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

def exhaustive
  @exhaustive
end

#exhaustive_facets_count ⇒ Object

See the ‘facetsCount` field of the `exhaustive` object in the response.



29
30
31
 
# File 'lib/algolia/models/search/search_response.rb', line 29

def exhaustive_facets_count
  @exhaustive_facets_count
end

#exhaustive_nb_hits ⇒ Object

See the ‘nbHits` field of the `exhaustive` object in the response.



32
33
34
 
# File 'lib/algolia/models/search/search_response.rb', line 32

def exhaustive_nb_hits
  @exhaustive_nb_hits
end

#exhaustive_typo ⇒ Object

See the ‘typo` field of the `exhaustive` object in the response.



35
36
37
 
# File 'lib/algolia/models/search/search_response.rb', line 35

def exhaustive_typo
  @exhaustive_typo
end

#facets ⇒ Object

Facet counts.



38
39
40
 
# File 'lib/algolia/models/search/search_response.rb', line 38

def facets
  @facets
end

#facets_stats ⇒ Object

Statistics for numerical facets.



41
42
43
 
# File 'lib/algolia/models/search/search_response.rb', line 41

def facets_stats
  @facets_stats
end

#hits ⇒ Object

Search results (hits). Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.



99
100
101
 
# File 'lib/algolia/models/search/search_response.rb', line 99

def hits
  @hits
end

#hits_per_page ⇒ Object

Number of hits per page.



96
97
98
 
# File 'lib/algolia/models/search/search_response.rb', line 96

def hits_per_page
  @hits_per_page
end

#index ⇒ Object

Index name used for the query.



44
45
46
 
# File 'lib/algolia/models/search/search_response.rb', line 44

def index
  @index
end

#index_used ⇒ Object

Index name used for the query. During A/B testing, the targeted index isn’t always the index used by the query.



47
48
49
 
# File 'lib/algolia/models/search/search_response.rb', line 47

def index_used
  @index_used
end

#message ⇒ Object

Warnings about the query.



50
51
52
 
# File 'lib/algolia/models/search/search_response.rb', line 50

def message
  @message
end

#nb_hits ⇒ Object

Number of results (hits).



90
91
92
 
# File 'lib/algolia/models/search/search_response.rb', line 90

def nb_hits
  @nb_hits
end

#nb_pages ⇒ Object

Number of pages of results.



93
94
95
 
# File 'lib/algolia/models/search/search_response.rb', line 93

def nb_pages
  @nb_pages
end

#nb_sorted_hits ⇒ Object

Number of hits selected and sorted by the relevant sort algorithm.



53
54
55
 
# File 'lib/algolia/models/search/search_response.rb', line 53

def nb_sorted_hits
  @nb_sorted_hits
end

#page ⇒ Object

Page of search results to retrieve.



87
88
89
 
# File 'lib/algolia/models/search/search_response.rb', line 87

def page
  @page
end

#params ⇒ Object

URL-encoded string of all search parameters.



105
106
107
 
# File 'lib/algolia/models/search/search_response.rb', line 105

def params
  @params
end

#parsed_query ⇒ Object

Post-(www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.



56
57
58
 
# File 'lib/algolia/models/search/search_response.rb', line 56

def parsed_query
  @parsed_query
end

#processing_time_ms ⇒ Object

Time the server took to process the request, in milliseconds.



59
60
61
 
# File 'lib/algolia/models/search/search_response.rb', line 59

def processing_time_ms
  @processing_time_ms
end

#processing_timings_ms ⇒ Object

Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.



62
63
64
 
# File 'lib/algolia/models/search/search_response.rb', line 62

def processing_timings_ms
  @processing_timings_ms
end

#query ⇒ Object

Search query.



102
103
104
 
# File 'lib/algolia/models/search/search_response.rb', line 102

def query
  @query
end

#query_after_removal ⇒ Object

Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.



65
66
67
 
# File 'lib/algolia/models/search/search_response.rb', line 65

def query_after_removal
  @query_after_removal
end

#query_id ⇒ Object

Unique identifier for the query. This is used for [click analytics](www.algolia.com/doc/guides/analytics/click-analytics/).



81
82
83
 
# File 'lib/algolia/models/search/search_response.rb', line 81

def query_id
  @query_id
end

#redirect ⇒ Object

Returns the value of attribute redirect.



67
68
69
 
# File 'lib/algolia/models/search/search_response.rb', line 67

def redirect
  @redirect
end

#rendering_content ⇒ Object

Returns the value of attribute rendering_content.



69
70
71
 
# File 'lib/algolia/models/search/search_response.rb', line 69

def rendering_content
  @rendering_content
end

#server_time_ms ⇒ Object

Time the server took to process the request, in milliseconds.



72
73
74
 
# File 'lib/algolia/models/search/search_response.rb', line 72

def server_time_ms
  @server_time_ms
end

#server_used ⇒ Object

Host name of the server that processed the request.



75
76
77
 
# File 'lib/algolia/models/search/search_response.rb', line 75

def server_used
  @server_used
end

#user_data ⇒ Object

An object with custom data. You can store up to 32kB as custom data.



78
79
80
 
# File 'lib/algolia/models/search/search_response.rb', line 78

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



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/algolia/models/search/search_response.rb', line 484

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.



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

def self.attribute_map
  {
    :ab_test_id => :abTestID,
    :ab_test_variant_id => :abTestVariantID,
    :around_lat_lng => :aroundLatLng,
    :automatic_radius => :automaticRadius,
    :exhaustive => :exhaustive,
    :applied_rules => :appliedRules,
    :exhaustive_facets_count => :exhaustiveFacetsCount,
    :exhaustive_nb_hits => :exhaustiveNbHits,
    :exhaustive_typo => :exhaustiveTypo,
    :facets => :facets,
    :facets_stats => :facets_stats,
    :index => :index,
    :index_used => :indexUsed,
    :message => :message,
    :nb_sorted_hits => :nbSortedHits,
    :parsed_query => :parsedQuery,
    :processing_time_ms => :processingTimeMS,
    :processing_timings_ms => :processingTimingsMS,
    :query_after_removal => :queryAfterRemoval,
    :redirect => :redirect,
    :rendering_content => :renderingContent,
    :server_time_ms => :serverTimeMS,
    :server_used => :serverUsed,
    :user_data => :userData,
    :query_id => :queryID,
    :_automatic_insights => :_automaticInsights,
    :page => :page,
    :nb_hits => :nbHits,
    :nb_pages => :nbPages,
    :hits_per_page => :hitsPerPage,
    :hits => :hits,
    :query => :query,
    :params => :params
  }
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



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/algolia/models/search/search_response.rb', line 455

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



197
198
199
200
201
202
203
 
# File 'lib/algolia/models/search/search_response.rb', line 197

def self.openapi_all_of
  [
    :"BaseSearchResponse",
    :"SearchHits",
    :"SearchPagination"
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



188
189
190
191
192
193
194
 
# File 'lib/algolia/models/search/search_response.rb', line 188

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

.types_mapping ⇒ Object

Attribute type mapping.



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

def self.types_mapping
  {
    :ab_test_id => :"Integer",
    :ab_test_variant_id => :"Integer",
    :around_lat_lng => :"String",
    :automatic_radius => :"String",
    :exhaustive => :"Exhaustive",
    :applied_rules => :"Array<Object>",
    :exhaustive_facets_count => :"Boolean",
    :exhaustive_nb_hits => :"Boolean",
    :exhaustive_typo => :"Boolean",
    :facets => :"Hash<String, Hash<String, Integer>>",
    :facets_stats => :"Hash<String, FacetStats>",
    :index => :"String",
    :index_used => :"String",
    :message => :"String",
    :nb_sorted_hits => :"Integer",
    :parsed_query => :"String",
    :processing_time_ms => :"Integer",
    :processing_timings_ms => :"Object",
    :query_after_removal => :"String",
    :redirect => :"Redirect",
    :rendering_content => :"RenderingContent",
    :server_time_ms => :"Integer",
    :server_used => :"String",
    :user_data => :"Object",
    :query_id => :"String",
    :_automatic_insights => :"Boolean",
    :page => :"Integer",
    :nb_hits => :"Integer",
    :nb_pages => :"Integer",
    :hits_per_page => :"Integer",
    :hits => :"Array<Hit>",
    :query => :"String",
    :params => :"String"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/algolia/models/search/search_response.rb', line 368

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    ab_test_id == other.ab_test_id &&
    ab_test_variant_id == other.ab_test_variant_id &&
    around_lat_lng == other.around_lat_lng &&
    automatic_radius == other.automatic_radius &&
    exhaustive == other.exhaustive &&
    applied_rules == other.applied_rules &&
    exhaustive_facets_count == other.exhaustive_facets_count &&
    exhaustive_nb_hits == other.exhaustive_nb_hits &&
    exhaustive_typo == other.exhaustive_typo &&
    facets == other.facets &&
    facets_stats == other.facets_stats &&
    index == other.index &&
    index_used == other.index_used &&
    message == other.message &&
    nb_sorted_hits == other.nb_sorted_hits &&
    parsed_query == other.parsed_query &&
    processing_time_ms == other.processing_time_ms &&
    processing_timings_ms == other.processing_timings_ms &&
    query_after_removal == other.query_after_removal &&
    redirect == other.redirect &&
    rendering_content == other.rendering_content &&
    server_time_ms == other.server_time_ms &&
    server_used == other.server_used &&
    user_data == other.user_data &&
    query_id == other.query_id &&
    _automatic_insights == other._automatic_insights &&
    page == other.page &&
    nb_hits == other.nb_hits &&
    nb_pages == other.nb_pages &&
    hits_per_page == other.hits_per_page &&
    hits == other.hits &&
    query == other.query &&
    params == other.params
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



568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/algolia/models/search/search_response.rb', line 568

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


408
409
410
 
# File 'lib/algolia/models/search/search_response.rb', line 408

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/algolia/models/search/search_response.rb', line 414

def hash
  [
    ab_test_id,
    ab_test_variant_id,
    around_lat_lng,
    automatic_radius,
    exhaustive,
    applied_rules,
    exhaustive_facets_count,
    exhaustive_nb_hits,
    exhaustive_typo,
    facets,
    facets_stats,
    index,
    index_used,
    message,
    nb_sorted_hits,
    parsed_query,
    processing_time_ms,
    processing_timings_ms,
    query_after_removal,
    redirect,
    rendering_content,
    server_time_ms,
    server_used,
    user_data,
    query_id,
    _automatic_insights,
    page,
    nb_hits,
    nb_pages,
    hits_per_page,
    hits,
    query,
    params
  ].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



534
535
536
 
# File 'lib/algolia/models/search/search_response.rb', line 534

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



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/algolia/models/search/search_response.rb', line 544

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 



538
539
540
 
# File 'lib/algolia/models/search/search_response.rb', line 538

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



528
529
530
 
# File 'lib/algolia/models/search/search_response.rb', line 528

def to_s
  to_hash.to_s
end