Class: Algolia::SearchClient

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/api/search_client.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = nil) ⇒ SearchClient

Returns a new instance of SearchClient.



10
11
12
13
14
15
16
 
# File 'lib/algolia/api/search_client.rb', line 10

def initialize(config = nil)
  raise "`config` is missing." if config.nil?
  raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
  raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""

  @api_client = Algolia::ApiClient.new(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



8
9
10
 
# File 'lib/algolia/api/search_client.rb', line 8

def api_client
  @api_client
end

Class Method Details

.create(app_id, api_key, opts = {}) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/algolia/api/search_client.rb', line 18

def self.create(app_id, api_key, opts = {})
  hosts = []
  hosts << Transport::StatefulHost.new("#{app_id}-dsn.algolia.net", accept: CallType::READ)
  hosts << Transport::StatefulHost.new("#{app_id}.algolia.net", accept: CallType::WRITE)

  hosts += 1
    .upto(3)
    .map do |i|
      Transport::StatefulHost.new("#{app_id}-#{i}.algolianet.com", accept: CallType::READ | CallType::WRITE)
    end
    .shuffle

  config = Algolia::Configuration.new(app_id, api_key, hosts, "Search", opts)
  create_with_config(config)
end

.create_with_config(config) ⇒ Object 



34
35
36
 
# File 'lib/algolia/api/search_client.rb', line 34

def self.create_with_config(config)
  new(config)
end

Instance Method Details

#add_api_key(api_key, request_options = {}) ⇒ AddApiKeyResponse

Creates a new API key with specific permissions and restrictions.

Required API Key ACLs:

- admin

Parameters:

  • api_key (ApiKey) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (AddApiKeyResponse) 


77
78
79
80
 
# File 'lib/algolia/api/search_client.rb', line 77

def add_api_key(api_key, request_options = {})
  response = add_api_key_with_http_info(api_key, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::AddApiKeyResponse")
end

#add_api_key_with_http_info(api_key, request_options = {}) ⇒ Http::Response

Creates a new API key with specific permissions and restrictions.

Required API Key ACLs:

- admin

Parameters:

  • api_key (ApiKey) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/algolia/api/search_client.rb', line 45

def add_api_key_with_http_info(api_key, request_options = {})
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    raise ArgumentError, "Parameter `api_key` is required when calling `add_api_key`."
  end

  path = "/1/keys"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(api_key)

  new_options = request_options.merge(
    :operation => :"SearchClient.add_api_key",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#add_or_update_object(index_name, object_id, body, request_options = {}) ⇒ UpdatedAtWithObjectIdResponse

If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update some attributes of an existing record, use the [‘partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

Required API Key ACLs:

- addObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique record identifier. (required)

  • body (Object) —

    The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtWithObjectIdResponse) 


136
137
138
139
140
141
142
 
# File 'lib/algolia/api/search_client.rb', line 136

def add_or_update_object(index_name, object_id, body, request_options = {})
  response = add_or_update_object_with_http_info(index_name, object_id, body, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Search::UpdatedAtWithObjectIdResponse"
  )
end

#add_or_update_object_with_http_info(index_name, object_id, body, request_options = {}) ⇒ Http::Response

If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update some attributes of an existing record, use the [&#x60;partial&#x60; operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [&#x60;batch&#x60; operation](#tag/Records/operation/batch).

Required API Key ACLs:

- addObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique record identifier. (required)

  • body (Object) —

    The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



91
92
93
94
95
96
97
98
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
 
# File 'lib/algolia/api/search_client.rb', line 91

def add_or_update_object_with_http_info(index_name, object_id, body, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `add_or_update_object`."
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    raise ArgumentError, "Parameter `object_id` is required when calling `add_or_update_object`."
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    raise ArgumentError, "Parameter `body` is required when calling `add_or_update_object`."
  end

  path = "/1/indexes/{indexName}/{objectID}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s)).sub(
    "{" + "objectID" + "}",
    Transport.encode_uri(object_id.to_s)
  )
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)

  new_options = request_options.merge(
    :operation => :"SearchClient.add_or_update_object",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#append_source(source, request_options = {}) ⇒ CreatedAtResponse

Adds a source to the list of allowed sources.

Required API Key ACLs:

- admin

Parameters:

  • source (Source) —

    Source to add. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (CreatedAtResponse) 


183
184
185
186
 
# File 'lib/algolia/api/search_client.rb', line 183

def append_source(source, request_options = {})
  response = append_source_with_http_info(source, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::CreatedAtResponse")
end

#append_source_with_http_info(source, request_options = {}) ⇒ Http::Response

Adds a source to the list of allowed sources.

Required API Key ACLs:

- admin

Parameters:

  • source (Source) —

    Source to add. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/algolia/api/search_client.rb', line 151

def append_source_with_http_info(source, request_options = {})
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    raise ArgumentError, "Parameter `source` is required when calling `append_source`."
  end

  path = "/1/security/sources/append"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(source)

  new_options = request_options.merge(
    :operation => :"SearchClient.append_source",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#assign_user_id(x_algolia_user_id, assign_user_id_params, request_options = {}) ⇒ CreatedAtResponse

Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.

Required API Key ACLs:

- admin

Parameters:

  • x_algolia_user_id (String) —

    Unique identifier of the user who makes the search request. (required)

  • assign_user_id_params (AssignUserIdParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (CreatedAtResponse) 


243
244
245
246
 
# File 'lib/algolia/api/search_client.rb', line 243

def assign_user_id(x_algolia_user_id, assign_user_id_params, request_options = {})
  response = assign_user_id_with_http_info(x_algolia_user_id, assign_user_id_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::CreatedAtResponse")
end

#assign_user_id_with_http_info(x_algolia_user_id, assign_user_id_params, request_options = {}) ⇒ Http::Response

Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.

Required API Key ACLs:

- admin

Parameters:

  • x_algolia_user_id (String) —

    Unique identifier of the user who makes the search request. (required)

  • assign_user_id_params (AssignUserIdParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



196
197
198
199
200
201
202
203
204
205
206
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
 
# File 'lib/algolia/api/search_client.rb', line 196

def assign_user_id_with_http_info(x_algolia_user_id, assign_user_id_params, request_options = {})
  # verify the required parameter 'x_algolia_user_id' is set
  if @api_client.config.client_side_validation && x_algolia_user_id.nil?
    raise ArgumentError, "Parameter `x_algolia_user_id` is required when calling `assign_user_id`."
  end

  pattern = /^[a-zA-Z0-9 \-*.]+$/
  if @api_client.config.client_side_validation && x_algolia_user_id !~ pattern
    raise(
      ArgumentError,
      "invalid value for 'x_algolia_user_id' when calling SearchClient.assign_user_id, must conform to the pattern #{pattern}."
    )
  end

  # verify the required parameter 'assign_user_id_params' is set
  if @api_client.config.client_side_validation && assign_user_id_params.nil?
    raise ArgumentError, "Parameter `assign_user_id_params` is required when calling `assign_user_id`."
  end

  path = "/1/clusters/mapping"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params[:"X-Algolia-User-ID"] = x_algolia_user_id
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(assign_user_id_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.assign_user_id",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#batch(index_name, batch_write_params, request_options = {}) ⇒ BatchResponse

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • batch_write_params (BatchWriteParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (BatchResponse) 


289
290
291
292
 
# File 'lib/algolia/api/search_client.rb', line 289

def batch(index_name, batch_write_params, request_options = {})
  response = batch_with_http_info(index_name, batch_write_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::BatchResponse")
end

#batch_assign_user_ids(x_algolia_user_id, batch_assign_user_ids_params, request_options = {}) ⇒ CreatedAtResponse

Assigns multiple user IDs to a cluster. **You can’t move users with this operation**.

Required API Key ACLs:

- admin

Parameters:

  • x_algolia_user_id (String) —

    Unique identifier of the user who makes the search request. (required)

  • batch_assign_user_ids_params (BatchAssignUserIdsParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (CreatedAtResponse) 


352
353
354
355
 
# File 'lib/algolia/api/search_client.rb', line 352

def batch_assign_user_ids(x_algolia_user_id, batch_assign_user_ids_params, request_options = {})
  response = batch_assign_user_ids_with_http_info(x_algolia_user_id, batch_assign_user_ids_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::CreatedAtResponse")
end

#batch_assign_user_ids_with_http_info(x_algolia_user_id, batch_assign_user_ids_params, request_options = {}) ⇒ Http::Response

Assigns multiple user IDs to a cluster. **You can&#39;t move users with this operation**.

Required API Key ACLs:

- admin

Parameters:

  • x_algolia_user_id (String) —

    Unique identifier of the user who makes the search request. (required)

  • batch_assign_user_ids_params (BatchAssignUserIdsParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



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
 
# File 'lib/algolia/api/search_client.rb', line 302

def batch_assign_user_ids_with_http_info(x_algolia_user_id, batch_assign_user_ids_params, request_options = {})
  # verify the required parameter 'x_algolia_user_id' is set
  if @api_client.config.client_side_validation && x_algolia_user_id.nil?
    raise ArgumentError, "Parameter `x_algolia_user_id` is required when calling `batch_assign_user_ids`."
  end

  pattern = /^[a-zA-Z0-9 \-*.]+$/
  if @api_client.config.client_side_validation && x_algolia_user_id !~ pattern
    raise(
      ArgumentError,
      "invalid value for 'x_algolia_user_id' when calling SearchClient.batch_assign_user_ids, must conform to the pattern #{pattern}."
    )
  end

  # verify the required parameter 'batch_assign_user_ids_params' is set
  if @api_client.config.client_side_validation && batch_assign_user_ids_params.nil?
    raise(
      ArgumentError,
      "Parameter `batch_assign_user_ids_params` is required when calling `batch_assign_user_ids`."
    )
  end

  path = "/1/clusters/mapping/batch"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params[:"X-Algolia-User-ID"] = x_algolia_user_id
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(batch_assign_user_ids_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.batch_assign_user_ids",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#batch_dictionary_entries(dictionary_name, batch_dictionary_entries_params, request_options = {}) ⇒ UpdatedAtResponse

Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.

Required API Key ACLs:

- editSettings

Parameters:

  • dictionary_name (DictionaryType) —

    Dictionary type in which to search. (required)

  • batch_dictionary_entries_params (BatchDictionaryEntriesParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtResponse) 


408
409
410
411
412
413
414
415
 
# File 'lib/algolia/api/search_client.rb', line 408

def batch_dictionary_entries(dictionary_name, batch_dictionary_entries_params, request_options = {})
  response = batch_dictionary_entries_with_http_info(
    dictionary_name,
    batch_dictionary_entries_params,
    request_options
  )
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
end

#batch_dictionary_entries_with_http_info(dictionary_name, batch_dictionary_entries_params, request_options = {}) ⇒ Http::Response

Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.

Required API Key ACLs:

- editSettings

Parameters:

  • dictionary_name (DictionaryType) —

    Dictionary type in which to search. (required)

  • batch_dictionary_entries_params (BatchDictionaryEntriesParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



365
366
367
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
 
# File 'lib/algolia/api/search_client.rb', line 365

def batch_dictionary_entries_with_http_info(dictionary_name, batch_dictionary_entries_params, request_options = {})
  # verify the required parameter 'dictionary_name' is set
  if @api_client.config.client_side_validation && dictionary_name.nil?
    raise ArgumentError, "Parameter `dictionary_name` is required when calling `batch_dictionary_entries`."
  end
  # verify the required parameter 'batch_dictionary_entries_params' is set
  if @api_client.config.client_side_validation && batch_dictionary_entries_params.nil?
    raise(
      ArgumentError,
      "Parameter `batch_dictionary_entries_params` is required when calling `batch_dictionary_entries`."
    )
  end

  path = "/1/dictionaries/{dictionaryName}/batch".sub(
    "{" + "dictionaryName" + "}",
    Transport.encode_uri(dictionary_name.to_s)
  )
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(batch_dictionary_entries_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.batch_dictionary_entries",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#batch_with_http_info(index_name, batch_write_params, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • batch_write_params (BatchWriteParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



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
 
# File 'lib/algolia/api/search_client.rb', line 254

def batch_with_http_info(index_name, batch_write_params, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `batch`."
  end
  # verify the required parameter 'batch_write_params' is set
  if @api_client.config.client_side_validation && batch_write_params.nil?
    raise ArgumentError, "Parameter `batch_write_params` is required when calling `batch`."
  end

  path = "/1/indexes/{indexName}/batch".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(batch_write_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.batch",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#browse(index_name, browse_params = nil, request_options = {}) ⇒ BrowseResponse

Retrieves records from an index, up to 1,000 per request. While searching retrieves hits (records augmented with attributes for highlighting and ranking details), browsing just returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn’t collect data when using ‘browse`. - Records are ranked by attributes and custom ranking. - There’s no ranking for: typo-tolerance, number of matched words, proximity, geo distance. Browse requests automatically apply these settings: - ‘advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`) If you send these parameters with your browse requests, they’ll be ignored.

Required API Key ACLs:

- browse

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • browse_params (BrowseParams) (defaults to: nil)
  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (BrowseResponse) 


458
459
460
461
 
# File 'lib/algolia/api/search_client.rb', line 458

def browse(index_name, browse_params = nil, request_options = {})
  response = browse_with_http_info(index_name, browse_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::BrowseResponse")
end

#browse_objects(index_name, browse_params = Search::BrowseParamsObject.new, request_options = {}, &block) ⇒ Object

Helper: Iterate on the ‘browse` method of the client to allow aggregating objects of an index.

Parameters:

  • index_name (String) —

    the ‘index_name` to browse. (required)

  • browse_params (BrowseParamsObject) (defaults to: Search::BrowseParamsObject.new) —

    the ‘browse_params` to send along with the query, they will be forwarded to the `browse` method.

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

    the requestOptions to send along with the query, they will be forwarded to the ‘browse` method.

  • block (Proc) —

    the block to execute on each object of the index.



3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
 
# File 'lib/algolia/api/search_client.rb', line 3242

def browse_objects(index_name, browse_params = Search::BrowseParamsObject.new, request_options = {}, &block)
  hits = []
  loop do
    res = browse(index_name, browse_params, request_options)
    if block_given?
      res.hits.each do |hit|
        block.call(hit)
      end
    else
      hits.concat(res.hits)
    end

    browse_params.cursor = res.cursor
    break if browse_params.cursor.nil?
  end

  hits unless block_given?
end

#browse_rules(index_name, search_rules_params = Search::SearchRulesParams.new(hits_per_page: 1000, page: 0), request_options = {}, &block) ⇒ Object

Helper: Iterate on the ‘searchRules` method of the client to allow aggregating rules of an index.

Parameters:

  • index_name (String) —

    the ‘index_name` to browse rules from. (required)

  • search_rules_params (SearchRulesParams) (defaults to: Search::SearchRulesParams.new(hits_per_page: 1000, page: 0)) —

    the parameters to send along with the query, they will be forwarded to the ‘searchRules` method.

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

    the requestOptions to send along with the query, they will be forwarded to the ‘searchRules` method.

  • block (Proc) —

    the block to execute on each rule of the index.



3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
 
# File 'lib/algolia/api/search_client.rb', line 3267

def browse_rules(
  index_name,
  search_rules_params = Search::SearchRulesParams.new(hits_per_page: 1000, page: 0),
  request_options = {},
  &block
)
  rules = []
  loop do
    res = search_rules(index_name, search_rules_params, request_options)
    if block_given?
      res.hits.each do |rule|
        block.call(rule)
      end
    else
      rules.concat(res.hits)
    end

    search_rules_params.page += 1
    break if res.nb_hits < search_rules_params.hits_per_page
  end

  rules unless block_given?
end

#browse_synonyms(index_name, search_synonyms_params = Search::SearchSynonymsParams.new(hits_per_page: 1000, page: 0), request_options = {}, &block) ⇒ Object

Helper: Iterate on the ‘searchSynonyms` method of the client to allow aggregating synonyms of an index.

Parameters:

  • index_name (String) —

    the ‘index_name` to browse synonyms from. (required)

  • search_synonyms_params (SearchSynonymsParams) (defaults to: Search::SearchSynonymsParams.new(hits_per_page: 1000, page: 0)) —

    the parameters to send along with the query, they will be forwarded to the ‘searchSynonyms` method.

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

    the requestOptions to send along with the query, they will be forwarded to the ‘searchSynonyms` method.

  • block (Proc) —

    the block to execute on each synonym of the index.



3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
 
# File 'lib/algolia/api/search_client.rb', line 3297

def browse_synonyms(
  index_name,
  search_synonyms_params = Search::SearchSynonymsParams.new(hits_per_page: 1000, page: 0),
  request_options = {},
  &block
)
  synonyms = []
  loop do
    res = search_synonyms(index_name, search_synonyms_params, request_options)
    if block_given?
      res.hits.each do |synonym|
        block.call(synonym)
      end
    else
      synonyms.concat(res.hits)
    end

    search_synonyms_params.page += 1
    break if res.nb_hits < search_synonyms_params.hits_per_page
  end

  synonyms unless block_given?
end

#browse_with_http_info(index_name, browse_params = nil, request_options = {}) ⇒ Http::Response

Retrieves records from an index, up to 1,000 per request. While searching retrieves hits (records augmented with attributes for highlighting and ranking details), browsing just returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn&#39;t collect data when using &#x60;browse&#x60;. - Records are ranked by attributes and custom ranking. - There&#39;s no ranking for: typo-tolerance, number of matched words, proximity, geo distance. Browse requests automatically apply these settings: - &#x60;advancedSyntax&#x60;: &#x60;false&#x60; - &#x60;attributesToHighlight&#x60;: &#x60;[]&#x60; - &#x60;attributesToSnippet&#x60;: &#x60;[]&#x60; - &#x60;distinct&#x60;: &#x60;false&#x60; - &#x60;enablePersonalization&#x60;: &#x60;false&#x60; - &#x60;enableRules&#x60;: &#x60;false&#x60; - &#x60;facets&#x60;: &#x60;[]&#x60; - &#x60;getRankingInfo&#x60;: &#x60;false&#x60; - &#x60;ignorePlurals&#x60;: &#x60;false&#x60; - &#x60;optionalFilters&#x60;: &#x60;[]&#x60; - &#x60;typoTolerance&#x60;: &#x60;true&#x60; or &#x60;false&#x60; (&#x60;min&#x60; and &#x60;strict&#x60; is evaluated to &#x60;true&#x60;) If you send these parameters with your browse requests, they&#39;ll be ignored.

Required API Key ACLs:

- browse

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • browse_params (BrowseParams) (defaults to: nil)
  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/algolia/api/search_client.rb', line 425

def browse_with_http_info(index_name, browse_params = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `browse`."
  end

  path = "/1/indexes/{indexName}/browse".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(browse_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.browse",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#chunked_batch(index_name, objects, action = Action::ADD_OBJECT, wait_for_tasks = false, batch_size = 1000, request_options = {}) ⇒ Array<BatchResponse>

Helper: Chunks the given ‘objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.

Parameters:

  • index_name (String) —

    the ‘index_name` where the operation will be performed.

  • objects (Array) —

    The array of ‘objects` to store in the given Algolia `index_name`.

  • action (Action) (defaults to: Action::ADD_OBJECT) —

    The ‘batch` `action` to perform on the given array of `objects`, defaults to `addObject`.

  • wait_for_tasks (Boolean) (defaults to: false) —

    Whether or not we should wait until every ‘batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.

  • batch_size (int) (defaults to: 1000) —

    The size of the chunk of ‘objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Array<BatchResponse>) 


3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
 
# File 'lib/algolia/api/search_client.rb', line 3440

def chunked_batch(
  index_name,
  objects,
  action = Action::ADD_OBJECT,
  wait_for_tasks = false,
  batch_size = 1000,
  request_options = {}
)
  responses = []
  objects.each_slice(batch_size) do |chunk|
    requests = chunk.map do |object|
      Search::BatchRequest.new(action: action, body: object)
    end

    responses.append(batch(index_name, Search::BatchWriteParams.new(requests: requests), request_options))
  end

  if wait_for_tasks
    responses.each do |response|
      wait_for_task(index_name, response.task_id)
    end
  end

  responses
end

#clear_objects(index_name, request_options = {}) ⇒ UpdatedAtResponse

Deletes only the records from an index while keeping settings, synonyms, and rules.

Required API Key ACLs:

- deleteIndex

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtResponse) 


502
503
504
505
 
# File 'lib/algolia/api/search_client.rb', line 502

def clear_objects(index_name, request_options = {})
  response = clear_objects_with_http_info(index_name, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
end

#clear_objects_with_http_info(index_name, request_options = {}) ⇒ Http::Response

Deletes only the records from an index while keeping settings, synonyms, and rules.

Required API Key ACLs:

- deleteIndex

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/algolia/api/search_client.rb', line 470

def clear_objects_with_http_info(index_name, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `clear_objects`."
  end

  path = "/1/indexes/{indexName}/clear".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.clear_objects",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#clear_rules(index_name, forward_to_replicas = nil, request_options = {}) ⇒ UpdatedAtResponse

Deletes all rules from the index.

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtResponse) 


549
550
551
552
 
# File 'lib/algolia/api/search_client.rb', line 549

def clear_rules(index_name, forward_to_replicas = nil, request_options = {})
  response = clear_rules_with_http_info(index_name, forward_to_replicas, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
end

#clear_rules_with_http_info(index_name, forward_to_replicas = nil, request_options = {}) ⇒ Http::Response

Deletes all rules from the index.

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/algolia/api/search_client.rb', line 515

def clear_rules_with_http_info(index_name, forward_to_replicas = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `clear_rules`."
  end

  path = "/1/indexes/{indexName}/rules/clear".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.clear_rules",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#clear_synonyms(index_name, forward_to_replicas = nil, request_options = {}) ⇒ UpdatedAtResponse

Deletes all synonyms from the index.

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtResponse) 


596
597
598
599
 
# File 'lib/algolia/api/search_client.rb', line 596

def clear_synonyms(index_name, forward_to_replicas = nil, request_options = {})
  response = clear_synonyms_with_http_info(index_name, forward_to_replicas, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
end

#clear_synonyms_with_http_info(index_name, forward_to_replicas = nil, request_options = {}) ⇒ Http::Response

Deletes all synonyms from the index.

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/algolia/api/search_client.rb', line 562

def clear_synonyms_with_http_info(index_name, forward_to_replicas = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `clear_synonyms`."
  end

  path = "/1/indexes/{indexName}/synonyms/clear".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.clear_synonyms",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#custom_delete(path, parameters = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


639
640
641
642
 
# File 'lib/algolia/api/search_client.rb', line 639

def custom_delete(path, parameters = nil, request_options = {})
  response = custom_delete_with_http_info(path, parameters, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_delete_with_http_info(path, parameters = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/algolia/api/search_client.rb', line 607

def custom_delete_with_http_info(path, parameters = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.custom_delete",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#custom_get(path, parameters = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


682
683
684
685
 
# File 'lib/algolia/api/search_client.rb', line 682

def custom_get(path, parameters = nil, request_options = {})
  response = custom_get_with_http_info(path, parameters, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_get_with_http_info(path, parameters = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/algolia/api/search_client.rb', line 650

def custom_get_with_http_info(path, parameters = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.custom_get",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#custom_post(path, parameters = nil, body = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


727
728
729
730
 
# File 'lib/algolia/api/search_client.rb', line 727

def custom_post(path, parameters = nil, body = nil, request_options = {})
  response = custom_post_with_http_info(path, parameters, body, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/algolia/api/search_client.rb', line 694

def custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)

  new_options = request_options.merge(
    :operation => :"SearchClient.custom_post",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#custom_put(path, parameters = nil, body = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


772
773
774
775
 
# File 'lib/algolia/api/search_client.rb', line 772

def custom_put(path, parameters = nil, body = nil, request_options = {})
  response = custom_put_with_http_info(path, parameters, body, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 
# File 'lib/algolia/api/search_client.rb', line 739

def custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)

  new_options = request_options.merge(
    :operation => :"SearchClient.custom_put",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#delete_api_key(key, request_options = {}) ⇒ DeleteApiKeyResponse

Deletes the API key.

Required API Key ACLs:

- admin

Parameters:

  • key (String) —

    API key. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DeleteApiKeyResponse) 


816
817
818
819
 
# File 'lib/algolia/api/search_client.rb', line 816

def delete_api_key(key, request_options = {})
  response = delete_api_key_with_http_info(key, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeleteApiKeyResponse")
end

#delete_api_key_with_http_info(key, request_options = {}) ⇒ Http::Response

Deletes the API key.

Required API Key ACLs:

- admin

Parameters:

  • key (String) —

    API key. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/algolia/api/search_client.rb', line 784

def delete_api_key_with_http_info(key, request_options = {})
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    raise ArgumentError, "Parameter `key` is required when calling `delete_api_key`."
  end

  path = "/1/keys/{key}".sub("{" + "key" + "}", Transport.encode_uri(key.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.delete_api_key",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#delete_by(index_name, delete_by_params, request_options = {}) ⇒ DeletedAtResponse

This operation doesn’t accept empty queries or filters. It’s more efficient to get a list of object IDs with the [‘browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).

Required API Key ACLs:

- deleteIndex

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • delete_by_params (DeleteByParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DeletedAtResponse) 


866
867
868
869
 
# File 'lib/algolia/api/search_client.rb', line 866

def delete_by(index_name, delete_by_params, request_options = {})
  response = delete_by_with_http_info(index_name, delete_by_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse")
end

#delete_by_with_http_info(index_name, delete_by_params, request_options = {}) ⇒ Http::Response

This operation doesn&#39;t accept empty queries or filters. It&#39;s more efficient to get a list of object IDs with the [&#x60;browse&#x60; operation](#tag/Search/operation/browse), and then delete the records using the [&#x60;batch&#x60; operation](tag/Records/operation/batch).

Required API Key ACLs:

- deleteIndex

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • delete_by_params (DeleteByParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/algolia/api/search_client.rb', line 829

def delete_by_with_http_info(index_name, delete_by_params, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `delete_by`."
  end
  # verify the required parameter 'delete_by_params' is set
  if @api_client.config.client_side_validation && delete_by_params.nil?
    raise ArgumentError, "Parameter `delete_by_params` is required when calling `delete_by`."
  end

  path = "/1/indexes/{indexName}/deleteByQuery".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(delete_by_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.delete_by",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#delete_index(index_name, request_options = {}) ⇒ DeletedAtResponse

Deletes an index and all its settings. - Deleting an index doesn’t delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).

Required API Key ACLs:

- deleteIndex

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DeletedAtResponse) 


910
911
912
913
 
# File 'lib/algolia/api/search_client.rb', line 910

def delete_index(index_name, request_options = {})
  response = delete_index_with_http_info(index_name, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse")
end

#delete_index_with_http_info(index_name, request_options = {}) ⇒ Http::Response

Deletes an index and all its settings. - Deleting an index doesn&#39;t delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).

Required API Key ACLs:

- deleteIndex

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
 
# File 'lib/algolia/api/search_client.rb', line 878

def delete_index_with_http_info(index_name, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `delete_index`."
  end

  path = "/1/indexes/{indexName}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.delete_index",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#delete_object(index_name, object_id, request_options = {}) ⇒ DeletedAtResponse

Deletes a record by its object ID. To delete more than one record, use the [‘batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).

Required API Key ACLs:

- deleteObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique record identifier. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DeletedAtResponse) 


963
964
965
966
 
# File 'lib/algolia/api/search_client.rb', line 963

def delete_object(index_name, object_id, request_options = {})
  response = delete_object_with_http_info(index_name, object_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse")
end

#delete_object_with_http_info(index_name, object_id, request_options = {}) ⇒ Http::Response

Deletes a record by its object ID. To delete more than one record, use the [&#x60;batch&#x60; operation](#tag/Records/operation/batch). To delete records matching a query, use the [&#x60;deleteByQuery&#x60; operation](#tag/Records/operation/deleteBy).

Required API Key ACLs:

- deleteObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique record identifier. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
 
# File 'lib/algolia/api/search_client.rb', line 923

def delete_object_with_http_info(index_name, object_id, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `delete_object`."
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    raise ArgumentError, "Parameter `object_id` is required when calling `delete_object`."
  end

  path = "/1/indexes/{indexName}/{objectID}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s)).sub(
    "{" + "objectID" + "}",
    Transport.encode_uri(object_id.to_s)
  )
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.delete_object",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#delete_objects(index_name, object_ids, request_options = {}) ⇒ BatchResponse

Helper: Deletes every records for the given objectIDs. The ‘chunked_batch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.

Parameters:

  • index_name (String) —

    : The ‘index_name` to delete `object_ids` from.

  • object_ids (Array) —

    : The object_ids to delete.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (BatchResponse) 


3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
 
# File 'lib/algolia/api/search_client.rb', line 3398

def delete_objects(index_name, object_ids, request_options = {})
  chunked_batch(
    index_name,
    object_ids.map { |id| {"objectID" => id} },
    Search::Action::DELETE_OBJECT,
    false,
    1000,
    request_options
  )
end

#delete_rule(index_name, object_id, forward_to_replicas = nil, request_options = {}) ⇒ UpdatedAtResponse

Deletes a rule by its ID. To find the object ID for rules, use the [‘search` operation](#tag/Rules/operation/searchRules).

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a rule object. (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtResponse) 


1018
1019
1020
1021
 
# File 'lib/algolia/api/search_client.rb', line 1018

def delete_rule(index_name, object_id, forward_to_replicas = nil, request_options = {})
  response = delete_rule_with_http_info(index_name, object_id, forward_to_replicas, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
end

#delete_rule_with_http_info(index_name, object_id, forward_to_replicas = nil, request_options = {}) ⇒ Http::Response

Deletes a rule by its ID. To find the object ID for rules, use the [&#x60;search&#x60; operation](#tag/Rules/operation/searchRules).

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a rule object. (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/algolia/api/search_client.rb', line 977

def delete_rule_with_http_info(index_name, object_id, forward_to_replicas = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `delete_rule`."
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    raise ArgumentError, "Parameter `object_id` is required when calling `delete_rule`."
  end

  path = "/1/indexes/{indexName}/rules/{objectID}"
    .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
    .sub("{" + "objectID" + "}", Transport.encode_uri(object_id.to_s))
  query_params = {}
  query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.delete_rule",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#delete_source(source, request_options = {}) ⇒ DeleteSourceResponse

Deletes a source from the list of allowed sources.

Required API Key ACLs:

- admin

Parameters:

  • source (String) —

    IP address range of the source. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DeleteSourceResponse) 


1062
1063
1064
1065
 
# File 'lib/algolia/api/search_client.rb', line 1062

def delete_source(source, request_options = {})
  response = delete_source_with_http_info(source, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeleteSourceResponse")
end

#delete_source_with_http_info(source, request_options = {}) ⇒ Http::Response

Deletes a source from the list of allowed sources.

Required API Key ACLs:

- admin

Parameters:

  • source (String) —

    IP address range of the source. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 
# File 'lib/algolia/api/search_client.rb', line 1030

def delete_source_with_http_info(source, request_options = {})
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    raise ArgumentError, "Parameter `source` is required when calling `delete_source`."
  end

  path = "/1/security/sources/{source}".sub("{" + "source" + "}", Transport.encode_uri(source.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.delete_source",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#delete_synonym(index_name, object_id, forward_to_replicas = nil, request_options = {}) ⇒ DeletedAtResponse

Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [‘search` operation](#tag/Synonyms/operation/searchSynonyms).

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a synonym object. (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DeletedAtResponse) 


1117
1118
1119
1120
 
# File 'lib/algolia/api/search_client.rb', line 1117

def delete_synonym(index_name, object_id, forward_to_replicas = nil, request_options = {})
  response = delete_synonym_with_http_info(index_name, object_id, forward_to_replicas, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse")
end

#delete_synonym_with_http_info(index_name, object_id, forward_to_replicas = nil, request_options = {}) ⇒ Http::Response

Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [&#x60;search&#x60; operation](#tag/Synonyms/operation/searchSynonyms).

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a synonym object. (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'lib/algolia/api/search_client.rb', line 1076

def delete_synonym_with_http_info(index_name, object_id, forward_to_replicas = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `delete_synonym`."
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    raise ArgumentError, "Parameter `object_id` is required when calling `delete_synonym`."
  end

  path = "/1/indexes/{indexName}/synonyms/{objectID}"
    .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
    .sub("{" + "objectID" + "}", Transport.encode_uri(object_id.to_s))
  query_params = {}
  query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.delete_synonym",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#generate_secured_api_key(parent_api_key, restrictions = {}) ⇒ String

Helper: Generates a secured API key based on the given ‘parent_api_key` and given `restrictions`.

Parameters:

  • parent_api_key (String) —

    Parent API key used the generate the secured key

  • restrictions (SecuredApiKeyRestrictions) (defaults to: {}) —

    Restrictions to apply on the secured key

Returns:

  • (String) 


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
 
# File 'lib/algolia/api/search_client.rb', line 3328

def generate_secured_api_key(parent_api_key, restrictions = {})
  restrictions = restrictions.to_hash
  if restrictions.key?(:searchParams)
    # merge searchParams with the root of the restrictions

    restrictions.merge!(restrictions[:searchParams])
    restrictions.delete(:searchParams)
  end

  url_encoded_restrictions = Algolia::Transport
    .stringify_query_params(restrictions)
    .sort
    .to_h
    .map do |key, value|
      "#{key}=#{value}"
    end
    .join("&")

  hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha256"), parent_api_key, url_encoded_restrictions)
  Base64.encode64("#{hmac}#{url_encoded_restrictions}").gsub("\n", "")
end

#get_api_key(key, request_options = {}) ⇒ GetApiKeyResponse

Parameters:

  • key (String) —

    API key. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetApiKeyResponse) 


1157
1158
1159
1160
 
# File 'lib/algolia/api/search_client.rb', line 1157

def get_api_key(key, request_options = {})
  response = get_api_key_with_http_info(key, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetApiKeyResponse")
end

#get_api_key_with_http_info(key, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • key (String) —

    API key. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/algolia/api/search_client.rb', line 1127

def get_api_key_with_http_info(key, request_options = {})
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    raise ArgumentError, "Parameter `key` is required when calling `get_api_key`."
  end

  path = "/1/keys/{key}".sub("{" + "key" + "}", Transport.encode_uri(key.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_api_key",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_app_task(task_id, request_options = {}) ⇒ GetTaskResponse

Checks the status of a given application task.

Required API Key ACLs:

- editSettings

Parameters:

  • task_id (Integer) —

    Unique task identifier. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetTaskResponse) 


1201
1202
1203
1204
 
# File 'lib/algolia/api/search_client.rb', line 1201

def get_app_task(task_id, request_options = {})
  response = get_app_task_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetTaskResponse")
end

#get_app_task_with_http_info(task_id, request_options = {}) ⇒ Http::Response

Checks the status of a given application task.

Required API Key ACLs:

- editSettings

Parameters:

  • task_id (Integer) —

    Unique task identifier. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
 
# File 'lib/algolia/api/search_client.rb', line 1169

def get_app_task_with_http_info(task_id, request_options = {})
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    raise ArgumentError, "Parameter `task_id` is required when calling `get_app_task`."
  end

  path = "/1/task/{taskID}".sub("{" + "taskID" + "}", Transport.encode_uri(task_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_app_task",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_dictionary_languages(request_options = {}) ⇒ Hash<String, Languages>

Lists supported languages with their supported dictionary types and number of custom entries.

Required API Key ACLs:

- settings

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Hash<String, Languages>) 


1238
1239
1240
1241
 
# File 'lib/algolia/api/search_client.rb', line 1238

def get_dictionary_languages(request_options = {})
  response = get_dictionary_languages_with_http_info(request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Hash<String, Languages>")
end

#get_dictionary_languages_with_http_info(request_options = {}) ⇒ Http::Response

Lists supported languages with their supported dictionary types and number of custom entries.

Required API Key ACLs:

- settings

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
 
# File 'lib/algolia/api/search_client.rb', line 1212

def get_dictionary_languages_with_http_info(request_options = {})
  path = "/1/dictionaries/*/languages"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_dictionary_languages",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_dictionary_settings(request_options = {}) ⇒ GetDictionarySettingsResponse

Retrieves the languages for which standard dictionary entries are turned off.

Required API Key ACLs:

- settings

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetDictionarySettingsResponse) 


1275
1276
1277
1278
1279
1280
1281
 
# File 'lib/algolia/api/search_client.rb', line 1275

def get_dictionary_settings(request_options = {})
  response = get_dictionary_settings_with_http_info(request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Search::GetDictionarySettingsResponse"
  )
end

#get_dictionary_settings_with_http_info(request_options = {}) ⇒ Http::Response

Retrieves the languages for which standard dictionary entries are turned off.

Required API Key ACLs:

- settings

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
 
# File 'lib/algolia/api/search_client.rb', line 1249

def get_dictionary_settings_with_http_info(request_options = {})
  path = "/1/dictionaries/*/settings"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_dictionary_settings",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_logs(offset = nil, length = nil, index_name = nil, type = nil, request_options = {}) ⇒ GetLogsResponse

The request must be authenticated by an API key with the [‘logs` ACL](www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn’t appear in the logs itself.

Required API Key ACLs:

- logs

Parameters:

  • offset (Integer) (defaults to: nil) —

    First log entry to retrieve. The most recent entries are listed first. (default to 0)

  • length (Integer) (defaults to: nil) —

    Maximum number of entries to retrieve. (default to 10)

  • index_name (String) (defaults to: nil) —

    Index for which to retrieve log entries. By default, log entries are retrieved for all indices.

  • type (LogType) (defaults to: nil) —

    Type of log entries to retrieve. By default, all log entries are retrieved. (default to ‘all’)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetLogsResponse) 


1334
1335
1336
1337
 
# File 'lib/algolia/api/search_client.rb', line 1334

def get_logs(offset = nil, length = nil, index_name = nil, type = nil, request_options = {})
  response = get_logs_with_http_info(offset, length, index_name, type, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetLogsResponse")
end

#get_logs_with_http_info(offset = nil, length = nil, index_name = nil, type = nil, request_options = {}) ⇒ Http::Response

The request must be authenticated by an API key with the [&#x60;logs&#x60; ACL](www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn&#39;t appear in the logs itself.

Required API Key ACLs:

- logs

Parameters:

  • offset (Integer) (defaults to: nil) —

    First log entry to retrieve. The most recent entries are listed first. (default to 0)

  • length (Integer) (defaults to: nil) —

    Maximum number of entries to retrieve. (default to 10)

  • index_name (String) (defaults to: nil) —

    Index for which to retrieve log entries. By default, log entries are retrieved for all indices.

  • type (LogType) (defaults to: nil) —

    Type of log entries to retrieve. By default, all log entries are retrieved. (default to ‘all’)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
 
# File 'lib/algolia/api/search_client.rb', line 1293

def get_logs_with_http_info(offset = nil, length = nil, index_name = nil, type = nil, request_options = {})
  if @api_client.config.client_side_validation && !length.nil? && length > 1000
    raise(
      ArgumentError,
      "invalid value for \"\"length\"\" when calling SearchClient.get_logs, must be smaller than or equal to 1000."
    )
  end

  path = "/1/logs"
  query_params = {}
  query_params[:offset] = offset unless offset.nil?
  query_params[:length] = length unless length.nil?
  query_params[:indexName] = index_name unless index_name.nil?
  query_params[:type] = type unless type.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_logs",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_object(index_name, object_id, attributes_to_retrieve = nil, request_options = {}) ⇒ Object

Retrieves one record by its object ID. To retrieve more than one record, use the [‘objects` operation](#tag/Records/operation/getObjects).

Required API Key ACLs:

- search

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique record identifier. (required)

  • attributes_to_retrieve (Array<String>) (defaults to: nil) —

    Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. &#x60;objectID&#x60; is always retrieved. Attributes included in &#x60;unretrievableAttributes&#x60; won&#39;t be retrieved unless the request is authenticated with the admin API key.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


1393
1394
1395
1396
 
# File 'lib/algolia/api/search_client.rb', line 1393

def get_object(index_name, object_id, attributes_to_retrieve = nil, request_options = {})
  response = get_object_with_http_info(index_name, object_id, attributes_to_retrieve, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Object")
end

#get_object_with_http_info(index_name, object_id, attributes_to_retrieve = nil, request_options = {}) ⇒ Http::Response

Retrieves one record by its object ID. To retrieve more than one record, use the [&#x60;objects&#x60; operation](#tag/Records/operation/getObjects).

Required API Key ACLs:

- search

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique record identifier. (required)

  • attributes_to_retrieve (Array<String>) (defaults to: nil) —

    Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. &#x60;objectID&#x60; is always retrieved. Attributes included in &#x60;unretrievableAttributes&#x60; won&#39;t be retrieved unless the request is authenticated with the admin API key.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'lib/algolia/api/search_client.rb', line 1348

def get_object_with_http_info(index_name, object_id, attributes_to_retrieve = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `get_object`."
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    raise ArgumentError, "Parameter `object_id` is required when calling `get_object`."
  end

  path = "/1/indexes/{indexName}/{objectID}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s)).sub(
    "{" + "objectID" + "}",
    Transport.encode_uri(object_id.to_s)
  )
  query_params = {}
  unless attributes_to_retrieve.nil?
    query_params[:attributesToRetrieve] = @api_client.build_collection_param(attributes_to_retrieve, :multi)
  end

  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_object",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_objects(get_objects_params, request_options = {}) ⇒ GetObjectsResponse

Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.

Required API Key ACLs:

- search

Parameters:

  • get_objects_params (GetObjectsParams) —

    Request object. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetObjectsResponse) 


1437
1438
1439
1440
 
# File 'lib/algolia/api/search_client.rb', line 1437

def get_objects(get_objects_params, request_options = {})
  response = get_objects_with_http_info(get_objects_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetObjectsResponse")
end

#get_objects_with_http_info(get_objects_params, request_options = {}) ⇒ Http::Response

Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.

Required API Key ACLs:

- search

Parameters:

  • get_objects_params (GetObjectsParams) —

    Request object. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/algolia/api/search_client.rb', line 1405

def get_objects_with_http_info(get_objects_params, request_options = {})
  # verify the required parameter 'get_objects_params' is set
  if @api_client.config.client_side_validation && get_objects_params.nil?
    raise ArgumentError, "Parameter `get_objects_params` is required when calling `get_objects`."
  end

  path = "/1/indexes/*/objects"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(get_objects_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.get_objects",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => true
  )

  @api_client.call_api(:POST, path, new_options)
end

#get_rule(index_name, object_id, request_options = {}) ⇒ Rule

Retrieves a rule by its ID. To find the object ID of rules, use the [‘search` operation](#tag/Rules/operation/searchRules).

Required API Key ACLs:

- settings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a rule object. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Rule) 


1489
1490
1491
1492
 
# File 'lib/algolia/api/search_client.rb', line 1489

def get_rule(index_name, object_id, request_options = {})
  response = get_rule_with_http_info(index_name, object_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Rule")
end

#get_rule_with_http_info(index_name, object_id, request_options = {}) ⇒ Http::Response

Retrieves a rule by its ID. To find the object ID of rules, use the [&#x60;search&#x60; operation](#tag/Rules/operation/searchRules).

Required API Key ACLs:

- settings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a rule object. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'lib/algolia/api/search_client.rb', line 1450

def get_rule_with_http_info(index_name, object_id, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `get_rule`."
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    raise ArgumentError, "Parameter `object_id` is required when calling `get_rule`."
  end

  path = "/1/indexes/{indexName}/rules/{objectID}"
    .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
    .sub("{" + "objectID" + "}", Transport.encode_uri(object_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_rule",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_secured_api_key_remaining_validity(secured_api_key) ⇒ Integer

Helper: Retrieves the remaining validity of the previous generated ‘secured_api_key`, the `validUntil` parameter must have been provided.

Parameters:

  • secured_api_key (String)

Returns:

  • (Integer) 


3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
 
# File 'lib/algolia/api/search_client.rb', line 3356

def get_secured_api_key_remaining_validity(secured_api_key)
  now = Time.now.to_i
  decoded_key = Base64.decode64(secured_api_key)
  regex = "validUntil=(\\d+)"
  matches = decoded_key.match(regex)

  if matches.nil?
    raise AlgoliaError, "The SecuredApiKey doesn't have a validUntil parameter."
  end

  valid_until = matches[1].to_i

  valid_until - now
end

#get_settings(index_name, request_options = {}) ⇒ SettingsResponse

Retrieves an object with non-null index settings.

Required API Key ACLs:

- search

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SettingsResponse) 


1533
1534
1535
1536
 
# File 'lib/algolia/api/search_client.rb', line 1533

def get_settings(index_name, request_options = {})
  response = get_settings_with_http_info(index_name, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SettingsResponse")
end

#get_settings_with_http_info(index_name, request_options = {}) ⇒ Http::Response

Retrieves an object with non-null index settings.

Required API Key ACLs:

- search

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/algolia/api/search_client.rb', line 1501

def get_settings_with_http_info(index_name, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `get_settings`."
  end

  path = "/1/indexes/{indexName}/settings".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_settings",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_sources(request_options = {}) ⇒ Array<Source>

Retrieves all allowed IP addresses with access to your application.

Required API Key ACLs:

- admin

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Array<Source>) 


1570
1571
1572
1573
 
# File 'lib/algolia/api/search_client.rb', line 1570

def get_sources(request_options = {})
  response = get_sources_with_http_info(request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Array<Search::Source>")
end

#get_sources_with_http_info(request_options = {}) ⇒ Http::Response

Retrieves all allowed IP addresses with access to your application.

Required API Key ACLs:

- admin

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
 
# File 'lib/algolia/api/search_client.rb', line 1544

def get_sources_with_http_info(request_options = {})
  path = "/1/security/sources"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_sources",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_synonym(index_name, object_id, request_options = {}) ⇒ SynonymHit

Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [‘search` operation](#tag/Synonyms/operation/searchSynonyms).

Required API Key ACLs:

- settings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a synonym object. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SynonymHit) 


1622
1623
1624
1625
 
# File 'lib/algolia/api/search_client.rb', line 1622

def get_synonym(index_name, object_id, request_options = {})
  response = get_synonym_with_http_info(index_name, object_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SynonymHit")
end

#get_synonym_with_http_info(index_name, object_id, request_options = {}) ⇒ Http::Response

Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [&#x60;search&#x60; operation](#tag/Synonyms/operation/searchSynonyms).

Required API Key ACLs:

- settings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a synonym object. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
 
# File 'lib/algolia/api/search_client.rb', line 1583

def get_synonym_with_http_info(index_name, object_id, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `get_synonym`."
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    raise ArgumentError, "Parameter `object_id` is required when calling `get_synonym`."
  end

  path = "/1/indexes/{indexName}/synonyms/{objectID}"
    .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
    .sub("{" + "objectID" + "}", Transport.encode_uri(object_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_synonym",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_task(index_name, task_id, request_options = {}) ⇒ GetTaskResponse

Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks’ responses include a task ID that you can use to check the status.

Required API Key ACLs:

- addObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • task_id (Integer) —

    Unique task identifier. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetTaskResponse) 


1674
1675
1676
1677
 
# File 'lib/algolia/api/search_client.rb', line 1674

def get_task(index_name, task_id, request_options = {})
  response = get_task_with_http_info(index_name, task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetTaskResponse")
end

#get_task_with_http_info(index_name, task_id, request_options = {}) ⇒ Http::Response

Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks&#39; responses include a task ID that you can use to check the status.

Required API Key ACLs:

- addObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • task_id (Integer) —

    Unique task identifier. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
 
# File 'lib/algolia/api/search_client.rb', line 1635

def get_task_with_http_info(index_name, task_id, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `get_task`."
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    raise ArgumentError, "Parameter `task_id` is required when calling `get_task`."
  end

  path = "/1/indexes/{indexName}/task/{taskID}"
    .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
    .sub("{" + "taskID" + "}", Transport.encode_uri(task_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_task",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_user_ids(request_options = {}) ⇒ GetTopUserIdsResponse

Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clusters, the response isn’t real-time.

Required API Key ACLs:

- admin

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetTopUserIdsResponse) 


1711
1712
1713
1714
 
# File 'lib/algolia/api/search_client.rb', line 1711

def get_top_user_ids(request_options = {})
  response = get_top_user_ids_with_http_info(request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetTopUserIdsResponse")
end

#get_top_user_ids_with_http_info(request_options = {}) ⇒ Http::Response

Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clusters, the response isn&#39;t real-time.

Required API Key ACLs:

- admin

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
 
# File 'lib/algolia/api/search_client.rb', line 1685

def get_top_user_ids_with_http_info(request_options = {})
  path = "/1/clusters/mapping/top"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_top_user_ids",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_user_id(user_id, request_options = {}) ⇒ UserId

Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn’t real-time.

Required API Key ACLs:

- admin

Parameters:

  • user_id (String) —

    Unique identifier of the user who makes the search request. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UserId) 


1763
1764
1765
1766
 
# File 'lib/algolia/api/search_client.rb', line 1763

def get_user_id(user_id, request_options = {})
  response = get_user_id_with_http_info(user_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UserId")
end

#get_user_id_with_http_info(user_id, request_options = {}) ⇒ Http::Response

Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn&#39;t real-time.

Required API Key ACLs:

- admin

Parameters:

  • user_id (String) —

    Unique identifier of the user who makes the search request. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'lib/algolia/api/search_client.rb', line 1723

def get_user_id_with_http_info(user_id, request_options = {})
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    raise ArgumentError, "Parameter `user_id` is required when calling `get_user_id`."
  end

  pattern = /^[a-zA-Z0-9 \-*.]+$/
  if @api_client.config.client_side_validation && user_id !~ pattern
    raise(
      ArgumentError,
      "invalid value for 'user_id' when calling SearchClient.get_user_id, must conform to the pattern #{pattern}."
    )
  end

  path = "/1/clusters/mapping/{userID}".sub("{" + "userID" + "}", Transport.encode_uri(user_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.get_user_id",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#has_pending_mappings(get_clusters = nil, request_options = {}) ⇒ HasPendingMappingsResponse

To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.

Required API Key ACLs:

- admin

Parameters:

  • get_clusters (Boolean) (defaults to: nil) —

    Whether to include the cluster&#39;s pending mapping state in the response.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (HasPendingMappingsResponse) 


1803
1804
1805
1806
1807
1808
1809
 
# File 'lib/algolia/api/search_client.rb', line 1803

def has_pending_mappings(get_clusters = nil, request_options = {})
  response = has_pending_mappings_with_http_info(get_clusters, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Search::HasPendingMappingsResponse"
  )
end

#has_pending_mappings_with_http_info(get_clusters = nil, request_options = {}) ⇒ Http::Response

To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.

Required API Key ACLs:

- admin

Parameters:

  • get_clusters (Boolean) (defaults to: nil) —

    Whether to include the cluster&#39;s pending mapping state in the response.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
 
# File 'lib/algolia/api/search_client.rb', line 1775

def has_pending_mappings_with_http_info(get_clusters = nil, request_options = {})
  path = "/1/clusters/mapping/pending"
  query_params = {}
  query_params[:getClusters] = get_clusters unless get_clusters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.has_pending_mappings",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#list_api_keys(request_options = {}) ⇒ ListApiKeysResponse

Lists all API keys associated with your Algolia application, including their permissions and restrictions.

Required API Key ACLs:

- admin

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (ListApiKeysResponse) 


1843
1844
1845
1846
 
# File 'lib/algolia/api/search_client.rb', line 1843

def list_api_keys(request_options = {})
  response = list_api_keys_with_http_info(request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::ListApiKeysResponse")
end

#list_api_keys_with_http_info(request_options = {}) ⇒ Http::Response

Lists all API keys associated with your Algolia application, including their permissions and restrictions.

Required API Key ACLs:

- admin

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
 
# File 'lib/algolia/api/search_client.rb', line 1817

def list_api_keys_with_http_info(request_options = {})
  path = "/1/keys"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.list_api_keys",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#list_clusters(request_options = {}) ⇒ ListClustersResponse

Lists the available clusters in a multi-cluster setup.

Required API Key ACLs:

- admin

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (ListClustersResponse) 


1880
1881
1882
1883
 
# File 'lib/algolia/api/search_client.rb', line 1880

def list_clusters(request_options = {})
  response = list_clusters_with_http_info(request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::ListClustersResponse")
end

#list_clusters_with_http_info(request_options = {}) ⇒ Http::Response

Lists the available clusters in a multi-cluster setup.

Required API Key ACLs:

- admin

Parameters:

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
 
# File 'lib/algolia/api/search_client.rb', line 1854

def list_clusters_with_http_info(request_options = {})
  path = "/1/clusters"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.list_clusters",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#list_indices(page = nil, hits_per_page = nil, request_options = {}) ⇒ ListIndicesResponse

Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.

Required API Key ACLs:

- listIndexes

Parameters:

  • page (Integer) (defaults to: nil) —

    Requested page of the API response. If &#x60;null&#x60;, the API response is not paginated.

  • hits_per_page (Integer) (defaults to: nil) —

    Number of hits per page. (default to 100)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (ListIndicesResponse) 


1930
1931
1932
1933
 
# File 'lib/algolia/api/search_client.rb', line 1930

def list_indices(page = nil, hits_per_page = nil, request_options = {})
  response = list_indices_with_http_info(page, hits_per_page, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::ListIndicesResponse")
end

#list_indices_with_http_info(page = nil, hits_per_page = nil, request_options = {}) ⇒ Http::Response

Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.

Required API Key ACLs:

- listIndexes

Parameters:

  • page (Integer) (defaults to: nil) —

    Requested page of the API response. If &#x60;null&#x60;, the API response is not paginated.

  • hits_per_page (Integer) (defaults to: nil) —

    Number of hits per page. (default to 100)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
 
# File 'lib/algolia/api/search_client.rb', line 1893

def list_indices_with_http_info(page = nil, hits_per_page = nil, request_options = {})
  if @api_client.config.client_side_validation && !page.nil? && page < 0
    raise(
      ArgumentError,
      "invalid value for \"\"page\"\" when calling SearchClient.list_indices, must be greater than or equal to 0."
    )
  end

  path = "/1/indexes"
  query_params = {}
  query_params[:page] = page unless page.nil?
  query_params[:hitsPerPage] = hits_per_page unless hits_per_page.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.list_indices",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#list_user_ids(page = nil, hits_per_page = nil, request_options = {}) ⇒ ListUserIdsResponse

Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the response isn’t real-time.

Required API Key ACLs:

- admin

Parameters:

  • page (Integer) (defaults to: nil) —

    Requested page of the API response. If &#x60;null&#x60;, the API response is not paginated.

  • hits_per_page (Integer) (defaults to: nil) —

    Number of hits per page. (default to 100)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (ListUserIdsResponse) 


1980
1981
1982
1983
 
# File 'lib/algolia/api/search_client.rb', line 1980

def list_user_ids(page = nil, hits_per_page = nil, request_options = {})
  response = list_user_ids_with_http_info(page, hits_per_page, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::ListUserIdsResponse")
end

#list_user_ids_with_http_info(page = nil, hits_per_page = nil, request_options = {}) ⇒ Http::Response

Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the response isn&#39;t real-time.

Required API Key ACLs:

- admin

Parameters:

  • page (Integer) (defaults to: nil) —

    Requested page of the API response. If &#x60;null&#x60;, the API response is not paginated.

  • hits_per_page (Integer) (defaults to: nil) —

    Number of hits per page. (default to 100)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
 
# File 'lib/algolia/api/search_client.rb', line 1943

def list_user_ids_with_http_info(page = nil, hits_per_page = nil, request_options = {})
  if @api_client.config.client_side_validation && !page.nil? && page < 0
    raise(
      ArgumentError,
      "invalid value for \"\"page\"\" when calling SearchClient.list_user_ids, must be greater than or equal to 0."
    )
  end

  path = "/1/clusters/mapping"
  query_params = {}
  query_params[:page] = page unless page.nil?
  query_params[:hitsPerPage] = hits_per_page unless hits_per_page.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.list_user_ids",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#multiple_batch(batch_params, request_options = {}) ⇒ MultipleBatchResponse

Parameters:

  • batch_params (BatchParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (MultipleBatchResponse) 


2020
2021
2022
2023
 
# File 'lib/algolia/api/search_client.rb', line 2020

def multiple_batch(batch_params, request_options = {})
  response = multiple_batch_with_http_info(batch_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::MultipleBatchResponse")
end

#multiple_batch_with_http_info(batch_params, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • batch_params (BatchParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
 
# File 'lib/algolia/api/search_client.rb', line 1990

def multiple_batch_with_http_info(batch_params, request_options = {})
  # verify the required parameter 'batch_params' is set
  if @api_client.config.client_side_validation && batch_params.nil?
    raise ArgumentError, "Parameter `batch_params` is required when calling `multiple_batch`."
  end

  path = "/1/indexes/*/batch"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(batch_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.multiple_batch",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#operation_index(index_name, operation_index_params, request_options = {}) ⇒ UpdatedAtResponse

Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn’t exist yet, it’ll be created. Copy - Copying a source index that doesn’t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can’t copy the ‘enableReRanking`, `mode`, and `replicas` settings. - You can’t copy to a destination index that already has replicas. - Be aware of the [size limits](www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) Move - Moving a source index that doesn’t exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).

Required API Key ACLs:

- addObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • operation_index_params (OperationIndexParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtResponse) 


2070
2071
2072
2073
 
# File 'lib/algolia/api/search_client.rb', line 2070

def operation_index(index_name, operation_index_params, request_options = {})
  response = operation_index_with_http_info(index_name, operation_index_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
end

#operation_index_with_http_info(index_name, operation_index_params, request_options = {}) ⇒ Http::Response

Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn&#39;t exist yet, it&#39;ll be created. Copy - Copying a source index that doesn&#39;t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can&#39;t copy the &#x60;enableReRanking&#x60;, &#x60;mode&#x60;, and &#x60;replicas&#x60; settings. - You can&#39;t copy to a destination index that already has replicas. - Be aware of the [size limits](www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) Move - Moving a source index that doesn&#39;t exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).

Required API Key ACLs:

- addObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • operation_index_params (OperationIndexParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
 
# File 'lib/algolia/api/search_client.rb', line 2033

def operation_index_with_http_info(index_name, operation_index_params, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `operation_index`."
  end
  # verify the required parameter 'operation_index_params' is set
  if @api_client.config.client_side_validation && operation_index_params.nil?
    raise ArgumentError, "Parameter `operation_index_params` is required when calling `operation_index`."
  end

  path = "/1/indexes/{indexName}/operation".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(operation_index_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.operation_index",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#partial_update_object(index_name, object_id, attributes_to_update, create_if_not_exists = nil, request_options = {}) ⇒ UpdatedAtWithObjectIdResponse

Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn’t exist, a new record is added to the index if ‘createIfNotExists` is true. - If the index doesn’t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.

Required API Key ACLs:

- addObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique record identifier. (required)

  • attributes_to_update (Hash<String, AttributeToUpdate>) —

    Attributes with their values. (required)

  • create_if_not_exists (Boolean) (defaults to: nil) —

    Whether to create a new record if it doesn&#39;t exist. (default to true)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtWithObjectIdResponse) 


2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
 
# File 'lib/algolia/api/search_client.rb', line 2137

def partial_update_object(
  index_name,
  object_id,
  attributes_to_update,
  create_if_not_exists = nil,
  request_options = {}
)
  response = partial_update_object_with_http_info(
    index_name,
    object_id,
    attributes_to_update,
    create_if_not_exists,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Search::UpdatedAtWithObjectIdResponse"
  )
end

#partial_update_object_with_http_info(index_name, object_id, attributes_to_update, create_if_not_exists = nil, request_options = {}) ⇒ Http::Response

Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn&#39;t exist, a new record is added to the index if &#x60;createIfNotExists&#x60; is true. - If the index doesn&#39;t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.

Required API Key ACLs:

- addObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique record identifier. (required)

  • attributes_to_update (Hash<String, AttributeToUpdate>) —

    Attributes with their values. (required)

  • create_if_not_exists (Boolean) (defaults to: nil) —

    Whether to create a new record if it doesn&#39;t exist. (default to true)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
 
# File 'lib/algolia/api/search_client.rb', line 2085

def partial_update_object_with_http_info(
  index_name,
  object_id,
  attributes_to_update,
  create_if_not_exists = nil,
  request_options = {}
)
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `partial_update_object`."
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    raise ArgumentError, "Parameter `object_id` is required when calling `partial_update_object`."
  end
  # verify the required parameter 'attributes_to_update' is set
  if @api_client.config.client_side_validation && attributes_to_update.nil?
    raise ArgumentError, "Parameter `attributes_to_update` is required when calling `partial_update_object`."
  end

  path = "/1/indexes/{indexName}/{objectID}/partial"
    .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
    .sub("{" + "objectID" + "}", Transport.encode_uri(object_id.to_s))
  query_params = {}
  query_params[:createIfNotExists] = create_if_not_exists unless create_if_not_exists.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(attributes_to_update)

  new_options = request_options.merge(
    :operation => :"SearchClient.partial_update_object",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#partial_update_objects(index_name, objects, create_if_not_exists, request_options = {}) ⇒ BatchResponse

Helper: Replaces object content of all the given objects according to their respective ‘object_id` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.

Parameters:

  • index_name (String) —

    : The ‘index_name` to delete `object_ids` from.

  • objects (Array) —

    : The objects to partially update.

  • create_if_not_exists (Boolean) —

    : To be provided if non-existing objects are passed, otherwise, the call will fail.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (BatchResponse) 


3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
 
# File 'lib/algolia/api/search_client.rb', line 3418

def partial_update_objects(index_name, objects, create_if_not_exists, request_options = {})
  chunked_batch(
    index_name,
    objects,
    create_if_not_exists ? Search::Action::PARTIAL_UPDATE_OBJECT : Search::Action::PARTIAL_UPDATE_OBJECT_NO_CREATE,
    false,
    1000,
    request_options
  )
end

#remove_user_id(user_id, request_options = {}) ⇒ RemoveUserIdResponse

Deletes a user ID and its associated data from the clusters.

Required API Key ACLs:

- admin

Parameters:

  • user_id (String) —

    Unique identifier of the user who makes the search request. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (RemoveUserIdResponse) 


2204
2205
2206
2207
 
# File 'lib/algolia/api/search_client.rb', line 2204

def remove_user_id(user_id, request_options = {})
  response = remove_user_id_with_http_info(user_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::RemoveUserIdResponse")
end

#remove_user_id_with_http_info(user_id, request_options = {}) ⇒ Http::Response

Deletes a user ID and its associated data from the clusters.

Required API Key ACLs:

- admin

Parameters:

  • user_id (String) —

    Unique identifier of the user who makes the search request. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'lib/algolia/api/search_client.rb', line 2164

def remove_user_id_with_http_info(user_id, request_options = {})
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    raise ArgumentError, "Parameter `user_id` is required when calling `remove_user_id`."
  end

  pattern = /^[a-zA-Z0-9 \-*.]+$/
  if @api_client.config.client_side_validation && user_id !~ pattern
    raise(
      ArgumentError,
      "invalid value for 'user_id' when calling SearchClient.remove_user_id, must conform to the pattern #{pattern}."
    )
  end

  path = "/1/clusters/mapping/{userID}".sub("{" + "userID" + "}", Transport.encode_uri(user_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.remove_user_id",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#replace_all_objects(index_name, objects, batch_size = 1000, request_options = {}) ⇒ Array<ReplaceAllObjectsResponse>

Helper: Replaces all objects (records) in the given ‘index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.

Parameters:

  • index_name (String) —

    The ‘index_name` to replace `objects` in.

  • objects (Array) —

    The array of ‘objects` to store in the given Algolia `index_name`.

  • batch_size (int) (defaults to: 1000) —

    The size of the chunk of ‘objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Array<ReplaceAllObjectsResponse>) 


3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
 
# File 'lib/algolia/api/search_client.rb', line 3474

def replace_all_objects(index_name, objects, batch_size = 1000, request_options = {})
  tmp_index_name = index_name + "_tmp_" + rand(10_000_000).to_s

  copy_operation_response = operation_index(
    index_name,
    Search::OperationIndexParams.new(
      operation: Search::OperationType::COPY,
      destination: tmp_index_name,
      scope: [
        Search::ScopeType::SETTINGS,
        Search::ScopeType::RULES,
        Search::ScopeType::SYNONYMS
      ]
    ),
    request_options
  )

  batch_responses = chunked_batch(
    tmp_index_name,
    objects,
    Search::Action::ADD_OBJECT,
    true,
    batch_size,
    request_options
  )

  wait_for_task(tmp_index_name, copy_operation_response.task_id)

  copy_operation_response = operation_index(
    index_name,
    Search::OperationIndexParams.new(
      operation: Search::OperationType::COPY,
      destination: tmp_index_name,
      scope: [
        Search::ScopeType::SETTINGS,
        Search::ScopeType::RULES,
        Search::ScopeType::SYNONYMS
      ]
    ),
    request_options
  )

  wait_for_task(tmp_index_name, copy_operation_response.task_id)

  move_operation_response = operation_index(
    tmp_index_name,
    Search::OperationIndexParams.new(
      operation: Search::OperationType::MOVE,
      destination: index_name
    ),
    request_options
  )

  wait_for_task(tmp_index_name, move_operation_response.task_id)

  Search::ReplaceAllObjectsResponse.new(
    copy_operation_response: copy_operation_response,
    batch_responses: batch_responses,
    move_operation_response: move_operation_response
  )
end

#replace_sources(source, request_options = {}) ⇒ ReplaceSourceResponse

Replaces the list of allowed sources.

Required API Key ACLs:

- admin

Parameters:

  • source (Array<Source>) —

    Allowed sources. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (ReplaceSourceResponse) 


2248
2249
2250
2251
 
# File 'lib/algolia/api/search_client.rb', line 2248

def replace_sources(source, request_options = {})
  response = replace_sources_with_http_info(source, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::ReplaceSourceResponse")
end

#replace_sources_with_http_info(source, request_options = {}) ⇒ Http::Response

Replaces the list of allowed sources.

Required API Key ACLs:

- admin

Parameters:

  • source (Array<Source>) —

    Allowed sources. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
 
# File 'lib/algolia/api/search_client.rb', line 2216

def replace_sources_with_http_info(source, request_options = {})
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    raise ArgumentError, "Parameter `source` is required when calling `replace_sources`."
  end

  path = "/1/security/sources"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(source)

  new_options = request_options.merge(
    :operation => :"SearchClient.replace_sources",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#restore_api_key(key, request_options = {}) ⇒ AddApiKeyResponse

Restores a deleted API key. Restoring resets the ‘validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can’t be restored.

Required API Key ACLs:

- admin

Parameters:

  • key (String) —

    API key. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (AddApiKeyResponse) 


2292
2293
2294
2295
 
# File 'lib/algolia/api/search_client.rb', line 2292

def restore_api_key(key, request_options = {})
  response = restore_api_key_with_http_info(key, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::AddApiKeyResponse")
end

#restore_api_key_with_http_info(key, request_options = {}) ⇒ Http::Response

Restores a deleted API key. Restoring resets the &#x60;validity&#x60; attribute to &#x60;0&#x60;. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can&#39;t be restored.

Required API Key ACLs:

- admin

Parameters:

  • key (String) —

    API key. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
 
# File 'lib/algolia/api/search_client.rb', line 2260

def restore_api_key_with_http_info(key, request_options = {})
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    raise ArgumentError, "Parameter `key` is required when calling `restore_api_key`."
  end

  path = "/1/keys/{key}/restore".sub("{" + "key" + "}", Transport.encode_uri(key.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"SearchClient.restore_api_key",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#save_object(index_name, body, request_options = {}) ⇒ SaveObjectResponse

Adds a record to an index or replace it. - If the record doesn’t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn’t exist, a new record is added to your index. - If you add a record to an index that doesn’t exist yet, a new index is created. To update some attributes of a record, use the [‘partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

Required API Key ACLs:

- addObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • body (Object) —

    The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SaveObjectResponse) 


2342
2343
2344
2345
 
# File 'lib/algolia/api/search_client.rb', line 2342

def save_object(index_name, body, request_options = {})
  response = save_object_with_http_info(index_name, body, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SaveObjectResponse")
end

#save_object_with_http_info(index_name, body, request_options = {}) ⇒ Http::Response

Adds a record to an index or replace it. - If the record doesn&#39;t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn&#39;t exist, a new record is added to your index. - If you add a record to an index that doesn&#39;t exist yet, a new index is created. To update some attributes of a record, use the [&#x60;partial&#x60; operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [&#x60;batch&#x60; operation](#tag/Records/operation/batch).

Required API Key ACLs:

- addObject

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • body (Object) —

    The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
 
# File 'lib/algolia/api/search_client.rb', line 2305

def save_object_with_http_info(index_name, body, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `save_object`."
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    raise ArgumentError, "Parameter `body` is required when calling `save_object`."
  end

  path = "/1/indexes/{indexName}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)

  new_options = request_options.merge(
    :operation => :"SearchClient.save_object",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#save_objects(index_name, objects, request_options = {}) ⇒ BatchResponse

Helper: Saves the given array of objects in the given index. The ‘chunked_batch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.

Parameters:

  • index_name (String) —

    : The ‘index_name` to save `objects` in.

  • objects (Array) —

    : The array of ‘objects` to store in the given Algolia `indexName`.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (BatchResponse) 


3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
 
# File 'lib/algolia/api/search_client.rb', line 3379

def save_objects(index_name, objects, request_options = {})
  chunked_batch(
    index_name,
    objects,
    Search::Action::ADD_OBJECT,
    false,
    1000,
    request_options
  )
end

#save_rule(index_name, object_id, rule, forward_to_replicas = nil, request_options = {}) ⇒ UpdatedRuleResponse

If a rule with the specified object ID doesn’t exist, it’s created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [‘batch` operation](#tag/Rules/operation/saveRules).

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a rule object. (required)

  • rule (Rule) —

    (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedRuleResponse) 


2403
2404
2405
2406
 
# File 'lib/algolia/api/search_client.rb', line 2403

def save_rule(index_name, object_id, rule, forward_to_replicas = nil, request_options = {})
  response = save_rule_with_http_info(index_name, object_id, rule, forward_to_replicas, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedRuleResponse")
end

#save_rule_with_http_info(index_name, object_id, rule, forward_to_replicas = nil, request_options = {}) ⇒ Http::Response

If a rule with the specified object ID doesn&#39;t exist, it&#39;s created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [&#x60;batch&#x60; operation](#tag/Rules/operation/saveRules).

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a rule object. (required)

  • rule (Rule) —

    (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
 
# File 'lib/algolia/api/search_client.rb', line 2357

def save_rule_with_http_info(index_name, object_id, rule, forward_to_replicas = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `save_rule`."
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    raise ArgumentError, "Parameter `object_id` is required when calling `save_rule`."
  end
  # verify the required parameter 'rule' is set
  if @api_client.config.client_side_validation && rule.nil?
    raise ArgumentError, "Parameter `rule` is required when calling `save_rule`."
  end

  path = "/1/indexes/{indexName}/rules/{objectID}"
    .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
    .sub("{" + "objectID" + "}", Transport.encode_uri(object_id.to_s))
  query_params = {}
  query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(rule)

  new_options = request_options.merge(
    :operation => :"SearchClient.save_rule",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#save_rules(index_name, rules, forward_to_replicas = nil, clear_existing_rules = nil, request_options = {}) ⇒ UpdatedAtResponse

Create or update multiple rules. If a rule with the specified object ID doesn’t exist, Algolia creates a new one. Otherwise, existing rules are replaced.

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • rules (Array<Rule>) —

    (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • clear_existing_rules (Boolean) (defaults to: nil) —

    Whether existing rules should be deleted before adding this batch.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtResponse) 


2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
 
# File 'lib/algolia/api/search_client.rb', line 2465

def save_rules(index_name, rules, forward_to_replicas = nil, clear_existing_rules = nil, request_options = {})
  response = save_rules_with_http_info(
    index_name,
    rules,
    forward_to_replicas,
    clear_existing_rules,
    request_options
  )
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
end

#save_rules_with_http_info(index_name, rules, forward_to_replicas = nil, clear_existing_rules = nil, request_options = {}) ⇒ Http::Response

Create or update multiple rules. If a rule with the specified object ID doesn&#39;t exist, Algolia creates a new one. Otherwise, existing rules are replaced.

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • rules (Array<Rule>) —

    (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • clear_existing_rules (Boolean) (defaults to: nil) —

    Whether existing rules should be deleted before adding this batch.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
 
# File 'lib/algolia/api/search_client.rb', line 2418

def save_rules_with_http_info(
  index_name,
  rules,
  forward_to_replicas = nil,
  clear_existing_rules = nil,
  request_options = {}
)
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `save_rules`."
  end
  # verify the required parameter 'rules' is set
  if @api_client.config.client_side_validation && rules.nil?
    raise ArgumentError, "Parameter `rules` is required when calling `save_rules`."
  end

  path = "/1/indexes/{indexName}/rules/batch".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
  query_params[:clearExistingRules] = clear_existing_rules unless clear_existing_rules.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(rules)

  new_options = request_options.merge(
    :operation => :"SearchClient.save_rules",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#save_synonym(index_name, object_id, synonym_hit, forward_to_replicas = nil, request_options = {}) ⇒ SaveSynonymResponse

If a synonym with the specified object ID doesn’t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [‘batch` operation](#tag/Synonyms/operation/saveSynonyms).

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a synonym object. (required)

  • synonym_hit (SynonymHit) —

    (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SaveSynonymResponse) 


2532
2533
2534
2535
 
# File 'lib/algolia/api/search_client.rb', line 2532

def save_synonym(index_name, object_id, synonym_hit, forward_to_replicas = nil, request_options = {})
  response = save_synonym_with_http_info(index_name, object_id, synonym_hit, forward_to_replicas, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SaveSynonymResponse")
end

#save_synonym_with_http_info(index_name, object_id, synonym_hit, forward_to_replicas = nil, request_options = {}) ⇒ Http::Response

If a synonym with the specified object ID doesn&#39;t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [&#x60;batch&#x60; operation](#tag/Synonyms/operation/saveSynonyms).

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • object_id (String) —

    Unique identifier of a synonym object. (required)

  • synonym_hit (SynonymHit) —

    (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
 
# File 'lib/algolia/api/search_client.rb', line 2486

def save_synonym_with_http_info(index_name, object_id, synonym_hit, forward_to_replicas = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `save_synonym`."
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    raise ArgumentError, "Parameter `object_id` is required when calling `save_synonym`."
  end
  # verify the required parameter 'synonym_hit' is set
  if @api_client.config.client_side_validation && synonym_hit.nil?
    raise ArgumentError, "Parameter `synonym_hit` is required when calling `save_synonym`."
  end

  path = "/1/indexes/{indexName}/synonyms/{objectID}"
    .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
    .sub("{" + "objectID" + "}", Transport.encode_uri(object_id.to_s))
  query_params = {}
  query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(synonym_hit)

  new_options = request_options.merge(
    :operation => :"SearchClient.save_synonym",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#save_synonyms(index_name, synonym_hit, forward_to_replicas = nil, replace_existing_synonyms = nil, request_options = {}) ⇒ UpdatedAtResponse

If a synonym with the ‘objectID` doesn’t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • synonym_hit (Array<SynonymHit>) —

    (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • replace_existing_synonyms (Boolean) (defaults to: nil) —

    Whether to replace all synonyms in the index with the ones sent with this request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtResponse) 


2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
 
# File 'lib/algolia/api/search_client.rb', line 2594

def save_synonyms(
  index_name,
  synonym_hit,
  forward_to_replicas = nil,
  replace_existing_synonyms = nil,
  request_options = {}
)
  response = save_synonyms_with_http_info(
    index_name,
    synonym_hit,
    forward_to_replicas,
    replace_existing_synonyms,
    request_options
  )
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
end

#save_synonyms_with_http_info(index_name, synonym_hit, forward_to_replicas = nil, replace_existing_synonyms = nil, request_options = {}) ⇒ Http::Response

If a synonym with the &#x60;objectID&#x60; doesn&#39;t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • synonym_hit (Array<SynonymHit>) —

    (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • replace_existing_synonyms (Boolean) (defaults to: nil) —

    Whether to replace all synonyms in the index with the ones sent with this request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
 
# File 'lib/algolia/api/search_client.rb', line 2547

def save_synonyms_with_http_info(
  index_name,
  synonym_hit,
  forward_to_replicas = nil,
  replace_existing_synonyms = nil,
  request_options = {}
)
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `save_synonyms`."
  end
  # verify the required parameter 'synonym_hit' is set
  if @api_client.config.client_side_validation && synonym_hit.nil?
    raise ArgumentError, "Parameter `synonym_hit` is required when calling `save_synonyms`."
  end

  path = "/1/indexes/{indexName}/synonyms/batch".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
  query_params[:replaceExistingSynonyms] = replace_existing_synonyms unless replace_existing_synonyms.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(synonym_hit)

  new_options = request_options.merge(
    :operation => :"SearchClient.save_synonyms",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#search(search_method_params, request_options = {}) ⇒ SearchResponses

Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.

Required API Key ACLs:

- search

Parameters:

  • search_method_params (SearchMethodParams) —

    Muli-search request body. Results are returned in the same order as the requests. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SearchResponses) 


2650
2651
2652
2653
 
# File 'lib/algolia/api/search_client.rb', line 2650

def search(search_method_params, request_options = {})
  response = search_with_http_info(search_method_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SearchResponses")
end

#search_dictionary_entries(dictionary_name, search_dictionary_entries_params, request_options = {}) ⇒ SearchDictionaryEntriesResponse

Searches for standard and custom dictionary entries.

Required API Key ACLs:

- settings

Parameters:

  • dictionary_name (DictionaryType) —

    Dictionary type in which to search. (required)

  • search_dictionary_entries_params (SearchDictionaryEntriesParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SearchDictionaryEntriesResponse) 


2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
 
# File 'lib/algolia/api/search_client.rb', line 2710

def search_dictionary_entries(dictionary_name, search_dictionary_entries_params, request_options = {})
  response = search_dictionary_entries_with_http_info(
    dictionary_name,
    search_dictionary_entries_params,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Search::SearchDictionaryEntriesResponse"
  )
end

#search_dictionary_entries_with_http_info(dictionary_name, search_dictionary_entries_params, request_options = {}) ⇒ Http::Response

Searches for standard and custom dictionary entries.

Required API Key ACLs:

- settings

Parameters:

  • dictionary_name (DictionaryType) —

    Dictionary type in which to search. (required)

  • search_dictionary_entries_params (SearchDictionaryEntriesParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
 
# File 'lib/algolia/api/search_client.rb', line 2663

def search_dictionary_entries_with_http_info(
  dictionary_name,
  search_dictionary_entries_params,
  request_options = {}
)
  # verify the required parameter 'dictionary_name' is set
  if @api_client.config.client_side_validation && dictionary_name.nil?
    raise ArgumentError, "Parameter `dictionary_name` is required when calling `search_dictionary_entries`."
  end
  # verify the required parameter 'search_dictionary_entries_params' is set
  if @api_client.config.client_side_validation && search_dictionary_entries_params.nil?
    raise(
      ArgumentError,
      "Parameter `search_dictionary_entries_params` is required when calling `search_dictionary_entries`."
    )
  end

  path = "/1/dictionaries/{dictionaryName}/search".sub(
    "{" + "dictionaryName" + "}",
    Transport.encode_uri(dictionary_name.to_s)
  )
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(search_dictionary_entries_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.search_dictionary_entries",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => true
  )

  @api_client.call_api(:POST, path, new_options)
end

#search_for_facet_values(index_name, facet_name, search_for_facet_values_request = nil, request_options = {}) ⇒ SearchForFacetValuesResponse

Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the ‘sortFacetValueBy` parameter. - Searching for facet values doesn’t work if you have **more than 65 searchable facets and searchable attributes combined**.

Required API Key ACLs:

- search

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • facet_name (String) —

    Facet attribute in which to search for values. This attribute must be included in the &#x60;attributesForFaceting&#x60; index setting with the &#x60;searchable()&#x60; modifier. (required)

  • search_for_facet_values_request (SearchForFacetValuesRequest) (defaults to: nil)
  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SearchForFacetValuesResponse) 


2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
 
# File 'lib/algolia/api/search_client.rb', line 2776

def search_for_facet_values(index_name, facet_name, search_for_facet_values_request = nil, request_options = {})
  response = search_for_facet_values_with_http_info(
    index_name,
    facet_name,
    search_for_facet_values_request,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Search::SearchForFacetValuesResponse"
  )
end

#search_for_facet_values_with_http_info(index_name, facet_name, search_for_facet_values_request = nil, request_options = {}) ⇒ Http::Response

Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the &#x60;sortFacetValueBy&#x60; parameter. - Searching for facet values doesn&#39;t work if you have **more than 65 searchable facets and searchable attributes combined**.

Required API Key ACLs:

- search

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • facet_name (String) —

    Facet attribute in which to search for values. This attribute must be included in the &#x60;attributesForFaceting&#x60; index setting with the &#x60;searchable()&#x60; modifier. (required)

  • search_for_facet_values_request (SearchForFacetValuesRequest) (defaults to: nil)
  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
 
# File 'lib/algolia/api/search_client.rb', line 2731

def search_for_facet_values_with_http_info(
  index_name,
  facet_name,
  search_for_facet_values_request = nil,
  request_options = {}
)
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `search_for_facet_values`."
  end
  # verify the required parameter 'facet_name' is set
  if @api_client.config.client_side_validation && facet_name.nil?
    raise ArgumentError, "Parameter `facet_name` is required when calling `search_for_facet_values`."
  end

  path = "/1/indexes/{indexName}/facets/{facetName}/query"
    .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
    .sub("{" + "facetName" + "}", Transport.encode_uri(facet_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(search_for_facet_values_request)

  new_options = request_options.merge(
    :operation => :"SearchClient.search_for_facet_values",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => true
  )

  @api_client.call_api(:POST, path, new_options)
end

#search_rules(index_name, search_rules_params = nil, request_options = {}) ⇒ SearchRulesResponse

Searches for rules in your index.

Required API Key ACLs:

- settings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • search_rules_params (SearchRulesParams) (defaults to: nil)
  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SearchRulesResponse) 


2830
2831
2832
2833
 
# File 'lib/algolia/api/search_client.rb', line 2830

def search_rules(index_name, search_rules_params = nil, request_options = {})
  response = search_rules_with_http_info(index_name, search_rules_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SearchRulesResponse")
end

#search_rules_with_http_info(index_name, search_rules_params = nil, request_options = {}) ⇒ Http::Response

Searches for rules in your index.

Required API Key ACLs:

- settings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • search_rules_params (SearchRulesParams) (defaults to: nil)
  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
 
# File 'lib/algolia/api/search_client.rb', line 2797

def search_rules_with_http_info(index_name, search_rules_params = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `search_rules`."
  end

  path = "/1/indexes/{indexName}/rules/search".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(search_rules_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.search_rules",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => true
  )

  @api_client.call_api(:POST, path, new_options)
end

#search_single_index(index_name, search_params = nil, request_options = {}) ⇒ SearchResponse

Searches a single index and return matching search results (hits). This method lets you retrieve up to 1,000 hits. If you need more, use the [‘browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.

Required API Key ACLs:

- search

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • search_params (SearchParams) (defaults to: nil)
  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SearchResponse) 


2876
2877
2878
2879
 
# File 'lib/algolia/api/search_client.rb', line 2876

def search_single_index(index_name, search_params = nil, request_options = {})
  response = search_single_index_with_http_info(index_name, search_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SearchResponse")
end

#search_single_index_with_http_info(index_name, search_params = nil, request_options = {}) ⇒ Http::Response

Searches a single index and return matching search results (hits). This method lets you retrieve up to 1,000 hits. If you need more, use the [&#x60;browse&#x60; operation](#tag/Search/operation/browse) or increase the &#x60;paginatedLimitedTo&#x60; index setting.

Required API Key ACLs:

- search

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • search_params (SearchParams) (defaults to: nil)
  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
 
# File 'lib/algolia/api/search_client.rb', line 2843

def search_single_index_with_http_info(index_name, search_params = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `search_single_index`."
  end

  path = "/1/indexes/{indexName}/query".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(search_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.search_single_index",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => true
  )

  @api_client.call_api(:POST, path, new_options)
end

#search_synonyms(index_name, search_synonyms_params = nil, request_options = {}) ⇒ SearchSynonymsResponse

Searches for synonyms in your index.

Required API Key ACLs:

- settings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • search_synonyms_params (SearchSynonymsParams) (defaults to: nil) —

    Body of the &#x60;searchSynonyms&#x60; operation.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SearchSynonymsResponse) 


2925
2926
2927
2928
 
# File 'lib/algolia/api/search_client.rb', line 2925

def search_synonyms(index_name, search_synonyms_params = nil, request_options = {})
  response = search_synonyms_with_http_info(index_name, search_synonyms_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SearchSynonymsResponse")
end

#search_synonyms_with_http_info(index_name, search_synonyms_params = nil, request_options = {}) ⇒ Http::Response

Searches for synonyms in your index.

Required API Key ACLs:

- settings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • search_synonyms_params (SearchSynonymsParams) (defaults to: nil) —

    Body of the &#x60;searchSynonyms&#x60; operation.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
 
# File 'lib/algolia/api/search_client.rb', line 2889

def search_synonyms_with_http_info(index_name, search_synonyms_params = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `search_synonyms`."
  end

  path = "/1/indexes/{indexName}/synonyms/search".sub(
    "{" + "indexName" + "}",
    Transport.encode_uri(index_name.to_s)
  )
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(search_synonyms_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.search_synonyms",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => true
  )

  @api_client.call_api(:POST, path, new_options)
end

#search_user_ids(search_user_ids_params, request_options = {}) ⇒ SearchUserIdsResponse

Since it can take a few seconds to get the data from the different clusters, the response isn’t real-time. To ensure rapid updates, the user IDs index isn’t built at the same time as the mapping. Instead, it’s built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).

Required API Key ACLs:

- admin

Parameters:

  • search_user_ids_params (SearchUserIdsParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SearchUserIdsResponse) 


2969
2970
2971
2972
 
# File 'lib/algolia/api/search_client.rb', line 2969

def search_user_ids(search_user_ids_params, request_options = {})
  response = search_user_ids_with_http_info(search_user_ids_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SearchUserIdsResponse")
end

#search_user_ids_with_http_info(search_user_ids_params, request_options = {}) ⇒ Http::Response

Since it can take a few seconds to get the data from the different clusters, the response isn&#39;t real-time. To ensure rapid updates, the user IDs index isn&#39;t built at the same time as the mapping. Instead, it&#39;s built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).

Required API Key ACLs:

- admin

Parameters:

  • search_user_ids_params (SearchUserIdsParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
 
# File 'lib/algolia/api/search_client.rb', line 2937

def search_user_ids_with_http_info(search_user_ids_params, request_options = {})
  # verify the required parameter 'search_user_ids_params' is set
  if @api_client.config.client_side_validation && search_user_ids_params.nil?
    raise ArgumentError, "Parameter `search_user_ids_params` is required when calling `search_user_ids`."
  end

  path = "/1/clusters/mapping/search"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(search_user_ids_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.search_user_ids",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => true
  )

  @api_client.call_api(:POST, path, new_options)
end

#search_with_http_info(search_method_params, request_options = {}) ⇒ Http::Response

Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.

Required API Key ACLs:

- search

Parameters:

  • search_method_params (SearchMethodParams) —

    Muli-search request body. Results are returned in the same order as the requests. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
 
# File 'lib/algolia/api/search_client.rb', line 2618

def search_with_http_info(search_method_params, request_options = {})
  # verify the required parameter 'search_method_params' is set
  if @api_client.config.client_side_validation && search_method_params.nil?
    raise ArgumentError, "Parameter `search_method_params` is required when calling `search`."
  end

  path = "/1/indexes/*/queries"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(search_method_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.search",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => true
  )

  @api_client.call_api(:POST, path, new_options)
end

#set_dictionary_settings(dictionary_settings_params, request_options = {}) ⇒ UpdatedAtResponse

Turns standard stop word dictionary entries on or off for a given language.

Required API Key ACLs:

- editSettings

Parameters:

  • dictionary_settings_params (DictionarySettingsParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtResponse) 


3016
3017
3018
3019
 
# File 'lib/algolia/api/search_client.rb', line 3016

def set_dictionary_settings(dictionary_settings_params, request_options = {})
  response = set_dictionary_settings_with_http_info(dictionary_settings_params, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
end

#set_dictionary_settings_with_http_info(dictionary_settings_params, request_options = {}) ⇒ Http::Response

Turns standard stop word dictionary entries on or off for a given language.

Required API Key ACLs:

- editSettings

Parameters:

  • dictionary_settings_params (DictionarySettingsParams) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
 
# File 'lib/algolia/api/search_client.rb', line 2981

def set_dictionary_settings_with_http_info(dictionary_settings_params, request_options = {})
  # verify the required parameter 'dictionary_settings_params' is set
  if @api_client.config.client_side_validation && dictionary_settings_params.nil?
    raise(
      ArgumentError,
      "Parameter `dictionary_settings_params` is required when calling `set_dictionary_settings`."
    )
  end

  path = "/1/dictionaries/*/settings"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(dictionary_settings_params)

  new_options = request_options.merge(
    :operation => :"SearchClient.set_dictionary_settings",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#set_settings(index_name, index_settings, forward_to_replicas = nil, request_options = {}) ⇒ UpdatedAtResponse

Update the specified index settings. Index settings that you don’t specify are left unchanged. Specify ‘null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • index_settings (IndexSettings) —

    (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdatedAtResponse) 


3069
3070
3071
3072
 
# File 'lib/algolia/api/search_client.rb', line 3069

def set_settings(index_name, index_settings, forward_to_replicas = nil, request_options = {})
  response = set_settings_with_http_info(index_name, index_settings, forward_to_replicas, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
end

#set_settings_with_http_info(index_name, index_settings, forward_to_replicas = nil, request_options = {}) ⇒ Http::Response

Update the specified index settings. Index settings that you don&#39;t specify are left unchanged. Specify &#x60;null&#x60; to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.

Required API Key ACLs:

- editSettings

Parameters:

  • index_name (String) —

    Name of the index on which to perform the operation. (required)

  • index_settings (IndexSettings) —

    (required)

  • forward_to_replicas (Boolean) (defaults to: nil) —

    Whether changes are applied to replica indices.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
 
# File 'lib/algolia/api/search_client.rb', line 3030

def set_settings_with_http_info(index_name, index_settings, forward_to_replicas = nil, request_options = {})
  # verify the required parameter 'index_name' is set
  if @api_client.config.client_side_validation && index_name.nil?
    raise ArgumentError, "Parameter `index_name` is required when calling `set_settings`."
  end
  # verify the required parameter 'index_settings' is set
  if @api_client.config.client_side_validation && index_settings.nil?
    raise ArgumentError, "Parameter `index_settings` is required when calling `set_settings`."
  end

  path = "/1/indexes/{indexName}/settings".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
  query_params = {}
  query_params[:forwardToReplicas] = forward_to_replicas unless forward_to_replicas.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(index_settings)

  new_options = request_options.merge(
    :operation => :"SearchClient.set_settings",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#update_api_key(key, api_key, request_options = {}) ⇒ UpdateApiKeyResponse

Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.

Required API Key ACLs:

- admin

Parameters:

  • key (String) —

    API key. (required)

  • api_key (ApiKey) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (UpdateApiKeyResponse) 


3119
3120
3121
3122
 
# File 'lib/algolia/api/search_client.rb', line 3119

def update_api_key(key, api_key, request_options = {})
  response = update_api_key_with_http_info(key, api_key, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdateApiKeyResponse")
end

#update_api_key_with_http_info(key, api_key, request_options = {}) ⇒ Http::Response

Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.

Required API Key ACLs:

- admin

Parameters:

  • key (String) —

    API key. (required)

  • api_key (ApiKey) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
 
# File 'lib/algolia/api/search_client.rb', line 3082

def update_api_key_with_http_info(key, api_key, request_options = {})
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    raise ArgumentError, "Parameter `key` is required when calling `update_api_key`."
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    raise ArgumentError, "Parameter `api_key` is required when calling `update_api_key`."
  end

  path = "/1/keys/{key}".sub("{" + "key" + "}", Transport.encode_uri(key.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(api_key)

  new_options = request_options.merge(
    :operation => :"SearchClient.update_api_key",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#wait_for_api_key(key, operation, api_key = {}, max_retries = 50, timeout = -> (retry_count) { [retry_count * 200, 5000].min }, request_options = {}) ⇒ Http::Response

Helper: Wait for an API key to be added, updated or deleted based on a given ‘operation`.

Parameters:

  • key (String) —

    the ‘key` that has been added, deleted or updated.

  • operation (String) —

    the ‘operation` that was done on a `key`.

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

    necessary to know if an ‘update` operation has been processed, compare fields of the response with it.

  • max_retries (Integer) (defaults to: 50) —

    the maximum number of retries.

  • timeout (Proc) (defaults to: -> (retry_count) { [retry_count * 200, 5000].min }) —

    the function to decide how long to wait between retries.

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

    the requestOptions to send along with the query, they will be forwarded to the ‘getApikey` method and merged with the transporter requestOptions.

Returns:

Raises:



3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
 
# File 'lib/algolia/api/search_client.rb', line 3189

def wait_for_api_key(
  key,
  operation,
  api_key = {},
  max_retries = 50,
  timeout = -> (retry_count) { [retry_count * 200, 5000].min },
  request_options = {}
)
  retries = 0
  if operation == "update"
    raise ArgumentError, "`api_key` is required when waiting for an `update` operation." if api_key.nil?
    while retries < max_retries
      updated_key = get_api_key(key, request_options)
      updated_key_hash = updated_key.to_hash
      equals = true
      api_key.to_hash.each do |k, v|
        equals &&= updated_key_hash[k] == v
      end

      return updated_key if equals

      retries += 1
      sleep(timeout.call(retries) / 1000.0)
    end

    raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
  end

  while retries < max_retries
    begin
      res = get_api_key(key, request_options)
      return res if operation == "add"
    rescue AlgoliaHttpError => e
      if e.code == 404
        return nil if operation == "delete"
      else
        raise e
      end
    end

    retries += 1
    sleep(timeout.call(retries) / 1000.0)
  end

  raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
end

#wait_for_app_task(task_id, max_retries = 50, timeout = -> (retry_count) { [retry_count * 200, 5000].min }, request_options = {}) ⇒ Http::Response

Helper: Wait for an application-level task to be published (completed) for a given ‘task_id`.

Parameters:

  • task_id (Integer) —

    the ‘task_id` returned in the method response. (required)

  • max_retries (Integer) (defaults to: 50) —

    the maximum number of retries. (optional, default to 50)

  • timeout (Proc) (defaults to: -> (retry_count) { [retry_count * 200, 5000].min }) —

    the function to decide how long to wait between retries. (optional)

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

    the requestOptions to send along with the query, they will be forwarded to the ‘get_task` method.

Returns:

Raises:



3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
 
# File 'lib/algolia/api/search_client.rb', line 3160

def wait_for_app_task(
  task_id,
  max_retries = 50,
  timeout = -> (retry_count) { [retry_count * 200, 5000].min },
  request_options = {}
)
  retries = 0
  while retries < max_retries
    res = get_app_task(task_id, request_options)
    if res.status == "published"
      return res
    end

    retries += 1
    sleep(timeout.call(retries) / 1000.0)
  end

  raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
end

#wait_for_task(index_name, task_id, max_retries = 50, timeout = -> (retry_count) { [retry_count * 200, 5000].min }, request_options = {}) ⇒ Http::Response

Helper: Wait for a task to be published (completed) for a given ‘index_name` and `task_id`.

Parameters:

  • index_name (String) —

    the ‘index_name` where the operation was performed. (required)

  • task_id (Integer) —

    the ‘task_id` returned in the method response. (required)

  • max_retries (Integer) (defaults to: 50) —

    the maximum number of retries. (optional, default to 50)

  • timeout (Proc) (defaults to: -> (retry_count) { [retry_count * 200, 5000].min }) —

    the function to decide how long to wait between retries. (optional)

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

    the requestOptions to send along with the query, they will be forwarded to the ‘get_task` method.

Returns:

Raises:



3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
 
# File 'lib/algolia/api/search_client.rb', line 3132

def wait_for_task(
  index_name,
  task_id,
  max_retries = 50,
  timeout = -> (retry_count) { [retry_count * 200, 5000].min },
  request_options = {}
)
  retries = 0
  while retries < max_retries
    res = get_task(index_name, task_id, request_options)
    if res.status == "published"
      return res
    end

    retries += 1
    sleep(timeout.call(retries) / 1000.0)
  end

  raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
end