RubyGems - algoliasearch - Versions diffs - 1.10.0 → 1.11.0 - Mend

algoliasearch 1.10.0 → 1.11.0

Files changed (12) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9aa3ec8a147ae10740f99b9f04eb82cd49b8731b
-  data.tar.gz: 9fe92762186104bb95e67f43be839694bfe40cb4
+  metadata.gz: 2a37e65bca2bf7c296add2c0f0187ab5bd33eedb
+  data.tar.gz: 7889a0cce2a6470260c3616ca71fda9022084792
 SHA512:
-  metadata.gz: 1ab1dae58906b5d01180379396e3ee00cd1c67a755a0ebfd29945f80c10a5813dfc8ccf431e0a6145e6a04108efc613f9aa2b9a0297ed1a6cede28d6de030262
-  data.tar.gz: f95d7a77dc2a6bc342985171f5de609c74ea3590a31cb12ab61be817b3d8c781fc5e9721f2540783ebbe1cdad3d82ed5c35538ce7d1a4ebf5810cd956aa0923b
+  metadata.gz: db44fe908876413039e4efb0a447f9fbf7b95a3cbd11e0401d1bb53500e13d4d6b133772bb7b589c96b4de08f178a50443f101285df47a8e917c6b21c8a8d79a
+  data.tar.gz: 04f539db59d6de73e6d088b19b80a2182d1f931c5649e0c6af5fc4e968bd4fc698e4a9797c88a1041e1b0dc843a0a9c599892441893645330a605a07c7bdf230

data/.travis.yml CHANGED Viewed

@@ -6,13 +6,12 @@ rvm:
 - 1.8.7
 - 1.9.3
 - 2.0.0
-- 2.1.5
-- 2.2.2
-- 2.3.0
+- 2.1.10
+- 2.2.5
+- 2.3.1
 - jruby
 - rbx-2
-install:
-- bundle install
+cache: bundler
 env:
   global:
   - secure: OFKp0J81VrKXfpQZWkwSfsG/knN4tr45yDAGekFy4FKcA6Ra6EqDUzcY1MVrkKq9YRUgLJRfjgqF3Ei0cm2qMo1dy5XUG/fY8upTVdQK2Nm1qfbjnh70+vnYpHidHg9pEI8QROwsM7n19QoT16j1af4UinGFE/HBiJpuXcABuLw=

data/ChangeLog CHANGED Viewed

@@ -1,5 +1,8 @@
 CHANGELOG
+2016-08-21 1.11.0
+      * Upgraded to httpclient 2.8.1 to avoid reseting the keep-alive while changing timeouts
 2016-07-11 1.10.0
       * `{get,set}_settings` now take optional custom query parameters

data/Gemfile CHANGED Viewed

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
-gem 'httpclient', '~> 2.7.1'
+gem 'httpclient', '~> 2.8.2'
 gem 'json', '>= 1.5.1'
 gem 'rubysl', '~> 2.0', :platform => :rbx

data/Gemfile.lock CHANGED Viewed

@@ -31,7 +31,7 @@ GEM
       net-http-persistent (>= 2.7)
       net-http-pipeline
     highline (1.6.21)
-    httpclient (2.7.1)
+    httpclient (2.8.2.2)
     json (1.8.3)
     json (1.8.3-java)
     launchy (2.4.3)
@@ -311,7 +311,7 @@ PLATFORMS
 DEPENDENCIES
   coveralls
   highline (< 1.7.0)
-  httpclient (~> 2.7.1)
+  httpclient (~> 2.8.2)
   json (>= 1.5.1)
   mime-types (< 2.0)
   rake

data/README.md CHANGED Viewed

@@ -2,17 +2,14 @@
 # Algolia Search API Client for Ruby
-<!--/NO_HTML-->
-<!--NO_HTML-->
 [Algolia Search](https://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
-<!--/NO_HTML-->
 Our Ruby client lets you easily use the [Algolia Search API](https://www.algolia.com/doc/rest) from your backend. It wraps the [Algolia Search REST API](https://www.algolia.com/doc/rest).
@@ -24,51 +21,135 @@ Our Ruby client lets you easily use the [Algolia Search API](https://www.algolia
-<!--NO_HTML-->
-Table of Contents
------------------
+## Table of Contents
 **Getting Started**
-1. [Setup](#setup)
+1. [Getting started](#getting-started)
 1. [Quick Start](#quick-start)
-1. [Guides & Tutorials](#guides-tutorials)
+1. [Guides & Tutorials](#guides--tutorials)
 **Commands Reference**
-1. [Add a new object](#add-a-new-object-to-the-index)
-1. [Update an object](#update-an-existing-object-in-the-index)
-1. [Search](#search)
-1. [Multiple queries](#multiple-queries)
-1. [Get an object](#get-an-object)
-1. [Delete an object](#delete-an-object)
-1. [Delete by query](#delete-by-query)
-1. [Index settings](#index-settings)
-1. [List indices](#list-indices)
-1. [Delete an index](#delete-an-index)
-1. [Clear an index](#clear-an-index)
-1. [Wait indexing](#wait-indexing)
-1. [Batch writes](#batch-writes)
-1. [Copy / Move an index](#copy--move-an-index)
-1. [Backup / Export an index](#backup--export-an-index)
-1. [API Keys](#api-keys)
-1. [Logs](#logs)
-1. [Mock](#mock)
+Getting started
+1. [Install](#install)
+1. [Init index](#init-index---init_index)
+Search
+1. [Search in an index](#search-in-an-index---search)
+1. [Find by IDs](#find-by-ids---get_objects)
+Indexing
+1. [Add objects](#add-objects---add_objects)
+1. [Update objects](#update-objects---save_objects)
+1. [Partial update](#partial-update---partial_update_objects)
+1. [Delete objects](#delete-objects---delete_objects)
+Settings
+1. [Get settings](#get-settings---get_settings)
+1. [Set settings](#set-settings---set_settings)
+Manage Indices
+1. [List indices](#list-indices---list_indexes)
+1. [Delete index](#delete-index---delete_index)
+1. [Clear index](#clear-index---clear_index)
+1. [Copy index](#copy-index---copy_index)
+1. [Move index](#move-index---move_index)
+Api Keys
+1. [Generate key](#generate-key---generate_secured_api_key)
+Synonyms
+1. [Save synonym](#save-synonym---save_synonym)
+1. [Batch synonyms](#batch-synonyms---batch_synonyms)
+1. [Editing Synonyms](#editing-synonyms)
+1. [Delete Synonyms](#delete-synonyms---delete_synonyms)
+1. [Clear all synonyms](#clear-all-synonyms---clear_synonyms)
+1. [Get synonym](#get-synonym---get_synonym)
+1. [Search synonyms](#search-synonyms---search_synonyms)
+Advanced
+1. [Custom batch](#custom-batch---batch)
+1. [Wait for operations](#wait-for-operations---wait_task)
+1. [Multiple queries](#multiple-queries---multiple_queries)
+1. [Delete by query](#delete-by-query---delete_by_query)
+1. [Backup / Export an index](#backup--export-an-index---browse)
+1. [List api keys](#list-api-keys---list_api_keys)
+1. [Add user key](#add-user-key---add_user_key)
+1. [Update user key](#update-user-key---update_user_key)
+1. [Delete user key](#delete-user-key---delete_user_key)
+1. [Get key permissions](#get-key-permissions---get_user_key_acl)
+1. [Get Logs](#get-logs---get_logs)
+Mocking
+1. [Mocking](#mocking)
+## Guides & Tutorials
+Check our [online guides](https://www.algolia.com/doc):
+ * [Data Formatting](https://www.algolia.com/doc/indexing/formatting-your-data)
+ * [Import and Synchronize data](https://www.algolia.com/doc/indexing/import-synchronize-data/ruby)
+ * [Autocomplete](https://www.algolia.com/doc/search/auto-complete)
+ * [Instant search page](https://www.algolia.com/doc/search/instant-search)
+ * [Filtering and Faceting](https://www.algolia.com/doc/search/filtering-faceting)
+ * [Sorting](https://www.algolia.com/doc/relevance/sorting)
+ * [Ranking Formula](https://www.algolia.com/doc/relevance/ranking)
+ * [Typo-Tolerance](https://www.algolia.com/doc/relevance/typo-tolerance)
+ * [Geo-Search](https://www.algolia.com/doc/geo-search/geo-search-overview)
+ * [Security](https://www.algolia.com/doc/security/best-security-practices)
+ * [API-Keys](https://www.algolia.com/doc/security/api-keys)
+ * [REST API](https://www.algolia.com/doc/rest)
 <!--/NO_HTML-->
-Setup
-============
-To setup your project, follow these steps:
+## Getting Started
+### Install
+Install AlgoliaSearch using:
+```bash
+gem install algoliasearch
+```
+#### Ruby on Rails
+If you're a Ruby on Rails user; you're probably looking for the [algoliasearch-rails](https://github.com/algolia/algoliasearch-rails) gem.
- 1. Install AlgoliaSearch using <code>gem install algoliasearch</code>.
- 2. Initialize the client with your ApplicationID and API-Key. You can find all of them on [your Algolia account](http://www.algolia.com/users/edit).
+### Init index - `init_index`
+To initialize the client, you need your **Application ID** and **API Key**. You can find both of them on [your Algolia account](https://www.algolia.com/api-keys).
 ```ruby
 require 'rubygems'
@@ -78,14 +159,10 @@ Algolia.init :application_id => "YourApplicationID",
              :api_key        => "YourAPIKey"
 ```
-### Ruby on Rails
-If you're a Ruby on Rails user; you're probably looking for the [algoliasearch-rails](https://github.com/algolia/algoliasearch-rails) gem.
+### Quick Start
-Quick Start
--------------
 In 30 seconds, this quick start tutorial will show you how to index and search objects.
@@ -98,6 +175,7 @@ index.add_objects(batch)
 ```
 You can now search for contacts using firstname, lastname, company, etc. (even with typos):
 ```ruby
 # search by firstname
 puts index.search('jimmie').to_json
@@ -110,17 +188,20 @@ puts index.search('jimmie paint').to_json
 ```
 Settings can be customized to tune the search behavior. For example, you can add a custom sort by number of followers to the already great built-in relevance:
 ```ruby
 index.set_settings({"customRanking" => ["desc(followers)"]})
 ```
 You can also configure the list of attributes you want to index by order of importance (first = most important):
 ```ruby
 index.set_settings({"attributesToIndex" => ["lastname", "firstname", "company",
                                             "email", "city", "address"]})
 ```
 Since the engine is designed to suggest results as you type, you'll generally search by prefix. In this case the order of attributes is very important to decide which hit is the best:
 ```ruby
 puts index.search('or').to_json
 puts index.search('jim').to_json
@@ -132,7 +213,7 @@ puts index.search('jim').to_json
   * It will offload unnecessary tasks from your servers
 ```html
-<script src="//cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
+<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
 <script>
 var client = algoliasearch('ApplicationID', 'apiKey');
 var index = client.initIndex('indexName');
@@ -166,34 +247,272 @@ function searchCallback(err, content) {
-<!--NO_HTML-->
-Guides & Tutorials
-================
-Check our [online guides](https://www.algolia.com/doc):
- * [Data Formatting](https://www.algolia.com/doc/indexing/formatting-your-data)
- * [Import and Synchronize data](https://www.algolia.com/doc/indexing/import-synchronize-data/ruby)
- * [Autocomplete](https://www.algolia.com/doc/search/auto-complete)
- * [Instant search page](https://www.algolia.com/doc/search/instant-search)
- * [Filtering and Faceting](https://www.algolia.com/doc/search/filtering-faceting)
- * [Sorting](https://www.algolia.com/doc/relevance/sorting)
- * [Ranking Formula](https://www.algolia.com/doc/relevance/ranking)
- * [Typo-Tolerance](https://www.algolia.com/doc/relevance/typo-tolerance)
- * [Geo-Search](https://www.algolia.com/doc/geo-search/geo-search-overview)
- * [Security](https://www.algolia.com/doc/security/best-security-practices)
- * [API-Keys](https://www.algolia.com/doc/security/api-keys)
- * [REST API](https://www.algolia.com/doc/rest)
+## Search
-<!--/NO_HTML-->
+### Search in an index - `search`
+**Notes:** If you are building a web application, you may be more interested in using our [JavaScript client](https://github.com/algolia/algoliasearch-client-js) to perform queries. It brings two benefits:
+  * Your users get a better response time by not going through your servers
+  * It will offload unnecessary tasks from your servers.
+To perform a search, you only need to initialize the index and perform a call to the search function.
+The search query allows only to retrieve 1000 hits. If you need to retrieve more than 1000 hits (e.g. for SEO), you can use [Backup / Retrieve all index content](#backup--export-an-index).
+```ruby
+index = Algolia::Index.new("contacts")
+res = index.search("query string")
+res = index.search("query string", { "attributesToRetrieve" => "firstname,lastname", "hitsPerPage" => 20})
+```
+### Search Response Format
+#### Sample
+The server response will look like:
+```json
+{
+  "hits": [
+    {
+      "firstname": "Jimmie",
+      "lastname": "Barninger",
+      "objectID": "433",
+      "_highlightResult": {
+        "firstname": {
+          "value": "<em>Jimmie</em>",
+          "matchLevel": "partial"
+        },
+        "lastname": {
+          "value": "Barninger",
+          "matchLevel": "none"
+        },
+        "company": {
+          "value": "California <em>Paint</em> & Wlpaper Str",
+          "matchLevel": "partial"
+        }
+      }
+    }
+  ],
+  "page": 0,
+  "nbHits": 1,
+  "nbPages": 1,
+  "hitsPerPage": 20,
+  "processingTimeMS": 1,
+  "query": "jimmie paint",
+  "params": "query=jimmie+paint&attributesToRetrieve=firstname,lastname&hitsPerPage=50"
+}
+```
+#### Fields
+- `hits` (array): The hits returned by the search, sorted according to the ranking formula.
+    Hits are made of the JSON objects that you stored in the index; therefore, they are mostly schema-less. However, Algolia does enrich them with a few additional fields:
+    - `_highlightResult` (object, optional): Highlighted attributes. *Note: Only returned when [`attributesToHighlight`](#attributestohighlight) is non-empty.*
+        - `${attribute_name}` (object): Highlighting for one attribute.
+            - `value` (string): Markup text with occurrences highlighted. The tags used for highlighting are specified via [`highlightPreTag`](#highlightpretag) and [`highlightPostTag`](#highlightposttag).
+            - `matchLevel` (string, enum) = {`none` | `partial` | `full`}: Indicates how well the attribute matched the search query.
+            - `matchedWords` (array): List of words *from the query* that matched the object.
+            - `fullyHighlighted` (boolean): Whether the entire attribute value is highlighted.
+    - `_snippetResult` (object, optional): Snippeted attributes. *Note: Only returned when [`attributesToSnippet`](#attributestosnippet) is non-empty.*
+        - `${attribute_name}` (object): Snippeting for the corresponding attribute.
+            - `value` (string): Markup text with occurrences highlighted and optional ellipsis indicators. The tags used for highlighting are specified via [`highlightPreTag`](#highlightpretag) and [`highlightPostTag`](#highlightposttag). The text used to indicate ellipsis is specified via [`snippetEllipsisText`](#snippetellipsistext).
+            - `matchLevel` (string, enum) = {`none` | `partial` | `full`}: Indicates how well the attribute matched the search query.
+    - `_rankingInfo` (object, optional): Ranking information. *Note: Only returned when [`getRankingInfo`](#getrankinginfo) is `true`.*
+        - `nbTypos` (integer): Number of typos encountered when matching the record. Corresponds to the `typos` ranking criterion in the ranking formula.
+        - `firstMatchedWord` (integer): Position of the most important matched attribute in the attributes to index list. Corresponds to the `attribute` ranking criterion in the ranking formula.
+        - `proximityDistance` (integer): When the query contains more than one word, the sum of the distances between matched words. Corresponds to the `proximity` criterion in the ranking formula.
+        - `userScore` (integer): Custom ranking for the object, expressed as a single numerical value. Conceptually, it's what the position of the object would be in the list of all objects sorted by custom ranking. Corresponds to the `custom` criterion in the ranking formula.
+        - `geoDistance` (integer): Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision.
+        - `geoPrecision` (integer): Precision used when computed the geo distance, in meters. All distances will be floored to a multiple of this precision.
+        - `nbExactWords` (integer): Number of exactly matched words. If `alternativeAsExact` is set, it may include plurals and/or synonyms.
+        - `words` (integer): Number of matched words, including prefixes and typos.
+        - `filters` (integer): *This field is reserved for advanced usage.* It will be zero in most cases.
+    - `_distinctSeqID` (integer): *Note: Only returned when [`distinct`](#distinct) is non-zero.* When two consecutive results have the same value for the attribute used for "distinct", this field is used to distinguish between them.
+- `nbHits` (integer): Number of hits that the search query matched.
+- `page` (integer): Index of the current page (zero-based). See the [`page`](#page) search parameter.
+- `hitsPerPage` (integer): Maximum number of hits returned per page. See the [`hitsPerPage`](#hitsperpage) search parameter.
+- `nbPages` (integer): Number of pages corresponding to the number of hits. Basically, `ceil(nbHits / hitsPerPage)`.
+- `processingTimeMS` (integer): Time that the server took to process the request, in milliseconds. *Note: This does not include network time.*
+- `query` (string): An echo of the query text. See the [`query`](#query) search parameter.
+- `queryAfterRemoval` (string, optional): *Note: Only returned when [`removeWordsIfNoResults`](#removewordsifnoresults) is set.* A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. The removed parts are surrounded by `<em>` tags.
+- `params` (string, URL-encoded): An echo of all search parameters.
+- `message` (string, optional): Used to return warnings about the query.
+- `aroundLatLng` (string, optional): *Note: Only returned when [`aroundLatLngViaIP`](#aroundlatlngviaip) is set.* The computed geo location. **Warning: for legacy reasons, this parameter is a string and not an object.** Format: `${lat},${lng}`, where the latitude and longitude are expressed as decimal floating point numbers.
+- `automaticRadius` (integer, optional): *Note: Only returned for geo queries without an explicitly specified radius (see `aroundRadius`).* The automatically computed radius. **Warning: for legacy reasons, this parameter is a string and not an integer.**
+When [`getRankingInfo`](#getrankinginfo) is set to `true`, the following additional fields are returned:
+- `serverUsed` (string): Actual host name of the server that processed the request. (Our DNS supports automatic failover and load balancing, so this may differ from the host name used in the request.)
+- `parsedQuery` (string): The query string that will be searched, after normalization.
+- `timeoutCounts` (boolean): Whether a timeout was hit when computing the facet counts. When `true`, the counts will be interpolated (i.e. approximate). See also `exhaustiveFacetsCount`.
+- `timeoutHits` (boolean): Whether a timeout was hit when retrieving the hits. When true, some results may be missing.
+... and ranking information is also added to each of the hits (see above).
+When [`facets`](#facets) is non-empty, the following additional fields are returned:
+- `facets` (object): Maps each facet name to the corresponding facet counts:
+    - `${facet_name}` (object): Facet counts for the corresponding facet name:
+        - `${facet_value}` (integer): Count for this facet value.
+- `facets_stats` (object, optional): *Note: Only returned when at least one of the returned facets contains numerical values.* Statistics for numerical facets:
+    - `${facet_name}` (object): The statistics for a given facet:
+        - `min` (integer | float): The minimum value in the result set.
+        - `max` (integer | float): The maximum value in the result set.
+        - `avg` (integer | float): The average facet value in the result set.
+        - `sum` (integer | float): The sum of all values in the result set.
+- `exhaustiveFacetsCount` (boolean): Whether the counts are exhaustive (`true`) or approximate (`false`). *Note: When using [`distinct`](#distinct), the facet counts cannot be exhaustive.*
+### Search Parameters
+<!--PARAMETERS_LINK-->
+Here is the list of parameters you can use with the search method (`search` [scope](#scope)):
+Parameters that can also be used in a setSettings also have the `indexing` [scope](#scope)
+**Search**
+- [query](#query) `search`
+**Attributes**
+- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
+**Filtering / Faceting**
+- [filters](#filters) `search`
+- [facets](#facets) `search`
+- [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
+**Highlighting / Snippeting**
+- [attributesToHighlight](#attributestohighlight) `settings`, `search`
+- [attributesToSnippet](#attributestosnippet) `settings`, `search`
+- [highlightPreTag](#highlightpretag) `settings`, `search`
+- [highlightPostTag](#highlightposttag) `settings`, `search`
+- [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
-Add a new object to the Index
-==================
+**Pagination**
+- [page](#page) `search`
+- [hitsPerPage](#hitsperpage) `settings`, `search`
+**Typos**
+- [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
+- [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
+- [typoTolerance](#typotolerance) `settings`, `search`
+- [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
+- [ignorePlurals](#ignoreplurals) `settings`, `search`
+- [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
+**Geo-Search**
+- [aroundLatLng](#aroundlatlng) `search`
+- [aroundLatLngViaIP](#aroundlatlngviaip) `search`
+- [aroundRadius](#aroundradius) `search`
+- [aroundPrecision](#aroundprecision) `search`
+- [minimumAroundRadius](#minimumaroundradius) `search`
+- [insideBoundingBox](#insideboundingbox) `search`
+- [insidePolygon](#insidepolygon) `search`
+**Query Strategy**
+- [queryType](#querytype) `settings`, `search`
+- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
+- [advancedSyntax](#advancedsyntax) `settings`, `search`
+- [optionalWords](#optionalwords) `settings`, `search`
+- [removeStopWords](#removestopwords) `settings`, `search`
+- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
+- [alternativesAsExact](#alternativesasexact) `settings`, `search`
+**Advanced**
+- [distinct](#distinct) `settings`, `search`
+- [getRankingInfo](#getrankinginfo) `search`
+- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
+- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
+- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
+- [analytics](#analytics) `search`
+<!--/PARAMETERS_LINK-->
+### Find by IDs - `get_objects`
+You can easily retrieve an object using its `objectID` and optionally specify a comma separated list of attributes you want:
+```ruby
+# Retrieves all attributes
+index.get_object("myID")
+# Retrieves firstname and lastname attributes
+res = index.get_object("myID", "firstname,lastname")
+# Retrieves only the firstname attribute
+res = index.get_object("myID", "firstname")
+```
+You can also retrieve a set of objects:
+```ruby
+res = index.get_objects(["myID", "myID2"])
+```
+## Indexing
+### Add objects - `add_objects`
 Each entry in an index has a unique identifier called `objectID`. There are two ways to add an entry to the index:
@@ -219,8 +538,8 @@ res = index.add_object({"firstname" => "Jimmie",
 puts "ObjectID=" + res["objectID"]
 ```
-Update an existing object in the Index
-==================
+### Update objects - `save_objects`
 You have three options when updating an existing object:
@@ -237,6 +556,8 @@ index.save_object({"firstname" => "Jimmie",
                    "objectID" => "myID"})
 ```
+### Partial update - `partial_update_objects`
 You have many ways to update an object's attributes:
  1. Set the attribute value
@@ -294,1726 +615,1442 @@ index.partial_update_object({"price" => {"value" => 42, "_operation" => "Decreme
 Note: Here we are decrementing the value by `42`. To decrement just by one, put
 `value:1`.
-Search
-==================
+### Delete objects - `delete_objects`
-**Notes:** If you are building a web application, you may be more interested in using our [JavaScript client](https://github.com/algolia/algoliasearch-client-js) to perform queries. It brings two benefits:
-  * Your users get a better response time by not going through your servers
-  * It will offload unnecessary tasks from your servers.
+You can delete an object using its `objectID`:
+```ruby
+index.delete_object("myID")
+```
+### Delete by query - `delete_by_query`
+You can delete all objects matching a single query with the following code. Internally, the API client performs the query, deletes all matching hits, and waits until the deletions have been applied.
-To perform a search, you only need to initialize the index and perform a call to the search function.
-The search query allows only to retrieve 1000 hits, if you need to retrieve more than 1000 hits for seo, you can use [Backup / Retrieve all index content](#backup--export-an-index)
+Take your precautions when using this method. Calling it with an empty query will result in cleaning the index of all its records.
 ```ruby
-index = Algolia::Index.new("contacts")
-res = index.search("query string")
-res = index.search("query string", { "attributesToRetrieve" => "firstname,lastname", "hitsPerPage" => 20})
+params = {}
+index.delete_by_query("John", params)
 ```
-The server response will look like:
+### Wait for operations - `wait_task`
-```json
-{
-  "hits": [
-    {
-      "firstname": "Jimmie",
-      "lastname": "Barninger",
-      "objectID": "433",
-      "_highlightResult": {
-        "firstname": {
-          "value": "<em>Jimmie</em>",
-          "matchLevel": "partial"
-        },
-        "lastname": {
-          "value": "Barninger",
-          "matchLevel": "none"
-        },
-        "company": {
-          "value": "California <em>Paint</em> & Wlpaper Str",
-          "matchLevel": "partial"
-        }
-      }
-    }
-  ],
-  "page": 0,
-  "nbHits": 1,
-  "nbPages": 1,
-  "hitsPerPage": 20,
-  "processingTimeMS": 1,
-  "query": "jimmie paint",
-  "params": "query=jimmie+paint&attributesToRetrieve=firstname,lastname&hitsPerPage=50"
-}
+All write operations in Algolia are asynchronous by design.
+It means that when you add or update an object to your index, our servers will
+reply to your request with a `taskID` as soon as they understood the write
+operation.
+The actual insert and indexing will be done after replying to your code.
+You can wait for a task to complete using  the same method with a `!`.
+For example, to wait for indexing of a new object:
+```ruby
+res = index.add_object!({"firstname" => "Jimmie",
+                         "lastname" => "Barninger"})
 ```
-You can use the following optional arguments:
+If you want to ensure multiple objects have been indexed, you only need to check
+the biggest `taskID` with `wait_task`.
-## Full Text Search Parameters
-<table><tbody>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>query</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The instant search query string, used to set the string you want to search in your index. If no query parameter is set, the textual search will match with all the objects.</p>
+## Settings
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>queryType</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>prefixLast</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Selects how the query words are interpreted. It can be one of the following values:</p>
-<ul>
-<li><code>prefixAll</code>: All query words are interpreted as prefixes. This option is not recommended.</li>
-<li><code>prefixLast</code>: Only the last word is interpreted as a prefix (default behavior).</li>
-<li><code>prefixNone</code>: No query word is interpreted as a prefix. This option is not recommended.</li>
-</ul>
+### Get settings - `get_settings`
-      </td>
-    </tr>
+You can retrieve settings:
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>removeWordsIfNoResults</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>none</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>This option is used to select a strategy in order to avoid having an empty result page. There are three different options:</p>
+```ruby
+res = index.get_settings
+puts settings.to_json
+```
-<ul>
-<li><code>lastWords</code>: When a query does not return any results, the last word will be added as optional. The process is repeated with n-1 word, n-2 word, ... until there are results.</li>
-<li><code>firstWords</code>: When a query does not return any results, the first word will be added as optional. The process is repeated with second word, third word, ... until there are results.</li>
-<li><code>allOptional</code>: When a query does not return any results, a second trial will be made with all words as optional. This is equivalent to transforming the AND operand between query terms to an OR operand.</li>
-<li><code>none</code>: No specific processing is done when a query does not return any results (default behavior).</li>
-</ul>
+### Set settings - `set_settings`
-      </td>
-    </tr>
+```ruby
+index.set_settings({"customRanking" => ["desc(followers)"]})
+```
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>minWordSizefor1Typo</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>number</strong></em></div><div><em>Default: <strong>4</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The minimum number of characters in a query word to accept one typo in this word.<br/>Defaults to 4.</p>
+**Warning**
-      </td>
-    </tr>
+Performance wise, it's better to do a `set_settings` before pushing the data
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>minWordSizefor2Typos</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>number</strong></em></div><div><em>Default: <strong>8</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The minimum number of characters in a query word to accept two typos in this word.<br/>Defaults to 8.</p>
+#### Slave settings
-      </td>
-    </tr>
+You can forward all settings updates to the slaves of an index by using the `forwardToSlaves` option:
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>typoTolerance</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>true</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>This option allows you to control the number of typos allowed in the result set:</p>
+```ruby
+index.set_settings({"customRanking" => ["desc(followers)"]}, {"forwardToSlave" => true})
+```
-<ul>
-<li><code>true</code>: The typo tolerance is enabled and all matching hits are retrieved (default behavior).</li>
-<li><code>false</code>: The typo tolerance is disabled. All results with typos will be hidden.</li>
-<li><code>min</code>: Only keep results with the minimum number of typos. For example, if one result matches without typos, then all results with typos will be hidden.</li>
-<li><code>strict</code>: Hits matching with 2 typos are not retrieved if there are some matching without typos.</li>
-</ul>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>allowTyposOnNumericTokens</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>true</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>If set to false, disables typo tolerance on numeric tokens (numbers). Defaults to true.</p>
+### Index settings parameters
-      </td>
-    </tr>
+<!--PARAMETERS_LINK-->
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>ignorePlural</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>false</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>If set to true, plural won&#39;t be considered as a typo. For example, car and cars, or foot and feet will be considered as equivalent. Defaults to false.</p>
+Here is the list of parameters you can use with the set settings method (`indexing` [scope](#scope))
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>disableTypoToleranceOnAttributes</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>[]</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>List of attributes on which you want to disable typo tolerance (must be a subset of the <code>attributesToIndex</code> index setting). Attributes are separated with a comma such as <code>&quot;name,address&quot;</code>. You can also use JSON string array encoding such as <code>encodeURIComponent(&quot;[\&quot;name\&quot;,\&quot;address\&quot;]&quot;)</code>. By default, this list is empty.</p>
+Parameters that can be overridden at search time also have the `search` [scope](#scope)
-      </td>
-    </tr>
+**Attributes**
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>restrictSearchableAttributes</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>attributesToIndex</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>List of attributes you want to use for textual search (must be a subset of the <code>attributesToIndex</code> index setting). Attributes are separated with a comma such as <code>&quot;name,address&quot;</code>. You can also use JSON string array encoding such as <code>encodeURIComponent(&quot;[\&quot;name\&quot;,\&quot;address\&quot;]&quot;)</code>. By default, all attributes specified in the <code>attributesToIndex</code> settings are used to search.</p>
+- [attributesToIndex](#attributestoindex) `settings`
+- [attributesForFaceting](#attributesforfaceting) `settings`
+- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
+- [unretrievableAttributes](#unretrievableattributes) `settings`
-      </td>
-    </tr>
+**Ranking**
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>removeStopWords</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>false</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Remove stop words from the query <strong>before</strong> executing it. Defaults to <code>false</code>. Use a boolean to enable/disable all 41 supported languages and a comma separated list of iso codes of the languages you want to use consider to enable the stopwords removal on a subset of them (select the one you have in your records). In most use-cases, you shouldn&#39;t need to enable this option.</p>
+- [ranking](#ranking) `settings`
+- [customRanking](#customranking) `settings`
+- [slaves](#slaves) `settings`
-<p>List of 41 supported languages with their associated iso code: Arabic=ar, Armenian=hy, Basque=eu, Bengali=bn, Brazilian=pt-br, Bulgarian=bg, Catalan=ca, Chinese=zh, Czech=cs, Danish=da, Dutch=nl, English=en, Finnish=fi, French=fr, Galician=gl, German=de, Greek=el, Hindi=hi, Hungarian=hu, Indonesian=id, Irish=ga, Italian=it, Japanese=ja, Korean=ko, Kurdish=ku, Latvian=lv, Lithuanian=lt, Marathi=mr, Norwegian=no, Persian (Farsi)=fa, Polish=pl, Portugese=pt, Romanian=ro, Russian=ru, Slovak=sk, Spanish=es, Swedish=sv, Thai=th, Turkish=tr, Ukranian=uk, Urdu=ur</p>
+**Filtering / Faceting**
-<p>Stop words removal is applied on query words that are not interpreted as a prefix. The behavior depends of the queryType parameter:</p>
+- [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
-<ul>
-<li><p><code>queryType=prefixLast</code> means the last query word is a prefix and it won’t be considered for stop words removal</p></li>
-<li><p><code>queryType=prefixNone</code> means no query word are prefix, stop words removal will be applied on all query words</p></li>
-<li><p><code>queryType=prefixAll</code> means all query terms are prefix, stop words won’t be removed</p></li>
-</ul>
+**Highlighting / Snippeting**
-<p>This parameter is useful when you have a query in natural language like “what is a record?”. In this case, before executing the query, we will remove “what”, “is” and “a” in order to just search for “record”. This removal will remove false positive because of stop words, especially when combined with optional words. For most use cases, it is better to not use this feature as people search by keywords on search engines.</p>
+- [attributesToHighlight](#attributestohighlight) `settings`, `search`
+- [attributesToSnippet](#attributestosnippet) `settings`, `search`
+- [highlightPreTag](#highlightpretag) `settings`, `search`
+- [highlightPostTag](#highlightposttag) `settings`, `search`
+- [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
-      </td>
-    </tr>
+**Pagination**
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>exactOnSingleWordQuery</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>attribute</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>This parameter control how the <code>exact</code> ranking criterion is computed when the query contains one word. There is three different values:</p>
+- [hitsPerPage](#hitsperpage) `settings`, `search`
-<ul>
-<li><p><code>none</code>: no exact on single word query</p></li>
-<li><p><code>word</code>: exact set to 1 if the query word is found in the record. The query word needs to have at least 3 chars and not be part of our stop words dictionary</p></li>
-<li><p><code>attribute</code> (default): exact set to 1 if there is an attribute containing a string equals to the query</p></li>
-</ul>
+**Typos**
-      </td>
-    </tr>
+- [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
+- [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
+- [typoTolerance](#typotolerance) `settings`, `search`
+- [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
+- [ignorePlurals](#ignoreplurals) `settings`, `search`
+- [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
+- [separatorsToIndex](#separatorstoindex) `settings`
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>alternativesAsExact</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>["ignorePlurals", "singleWordSynonym"]</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Specify the list of approximation that should be considered as an exact match in the ranking formula:</p>
+**Query Strategy**
-<ul>
-<li><p><code>ignorePlurals</code>: alternative words added by the ignorePlurals feature</p></li>
-<li><p><code>singleWordSynonym</code>: single-word synonym (For example &quot;NY&quot; = &quot;NYC&quot;)</p></li>
-<li><p><code>multiWordsSynonym</code>: multiple-words synonym (For example &quot;NY&quot; = &quot;New York&quot;)</p></li>
-</ul>
+- [queryType](#querytype) `settings`, `search`
+- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
+- [advancedSyntax](#advancedsyntax) `settings`, `search`
+- [optionalWords](#optionalwords) `settings`, `search`
+- [removeStopWords](#removestopwords) `settings`, `search`
+- [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
+- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
+- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
+- [alternativesAsExact](#alternativesasexact) `settings`, `search`
-      </td>
-    </tr>
+**Advanced**
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>advancedSyntax</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>0 (false)</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Enables the advanced query syntax. Defaults to 0 (false).</p>
+- [attributeForDistinct](#attributefordistinct) `settings`
+- [distinct](#distinct) `settings`, `search`
+- [numericAttributesToIndex](#numericattributestoindex) `settings`
+- [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
+- [altCorrections](#altcorrections) `settings`
+- [placeholders](#placeholders) `settings`
-<ul>
-<li><strong>Phrase query</strong>: A phrase query defines a particular sequence of terms. A phrase query is built by Algolia&#39;s query parser for words surrounded by <code>&quot;</code>. For example, <code>&quot;search engine&quot;</code> will retrieve records having <code>search</code> next to <code>engine</code> only. Typo tolerance is <em>disabled</em> on phrase queries.</li>
-<li><strong>Prohibit operator</strong>: The prohibit operator excludes records that contain the term after the <code>-</code> symbol. For example, <code>search -engine</code> will retrieve records containing <code>search</code> but not <code>engine</code>.</li>
-</ul>
+<!--/PARAMETERS_LINK-->
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>analytics</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>true</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>If set to false, this query will not be taken into account in the analytics feature. Defaults to true.</p>
+## Parameters
-      </td>
-    </tr>
+### Overview
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>synonyms</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>true</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>If set to false, this query will not use synonyms defined in the configuration. Defaults to true.</p>
+#### Scope
-      </td>
-    </tr>
+Each parameter in this page has a scope. Depending on the scope, you can use the parameter within the `setSettings`
+and/or the `search` method
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>replaceSynonymsInHighlight</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>true</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>If set to false, words matched via synonym expansion will not be replaced by the matched synonym in the highlight results. Defaults to true.</p>
+They are three scopes:
-      </td>
-    </tr>
+- `settings`: The setting can only be used in the `setSettings` method
+- `search`: The setting can only be used in the `search` method
+- `settings` `search`: The setting can be used in the `setSettings` method and be override in the`search` method
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>optionalWords</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>[]</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>A string that contains the comma separated list of words that should be considered as optional when found in the query.</p>
-      </td>
-    </tr>
-</tbody></table>
+#### Parameters List
-## Pagination Parameters
+**Search**
-<table><tbody>
+- [query](#query) `search`
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>page</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>integer</strong></em></div><div><em>Default: <strong>0</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Pagination parameter used to select the page to retrieve.<br/>Page is zero based and defaults to 0. Thus, to retrieve the 10th page you need to set <code>page=9</code>.</p>
+**Attributes**
-      </td>
-    </tr>
+- [attributesForFaceting](#attributesforfaceting) `settings`
+- [attributesToIndex](#attributestoindex) `settings`
+- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
+- [unretrievableAttributes](#unretrievableattributes) `settings`
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>hitsPerPage</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>integer</strong></em></div><div><em>Default: <strong>20</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Pagination parameter used to select the number of hits per page. Defaults to 20.</p>
-      </td>
-    </tr>
+**Ranking**
-</tbody></table>
+- [ranking](#ranking) `settings`
+- [customRanking](#customranking) `settings`
+- [slaves](#slaves) `settings`
+**Filtering / Faceting**
-## Geo-search Parameters
-<table><tbody>
+- [filters](#filters) `search`
+- [facets](#facets) `search`
+- [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>aroundLatLng</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Search for entries around a given latitude/longitude (specified as two floats separated by a comma).<br/>For example, <code>aroundLatLng=47.316669,5.016670</code>.</p>
+**Highlighting / Snippeting**
-<p>By default the maximum distance is automatically guessed based on the density of the area but you can specify it manually in meters with the <strong>aroundRadius</strong> parameter. The precision for ranking can be set with <strong>aroundPrecision</strong> parameter. For example, if you set aroundPrecision=100, the distances will be considered by ranges of 100m, for example all distances 0 and 100m will be considered as identical for the &quot;geo&quot; ranking parameter.<br/><br/>When <strong>aroundRadius</strong> is not set, the radius is computed automatically using the density of the area, you can retrieve the computed radius in the <strong>automaticRadius</strong> attribute of the answer, you can also use the <strong>minimumAroundRadius</strong> query parameter to specify a minimum radius in meters for the automatic computation of <strong>aroundRadius</strong>.</p>
+- [attributesToHighlight](#attributestohighlight) `settings`, `search`
+- [attributesToSnippet](#attributestosnippet) `settings`, `search`
+- [highlightPreTag](#highlightpretag) `settings`, `search`
+- [highlightPostTag](#highlightposttag) `settings`, `search`
+- [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
+- [restrictHighlightAndSnippetArrays](#restricthighlightandsnippetarrays) `settings`, `search`
-<p>At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form <code>&quot;_geoloc&quot;:{&quot;lat&quot;:48.853409, &quot;lng&quot;:2.348800}</code> or <code>&quot;_geoloc&quot;:[{&quot;lat&quot;:48.853409, &quot;lng&quot;:2.348800},{&quot;lat&quot;:48.547456, &quot;lng&quot;:2.972075}]</code> if you have several geo-locations in your record).</p>
+**Pagination**
-      </td>
-    </tr>
+- [page](#page) `search`
+- [hitsPerPage](#hitsperpage) `settings`, `search`
+**Typos**
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>aroundLatLngViaIP</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Search for entries around a given latitude/longitude automatically computed from user IP address.<br/>To enable it, use <code>aroundLatLngViaIP=true</code>.</p>
+- [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
+- [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
+- [typoTolerance](#typotolerance) `settings`, `search`
+- [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
+- [ignorePlurals](#ignoreplurals) `settings`, `search`
+- [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
+- [separatorsToIndex](#separatorstoindex) `settings`
-<p>You can specify the maximum distance in meters with the <code>aroundRadius</code> parameter and the precision for ranking with <code>aroundPrecision</code>. For example, if you set aroundPrecision=100, two objects that are in the range 0-99m will be considered as identical in the ranking for the &quot;geo&quot; ranking parameter (same for 100-199, 200-299, ... ranges).</p>
+**Geo-Search**
-<p>At indexing, you should specify the geo location of an object with the <code>_geoloc</code> attribute in the form <code>{&quot;_geoloc&quot;:{&quot;lat&quot;:48.853409, &quot;lng&quot;:2.348800}}</code>.</p>
+- [aroundLatLng](#aroundlatlng) `search`
+- [aroundLatLngViaIP](#aroundlatlngviaip) `search`
+- [aroundRadius](#aroundradius) `search`
+- [aroundPrecision](#aroundprecision) `search`
+- [minimumAroundRadius](#minimumaroundradius) `search`
+- [insideBoundingBox](#insideboundingbox) `search`
+- [insidePolygon](#insidepolygon) `search`
-      </td>
-    </tr>
+**Query Strategy**
+- [queryType](#querytype) `settings`, `search`
+- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
+- [advancedSyntax](#advancedsyntax) `settings`, `search`
+- [optionalWords](#optionalwords) `settings`, `search`
+- [removeStopWords](#removestopwords) `settings`, `search`
+- [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
+- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
+- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
+- [alternativesAsExact](#alternativesasexact) `settings`, `search`
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>insideBoundingBox</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Search entries inside a given area defined by the two extreme points of a rectangle (defined by 4 floats: p1Lat,p1Lng,p2Lat,p2Lng).<br/>For example, <code>insideBoundingBox=47.3165,4.9665,47.3424,5.0201</code>).<br/>At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form <code>&quot;_geoloc&quot;:{&quot;lat&quot;:48.853409, &quot;lng&quot;:2.348800}</code> or <code>&quot;_geoloc&quot;:[{&quot;lat&quot;:48.853409, &quot;lng&quot;:2.348800},{&quot;lat&quot;:48.547456, &quot;lng&quot;:2.972075}]</code> if you have several geo-locations in your record). You can use several bounding boxes (OR) by passing more than 4 values. For example instead of having 4 values you can pass 8 to search inside the UNION of two bounding boxes.</p>
+**Advanced**
-      </td>
-    </tr>
+- [attributeForDistinct](#attributefordistinct) `settings`
+- [distinct](#distinct) `settings`, `search`
+- [getRankingInfo](#getrankinginfo) `search`
+- [numericAttributesToIndex](#numericattributestoindex) `settings`
+- [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
+- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
+- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
+- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
+- [analytics](#analytics) `search`
+- [altCorrections](#altcorrections) `settings`
+- [placeholders](#placeholders) `settings`
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>insidePolygon</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Search entries inside a given area defined by a set of points (defined by a minimum of 6 floats: p1Lat,p1Lng,p2Lat,p2Lng,p3Lat,p3Long).<br/>For example <code>InsidePolygon=47.3165,4.9665,47.3424,5.0201,47.32,4.98</code>).<br/>At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form <code>&quot;_geoloc&quot;:{&quot;lat&quot;:48.853409, &quot;lng&quot;:2.348800}</code> or <code>&quot;_geoloc&quot;:[{&quot;lat&quot;:48.853409, &quot;lng&quot;:2.348800},{&quot;lat&quot;:48.547456, &quot;lng&quot;:2.972075}]</code> if you have several geo-locations in your record).</p>
+### Search
-      </td>
-    </tr>
+#### query
-</tbody></table>
+- scope: `search`
+- type: `string`
+- default: `""`
-## Parameters to Control Results Content
+The instant search query string, used to set the string you want to search in your index. If no query parameter is set, the textual search will match with all the objects.
-<table><tbody>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>attributesToRetrieve</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>A string that contains the list of attributes you want to retrieve in order to minimize the size of the JSON answer.</p>
+### Attributes
-<p>Attributes are separated with a comma (for example <code>&quot;name,address&quot;</code>). You can also use a string array encoding (for example <code>[&quot;name&quot;,&quot;address&quot;]</code> ). By default, all attributes are retrieved. You can also use <code>*</code> to retrieve all values when an <strong>attributesToRetrieve</strong> setting is specified for your index.</p>
+#### attributesToIndex
-<p><code>objectID</code> is always retrieved even when not specified.</p>
+- scope: `settings`
+- type: `array of strings`
+- default: `*`
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>attributesToHighlight</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>A string that contains the list of attributes you want to highlight according to the query. Attributes are separated by commas. You can also use a string array encoding (for example <code>[&quot;name&quot;,&quot;address&quot;]</code>). If an attribute has no match for the query, the raw value is returned. By default, all indexed attributes are highlighted (as long as they are strings). You can use <code>*</code> if you want to highlight all attributes. A matchLevel is returned for each highlighted attribute and can contain:</p>
+The list of attributes you want index (i.e. to make searchable).
-<ul>
-<li><strong>full</strong>: If all the query terms were found in the attribute.</li>
-<li><strong>partial</strong>: If only some of the query terms were found.</li>
-<li><strong>none</strong>: If none of the query terms were found.</li>
-</ul>
+If set to null, all textual and numerical attributes of your objects are indexed.
+Make sure you updated this setting to get optimal results.
-      </td>
-    </tr>
+This parameter has two important uses:
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>attributesToSnippet</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>A string that contains the list of attributes to snippet alongside the number of words to return (syntax is <code>attributeName:nbWords</code>). Attributes are separated by commas (Example: <code>attributesToSnippet=name:10,content:10</code>).</p>
+1. **Limit the attributes to index.** For example, if you store the URL of a picture, you want to store it and be able to retrieve it, but you probably don't want to search in the URL.
-<p>You can also use a string array encoding (Example: <code>attributesToSnippet: [&quot;name:10&quot;,&quot;content:10&quot;]</code>). By default, no snippet is computed.</p>
+2. **Control part of the ranking.** The contents of the `attributesToIndex` parameter impacts ranking in two complementary ways:
-      </td>
-    </tr>
+    First, the order in which attributes are listed defines their ranking priority: matches in attributes at the beginning of the list will be considered more important than matches in attributes further down the list. To assign the same priority to several attributes, pass them within the same string, separated by commas. For example, by specifying `["title,"alternative_title", "text"]`, `title` and `alternative_title` will have the same priority, but a higher priority than `text`.
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>getRankingInfo</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>If set to 1, the result hits will contain ranking information in the <code>_rankingInfo</code> attribute.</p>
+    Then, within the same attribute, matches near the beginning of the text will be considered more important than matches near the end. You can disable this behavior by wrapping your attribute name inside an `unordered()` modifier. For example, `["title", "unordered(text)"]` will consider all positions inside the `text` attribute as equal, but positions inside the `title` attribute will still matter.
-      </td>
-    </tr>
+**Note:** To get a full description of how the ranking works, you can have a look at our [Ranking guide](https://www.algolia.com/doc/guides/relevance/ranking).
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>highlightPreTag</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string</strong></em></div><div><em>Default: <strong>&lt;em&gt;</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Specify the string that is inserted before the highlighted parts in the query result (defaults to <code>&lt;em&gt;</code>).</p>
-      </td>
-    </tr>
+#### attributesForFaceting
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>highlightPostTag</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string</strong></em></div><div><em>Default: <strong>&lt;/em&gt;</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Specify the string that is inserted after the highlighted parts in the query result (defaults to <code>&lt;/em&gt;</code>)</p>
+- scope: `settings`
+- type: `array of strings`
+- default: `null`
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>snippetEllipsisText</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string</strong></em></div><div><em>Default: <strong>''</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>String used as an ellipsis indicator when a snippet is truncated. Defaults to an empty string for all accounts created before 10/2/2016, and to <code>…</code> (UTF-8 U+2026) for accounts created after that date.</p>
+The list of attributes you want to use for faceting.
+All strings within these attributes will be extracted and added as facets.
+If set to `null`, no attribute is used for faceting.
-      </td>
-    </tr>
+#### unretrievableAttributes
+- scope: `settings`
+- type: `array of strings`
+- default: `null`
+The list of attributes that cannot be retrieved at query time.
+This feature allows you to have attributes that are used for indexing
+and/or ranking but cannot be retrieved.
-</tbody></table>
+**Warning**: For testing purposes, this setting is ignored when you're using the **admin** API key.
-## Numeric Search Parameters
+#### attributesToRetrieve
-<table><tbody>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>numericFilters</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>A string that contains the comma separated list of numeric filters you want to apply. The filter syntax is <code>attributeName</code> followed by <code>operand</code> followed by <code>value</code>. Supported operands are <code>&lt;</code>, <code>&lt;=</code>, <code>=</code>, <code>&gt;</code> and <code>&gt;=</code>.</p>
+- scope: `settings`, `search`
+- type: `array of strings`
+- default: `*`
-      </td>
-    </tr>
-</tbody></table>
-You can easily perform range queries via the `:` operator. This is equivalent to combining a `>=` and `<=` operand. For example, `numericFilters=price:10 to 1000`.
+A string that contains the list of attributes you want to retrieve in order to minimize the size of the JSON answer.
-You can also mix OR and AND operators. The OR operator is defined with a parenthesis syntax. For example, `(code=1 AND (price:[0-100] OR price:[1000-2000]))` translates to `encodeURIComponent("code=1,(price:0 to 100,price:1000 to 2000)")`.
+Attributes are separated with a comma (for example `"name,address"`).
+You can also use a string array encoding (for example `["name","address"]` ).
+By default, all attributes are retrieved.
+You can also use `*` to retrieve all values when an **attributesToRetrieve** setting is specified for your index.
-You can also use a string array encoding (for example `numericFilters: ["price>100","price<1000"]`).
+**Note:** `objectID` is always retrieved, even when not specified.
-## Category Search Parameters
-<table><tbody>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>tagFilters</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Filter the query by a set of tags. You can AND tags by separating them with commas. To OR tags, you must add parentheses. For example, <code>tagFilters=tag1,(tag2,tag3)</code> means <em>tag1 AND (tag2 OR tag3)</em>. You can also use a string array encoding. For example, <code>tagFilters: [&quot;tag1&quot;,[&quot;tag2&quot;,&quot;tag3&quot;]]</code> means <em>tag1 AND (tag2 OR tag3)</em>. Negations are supported via the <code>-</code> operator, prefixing the value. For example: <code>tagFilters=tag1,-tag2</code>.</p>
+#### restrictSearchableAttributes
-<p>At indexing, tags should be added in the <strong>_tags</strong> attribute of objects. For example <code>{&quot;_tags&quot;:[&quot;tag1&quot;,&quot;tag2&quot;]}</code>.</p>
+- scope: `search`
+- type: `array of strings`
+- default: `attributesToIndex`
-      </td>
-    </tr>
-</tbody></table>
-## Faceting Parameters
+List of attributes you want to use for textual search (must be a subset of the `attributesToIndex` index setting).
+Attributes are separated with a comma such as `"name,address"`.
+You can also use JSON string array encoding such as `encodeURIComponent("[\"name\",\"address\"]")`.
+By default, all attributes specified in the `attributesToIndex` settings are used to search.
-<table><tbody>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>facetFilters</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Filter the query with a list of facets. Facets are separated by commas and is encoded as <code>attributeName:value</code>. To OR facets, you must add parentheses. For example: <code>facetFilters=(category:Book,category:Movie),author:John%20Doe</code>. You can also use a string array encoding. For example, <code>[[&quot;category:Book&quot;,&quot;category:Movie&quot;],&quot;author:John%20Doe&quot;]</code>.</p>
+### Ranking
-      </td>
-    </tr>
+#### ranking
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>facets</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>List of object attributes that you want to use for faceting. For each of the declared attributes, you&#39;ll be able to retrieve a list of the most relevant facet values, and their associated count for the current query.</p>
+- scope: `settings`
+- type: `array of strings`
+- default: `['typo', 'geo', 'words', 'filters', 'proximity', 'attribute', 'exact', 'custom']`
-<p>Attributes are separated by a comma. For example, <code>&quot;category,author&quot;</code>. You can also use JSON string array encoding. For example, <code>[&quot;category&quot;,&quot;author&quot;]</code>. Only the attributes that have been added in <strong>attributesForFaceting</strong> index setting can be used in this parameter. You can also use <code>*</code> to perform faceting on all attributes specified in <code>attributesForFaceting</code>. If the number of results is important, the count can be approximate, the attribute <code>exhaustiveFacetsCount</code> in the response is true when the count is exact.</p>
-      </td>
-    </tr>
+Controls the way results are sorted.
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>maxValuesPerFacet</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Limit the number of facet values returned for each facet. For example, <code>maxValuesPerFacet=10</code> will retrieve a maximum of 10 values per facet.</p>
+We have nine available criterion:
-      </td>
-    </tr>
+* `typo`: Sort according to number of typos.
+* `geo`: Sort according to decreasing distance when performing a geo location based search.
+* `words`: Sort according to the number of query words matched by decreasing order. This parameter is useful when you use the `optionalWords` query parameter to have results with the most matched words first.
+* `proximity`: Sort according to the proximity of the query words in hits.
+* `attribute`: Sort according to the order of attributes defined by attributesToIndex.
+* `exact`:
+  * If the user query contains one word: sort objects having an attribute that is exactly the query word before others. For example, if you search for the TV show "V", you want to find it with the "V" query and avoid getting all popular TV shows starting by the letter V before it.
+  * If the user query contains multiple words: sort according to the number of words that matched exactly (not as a prefix).
+* `custom`: Sort according to a user defined formula set in the `customRanking` attribute.
+* `asc(attributeName)`: Sort according to a numeric attribute using ascending order. `attributeName` can be the name of any numeric attribute in your records (integer, double or boolean).
+* `desc(attributeName)`: Sort according to a numeric attribute using descending order. `attributeName` can be the name of any numeric attribute in your records (integer, double or boolean).
-</tbody></table>
+To get a full description of how the Ranking works,
+you can have a look at our [Ranking guide](https://www.algolia.com/doc/guides/relevance/ranking).
-## Unified Filter Parameter (SQL - like)
+#### customRanking
-<table><tbody>
+- scope: `settings`
+- type: `array of strings`
+- default: `[]`
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>filters</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Filter the query with numeric, facet or/and tag filters. The syntax is a SQL like syntax, you can use the OR and AND keywords. The syntax for the underlying numeric, facet and tag filters is the same than in the other filters:
-<code>available=1 AND (category:Book OR NOT category:Ebook) AND _tags:public</code>
-<code>date: 1441745506 TO 1441755506 AND inStock &gt; 0 AND author:&quot;John Doe&quot;</code></p>
-<p>If no attribute name is specified, the filter applies to <code>_tags</code>. For example: <code>public OR user_42</code> will translate to <code>_tags:public OR _tags:user_42</code>.</p>
+Lets you specify part of the ranking.
-<p>The list of keywords is:</p>
+The syntax of this condition is an array of strings containing attributes
+prefixed by the asc (ascending order) or desc (descending order) operator.
-<ul>
-<li><code>OR</code>: create a disjunctive filter between two filters.</li>
-<li><code>AND</code>: create a conjunctive filter between two filters.</li>
-<li><code>TO</code>: used to specify a range for a numeric filter.</li>
-<li><code>NOT</code>: used to negate a filter. The syntax with the <code>-</code> isn’t allowed.</li>
-</ul>
+For example, `"customRanking" => ["desc(population)", "asc(name)"]`.
-      </td>
-    </tr>
-</tbody></table>
-*Note*: To specify a value with spaces or with a value equal to a keyword, it's possible to add quotes.
+To get a full description of how the Custom Ranking works,
+you can have a look at our [Ranking guide](https://www.algolia.com/doc/guides/relevance/ranking).
-**Warning:**
+#### slaves
-* Like for the other filters (for performance reasons), it's not possible to have FILTER1 OR (FILTER2 AND FILTER3).
-* It's not possible to mix different categories of filters inside an OR like: num=3 OR tag1 OR facet:value
-* It's not possible to negate a group, it's only possible to negate a filter:  NOT(FILTER1 OR (FILTER2) is not allowed.
+- scope: `settings`
+- type: `array of strings`
+- default: `[]`
-## Distinct Parameter
+The list of indices on which you want to replicate all write operations.
-<table><tbody>
+In order to get response times in milliseconds, we pre-compute part of the ranking during indexing.
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>distinct</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>If set to 1, enables the distinct feature, disabled by default, if the <code>attributeForDistinct</code> index setting is set. This feature is similar to the SQL &quot;distinct&quot; keyword. When enabled in a query with the <code>distinct=1</code> parameter, all hits containing a duplicate value for the attributeForDistinct attribute are removed from results. For example, if the chosen attribute is <code>show_name</code> and several hits have the same value for <code>show_name</code>, then only the best one is kept and the others are removed.</p>
+If you want to use different ranking configurations depending of the use case,
+you need to create one index per ranking configuration.
-      </td>
-    </tr>
+This option enables you to perform write operations only on this index and automatically
+update slave indices with the same operations.
-</tbody></table>
+### Filtering / Faceting
-To get a full understanding of how `Distinct` works, you can have a look at our [guide on distinct](https://www.algolia.com/doc/search/distinct).
+#### filters
+- scope: `search`
+- type: `string`
+- default: `""`
+Filter the query with numeric, facet or/and tag filters.
+The syntax is a SQL like syntax, you can use the OR and AND keywords.
+The syntax for the underlying numeric, facet and tag filters is the same than in the other filters:
-Multiple queries
-==================
+`available=1 AND (category:Book OR NOT category:Ebook) AND _tags:public`
+`date: 1441745506 TO 1441755506 AND inStock > 0 AND author:"John Doe"`
-You can send multiple queries with a single API call using a batch of queries:
+If no attribute name is specified,
+the filter applies to `_tags`.
-```ruby
-# perform 3 queries in a single API call:
-# - 1st query targets index `categories`
-# - 2nd and 3rd queries target index `products`
-res = Algolia.multiple_queries([{:index_name => "categories", "query" => my_query_string, "hitsPerPage" => 3}
-  , {:index_name => "products", "query" => my_query_string, "hitsPerPage" => 3, "filters" => "_tags:promotion"}
-  , {:index_name => "products", "query" => my_query_string, "hitsPerPage" => 10}])
+For example: `public OR user_42` will translate to `_tags:public OR _tags:user_42`.
-puts res["results"]
-```
+The list of keywords is:
-The resulting JSON answer contains a ```results``` array storing the underlying queries answers. The answers order is the same than the requests order.
+* `OR`: create a disjunctive filter between two filters.
+* `AND`: create a conjunctive filter between two filters.
+* `TO`: used to specify a range for a numeric filter.
+* `NOT`: used to negate a filter. The syntax with the `-` isn’t allowed.
-You can specify a `strategy` parameter to optimize your multiple queries:
-- `none`: Execute the sequence of queries until the end.
-- `stopIfEnoughMatches`: Execute the sequence of queries until the number of hits is reached by the sum of hits.
+**Note:** To specify a value with spaces or with a value equal to a keyword, it's possible to add quotes.
+**Warnings:**
+* Like for the other filters (for performance reasons), it's not possible to have `FILTER1 OR (FILTER2 AND FILTER3)`.
+* It is not possible to mix different categories of filters inside an OR like: `num=3 OR tag1 OR facet:value`.
+* It is not possible to negate a group; only individual filters can be negated:  `NOT(FILTER1 OR (FILTER2))` is not allowed.
-Get an object
-==================
-You can easily retrieve an object using its `objectID` and optionally specify a comma separated list of attributes you want:
+#### facets
-```ruby
-# Retrieves all attributes
-index.get_object("myID")
-# Retrieves firstname and lastname attributes
-res = index.get_object("myID", "firstname,lastname")
-# Retrieves only the firstname attribute
-res = index.get_object("myID", "fistname")
+- scope: `search`
+- type: `string`
+- default: `""`
+You can use [facets](#facets) to retrieve only a part of your attributes declared in
+**[attributesForFaceting](#attributesforfaceting)** attributes.
+It will not filter your results, if you want to filter results you should use [filters](#filters).
+For each of the declared attributes, you'll be able to retrieve a list of the most relevant facet values,
+and their associated count for the current query.
+**Example**
+If you have defined in your **[attributesForFaceting](#attributesforfaceting)**:
+```
+["category", "author", "nb_views", "nb_downloads"]
 ```
-You can also retrieve a set of objects:
+... but, for the current search, you want to retrieve facet values only for `category` and `author`, then you can specify:
-```ruby
-res = index.get_objects(["myID", "myID2"])
+```
+["category", "author"]
 ```
-Delete an object
-==================
+**Warnings**
-You can delete an object using its `objectID`:
+- When using [facets](#facets) in a search query, only attributes that have been added in **attributesForFaceting** index setting can be used in this parameter.
+You can also use `*` to perform faceting on all attributes specified in `attributesForFaceting`.
+If the number of results is important, the count can be approximate,
+the attribute `exhaustiveFacetsCount` in the response is true when the count is exact.
-```ruby
-index.delete_object("myID")
-```
+#### maxValuesPerFacet
-Delete by query
-==================
+- scope: `settings`, `search`
+- type: `integer`
+- default: `""`
-You can delete all objects matching a single query with the following code. Internally, the API client performs the query, deletes all matching hits, and waits until the deletions have been applied.
+Limit the number of facet values returned for each facet.
-```ruby
-params = {}
-index.delete_by_query("John", params)
-```
+For example, `maxValuesPerFacet=10` will retrieve a maximum of 10 values per facet.
+### Highlighting / Snippeting
-Index Settings
-==================
+#### attributesToHighlight
-You can easily retrieve or update settings:
+- scope: `settings`, `search`
+- type: `array of strings`
+- default: `null`
-```ruby
-res = index.get_settings
-puts settings.to_json
-```
-```ruby
-index.set_settings({"customRanking" => ["desc(followers)"]})
-```
+Default list of attributes to highlight.
+If set to null, all indexed attributes are highlighted.
-## Slave settings
+A string that contains the list of attributes you want to highlight according to the query.
+Attributes are separated by commas.
+You can also use a string array encoding (for example `["name","address"]`).
+If an attribute has no match for the query, the raw value is returned.
+By default, all indexed attributes are highlighted (as long as they are strings).
+You can use `*` if you want to highlight all attributes.
-You can forward all settings updates to the slaves of an index by using the `forwardToSlaves` option:
+A matchLevel is returned for each highlighted attribute and can contain:
-```ruby
-index.set_settings({"customRanking" => ["desc(followers)"]}, {"forwardToSlave" => true})
-```
+* `full`: If all the query terms were found in the attribute.
+* `partial`: If only some of the query terms were found.
+* `none`: If none of the query terms were found.
-## Indexing parameters
+#### attributesToSnippet
-<table><tbody>
+- scope: `settings`, `search`
+- type: `array of strings`
+- default: `null`
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>attributesToIndex</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>array of strings</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The list of attributes you want index (i.e. to make searchable).</p>
-<p>If set to null, all textual and numerical attributes of your objects are indexed. Make sure you updated this setting to get optimal results.</p>
+Default list of attributes to snippet alongside the number of words to return (syntax is `attributeName:nbWords`).
+If set to null, no snippet is computed.
-<p>This parameter has two important uses:</p>
+#### highlightPreTag
-<ul>
-<li><em>Limit the attributes to index</em>.<br/>For example, if you store the URL of a picture, you want to store it and be able to retrieve it, but you probably don&#39;t want to search in the URL.</li>
-<li><em>Control part of the ranking</em>.<br/> Matches in attributes at the beginning of the list will be considered more important than matches in attributes further down the list. In one attribute, matching text at the beginning of the attribute will be considered more important than text after. You can disable this behavior if you add your attribute inside <code>unordered(AttributeName)</code>. For example, <code>attributesToIndex: [&quot;title&quot;, &quot;unordered(text)&quot;]</code>.
-You can decide to have the same priority for two attributes by passing them in the same string using a comma as a separator. For example <code>title</code> and <code>alternative_title</code> have the same priority in this example, which is different than text priority: <code>attributesToIndex:[&quot;title,alternative_title&quot;, &quot;text&quot;]</code>.
-To get a full description of how the Ranking works, you can have a look at our <a href="https://www.algolia.com/doc/relevance/ranking">Ranking guide</a>.</li>
-<li><strong>numericAttributesToIndex</strong>: (array of strings) All numerical attributes are automatically indexed as numerical filters (allowing filtering operations like <code>&lt;</code> and <code>&lt;=</code>). If you don&#39;t need filtering on some of your numerical attributes, you can specify this list to speed up the indexing.<br/> If you only need to filter on a numeric value with the operator &#39;=&#39;, you can speed up the indexing by specifying the attribute with <code>equalOnly(AttributeName)</code>. The other operators will be disabled.</li>
-</ul>
+- scope: `settings`, `search`
+- type: `string`
+- default: `<em>`
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>attributesForFaceting</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>array of strings</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The list of fields you want to use for faceting. All strings in the attribute selected for faceting are extracted and added as a facet. If set to null, no attribute is used for faceting.</p>
+Specify the string that is inserted before the highlighted parts in the query result (defaults to `<em>`).
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>attributeForDistinct</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The name of the attribute used for the <code>Distinct</code> feature. This feature is similar to the SQL &quot;distinct&quot; keyword. When enabled in queries with the <code>distinct=1</code> parameter, all hits containing a duplicate value for this attribute are removed from the results. For example, if the chosen attribute is <code>show_name</code> and several hits have the same value for <code>show_name</code>, then only the first one is kept and the others are removed from the results. To get a full understanding of how <code>Distinct</code> works, you can have a look at our <a href="https://www.algolia.com/doc/search/distinct">guide on distinct</a>.</p>
-      </td>
-    </tr>
+#### highlightPostTag
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>ranking</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>array of strings</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Controls the way results are sorted.</p>
+- scope: `settings`, `search`
+- type: `string`
+- default: `</em>`
-<p>We have nine available criteria:</p>
-<ul>
-<li><code>typo</code>: Sort according to number of typos.</li>
-<li><code>geo</code>: Sort according to decreasing distance when performing a geo location based search.</li>
-<li><code>words</code>: Sort according to the number of query words matched by decreasing order. This parameter is useful when you use the <code>optionalWords</code> query parameter to have results with the most matched words first.</li>
-<li><code>proximity</code>: Sort according to the proximity of the query words in hits.</li>
-<li><code>attribute</code>: Sort according to the order of attributes defined by attributesToIndex.</li>
-<li><code>exact</code>:
+Specify the string that is inserted after the highlighted parts in the query result (defaults to `</em>`).
-<ul>
-<li>If the user query contains one word: sort objects having an attribute that is exactly the query word before others. For example, if you search for the TV show &quot;V&quot;, you want to find it with the &quot;V&quot; query and avoid getting all popular TV shows starting by the letter V before it.</li>
-<li>If the user query contains multiple words: sort according to the number of words that matched exactly (not as a prefix).</li>
-</ul></li>
-<li><code>custom</code>: Sort according to a user defined formula set in the <code>customRanking</code> attribute.</li>
-<li><code>asc(attributeName)</code>: Sort according to a numeric attribute using ascending order. <code>attributeName</code> can be the name of any numeric attribute in your records (integer, double or boolean).</li>
-<li><code>desc(attributeName)</code>: Sort according to a numeric attribute using descending order. <code>attributeName</code> can be the name of any numeric attribute in your records (integer, double or boolean). <br/>The standard order is <code>[&quot;typo&quot;, &quot;geo&quot;, &quot;words&quot;, &quot;proximity&quot;, &quot;attribute&quot;, &quot;exact&quot;, &quot;custom&quot;]</code>.
-To get a full description of how the Ranking works, you can have a look at our <a href="https://www.algolia.com/doc/relevance/ranking">Ranking guide</a>.</li>
-</ul>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>customRanking</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>array of strings</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Lets you specify part of the ranking.</p>
+#### snippetEllipsisText
-<p>The syntax of this condition is an array of strings containing attributes prefixed by the asc (ascending order) or desc (descending order) operator. For example, <code>&quot;customRanking&quot; =&gt; [&quot;desc(population)&quot;, &quot;asc(name)&quot;]</code>.</p>
+- scope: `settings`, `search`
+- type: `string`
+- default: `…`
-<p>To get a full description of how the Custom Ranking works, you can have a look at our <a href="https://www.algolia.com/doc/relevance/ranking">Ranking guide</a>.</p>
-      </td>
-    </tr>
+String used as an ellipsis indicator when a snippet is truncated.
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>queryType</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>prefixLast</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Select how the query words are interpreted. It can be one of the following values:</p>
+**Note:** Defaults to an empty string for all accounts created before 10/2/2016, and to `…` (U+2026) for accounts created after that date.
-<ul>
-<li><code>prefixAll</code>: All query words are interpreted as prefixes.</li>
-<li><code>prefixLast</code>: Only the last word is interpreted as a prefix (default behavior).</li>
-<li><code>prefixNone</code>: No query word is interpreted as a prefix. This option is not recommended.</li>
-</ul>
+#### restrictHighlightAndSnippetArrays
-      </td>
-    </tr>
+- scope: `settings`, `search`
+- type: `boolean`
+- default: `false`
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>separatorsToIndex</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>empty</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Specify the separators (punctuation characters) to index. By default, separators are not indexed. Use <code>+#</code> to be able to search Google+ or C#.</p>
-      </td>
-    </tr>
+If set to true, restrict arrays in highlights and snippets to items that matched the query at least partially else return all array items in highlights and snippets.
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>slaves</code></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The list of indices on which you want to replicate all write operations. In order to get response times in milliseconds, we pre-compute part of the ranking during indexing. If you want to use different ranking configurations depending of the use case, you need to create one index per ranking configuration. This option enables you to perform write operations only on this index and automatically update slave indices with the same operations.</p>
+### Pagination
-      </td>
-    </tr>
+#### page
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>unretrievableAttributes</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>empty</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The list of attributes that cannot be retrieved at query time. This feature allows you to have attributes that are used for indexing and/or ranking but cannot be retrieved. Defaults to null. Warning: for testing purposes, this setting is ignored when you&#39;re using the ADMIN API Key.</p>
+- scope: `search`
+- type: `integer`
+- default: `0`
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>allowCompressionOfIntegerArray</code></div>
-            <div class="client-readme-param-meta"><div><em>Default: <strong>false</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Allows compression of big integer arrays. In data-intensive use-cases, we recommended enabling this feature and then storing the list of user IDs or rights as an integer array. When enabled, the integer array is reordered to reach a better compression ratio. Defaults to false.</p>
+Pagination parameter used to select the page to retrieve.
-      </td>
-    </tr>
+**Warning:** Page is zero based. Thus, to retrieve the 10th page, you need to set `page=9`.
-</tbody></table>
+#### hitsPerPage
-## Query expansion
+- scope: `settings`, `search`
+- type: `integer`
+- default: `20`
-<table><tbody>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>synonyms</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>array of array of string considered as equals</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>For example, you may want to retrieve the <strong>black ipad</strong> record when your users are searching for <strong>dark ipad</strong>, even if the word <strong>dark</strong> is not part of the record. To do this, you need to configure <strong>black</strong> as a synonym of <strong>dark</strong>. For example, <code>&quot;synomyms&quot;: [ [ &quot;black&quot;, &quot;dark&quot; ], [ &quot;small&quot;, &quot;little&quot;, &quot;mini&quot; ], ... ]</code>. The Synonym feature also supports multi-words expressions like <code>&quot;synonyms&quot;: [ [&quot;NYC&quot;, &quot;New York City&quot;] ]</code></p>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>placeholders</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>hash of array of words</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>This is an advanced use-case to define a token substitutable by a list of words without having the original token searchable. It is defined by a hash associating placeholders to lists of substitutable words. For example, <code>&quot;placeholders&quot;: { &quot;&lt;streetnumber&gt;&quot;: [&quot;1&quot;, &quot;2&quot;, &quot;3&quot;, ..., &quot;9999&quot;]}</code> would allow it to be able to match all street numbers. We use the <code>&lt; &gt;</code> tag syntax to define placeholders in an attribute. For example:</p>
+Pagination parameter used to select the number of hits per page.
-<ul>
-<li>Push a record with the placeholder: <code>{ &quot;name&quot; : &quot;Apple Store&quot;, &quot;address&quot; : &quot;&amp;lt;streetnumber&amp;gt; Opera street, Paris&quot; }</code>.</li>
-<li>Configure the placeholder in your index settings: <code>&quot;placeholders&quot;: { &quot;&lt;streetnumber&gt;&quot; : [&quot;1&quot;, &quot;2&quot;, &quot;3&quot;, &quot;4&quot;, &quot;5&quot;, ... ], ... }</code>.</li>
-</ul>
+### Typos
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>disableTypoToleranceOnWords</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string array</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Specify a list of words on which automatic typo tolerance will be disabled.</p>
+#### minWordSizefor1Typo
+- scope: `settings`, `search`
+- type: `integer`
+- default: `4`
+The minimum number of characters needed to accept one typo.
+#### minWordSizefor2Typos
+- scope: `settings`, `search`
+- type: `integer`
+- default: `8`
+The minimum number of characters needed to accept two typos.
+#### typoTolerance
+- scope: `settings`, `search`
+- type: `boolean`
+- default: `true`
+This option allows you to control the number of typos allowed in the result set:
+* `true`: The typo tolerance is enabled and all matching hits are retrieved (default behavior).
+* `false`: The typo tolerance is disabled. All results with typos will be hidden.
+* `min`: Only keep results with the minimum number of typos. For example, if one result matches without typos, then all results with typos will be hidden.
+* `strict`: Hits matching with 2 typos are not retrieved if there are some matching without typos.
+#### allowTyposOnNumericTokens
+- scope: `settings`, `search`
+- type: `boolean`
+- default: `true`
+If set to false, disables typo tolerance on numeric tokens (numbers).
+#### ignorePlurals
+- scope: `settings`, `search`
+- type: `boolean`
+- default: `false`
+If set to true, plural won't be considered as a typo. For example, car and cars, or foot and feet will be considered as equivalent. Defaults to false.
+#### disableTypoToleranceOnAttributes
+- scope: `settings`, `search`
+- type: `string`
+- default: `""`
+List of attributes on which you want to disable typo tolerance
+(must be a subset of the `attributesToIndex` index setting).
+Attributes are separated with a comma such as `"name,address"`.
+You can also use JSON string array encoding such as `encodeURIComponent("[\"name\",\"address\"]")`.
+#### separatorsToIndex
+- scope: `settings`
+- type: `string`
+- default: `""`
+Specify the separators (punctuation characters) to index.
+By default, separators are not indexed.
+**Example:** Use `+#` to be able to search for "Google+" or "C#".
+### Geo-Search
+Geo search requires that you provide at least one geo location in each record at indexing time, under the `_geoloc` attribute. Each location must be an object with two numeric `lat` and `lng` attributes. You may specify either one location:
+```
+{
+  "_geoloc": {
+    "lat": 48.853409,
+    "lng": 2.348800
+  }
+}
+```
+... or an array of locations:
+```
+{
+  "_geoloc": [
+    {
+      "lat": 48.853409,
+      "lng": 2.348800
+    },
+    {
+      "lat": 48.547456,
+      "lng": 2.972075
+    }
+  ]
+}
+```
+#### aroundLatLng
+- scope: `search`
+- type: `string`
+- default: ``
+Search for entries around a given location (specified as two floats separated by a comma).
+For example, `aroundLatLng=47.316669,5.016670`.
+- By default the maximum distance is automatically guessed based on the density of the area
+but you can specify it manually in meters with the **aroundRadius** parameter.
+The precision for ranking can be set with **aroundPrecision** parameter.
+- If you set aroundPrecision=100, the distances will be considered by ranges of 100m.
+- For example all distances 0 and 100m will be considered as identical for the "geo" ranking parameter.
+When `aroundRadius` is not set, the radius is computed automatically using the density of the area; you can retrieve the computed value in the `automaticRadius` attribute of the response.
+You can also use the `minimumAroundRadius` query parameter to specify a minimum radius in meters for the automatic computation of `aroundRadius`.
+#### aroundLatLngViaIP
+- scope: `search`
+- type: `string`
+- default: `false`
+Search for entries around a given latitude/longitude automatically computed from user IP address.
+To enable it, use `aroundLatLngViaIP=true`.
+You can specify the maximum distance in meters with the `aroundRadius` parameter
+and the precision for ranking with `aroundPrecision`.
+For example:
+- if you set aroundPrecision=100,
+two objects that are in the range 0-99m
+will be considered as identical in the ranking for the "geo" ranking parameter (same for 100-199, 200-299, ... ranges).
+#### aroundRadius
+- scope: `search`
+- type: `integer`, `"all"`
+- default: `null`
+Control the radius associated with a geo search. Defined in meters.
+If not set, the radius is computed automatically using the density of the area. You can retrieve the computed radius in the `automaticRadius` attribute of the response. You can also specify a minimum value for the automatic radius by using the `minimumAroundRadius` query parameter. You can specify `aroundRadius=all` if you want to compute the geo distance without filtering in a geo area; this option will be faster than specifying a big integer value.
+#### aroundPrecision
+- scope: `search`
+- type: `integer`
+- default: `null`
+Control the precision of a geo search. Defined in meters. For example, if you set `aroundPrecision=100`, two objects that are in the range 0-99m will be considered as identical in the ranking for the `geo` ranking parameter (same for 100-199, 200-299, … ranges).
+#### minimumAroundRadius
+- scope: `search`
+- type: `integer`
+- default: `null`
+Define the minimum radius used for a geo search when `aroundRadius` is not set. The radius is computed automatically using the density of the area. You can retrieve the computed radius in the `automaticRadius` attribute of the answer.
+#### insideBoundingBox
+- scope: `search`
+- type: `string`
+- default: `null`
+Search entries inside a given area defined by the two extreme points of a rectangle
+(defined by 4 floats: p1Lat,p1Lng,p2Lat,p2Lng).
+For example:
+- `insideBoundingBox=47.3165,4.9665,47.3424,5.0201`
+You can use several bounding boxes (OR) by passing more than 4 values.
+For example: instead of having 4 values you can pass 8 to search inside the UNION of two bounding boxes.
+#### insidePolygon
+- scope: `search`
+- type: `string`
+- default: ``
+Search entries inside a given area defined by a set of points
+(defined by a minimum of 6 floats: p1Lat,p1Lng,p2Lat,p2Lng,p3Lat,p3Long).
+For example:
+`InsidePolygon=47.3165,4.9665,47.3424,5.0201,47.32,4.98`).
+### Query Strategy
+#### queryType
+- scope: `settings`, `search`
+- type: `enum`
+- default: `'prefixLast'`
+Selects how the query words are interpreted. It can be one of the following values:
+* `prefixAll`:
+All query words are interpreted as prefixes. This option is not recommended.
+* `prefixLast`:
+Only the last word is interpreted as a prefix (default behavior).
+* `prefixNone`:
+No query word is interpreted as a prefix. This option is not recommended.
+#### removeWordsIfNoResults
+- scope: `settings`, `search`
+- type: `string`
+- default: `'none'`
+This option is used to select a strategy in order to avoid having an empty result page.
+There are four different options:
+- `lastWords`:
+When a query does not return any results, the last word will be added as optional.
+The process is repeated with n-1 word, n-2 word, ... until there are results.
+- `firstWords`:
+When a query does not return any results, the first word will be added as optional.
+The process is repeated with second word, third word, ... until there are results.
+- `allOptional`:
+When a query does not return any results, a second trial will be made with all words as optional.
+This is equivalent to transforming the AND operand between query terms to an OR operand.
+- `none`:
+No specific processing is done when a query does not return any results (default behavior).
+#### advancedSyntax
+- scope: `settings`, `search`
+- type: `boolean`
+- default: `false`
+Enables the advanced query syntax.
+This syntax allow to do two things:
+* **Phrase query**: A phrase query defines a particular sequence of terms. A phrase query is built by Algolia's query parser for words surrounded by `"`. For example, `"search engine"` will retrieve records having `search` next to `engine` only. Typo tolerance is _disabled_ on phrase queries.
+* **Prohibit operator**: The prohibit operator excludes records that contain the term after the `-` symbol. For example, `search -engine` will retrieve records containing `search` but not `engine`.
+#### optionalWords
+- scope: `settings`, `search`
+- type: `array of strings`
+- default: `[]`
+A string that contains the comma separated list of words that should be considered as optional when found in the query.
+#### removeStopWords
+- scope: `settings`, `search`
+- type: `boolean`, `array of strings`
+- default: `false`
+Remove stop words from the query **before** executing it. It can be:
+- a **boolean**: enable or disable stop words for all 41 supported languages; or
+- a **list of language ISO codes** (as a comma-separated string) for which stop words should be enabled.
+In most use-cases, **we don’t recommend enabling this option**.
+List of 41 supported languages with their associated iso code: Arabic=`ar`, Armenian=`hy`, Basque=`eu`, Bengali=`bn`, Brazilian=`pt-br`, Bulgarian=`bg`, Catalan=`ca`, Chinese=`zh`, Czech=`cs`, Danish=`da`, Dutch=`nl`, English=`en`, Finnish=`fi`, French=`fr`, Galician=`gl`, German=`de`, Greek=`el`, Hindi=`hi`, Hungarian=`hu`, Indonesian=`id`, Irish=`ga`, Italian=`it`, Japanese=`ja`, Korean=`ko`, Kurdish=`ku`, Latvian=`lv`, Lithuanian=`lt`, Marathi=`mr`, Norwegian=`no`, Persian (Farsi)=`fa`, Polish=`pl`, Portugese=`pt`, Romanian=`ro`, Russian=`ru`, Slovak=`sk`, Spanish=`es`, Swedish=`sv`, Thai=`th`, Turkish=`tr`, Ukranian=`uk`, Urdu=`ur`.
+Stop words removal is applied on query words that are not interpreted as a prefix. The behavior depends of the `queryType` parameter:
+* `queryType=prefixLast` means the last query word is a prefix and it won’t be considered for stop words removal
+* `queryType=prefixNone` means no query word are prefix, stop words removal will be applied on all query words
+* `queryType=prefixAll` means all query terms are prefix, stop words won’t be removed
+This parameter is useful when you have a query in natural language like “what is a record?”.
+In this case, before executing the query, we will remove “what”, “is” and “a” in order to just search for “record”.
+This removal will remove false positive because of stop words, especially when combined with optional words.
+For most use cases, it is better to not use this feature as people search by keywords on search engines.
+#### disablePrefixOnAttributes
+- scope: `settings`
+- type: `array of strings`
+- default: `[]`
+List of attributes on which you want to disable prefix matching
+(must be a subset of the `attributesToIndex` index setting).
+This setting is useful on attributes that contain string that should not be matched as a prefix
+(for example a product SKU).
+#### disableExactOnAttributes
+- scope: `settings`, `search`
+- type: `array of strings`
+- default: `[]`
+List of attributes on which you want to disable the computation of `exact` criteria
+(must be a subset of the `attributesToIndex` index setting).
+#### exactOnSingleWordQuery
+- scope: `settings`, `search`
+- type: `string`
+- default: `attribute`
+This parameter control how the `exact` ranking criterion is computed when the query contains one word. There are three different values:
+* `none`: no exact on single word query
+* `word`: exact set to 1 if the query word is found in the record. The query word needs to have at least 3 chars and not be part of our stop words dictionary
+* `attribute` (default): exact set to 1 if there is an attribute containing a string equals to the query
+#### alternativesAsExact
+- scope: `settings`, `search`
+- type: `string`
+- default: `['ignorePlurals', 'singleWordSynonym']`
+Specify the list of approximation that should be considered as an exact match in the ranking formula:
+* `ignorePlurals`: alternative words added by the ignorePlurals feature
+* `singleWordSynonym`: single-word synonym (For example "NY" = "NYC")
+* `multiWordsSynonym`: multiple-words synonym (For example "NY" = "New York")
+### Advanced
+#### attributeForDistinct
+- scope: `settings`
+- type: `string`
+- default: `null`
+The name of the attribute used for the `Distinct` feature.
+This feature is similar to the SQL "distinct" keyword.
+When enabled in queries with the `distinct=1` parameter,
+all hits containing a duplicate value for this attribute are removed from the results.
+For example, if the chosen attribute is `show_name` and several hits have the same value for `show_name`,
+then only the first one is kept and the others are removed from the results.
+To get a full understanding of how `Distinct` works,
+you can have a look at our [guide on distinct](https://www.algolia.com/doc/search/distinct).
+#### distinct
+- scope: `settings`, `search`
+- type: `integer`
+- default: `0`
+If set to 1,
+enables the distinct feature, disabled by default, if the `attributeForDistinct` index setting is set.
+This feature is similar to the SQL "distinct" keyword.
+When enabled in a query with the `distinct=1` parameter,
+all hits containing a duplicate value for the attributeForDistinct attribute are removed from results.
+For example, if the chosen attribute is `show_name` and several hits have the same value for `show_name`,
+then only the best one is kept and the others are removed.
+To get a full understanding of how `Distinct` works,
+you can have a look at our [guide on distinct](https://www.algolia.com/doc/search/distinct).
+#### getRankingInfo
+- scope: `search`
+- type: `boolean`
+- default: `false`
+If set to true,
+the result hits will contain ranking information in the **_rankingInfo** attribute.
+#### numericAttributesToIndex
+- scope: `settings`
+- type: `array of strings`
+- default: ``
+All numerical attributes are automatically indexed as numerical filters
+(allowing filtering operations like `<` and `<=`).
+If you don't need filtering on some of your numerical attributes,
+you can specify this list to speed up the indexing.
+If you only need to filter on a numeric value with the `=` operator,
+you can speed up the indexing by specifying the attribute with `equalOnly(AttributeName)`.
+The other operators will be disabled.
+#### allowCompressionOfIntegerArray
+- scope: `settings`
+- type: `boolean`
+- default: `false`
+Allows compression of big integer arrays.
+In data-intensive use-cases,
+we recommended enabling this feature and then storing the list of user IDs or rights as an integer array.
+When enabled, the integer array is reordered to reach a better compression ratio.
+#### numericFilters (deprecated)
+- scope: `search`
+- type: `array of strings`
+- default: `[]`
+*This parameter is deprecated. Please use [filters](#filters) instead.*
+A string that contains the comma separated list of numeric filters you want to apply.
+The filter syntax is `attributeName` followed by `operand` followed by `value`.
+Supported operands are `<`, `<=`, `=`, `>` and `>=`.
+You can easily perform range queries via the `:` operator.
+This is equivalent to combining a `>=` and `<=` operand.
+For example, `numericFilters=price:10 to 1000`.
+You can also mix OR and AND operators.
+The OR operator is defined with a parenthesis syntax.
+For example, `(code=1 AND (price:[0-100] OR price:[1000-2000]))`
+translates to `encodeURIComponent("code=1,(price:0 to 100,price:1000 to 2000)")`.
+You can also use a string array encoding (for example `numericFilters: ["price>100","price<1000"]`).
+#### tagFilters (deprecated)
+- scope: `search`
+- type: `string`
+- default: `""`
+*This parameter is deprecated. Please use [filters](#filters) instead.*
+Filter the query by a set of tags.
+You can AND tags by separating them with commas.
+To OR tags, you must add parentheses.
+For example, `tagFilters=tag1,(tag2,tag3)` means *tag1 AND (tag2 OR tag3)*.
+You can also use a string array encoding.
+For example, `tagFilters: ["tag1",["tag2","tag3"]]` means *tag1 AND (tag2 OR tag3)*.
+Negations are supported via the `-` operator, prefixing the value.
+For example: `tagFilters=tag1,-tag2`.
+At indexing, tags should be added in the **_tags** attribute of objects.
+For example `{"_tags":["tag1","tag2"]}`.
+#### facetFilters (deprecated)
+- scope: `search`
+- type: `string`
+- default: `""`
+*This parameter is deprecated. Please use [filters](#filters) instead.*
+Filter the query with a list of facets. Facets are separated by commas and is encoded as `attributeName:value`.
+To OR facets, you must add parentheses.
+For example: `facetFilters=(category:Book,category:Movie),author:John%20Doe`.
+You can also use a string array encoding.
+For example, `[["category:Book","category:Movie"],"author:John%20Doe"]`.
+#### analytics
+- scope: `search`
+- type: `boolean`
+- default: `true`
+If set to false, this query will not be taken into account in the analytics feature.
+#### placeholders
+- scope: `settings`
+- type: `hash of array of words`
+- default: ``
+This is an advanced use-case to define a token substitutable by a list of words
+without having the original token searchable.
+It is defined by a hash associating placeholders to lists of substitutable words.
+For example, `"placeholders": { "<streetnumber>": ["1", "2", "3", ..., "9999"]}`
+would allow it to be able to match all street numbers. We use the `< >` tag syntax
+to define placeholders in an attribute.
+For example:
+* Push a record with the placeholder:
+`{ "name" : "Apple Store", "address" : "&lt;streetnumber&gt; Opera street, Paris" }`.
+* Configure the placeholder in your index settings:
+`"placeholders": { "<streetnumber>" : ["1", "2", "3", "4", "5", ... ], ... }`.
+#### altCorrections
+- scope: `settings`
+- type: `array of objects`
+- default: `[]`
+Specify alternative corrections that you want to consider.
+Each alternative correction is described by an object containing three attributes:
+* `word` (string): The word to correct.
+* `correction` (string): The corrected word.
+* `nbTypos` (integer): The number of typos (1 or 2) that will be considered for the ranking algorithm (1 typo is better than 2 typos).
+For example:
+```
+"altCorrections": [
+  { "word" : "foot", "correction": "feet", "nbTypos": 1 },
+  { "word": "feet", "correction": "foot", "nbTypos": 1 }
+]
+```
+## Manage Indices
+### Create an index
+To create an index, you need to perform any indexing operation like:
+- set settings
+- add object
+### List indices - `list_indexes`
+You can list all your indices along with their associated information (number of entries, disk size, etc.) with the `list_indexes` method:
+```ruby
+Algolia.list_indexes
+```
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>disableTypoToleranceOnAttributes</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string array</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>List of attributes on which you want to disable typo tolerance (must be a subset of the <code>attributesToIndex</code> index setting). By default the list is empty.</p>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>disablePrefixOnAttributes</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string array</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>List of attributes on which you want to disable prefix matching (must be a subset of the <code>attributesToIndex</code> index setting). This setting is useful on attributes that contain string that should not be matched as a prefix (for example a product SKU). By default the list is empty.</p>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>disableExactOnAttributes</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string array</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>List of attributes on which you want to disable the computation of <code>exact</code> criteria (must be a subset of the <code>attributesToIndex</code> index setting). By default the list is empty.</p>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>altCorrections</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>object array</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Specify alternative corrections that you want to consider. Each alternative correction is described by an object containing three attributes:</p>
+### Delete index - `delete_index`
-<ul>
-<li><strong>word</strong>: The word to correct.</li>
-<li><strong>correction</strong>: The corrected word.</li>
-<li><strong>nbTypos</strong> The number of typos (1 or 2) that will be considered for the ranking algorithm (1 typo is better than 2 typos).</li>
-</ul>
+You can delete an index using its name:
-<p>For example <code>&quot;altCorrections&quot;: [ { &quot;word&quot; : &quot;foot&quot;, &quot;correction&quot;: &quot;feet&quot;, &quot;nbTypos&quot;: 1 }, { &quot;word&quot;: &quot;feet&quot;, &quot;correction&quot;: &quot;foot&quot;, &quot;nbTypos&quot;: 1 } ]</code>.</p>
+```ruby
+index = Algolia::Index.new("contacts")
+index.delete_index
+```
-      </td>
-    </tr>
-</tbody></table>
+### Clear index - `clear_index`
-## Default query parameters (can be overwritten by queries)
+You can delete the index contents without removing settings and index specific API keys by using the `clearIndex` command:
-<table><tbody>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>minWordSizefor1Typo</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>integer</strong></em></div><div><em>Default: <strong>4</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The minimum number of characters needed to accept one typo (default = 4).</p>
+```ruby
+index.clear_index
+```
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>minWordSizefor2Typos</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>integer</strong></em></div><div><em>Default: <strong>8</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The minimum number of characters needed to accept two typos (default = 8).</p>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>hitsPerPage</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>integer</strong></em></div><div><em>Default: <strong>10</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>The number of hits per page (default = 10).</p>
+### Copy index - `copy_index`
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>attributesToRetrieve</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>array of strings</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Default list of attributes to retrieve in objects. If set to null, all attributes are retrieved.</p>
+You can copy an existing index using the `copy` command.
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>attributesToHighlight</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>array of strings</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Default list of attributes to highlight. If set to null, all indexed attributes are highlighted.</p>
+**Warning**: The copy command will overwrite the destination index.
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>attributesToSnippet</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>array of strings</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Default list of attributes to snippet alongside the number of words to return (syntax is <code>attributeName:nbWords</code>).<br/>By default, no snippet is computed. If set to null, no snippet is computed.</p>
+```ruby
+# Copy MyIndex in MyIndexCopy
+puts Algolia.copy_index("MyIndex", "MyIndexCopy")
+```
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>highlightPreTag</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Specify the string that is inserted before the highlighted parts in the query result (defaults to <code>&lt;em&gt;</code>).</p>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>highlightPostTag</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Specify the string that is inserted after the highlighted parts in the query result (defaults to <code>&lt;/em&gt;</code>).</p>
+### Move index - `move_index`
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>optionalWords</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>array of strings</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Specify a list of words that should be considered optional when found in the query.</p>
+In some cases, you may want to totally reindex all your data. In order to keep your existing service
+running while re-importing your data we recommend the usage of a temporary index plus an atomical
+move using the `move_index` method.
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>allowTyposOnNumericTokens</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>boolean</strong></em></div><div><em>Default: <strong>false</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>If set to false, disable typo-tolerance on numeric tokens (=numbers) in the query word. For example the query <code>&quot;304&quot;</code> will match with <code>&quot;30450&quot;</code>, but not with <code>&quot;40450&quot;</code> that would have been the case with typo-tolerance enabled. Can be very useful on serial numbers and zip codes searches. Defaults to false.</p>
+```ruby
+# Rename MyNewIndex in MyIndex (and overwrite it)
+puts Algolia.move_index("MyNewIndex", "MyIndex")
+```
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>ignorePlurals</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>boolean</strong></em></div><div><em>Default: <strong>false</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>If set to true, singular/plural forms won’t be considered as typos (for example car/cars and foot/feet will be considered as equivalent). Defaults to false.</p>
+**Note**:
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>advancedSyntax</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>integer (0 or 1)</strong></em></div><div><em>Default: <strong>0</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Enable the advanced query syntax. Defaults to 0 (false).</p>
+The move_index method will overwrite the destination index, and delete the temporary index.
-<ul>
-<li><p><strong>Phrase query:</strong> a phrase query defines a particular sequence of terms. A phrase query is build by Algolia&#39;s query parser for words surrounded by <code>&quot;</code>. For example, <code>&quot;search engine&quot;</code> will retrieve records having <code>search</code> next to <code>engine</code> only. Typo-tolerance is disabled on phrase queries.</p></li>
-<li><p><strong>Prohibit operator:</strong> The prohibit operator excludes records that contain the term after the <code>-</code> symbol. For example <code>search -engine</code> will retrieve records containing <code>search</code> but not <code>engine</code>.</p></li>
-</ul>
+**Warning**
+The move_index operation will override all settings of the destination,
+There is one exception for the [slaves](#slaves) parameter which is not impacted.
+For example, if you want to fully update your index `MyIndex` every night, we recommend the following process:
+ 1. Get settings and synonyms from the old index using [Get settings](#get-settings---get_settings)
+  and [Get synonym](#get-synonym---get_synonym).
+ 1. Apply settings and synonyms to the temporary index `MyTmpIndex`, (this will create the `MyTmpIndex` index)
+  using [Set settings](#set-settings---set_settings) and [Batch synonyms](#batch-synonyms---batch_synonyms)
+  (make sure to remove the [slaves](#slaves) parameter from the settings if it exists).
+ 1. Import your records into a new index using [Add objects](#add-objects---add_objects).
+ 1. Atomically replace the index `MyIndex` with the content and settings of the index `MyTmpIndex`
+ using the [Move index](#move-index---move_index) method.
+ This will automatically override the old index without any downtime on the search.
+ 1. You'll end up with only one index called `MyIndex`, that contains the records and settings pushed to `MyTmpIndex`
+ and the slave-indices that were initially attached to `MyIndex` will be in sync with the new data.
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>replaceSynonymsInHighlight</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>boolean</strong></em></div><div><em>Default: <strong>true</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>If set to false, words matched via synonyms expansion will not be replaced by the matched synonym in the highlighted result. Defaults to true.</p>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>maxValuesPerFacet</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>integer</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Limit the number of facet values returned for each facet. For example: <code>maxValuesPerFacet=10</code> will retrieve max 10 values per facet.</p>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>distinct</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>integer (0 or 1)</strong></em></div><div><em>Default: <strong>0</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Enable the distinct feature (disabled by default) if the <code>attributeForDistinct</code> index setting is set. This feature is similar to the SQL &quot;distinct&quot; keyword: when enabled in a query with the <code>distinct=1</code> parameter, all hits containing a duplicate value for the<code>attributeForDistinct</code> attribute are removed from results. For example, if the chosen attribute is <code>show_name</code> and several hits have the same value for <code>show_name</code>, then only the best one is kept and others are removed.</p>
-<p>To get a full understanding of how <code>Distinct</code> works, you can have a look at our <a href="https://www.algolia.com/doc/search/distinct">guide on distinct</a>.</p>
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>typoTolerance</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string</strong></em></div><div><em>Default: <strong>true</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>This setting has four different options:</p>
-<ul>
-<li><p><code>true:</code> activate the typo-tolerance (default value).</p></li>
-<li><p><code>false:</code> disable the typo-tolerance</p></li>
-<li><p><code>min:</code> keep only results with the lowest number of typos. For example if one result matches without typos, then all results with typos will be hidden.</p></li>
-<li><p><code>strict:</code> if there is a match without typo, then all results with 2 typos or more will be removed.</p></li>
-</ul>
+## Api Keys
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>removeStopWords</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>boolean or string array</strong></em></div><div><em>Default: <strong>false</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Remove stop words from the query <strong>before</strong> executing it. Defaults to <code>false</code>. Use a boolean to enable/disable all 41 supported languages and an array of string listing the iso codes of the languages you want to use consider to enable the stop words removal on a subset of them (select the one you have in your records).</p>
+The **admin** API key provides full control of all your indices. *The admin API key should always be kept secure; do NOT use it from outside your back-end.*
-<p>List of 41 supported languages with their associated iso code: Arabic=ar, Armenian=hy, Basque=eu, Bengali=bn, Brazilian=pt-br, Bulgarian=bg, Catalan=ca, Chinese=zh, Czech=cs, Danish=da, Dutch=nl, English=en, Finnish=fi, French=fr, Galician=gl, German=de, Greek=el, Hindi=hi, Hungarian=hu, Indonesian=id, Irish=ga, Italian=it, Japanese=ja, Korean=ko, Kurdish=ku, Latvian=lv, Lithuanian=lt, Marathi=mr, Norwegian=no, Persian (Farsi)=fa, Polish=pl, Portugese=pt, Romanian=ro, Russian=ru, Slovak=sk, Spanish=es, Swedish=sv, Thai=th, Turkish=tr, Ukranian=uk, Urdu=ur.</p>
+You can also generate user API keys to control security.
+These API keys can be restricted to a set of operations or/and restricted to a given index.
-<p>Stop words removal is applied on query words that are not interpreted as a prefix. The behavior depends of the queryType setting:</p>
+### Generate key - `generate_secured_api_key`
-<ul>
-<li><p><code>queryType=prefixLast</code> means the last query word is a prefix and it won’t be considered for stop words removal</p></li>
-<li><p><code>queryType=prefixNone</code> means no query word are prefix, stop words removal will be applied on all query words</p></li>
-<li><p><code>queryType=prefixAll</code> means all query terms are prefix, stop words won’t be removed</p></li>
-</ul>
+You may have a single index containing **per user** data. In that case, all records should be tagged with their associated `user_id` in order to add a `tagFilters=user_42` filter at query time to retrieve only what a user has access to. If you're using the [JavaScript client](http://github.com/algolia/algoliasearch-client-js), it will result in a security breach since the user is able to modify the `tagFilters` you've set by modifying the code from the browser. To keep using the JavaScript client (recommended for optimal latency) and target secured records, you can generate a secured API key from your backend:
-<p>This index setting is useful when you have queries in natural language like “what is a record?”. In this case, before executing the query, we will remove “what”, “is” and “a” in order to just search for “record”. This removal will remove false positive because of stop words. For most use cases, it is better to not use this feature as people search by keywords on search engines.</p>
+```ruby
+# generate a public API key for user 42. Here, records are tagged with:
+#  - 'user_XXXX' if they are visible by user XXXX
+public_key = Algolia.generate_secured_api_key 'YourSearchOnlyApiKey', {'filters'=> '_tags:user_42'}
+```
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>exactOnSingleWordQuery</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string</strong></em></div><div><em>Default: <strong>attribute</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>This parameter controls how the <code>exact</code> ranking criterion is computed when the query contains one word. There is three different values:</p>
+This public API key can then be used in your JavaScript code as follow:
-<ul>
-<li><p><code>none</code>: no <code>exact</code> on single word query</p></li>
-<li><p><code>word</code>: <code>exact</code> set to 1 if the query word is found in the record. The query word needs to have at least 3 chars and not be part of our stop words dictionary</p></li>
-<li><p><code>attribute</code> (default): exact set to 1 if there is an attribute containing a string equals to the query</p></li>
-</ul>
+```js
+var client = algoliasearch('YourApplicationID', '<%= public_api_key %>');
-      </td>
-    </tr>
-    <tr>
-      <td valign='top'>
-        <div class='client-readme-param-container'>
-          <div class='client-readme-param-container-inner'>
-            <div class='client-readme-param-name'><code>alternativesAsExact</code></div>
-            <div class="client-readme-param-meta"><div><em>Type: <strong>string array</strong></em></div><div><em>Default: <strong>["ignorePlurals", "singleWordSynonym"]</strong></em></div></div>
-          </div>
-        </div>
-      </td>
-      <td class='client-readme-param-content'>
-        <p>Specify the list of approximation that should be considered as an exact match in the ranking formula:</p>
+var index = client.initIndex('indexName')
-<ul>
-<li><p><code>ignorePlurals</code>: alternative words added by the ignorePlurals feature</p></li>
-<li><p><code>singleWordSynonym</code>: single-word synonym (For example &quot;NY&quot; = &quot;NYC&quot;)</p></li>
-<li><p><code>multiWordsSynonym</code>: multiple-words synonym (For example &quot;NY&quot; = &quot;New York&quot;)</p></li>
-</ul>
+index.search('something', function(err, content) {
+  if (err) {
+    console.error(err);
+    return;
+  }
-      </td>
-    </tr>
-  </tbody></table>
+  console.log(content);
+});
+```
+You can mix rate limits and secured API keys by setting a `userToken` query parameter at API key generation time. When set, a unique user will be identified by her `IP + user_token` instead of only by her `IP`. This allows you to restrict a single user to performing a maximum of `N` API calls per hour, even if she shares her `IP` with another user.
+```ruby
+# generate a public API key for user 42. Here, records are tagged with:
+#  - 'user_XXXX' if they are visible by user XXXX
+public_key = Algolia.generate_secured_api_key 'YourSearchOnlyApiKey', {'filters'=> '_tags:user_42', 'userToken'=> 'user_42'}
+```
+This public API key can then be used in your JavaScript code as follow:
-List indices
-==================
-You can list all your indices along with their associated information (number of entries, disk size, etc.) with the `list_indexes` method:
+```js
+var client = algoliasearch('YourApplicationID', '<%= public_api_key %>');
-```ruby
-Algolia.list_indexes
+var index = client.initIndex('indexName')
+index.search('another query', function(err, content) {
+  if (err) {
+    console.error(err);
+    return;
+  }
+  console.log(content);
+});
 ```
-Delete an index
-==================
-You can delete an index using its name:
+## Synonyms
+### Save synonym - `save_synonym`
+This method saves a single synonym record into the index.
+In this example, we specify true to forward the creation to slave indices.
+By default the behavior is to save only on the specified index.
 ```ruby
-index = Algolia::Index.new("contacts")
-index.delete_index
+index.save_synonym('a-unique-identifier', {
+  :objectID => 'a-unique-identifier',
+  :type => 'synonym',
+  :synonyms => ['car', 'vehicle', 'auto']
+}, true)
 ```
+### Batch synonyms - `batch_synonyms`
+Use the batch method to create a large number of synonyms at once,
+forward them to slave indices if desired,
+and optionally replace all existing synonyms
+on the index with the content of the batch using the replaceExistingSynonyms parameter.
+You should always use replaceExistingSynonyms to atomically replace all synonyms
+on a production index. This is the only way to ensure the index always
+has a full list of synonyms to use during the indexing of the new list.
+```ruby
+# Batch synonyms, with slave forwarding and atomic replacement of existing synonyms
+index.batch_synonyms([{
+  :objectID => 'a-unique-identifier',
+  :type => 'synonym',
+  :synonyms => ['car', 'vehicle', 'auto']
+}, {
+  :objectID => 'another-unique-identifier',
+  :type => 'synonym',
+  :synonyms => ['street', 'st']
+}], true, true)
+```
+### Editing Synonyms
+Updating the value of a specific synonym record is the same as creating one.
+Make sure you specify the same objectID used to create the record and the synonyms
+will be updated.
+When updating multiple synonyms in a batch call (but not all synonyms),
+make sure you set replaceExistingSynonyms to false (or leave it out,
+false is the default value).
+Otherwise, the entire synonym list will be replaced only partially with the records
+in the batch update.
+### Delete Synonyms - `delete_synonyms`
-Clear an index
-==================
-You can delete the index contents without removing settings and index specific API keys by using the clearIndex command:
+Use the normal index delete method to delete synonyms,
+specifying the objectID of the synonym record you want to delete.
+Forward the deletion to slave indices by setting the forwardToSlaves parameter to true.
 ```ruby
-index.clear_index
+# Delete and forward to slaves
+index.delete_synonym('a-unique-identifier', true)
 ```
-Wait indexing
-==================
+### Clear all synonyms - `clear_synonyms`
-All write operations in Algolia are asynchronous by design.
+This is a convenience method to delete all synonyms at once.
+It should not be used on a production index to then push a new list of synonyms:
+there would be a short period of time during which the index would have no synonyms
+at all.
-It means that when you add or update an object to your index, our servers will
-reply to your request with a `taskID` as soon as they understood the write
-operation.
+To atomically replace all synonyms of an index,
+use the batch method with the replaceExistingSynonyms parameter set to true.
-The actual insert and indexing will be done after replying to your code.
+```ruby
+# Clear synonyms and forward to slaves
+index.clear_synonyms(true)
+```
-You can wait for a task to complete using  the same method with a `!`.
+### Get synonym - `get_synonym`
+Search for synonym records by their objectID or by the text they contain.
+Both methods are covered here.
-For example, to wait for indexing of a new object:
 ```ruby
-res = index.add_object!({"firstname" => "Jimmie",
-                         "lastname" => "Barninger"})
+synonym = index.get_synonym('a-unique-identifier')
 ```
-If you want to ensure multiple objects have been indexed, you only need to check
-the biggest `taskID` with `wait_task`.
+### Search synonyms - `search_synonyms`
-Batch writes
-==================
+Search for synonym records similar to how you’d search normally.
+Accepted search parameters:
+- query: the actual search query to find synonyms. Use an empty query to browse all the synonyms of an index.
+- type: restrict the search to a specific type of synonym. Use an empty string to search all types (default behavior). Multiple types can be specified using a comma-separated list or an array.
+- page: the page to fetch when browsing through several pages of results. This value is zero-based.
+hitsPerPage: the number of synonyms to return for each call. The default value is 100.
+```ruby
+# Searching for "street" in synonyms and one-way synonyms; fetch the second page with 10 hits per page
+results = index.search_synonyms('street', {
+  :type => ['synonym', 'oneWaySynonym'],
+  :page => 1,
+  :hitsPerPage => 10
+})
+```
+## Advanced
+### Custom batch - `batch`
 You may want to perform multiple operations with one API call to reduce latency.
 We expose four methods to perform batch operations:
- * `add_objects`: Add an array of objects using automatic `objectID` assignment.
- * `save_objects`: Add or update an array of objects that contains an `objectID` attribute.
- * `delete_objects`: Delete an array of objectIDs.
- * `partial_update_objects`: Partially update an array of objects that contain an `objectID` attribute (only specified attributes will be updated).
+* Add objects - `add_objects`: Add an array of objects using automatic `objectID` assignment.
+* Update objects - `save_objects`: Add or update an array of objects that contains an `objectID` attribute.
+* Delete objects - `delete_objects`: Delete an array of objectIDs.
+* Partial update - `partial_update_objects`: Partially update an array of objects that contain an `objectID` attribute (only specified attributes will be updated).
 Example using automatic `objectID` assignment:
 ```ruby
 res = index.add_objects([{"firstname" => "Jimmie",
                           "lastname" => "Barninger"},
@@ -2022,6 +2059,7 @@ res = index.add_objects([{"firstname" => "Jimmie",
 ```
 Example with user defined `objectID` (add or update):
 ```ruby
 res = index.save_objects([{"firstname" => "Jimmie",
                           "lastname" => "Barninger",
@@ -2032,11 +2070,13 @@ res = index.save_objects([{"firstname" => "Jimmie",
 ```
 Example that deletes a set of records:
 ```ruby
 res = index.delete_objects(["myID1", "myID2"])
 ```
 Example that updates only the `firstname` attribute:
 ```ruby
 res = index.partial_update_objects([{"firstname" => "Jimmie",
                                      "objectID" => "SFO"},
@@ -2048,6 +2088,7 @@ res = index.partial_update_objects([{"firstname" => "Jimmie",
 If you have one index per user, you may want to perform a batch operations across severals indexes.
 We expose a method to perform this type of batch:
 ```ruby
 res = index.batch([
 	{"action"=> "addObject", "indexName"=> "index1", "body": {"firstname" => "Jimmie",
@@ -2057,36 +2098,14 @@ res = index.batch([
 ```
 The attribute **action** can have these values:
 - addObject
 - updateObject
 - partialUpdateObject
 - partialUpdateObjectNoCreate
 - deleteObject
-Copy / Move an index
-==================
-You can easily copy or rename an existing index using the `copy` and `move` commands.
-**Note**: Move and copy commands overwrite the destination index.
-```ruby
-# Rename MyIndex in MyIndexNewName
-puts Algolia.move_index("MyIndex", "MyIndexNewName")
-# Copy MyIndex in MyIndexCopy
-puts Algolia.copy_index("MyIndex", "MyIndexCopy")
-```
-The move command is particularly useful if you want to update a big index atomically from one version to another. For example, if you recreate your index `MyIndex` each night from a database by batch, you only need to:
- 1. Import your database into a new index using [batches](#batch-writes). Let's call this new index `MyNewIndex`.
- 1. Rename `MyNewIndex` to `MyIndex` using the move command. This will automatically override the old index and new queries will be served on the new one.
-```ruby
-# Rename MyNewIndex in MyIndex (and overwrite it)
-puts Algolia.move_index("MyNewIndex", "MyIndex")
-```
-Backup / Export an index
-==================
+### Backup / Export an index - `browse`
 The `search` method cannot return more than 1,000 results. If you need to
 retrieve all the content of your index (for backup, SEO purposes or for running
@@ -2098,7 +2117,48 @@ word proximity, geo distance and number of matched words are disabled. Results
 are still returned ranked by attributes and custom ranking.
-Example:
+#### Response Format
+##### Sample
+```json
+{
+  "hits": [
+    {
+      "firstname": "Jimmie",
+      "lastname": "Barninger",
+      "objectID": "433"
+    }
+  ],
+  "processingTimeMS": 7,
+  "query": "",
+  "params": "filters=level%3D20",
+  "cursor": "ARJmaWx0ZXJzPWxldmVsJTNEMjABARoGODA4OTIzvwgAgICAgICAgICAAQ=="
+}
+```
+##### Fields
+- `cursor` (string, optional): A cursor to retrieve the next chunk of data. If absent, it means that the end of the index has been reached.
+- `query` (string): Query text used to filter the results.
+- `params` (string, URL-encoded): Search parameters used to filter the results.
+- `processingTimeMS` (integer): Time that the server took to process the request, in milliseconds. *Note: This does not include network time.*
+The following fields are provided for convenience purposes, and **only when the browse is not filtered**:
+- `nbHits` (integer): Number of objects in the index.
+- `page` (integer): Index of the current page (zero-based).
+- `hitsPerPage` (integer): Maximum number of hits returned per page.
+- `nbPages` (integer): Number of pages corresponding to the number of hits. Basically, `ceil(nbHits / hitsPerPage)`.
+#### Example
 ```ruby
 # Iterate with a filter over the index
@@ -2110,16 +2170,7 @@ end
-API Keys
-==================
-The **admin** API key provides full control of all your indices. *The admin API key should always be kept secure; do NOT use it from outside your back-end.*
-You can also generate user API keys to control security.
-These API keys can be restricted to a set of operations or/and restricted to a given index.
-## List API keys
+### List api keys - `list_api_keys`
 To list existing keys, you can use:
@@ -2131,17 +2182,18 @@ index.list_user_keys
 ```
 Each key is defined by a set of permissions that specify the authorized actions. The different permissions are:
- * **search**: Allowed to search.
- * **browse**: Allowed to retrieve all index contents via the browse API.
- * **addObject**: Allowed to add/update an object in the index.
- * **deleteObject**: Allowed to delete an existing object.
- * **deleteIndex**: Allowed to delete index content.
- * **settings**: allows to get index settings.
- * **editSettings**: Allowed to change index settings.
- * **analytics**: Allowed to retrieve analytics through the analytics API.
- * **listIndexes**: Allowed to list all accessible indexes.
-## Create API keys
+* **search**: Allowed to search.
+* **browse**: Allowed to retrieve all index contents via the browse API.
+* **addObject**: Allowed to add/update an object in the index.
+* **deleteObject**: Allowed to delete an existing object.
+* **deleteIndex**: Allowed to delete index content.
+* **settings**: allows to get index settings.
+* **editSettings**: Allowed to change index settings.
+* **analytics**: Allowed to retrieve analytics through the analytics API.
+* **listIndexes**: Allowed to list all accessible indexes.
+### Add user key - `add_user_key`
 To create API keys:
@@ -2234,7 +2286,7 @@ You can also create an API Key with advanced settings:
         </div>
       </td>
       <td class='client-readme-param-content'>
-        <p>Specify the list of referers. You can target all referers starting with a prefix or ending with a suffix using the &#39;*&#39; character. For example, &quot;algolia.com/*&quot; matches all referers starting with &quot;algolia.com/&quot; and &quot;*.algolia.com&quot; matches all referers ending with &quot;.algolia.com&quot;. Defaults to all referers if empty or blank.</p>
+        <p>Specify the list of referers. You can target all referers starting with a prefix, ending with a suffix using the &#39;*&#39; character. For example, &quot;<a href="https://algolia.com/%5C*">https://algolia.com/\*</a>&quot; matches all referers starting with &quot;<a href="https://algolia.com/">https://algolia.com/</a>&quot; and &quot;*.algolia.com&quot; matches all referers ending with &quot;.algolia.com&quot;. If you want to allow the domain algolia.com you can use &quot;*algolia.com/*&quot;. Defaults to all referers if empty or blank.</p>
       </td>
     </tr>
@@ -2298,9 +2350,10 @@ res = Algolia.add_user_key(params)
 puts res['key']
 ```
-## Update API keys
+### Update user key - `update_user_key`
 To update the permissions of an existing key:
 ```ruby
 # Update an existing global API key that is valid for 300 seconds
 res = Algolia.update_user_key("myAPIKey", ["search"], 300)
@@ -2313,7 +2366,9 @@ puts res['key']
 res = index.update_user_key("myAPIKey", ["search"], 300, 100, 20, ['my_index1', 'my_index2'])
 puts res['key']
 ```
 To get the permissions of a given key:
 ```ruby
 # Gets the rights of a global key
 Algolia.get_user_key("f420238212c54dcfad07ea0aa6d5c45f")
@@ -2321,9 +2376,10 @@ Algolia.get_user_key("f420238212c54dcfad07ea0aa6d5c45f")
 index.get_user_key("71671c38001bf3ac857bc82052485107")
 ```
-## Delete API keys
+### Delete user key - `delete_user_key`
 To delete an existing key:
 ```ruby
 # Deletes a global key
 Algolia.delete_user_key("f420238212c54dcfad07ea0aa6d5c45f")
@@ -2331,76 +2387,67 @@ Algolia.delete_user_key("f420238212c54dcfad07ea0aa6d5c45f")
 index.delete_user_key("71671c38001bf3ac857bc82052485107")
 ```
+### Get key permissions - `get_user_key_acl`
-## Secured API keys (frontend)
-You may have a single index containing **per user** data. In that case, all records should be tagged with their associated `user_id` in order to add a `tagFilters=user_42` filter at query time to retrieve only what a user has access to. If you're using the [JavaScript client](http://github.com/algolia/algoliasearch-client-js), it will result in a security breach since the user is able to modify the `tagFilters` you've set by modifying the code from the browser. To keep using the JavaScript client (recommended for optimal latency) and target secured records, you can generate a secured API key from your backend:
+To get the permissions of a given key:
 ```ruby
-# generate a public API key for user 42. Here, records are tagged with:
-#  - 'user_XXXX' if they are visible by user XXXX
-public_key = Algolia.generate_secured_api_key 'YourSearchOnlyApiKey', {'filters'=> '_tags:user_42'}
+# Gets the rights of a global key
+Algolia.get_user_key("f420238212c54dcfad07ea0aa6d5c45f")
+# Gets the rights of an index specific key
+index.get_user_key("71671c38001bf3ac857bc82052485107")
 ```
-This public API key can then be used in your JavaScript code as follow:
-```js
-var client = algoliasearch('YourApplicationID', '<%= public_api_key %>');
+### Multiple queries - `multiple_queries`
-var index = client.initIndex('indexName')
+You can send multiple queries with a single API call using a batch of queries:
-index.search('something', function(err, content) {
-  if (err) {
-    console.error(err);
-    return;
-  }
+```ruby
+# perform 3 queries in a single API call:
+# - 1st query targets index `categories`
+# - 2nd and 3rd queries target index `products`
+res = Algolia.multiple_queries([{:index_name => "categories", "query" => my_query_string, "hitsPerPage" => 3}
+  , {:index_name => "products", "query" => my_query_string, "hitsPerPage" => 3, "filters" => "_tags:promotion"}
+  , {:index_name => "products", "query" => my_query_string, "hitsPerPage" => 10}])
-  console.log(content);
-});
+puts res["results"]
 ```
-You can mix rate limits and secured API keys by setting a `userToken` query parameter at API key generation time. When set, a unique user will be identified by her `IP + user_token` instead of only by her `IP`. This allows you to restrict a single user to performing a maximum of `N` API calls per hour, even if she shares her `IP` with another user.
+You can specify a `strategy` parameter to optimize your multiple queries:
-```ruby
-# generate a public API key for user 42. Here, records are tagged with:
-#  - 'user_XXXX' if they are visible by user XXXX
-public_key = Algolia.generate_secured_api_key 'YourSearchOnlyApiKey', {'filters'=> '_tags:user_42', 'userToken'=> 'user_42'}
-```
+- `none`: Execute the sequence of queries until the end.
+- `stopIfEnoughMatches`: Execute the sequence of queries until the number of hits is reached by the sum of hits.
-This public API key can then be used in your JavaScript code as follow:
+#### Response
-```js
-var client = algoliasearch('YourApplicationID', '<%= public_api_key %>');
+The resulting JSON contains the following fields:
-var index = client.initIndex('indexName')
+- `results` (array): The results for each request, in the order they were submitted. The contents are the same as in [Search in an index](#search-in-an-index---search).
-index.search('another query', function(err, content) {
-  if (err) {
-    console.error(err);
-    return;
-  }
+    Each result also includes the following additional fields:
-  console.log(content);
-});
-```
+    - `index` (string): The name of the targeted index.
+    - `processed` (boolean, optional): *Note: Only returned when `strategy` is `stopIfEnoughmatches`.* Whether the query was processed.
-Logs
-==================
+### Get Logs - `get_logs`
 You can retrieve the latest logs via this API. Each log entry contains:
- * Timestamp in ISO-8601 format
- * Client IP
- * Request Headers (API Key is obfuscated)
- * Request URL
- * Request method
- * Request body
- * Answer HTTP code
- * Answer body
- * SHA1 ID of entry
+* Timestamp in ISO-8601 format
+* Client IP
+* Request Headers (API Key is obfuscated)
+* Request URL
+* Request method
+* Request body
+* Answer HTTP code
+* Answer body
+* SHA1 ID of entry
 You can retrieve the logs of your last 1,000 API calls and browse them using the offset/length parameters:
@@ -2486,8 +2533,24 @@ puts Algolia.get_logs(0, 100).to_json
 puts Algolia.get_logs(0, 100, true).to_json
 ```
-Mock
-==================
+### REST API
+We've developed API clients for the most common programming languages and platforms.
+These clients are advanced wrappers on top of our REST API itself and have been made
+in order to help you integrating the service within your apps:
+for both indexing and search.
+Everything that can be done using the REST API can be done using those clients.
+The REST API lets your interact directly with Algolia platforms from anything that can send an HTTP request
+[Go to the REST API doc](https://algolia.com/doc/rest)
+## Mocking
+### Webmock
 For testing purposes, you may want to mock Algolia's API calls. We provide a [WebMock](https://github.com/bblimke/webmock) configuration that you can use including `algolia/webmock`:
@@ -2516,5 +2579,3 @@ end
 ```