Algolia Search API Client for Python
Project description
.. raw:: html
<!--NO_HTML-->
Algolia Search API Client for Python
====================================
.. raw:: html
<!--/NO_HTML-->
.. raw:: 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.
.. raw:: html
<!--/NO_HTML-->
Our Python 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>`__.
|Build Status| |PyPI version| |Coverage Status|
.. raw:: html
<!--NO_HTML-->
Table of Contents
-----------------
**Getting Started**
1. `Setup <#setup>`__
2. `Quick Start <#quick-start>`__
3. `Guides & Tutorials <#guides-tutorials>`__
**Commands Reference**
1. `Add a new object <#add-a-new-object-to-the-index>`__
2. `Update an object <#update-an-existing-object-in-the-index>`__
3. `Search <#search>`__
4. `Multiple queries <#multiple-queries>`__
5. `Get an object <#get-an-object>`__
6. `Delete an object <#delete-an-object>`__
7. `Delete by query <#delete-by-query>`__
8. `Index settings <#index-settings>`__
9. `List indices <#list-indices>`__
10. `Delete an index <#delete-an-index>`__
11. `Clear an index <#clear-an-index>`__
12. `Wait indexing <#wait-indexing>`__
13. `Batch writes <#batch-writes>`__
14. `Copy / Move an index <#copy--move-an-index>`__
15. `Backup / Export an index <#backup--export-an-index>`__
16. `API Keys <#api-keys>`__
17. `Logs <#logs>`__
.. raw:: html
<!--/NO_HTML-->
Setup
=====
To setup your project, follow these steps:
1. Install AlgoliaSearch using pip:
``pip install --upgrade algoliasearch``.
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>`__.
.. code:: python
from algoliasearch import algoliasearch
client = algoliasearch.Client("YourApplicationID", 'YourAPIKey')
**Note**: If you use this API Client with Google AppEngine (Thanks
[@apassant](https://github.com/apassant)), it will use ``urlfetch``
instead of using the ``request`` module. Please be aware of `urlfetch's
limits <https://cloud.google.com/appengine/docs/python/urlfetch/>`__,
and note that SSL certificates will not be verified for calls to domains
other than algolia.net due to the lack of SNI support in ``urlfetch``.
To run unit tests on the AppEngine stub, please define an
``APPENGINE_RUNTIME`` enviroment variable.
Quick Start
-----------
In 30 seconds, this quick start tutorial will show you how to index and
search objects.
Without any prior configuration, you can start indexing `500
contacts <https://github.com/algolia/algoliasearch-client-csharp/blob/master/contacts.json>`__
in the ``contacts`` index using the following code:
.. code:: python
index = client.init_index("contact")
batch = json.load(open('contacts.json'))
index.add_objects(batch)
You can now search for contacts using firstname, lastname, company, etc.
(even with typos):
.. code:: python
# search by firstname
print index.search("jimmie")
# search a firstname with typo
print index.search("jimie")
# search for a company
print index.search("california paint")
# search for a firstname & company
print index.search("jimmie paint")
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:
.. code:: python
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):
.. code:: python
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:
.. code:: python
print index.search("or")
print index.search("jim")
**Note:** 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
.. code:: html
<script src="//cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
<script>
var client = algoliasearch('ApplicationID', 'apiKey');
var index = client.initIndex('indexName');
// perform query "jim"
index.search('jim', searchCallback);
// the last optional argument can be used to add search parameters
index.search(
'jim', {
hitsPerPage: 5,
facets: '*',
maxValuesPerFacet: 10
},
searchCallback
);
function searchCallback(err, content) {
if (err) {
console.error(err);
return;
}
console.log(content);
}
</script>
.. raw:: html
<!--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/python>`__
\* `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>`__
.. raw:: html
<!--/NO_HTML-->
Add a new object to the Index
=============================
Each entry in an index has a unique identifier called ``objectID``.
There are two ways to add an entry to the index:
1. Using automatic ``objectID`` assignment. You will be able to access
it in the answer.
2. Supplying your own ``objectID``.
You don't need to explicitly create an index, it will be automatically
created the first time you add an object. Objects are schema less so you
don't need any configuration to start indexing. If you wish to configure
things, the settings section provides details about advanced settings.
Example with automatic ``objectID`` assignment:
.. code:: python
res = index.add_object({"firstname": "Jimmie",
"lastname": "Barninger"})
print "ObjectID=%s" % res["objectID"]
Example with manual ``objectID`` assignment:
.. code:: python
res = index.add_object({"firstname": "Jimmie",
"lastname": "Barninger"}, "myID")
print "ObjectID=%s" % res["objectID"]
Update an existing object in the Index
======================================
You have three options when updating an existing object:
1. Replace all its attributes.
2. Replace only some attributes.
3. Apply an operation to some attributes.
Example on how to replace all attributes of an existing object:
.. code:: python
index.save_object({"firstname": "Jimmie",
"lastname": "Barninger",
"city": "New York",
"objectID": "myID"})
You have many ways to update an object's attributes:
1. Set the attribute value
2. Add a string or number element to an array
3. Remove an element from an array
4. Add a string or number element to an array if it doesn't exist
5. Increment an attribute
6. Decrement an attribute
Example to update only the city attribute of an existing object:
.. code:: python
index.partial_update_object({"city": "San Francisco",
"objectID": "myID"})
Example to add a tag:
.. code:: python
index.partial_update_object({"_tags": { "value": "MyTag", "_operation": "Add"},
"objectID": "myID"})
Example to remove a tag:
.. code:: python
index.partial_update_object({"_tags": { "value": "MyTag", "_operation": "Remove"},
"objectID": "myID"})
Example to add a tag if it doesn't exist:
.. code:: python
index.partial_update_object({"_tags": { "value": "MyTag", "_operation": "AddUnique"},
"objectID": "myID"})
Example to increment a numeric value:
.. code:: python
index.partial_update_object({"price": { "value": 42, "_operation": "Increment"},
"objectID": "myID"})
Note: Here we are incrementing the value by ``42``. To increment just by
one, put ``value:1``.
Example to decrement a numeric value:
.. code:: python
index.partial_update_object({"price": { "value": 42, "_operation": "Decrement"},
"objectID": "myID"})
Note: Here we are decrementing the value by ``42``. To decrement just by
one, put ``value:1``.
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 for seo, you can use `Backup / Retrieve all
index content <#backup--export-an-index>`__
.. code:: python
index = client.init_index("contacts")
res = index.search("query string")
res = index.search("query string", { "attributesToRetrieve": "fistname,lastname", "hitsPerPage": 20})
The server response will look like:
.. code:: 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"
}
You can use the following optional arguments:
Full Text Search Parameters
---------------------------
.. raw:: html
<table>
.. raw:: html
<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>
</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>
.. raw:: html
<ul>
.. raw:: html
<li>
prefixAll: All query words are interpreted as prefixes. This option is
not recommended.
.. raw:: html
</li>
.. raw:: html
<li>
prefixLast: Only the last word is interpreted as a prefix (default
behavior).
.. raw:: html
</li>
.. raw:: html
<li>
prefixNone: No query word is interpreted as a prefix. This option is not
recommended.
.. raw:: html
</li>
.. raw:: html
</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>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>
.. raw:: html
<ul>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
none: No specific processing is done when a query does not return any
results (default behavior).
.. raw:: html
</li>
.. raw:: html
</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>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>
</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>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>
</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>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>
.. raw:: html
<ul>
.. raw:: html
<li>
true: The typo tolerance is enabled and all matching hits are retrieved
(default behavior).
.. raw:: html
</li>
.. raw:: html
<li>
false: The typo tolerance is disabled. All results with typos will be
hidden.
.. raw:: html
</li>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
strict: Hits matching with 2 typos are not retrieved if there are some
matching without typos.
.. raw:: html
</li>
.. raw:: html
</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>
</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>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't be considered as a typo. For example, car and cars, or foot and feet will be considered as equivalent. Defaults to false.</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>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>"name,address"</code>. You can also use JSON string array encoding such as <code>encodeURIComponent("[\"name\",\"address\"]")</code>. By default, this 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>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>"name,address"</code>. You can also use JSON string array encoding such as <code>encodeURIComponent("[\"name\",\"address\"]")</code>. By default, all attributes specified in the <code>attributesToIndex</code> settings are used to search.</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>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 the stop words from query before executing it. Defaults to false. Contains a list of stop words from 41 languages (Arabic, Armenian, Basque, Bengali, Brazilian, Bulgarian, Catalan, Chinese, Czech, Danish, Dutch, English, Finnish, French, Galician, German, Greek, Hindi, Hungarian, Indonesian, Irish, Italian, Japanese, Korean, Kurdish, Latvian, Lithuanian, Marathi, Norwegian, Persian, Polish, Portugese, Romanian, Russian, Slovak, Spanish, Swedish, Thai, Turkish, Ukranian, Urdu). In most use-cases, we don't recommend enabling this option.</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>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>
.. raw:: html
<ul>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
</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>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>
</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>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>
</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>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>
</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>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>
.. raw:: html
</tbody>
.. raw:: html
</table>
Pagination Parameters
---------------------
.. raw:: html
<table>
.. raw:: html
<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>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>
</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>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>
.. raw:: html
</tbody>
.. raw:: html
</table>
Geo-search Parameters
---------------------
.. raw:: html
<table>
.. raw:: html
<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>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>
.. raw:: html
<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
aroundRadius parameter. The precision for ranking can be set with
aroundPrecision 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 "geo"
ranking parameter.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, you can
also use the minimumAroundRadius query parameter to specify a minimum
radius in meters for the automatic computation of aroundRadius.
.. raw:: html
</p>
.. raw:: html
<p>
At indexing, you should specify geoloc of an object with the \_geoloc
attribute (in the form "\_geoloc":{"lat":48.853409, "lng":2.348800} or
"\_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456,
"lng":2.972075}] if you have several geo-locations in your record).
.. raw:: html
</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>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>
.. raw:: html
<p>
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).
.. raw:: html
</p>
.. raw:: html
<p>
At indexing, you should specify the geo location of an object with the
\_geoloc attribute in the form {"\_geoloc":{"lat":48.853409,
"lng":2.348800}}.
.. raw:: html
</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>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>"_geoloc":{"lat":48.853409, "lng":2.348800}</code> or <code>"_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456, "lng":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>
</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>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>"_geoloc":{"lat":48.853409, "lng":2.348800}</code> or <code>"_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456, "lng":2.972075}]</code> if you have several geo-locations in your record).</p>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Parameters to Control Results Content
-------------------------------------
.. raw:: html
<table>
.. raw:: html
<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>
.. raw:: html
<p>
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.
.. raw:: html
</p>
.. raw:: html
<p>
objectID is always retrieved even when not specified.
.. raw:: html
</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>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>["name","address"]</code>). If an attribute has no match for the query, the raw value is returned. By default, all indexed attributes are highlighted. You can use <code>*</code> if you want to highlight all attributes. A matchLevel is returned for each highlighted attribute and can contain:</p>
.. raw:: html
<ul>
.. raw:: html
<li>
full: If all the query terms were found in the attribute.
.. raw:: html
</li>
.. raw:: html
<li>
partial: If only some of the query terms were found.
.. raw:: html
</li>
.. raw:: html
<li>
none: If none of the query terms were found.
.. raw:: html
</li>
.. raw:: html
</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>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>
.. raw:: html
<p>
You can also use a string array encoding (Example: attributesToSnippet:
["name:10","content:10"]). By default, no snippet is computed.
.. raw:: html
</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>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>
</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><em>Default: <strong><em></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><em></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><em>Default: <strong></em></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></em></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>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>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Numeric Search Parameters
-------------------------
.. raw:: html
<table>
.. raw:: html
<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><</code>, <code><=</code>, <code>=</code>, <code>></code> and <code>>=</code>.</p>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</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``.
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"]``).
Category Search Parameters
--------------------------
.. raw:: html
<table>
.. raw:: html
<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: ["tag1",["tag2","tag3"]]</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>
.. raw:: html
<p>
At indexing, tags should be added in the \_tags attribute of objects.
For example {"\_tags":["tag1","tag2"]}.
.. raw:: html
</p>
::
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Faceting Parameters
-------------------
.. raw:: html
<table>
.. raw:: html
<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>[["category:Book","category:Movie"],"author:John%20Doe"]</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>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'll be able to retrieve a list of the most relevant facet values, and their associated count for the current query.</p>
.. raw:: html
<p>
Attributes are separated by a comma. For example, "category,author". You
can also use JSON string array encoding. For example,
["category","author"]. Only the 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.
.. raw:: html
</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>
</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>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Unified Filter Parameter (SQL - like)
-------------------------------------
.. raw:: html
<table>
.. raw:: html
<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>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:
available=1 AND (category:Book OR NOT category:Ebook) AND \_tags:public
date: 1441745506 TO 1441755506 AND inStock > 0 AND author:"John Doe"
.. raw:: html
</p>
.. raw:: html
<p>
If no attribute name is specified, the filter applies to \_tags. For
example: public OR user\_42 will translate to \_tags:public OR
\_tags:user\_42.
.. raw:: html
</p>
.. raw:: html
<p>
The list of keywords is:
.. raw:: html
</p>
.. raw:: html
<ul>
.. raw:: html
<li>
OR: create a disjunctive filter between two filters.
.. raw:: html
</li>
.. raw:: html
<li>
AND: create a conjunctive filter between two filters.
.. raw:: html
</li>
.. raw:: html
<li>
TO: used to specify a range for a numeric filter.
.. raw:: html
</li>
.. raw:: html
<li>
NOT: used to negate a filter. The syntax with the - isn’t allowed.
.. raw:: html
</li>
.. raw:: html
</ul>
::
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
*Note*: To specify a value with spaces or with a value equal to a
keyword, it's possible to add quotes.
**Warning:**
- 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.
Distinct Parameter
------------------
.. raw:: html
<table>
.. raw:: html
<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>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 "distinct" 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>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
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>`__.
Multiple queries
================
You can send multiple queries with a single API call using a batch of
queries:
.. code:: python
# perform 3 queries in a single API call:
# - 1st query targets index `categories`
# - 2nd and 3rd queries target index `products`
results = self.client.multiple_queries([{"indexName" : "categories", "query" : myQueryString, "hitsPerPage": 3}
, {"indexName" : "categories", "query" : myQueryString, "hitsPerPage": 3, "filters": "_tags:promotion"}
, {"indexName" : "categories", "query" : myQueryString, "hitsPerPage": 10}])
print results["results"]
The resulting JSON answer contains a ``results`` array storing the
underlying queries answers. The answers order is the same than the
requests order.
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.
Get an object
=============
You can easily retrieve an object using its ``objectID`` and optionally
specify a comma separated list of attributes you want:
.. code:: python
# 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:
.. code:: python
res = index.get_objects(["myID1", "myID2"])
Delete an object
================
You can delete an object using its ``objectID``:
.. code:: python
index.delete_object("myID")
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.
.. code:: python
params = {}
index.delete_by_query("John", params)
Index Settings
==============
You can easily retrieve or update settings:
.. code:: python
settings = index.get_settings()
print settings
.. code:: python
index.set_settings({"customRanking": ["desc(followers)"]})
Indexing parameters
-------------------
.. raw:: html
<table>
.. raw:: html
<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>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>
.. raw:: html
<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.
.. raw:: html
</p>
.. raw:: html
<p>
This parameter has two important uses:
.. raw:: html
</p>
.. raw:: html
<ul>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
Control part of the ranking. 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
unordered(AttributeName). For example, attributesToIndex: ["title",
"unordered(text)"]. 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 title and alternative\_title have the same
priority in this example, which is different than text priority:
attributesToIndex:["title,alternative\_title", "text"]. To get a full
description of how the Ranking works, you can have a look at our Ranking
guide.
.. raw:: html
</li>
.. raw:: html
<li>
numericAttributesToIndex: (array of strings) 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.
.. raw:: html
</li>
.. raw:: html
</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>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>
</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 "distinct" 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>
<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>
.. raw:: html
<p>
We have nine available criteria:
.. raw:: html
</p>
.. raw:: html
<ul>
.. raw:: html
<li>
typo: Sort according to number of typos.
.. raw:: html
</li>
.. raw:: html
<li>
geo: Sort according to decreasing distance when performing a geo
location based search.
.. raw:: html
</li>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
proximity: Sort according to the proximity of the query words in hits.
.. raw:: html
</li>
.. raw:: html
<li>
attribute: Sort according to the order of attributes defined by
attributesToIndex.
.. raw:: html
</li>
.. raw:: html
<li>
exact:
.. raw:: html
<ul>
.. raw:: html
<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 "V", you want to find it with the "V" query and avoid
getting all popular TV shows starting by the letter V before it.
.. raw:: html
</li>
.. raw:: html
<li>
If the user query contains multiple words: sort according to the number
of words that matched exactly (not as a prefix).
.. raw:: html
</li>
.. raw:: html
</ul>
.. raw:: html
</li>
.. raw:: html
<li>
custom: Sort according to a user defined formula set in the
customRanking attribute.
.. raw:: html
</li>
.. raw:: html
<li>
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).
.. raw:: html
</li>
.. raw:: html
<li>
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). The standard order is
["typo", "geo", "words", "proximity", "attribute", "exact", "custom"].
To get a full description of how the Ranking works, you can have a look
at our Ranking guide.
.. raw:: html
</li>
.. raw:: html
</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>
.. raw:: html
<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, "customRanking" => ["desc(population)",
"asc(name)"].
.. raw:: html
</p>
.. raw:: html
<p>
To get a full description of how the Custom Ranking works, you can have
a look at our Ranking guide.
.. raw:: html
</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>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>
.. raw:: html
<ul>
.. raw:: html
<li>
prefixAll: All query words are interpreted as prefixes.
.. raw:: html
</li>
.. raw:: html
<li>
prefixLast: Only the last word is interpreted as a prefix (default
behavior).
.. raw:: html
</li>
.. raw:: html
<li>
prefixNone: No query word is interpreted as a prefix. This option is not
recommended.
.. raw:: html
</li>
.. raw:: html
</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>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>
<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>
</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>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're using the ADMIN API Key.</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>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>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Query expansion
---------------
.. raw:: html
<table>
.. raw:: html
<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>"synomyms": [ [ "black", "dark" ], [ "small", "little", "mini" ], ... ]</code>. The Synonym feature also supports multi-words expressions like <code>"synonyms": [ ["NYC", "New York City"] ]</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>"placeholders": { "<streetnumber>": ["1", "2", "3", ..., "9999"]}</code> would allow it to be able to match all street numbers. We use the <code>< ></code> tag syntax to define placeholders in an attribute. For example:</p>
.. raw:: html
<ul>
.. raw:: html
<li>
Push a record with the placeholder: { "name" : "Apple Store", "address"
: "<streetnumber> Opera street, Paris" }.
.. raw:: html
</li>
.. raw:: html
<li>
Configure the placeholder in your index settings: "placeholders": {
"<streetnumber>" : ["1", "2", "3", "4", "5", ... ], ... }.
.. raw:: html
</li>
.. raw:: html
</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>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>
</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>
.. raw:: html
<ul>
.. raw:: html
<li>
word: The word to correct.
.. raw:: html
</li>
.. raw:: html
<li>
correction: The corrected word.
.. raw:: html
</li>
.. raw:: html
<li>
nbTypos The number of typos (1 or 2) that will be considered for the
ranking algorithm (1 typo is better than 2 typos).
.. raw:: html
</li>
.. raw:: html
</ul>
.. raw:: html
<p>
For example "altCorrections": [ { "word" : "foot", "correction": "feet",
"nbTypos": 1 }, { "word": "feet", "correction": "foot", "nbTypos": 1 }
].
.. raw:: html
</p>
::
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Default query parameters (can be overwritten by queries)
--------------------------------------------------------
.. raw:: html
<table>
.. raw:: html
<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>
</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>
</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>
</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>
</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>
</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><em></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></em></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>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>
</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>"304"</code> will match with <code>"30450"</code>, but not with <code>"40450"</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>
</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>
</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>
.. raw:: html
<ul>
.. raw:: html
<li>
.. raw:: html
<p>
Phrase query: a phrase query defines a particular sequence of terms. A
phrase query is build 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.
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
<li>
.. raw:: html
<p>
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.
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
</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>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 "distinct" 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>
.. raw:: html
<p>
To get a full understanding of how Distinct works, you can have a look
at our guide on distinct.
.. raw:: html
</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>
.. raw:: html
<ul>
.. raw:: html
<li>
.. raw:: html
<p>
true: activate the typo-tolerance (default value).
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
<li>
.. raw:: html
<p>
false: disable the typo-tolerance
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
<li>
.. raw:: html
<p>
min: 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.
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
<li>
.. raw:: html
<p>
strict: if there is a match without typo, then all results with 2 typos
or more will be removed.
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
</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>removeStopWords</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>Remove stop words from query before executing it. Defaults to false. Contains stop words for 41 languages (Arabic, Armenian, Basque, Bengali, Brazilian, Bulgarian, Catalan, Chinese, Czech, Danish, Dutch, English, Finnish, French, Galician, German, Greek, Hindi, Hungarian, Indonesian, Irish, Italian, Japanese, Korean, Kurdish, Latvian, Lithuanian, Marathi, Norwegian, Persian, Polish, Portugese, Romanian, Russian, Slovak, Spanish, Swedish, Thai, Turkish, Ukranian, Urdu)</p>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
List indices
============
You can list all your indices along with their associated information
(number of entries, disk size, etc.) with the ``list_indexes`` method:
.. code:: python
print client.list_indexes()
Delete an index
===============
You can delete an index using its name:
.. code:: python
client.delete_index("contacts")
Clear an index
==============
You can delete the index contents without removing settings and index
specific API keys by using the clearIndex command:
.. code:: python
index.clear_index()
Wait indexing
=============
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 ``waitTask`` method on the
``taskID`` returned by a write operation.
For example, to wait for indexing of a new object:
.. code:: python
res = index.add_object({"firstname": "Jimmie",
"lastname": "Barninger"})
index.wait_task(res["taskID"])
If you want to ensure multiple objects have been indexed, you only need
to check the biggest ``taskID``.
Batch writes
============
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).
Example using automatic ``objectID`` assignment:
.. code:: python
res = index.add_objects([{"firstname": "Jimmie",
"lastname": "Barninger"},
{"firstname": "Warren",
"lastname": "Speach"}])
Example with user defined ``objectID`` (add or update):
.. code:: python
res = index.save_objects([{"firstname": "Jimmie",
"lastname": "Barninger",
"objectID": "myID1"},
{"firstname": "Warren",
"lastname": "Speach",
"objectID": "myID2"}])
Example that deletes a set of records:
.. code:: python
res = index.delete_objects(["myID1", "myID2"])
Example that updates only the ``firstname`` attribute:
.. code:: python
res = index.partial_update_objects([{"firstname": "Jimmie",
"objectID": "myID1"},
{"firstname": "Warren",
"objectID": "myID2"}])
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:
.. code:: python
res = index.batch([
{"action": "addObject", "indexName": "index1", {"firstname": "Jimmie", "lastname": "Barninger"}},
{"action": "addObject", "indexName": "index2", {"firstname": "Warren", "lastname": "Speach"}}])
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.
.. code:: python
# Rename MyIndex in MyIndexNewName
print client.move_index("MyIndex", "MyIndexNewName")
# Copy MyIndex in MyIndexCopy
print client.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.
.. code:: python
# Rename MyNewIndex in MyIndex (and overwrite it)
print client.move_index("MyNewIndex", "MyIndex")
Backup / Export an index
========================
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 a script on it), you should use the ``browse`` method
instead. This method lets you retrieve objects beyond the 1,000 limit.
This method is optimized for speed. To make it fast, distinct,
typo-tolerance, word proximity, geo distance and number of matched words
are disabled. Results are still returned ranked by attributes and custom
ranking.
It will return a ``cursor`` alongside your data, that you can then use
to retrieve the next chunk of your records.
You can specify custom parameters (like ``page`` or ``hitsPerPage``) on
your first ``browse`` call, and these parameters will then be included
in the ``cursor``. Note that it is not possible to access records beyond
the 1,000th on the first call.
Example:
.. code:: python
# Iterate with a filter over the index
res = self.index.browse_all({"query": "test", "filters": "i<42"})
for hit in res
# Do something
# Retrieve the next cursor from the browse method
res = self.index.browse_from({"query": "test", "filters": "i<42"}, None)
print res["cursor"]
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
-------------
To list existing keys, you can use:
.. code:: python
# Lists global API Keys
client.list_user_keys()
# Lists API Keys that can access only to this index
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
---------------
To create API keys:
.. code:: python
# Creates a new global API key that can only perform search actions
res = client.add_user_key(["search"])
print res["key"]
# Creates a new API key that can only perform search action on this index
res = index.add_user_key(["search"])
print res["key"]
You can also create an API Key with advanced settings:
.. raw:: html
<table>
.. raw:: html
<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>validity</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Add a validity period. The key will be valid for a specific period of time (in seconds).</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>maxQueriesPerIPPerHour</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the maximum number of API calls allowed from an IP address per hour. Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 403 code is returned. Defaults to 0 (no rate limit). This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.</p>
.. raw:: html
<p>
Note: If you are sending the query through your servers, you must use
the enable\_rate\_limit\_forward("TheAdminAPIKey", "EndUserIP",
"APIKeyWithRateLimit") function to enable rate-limit.
.. raw:: html
</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>maxHitsPerQuery</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited). This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.</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>indexes</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the list of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the '*' character. For example, "dev_*" matches all indices starting with "dev_" and "*_dev" matches all indices ending with "_dev". Defaults to all indices if empty or blank.</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>referers</code></div>
</div>
</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 '*' character. For example, "algolia.com/*" matches all referers starting with "algolia.com/" and "*.algolia.com" matches all referers ending with ".algolia.com". Defaults to all referers if empty or blank.</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>queryParameters</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the list of query parameters. You can force the query parameters for a query using the url string format (param1=X&param2=Y...).</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>description</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify a description to describe where the key is used.</p>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
.. code:: python
# Creates a new index specific API key valid for 300 seconds, with a rate limit of 100 calls per hour per IP and a maximum of 20 hits
params = {
'validity': 300,
'maxQueriesPerIPPerHour': 100,
'maxHitsPerQuery': 20,
'indexes': ['dev_*'],
'referers': ['algolia.com/*'],
'queryParameters': 'typoTolerance=strict&ignorePlurals=false',
'description': 'Limited search only API key for algolia.com'
}
res = client.add_user_key(params)
print res["key"]
Update API keys
---------------
To update the permissions of an existing key:
.. code:: python
# Update an existing global API key that is valid for 300 seconds
res = client.update_user_key("myAPIKey", ["search"], 300)
print res["key"]
# Update an existing index specific API key valid for 300 seconds, with a rate limit of 100 calls per hour per IP and a maximum of 20 hits
res = index.update_user_key("myAPIKey", ["search"], 300, 100, 20)
print res["key"]
To get the permissions of a given key:
.. code:: python
# Gets the rights of a global key
print client.get_user_key_acl("f420238212c54dcfad07ea0aa6d5c45f")
# Gets the rights of an index specific key
print index.get_user_key_acl("71671c38001bf3ac857bc82052485107")
Delete API keys
---------------
To delete an existing key:
.. code:: python
# Deletes a global key
print client.delete_user_key("f420238212c54dcfad07ea0aa6d5c45f")
# Deletes an index specific key
print index.delete_user_key("71671c38001bf3ac857bc82052485107")
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:
.. code:: python
# generate a public API key for user 42. Here, records are tagged with:
# - 'user_XXXX' if they are visible by user XXXX
public_key = client.generate_secured_api_key('YourSearchOnlyApiKey', {'filters': '_tags:user_42'})
This public API key can then be used in your JavaScript code as follow:
.. code:: js
var client = algoliasearch('YourApplicationID', '<%= public_api_key %>');
var index = client.initIndex('indexName')
index.search('something', function(err, content) {
if (err) {
console.error(err);
return;
}
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.
.. code:: python
# generate a public API key for user 42. Here, records are tagged with:
# - 'user_XXXX' if they are visible by user XXXX
public_key = client.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:
.. code:: js
var client = algoliasearch('YourApplicationID', '<%= public_api_key %>');
var index = client.initIndex('indexName')
index.search('another query', function(err, content) {
if (err) {
console.error(err);
return;
}
console.log(content);
});
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
You can retrieve the logs of your last 1,000 API calls and browse them
using the offset/length parameters:
.. raw:: html
<table>
.. raw:: html
<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>offset</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the first entry to retrieve (0-based, 0 is the most recent log entry). Defaults to 0.</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>length</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the maximum number of entries to retrieve starting at the offset. Defaults to 10. Maximum allowed value: 1,000.</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>onlyErrors</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Retrieve only logs with an HTTP code different than 200 or 201. (deprecated)</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>type</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the type of logs to retrieve:</p>
.. raw:: html
<ul>
.. raw:: html
<li>
query: Retrieve only the queries.
.. raw:: html
</li>
.. raw:: html
<li>
build: Retrieve only the build operations.
.. raw:: html
</li>
.. raw:: html
<li>
error: Retrieve only the errors (same as onlyErrors parameters).
.. raw:: html
</li>
.. raw:: html
</ul>
::
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
.. code:: python
# Get last 10 log entries
print client.get_logs()
# Get last 100 log entries
print client.get_logs(0, 100)
**Unreachable hosts error?**
If you are seeing an error for ``Unreachable hosts`` when pushing data
to Algolia, this is caused by ``PyOpenSSL`` and older versions of
Python. You can see `more information
here <https://github.com/algolia/algoliasearch-client-python/issues/30>`__.
To fix, either upgrade your Python version or `your
urllib3 <https://github.com/algolia/algoliasearch-client-python/issues/30#issuecomment-151933567>`__.
.. |Build Status| image:: https://travis-ci.org/algolia/algoliasearch-client-python.svg?branch=master
:target: https://travis-ci.org/algolia/algoliasearch-client-python
.. |PyPI version| image:: https://badge.fury.io/py/algoliasearch.svg?branch=master
:target: http://badge.fury.io/py/algoliasearch
.. |Coverage Status| image:: https://coveralls.io/repos/algolia/algoliasearch-client-python/badge.svg?branch=master
:target: https://coveralls.io/r/algolia/algoliasearch-client-python
<!--NO_HTML-->
Algolia Search API Client for Python
====================================
.. raw:: html
<!--/NO_HTML-->
.. raw:: 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.
.. raw:: html
<!--/NO_HTML-->
Our Python 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>`__.
|Build Status| |PyPI version| |Coverage Status|
.. raw:: html
<!--NO_HTML-->
Table of Contents
-----------------
**Getting Started**
1. `Setup <#setup>`__
2. `Quick Start <#quick-start>`__
3. `Guides & Tutorials <#guides-tutorials>`__
**Commands Reference**
1. `Add a new object <#add-a-new-object-to-the-index>`__
2. `Update an object <#update-an-existing-object-in-the-index>`__
3. `Search <#search>`__
4. `Multiple queries <#multiple-queries>`__
5. `Get an object <#get-an-object>`__
6. `Delete an object <#delete-an-object>`__
7. `Delete by query <#delete-by-query>`__
8. `Index settings <#index-settings>`__
9. `List indices <#list-indices>`__
10. `Delete an index <#delete-an-index>`__
11. `Clear an index <#clear-an-index>`__
12. `Wait indexing <#wait-indexing>`__
13. `Batch writes <#batch-writes>`__
14. `Copy / Move an index <#copy--move-an-index>`__
15. `Backup / Export an index <#backup--export-an-index>`__
16. `API Keys <#api-keys>`__
17. `Logs <#logs>`__
.. raw:: html
<!--/NO_HTML-->
Setup
=====
To setup your project, follow these steps:
1. Install AlgoliaSearch using pip:
``pip install --upgrade algoliasearch``.
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>`__.
.. code:: python
from algoliasearch import algoliasearch
client = algoliasearch.Client("YourApplicationID", 'YourAPIKey')
**Note**: If you use this API Client with Google AppEngine (Thanks
[@apassant](https://github.com/apassant)), it will use ``urlfetch``
instead of using the ``request`` module. Please be aware of `urlfetch's
limits <https://cloud.google.com/appengine/docs/python/urlfetch/>`__,
and note that SSL certificates will not be verified for calls to domains
other than algolia.net due to the lack of SNI support in ``urlfetch``.
To run unit tests on the AppEngine stub, please define an
``APPENGINE_RUNTIME`` enviroment variable.
Quick Start
-----------
In 30 seconds, this quick start tutorial will show you how to index and
search objects.
Without any prior configuration, you can start indexing `500
contacts <https://github.com/algolia/algoliasearch-client-csharp/blob/master/contacts.json>`__
in the ``contacts`` index using the following code:
.. code:: python
index = client.init_index("contact")
batch = json.load(open('contacts.json'))
index.add_objects(batch)
You can now search for contacts using firstname, lastname, company, etc.
(even with typos):
.. code:: python
# search by firstname
print index.search("jimmie")
# search a firstname with typo
print index.search("jimie")
# search for a company
print index.search("california paint")
# search for a firstname & company
print index.search("jimmie paint")
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:
.. code:: python
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):
.. code:: python
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:
.. code:: python
print index.search("or")
print index.search("jim")
**Note:** 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
.. code:: html
<script src="//cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
<script>
var client = algoliasearch('ApplicationID', 'apiKey');
var index = client.initIndex('indexName');
// perform query "jim"
index.search('jim', searchCallback);
// the last optional argument can be used to add search parameters
index.search(
'jim', {
hitsPerPage: 5,
facets: '*',
maxValuesPerFacet: 10
},
searchCallback
);
function searchCallback(err, content) {
if (err) {
console.error(err);
return;
}
console.log(content);
}
</script>
.. raw:: html
<!--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/python>`__
\* `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>`__
.. raw:: html
<!--/NO_HTML-->
Add a new object to the Index
=============================
Each entry in an index has a unique identifier called ``objectID``.
There are two ways to add an entry to the index:
1. Using automatic ``objectID`` assignment. You will be able to access
it in the answer.
2. Supplying your own ``objectID``.
You don't need to explicitly create an index, it will be automatically
created the first time you add an object. Objects are schema less so you
don't need any configuration to start indexing. If you wish to configure
things, the settings section provides details about advanced settings.
Example with automatic ``objectID`` assignment:
.. code:: python
res = index.add_object({"firstname": "Jimmie",
"lastname": "Barninger"})
print "ObjectID=%s" % res["objectID"]
Example with manual ``objectID`` assignment:
.. code:: python
res = index.add_object({"firstname": "Jimmie",
"lastname": "Barninger"}, "myID")
print "ObjectID=%s" % res["objectID"]
Update an existing object in the Index
======================================
You have three options when updating an existing object:
1. Replace all its attributes.
2. Replace only some attributes.
3. Apply an operation to some attributes.
Example on how to replace all attributes of an existing object:
.. code:: python
index.save_object({"firstname": "Jimmie",
"lastname": "Barninger",
"city": "New York",
"objectID": "myID"})
You have many ways to update an object's attributes:
1. Set the attribute value
2. Add a string or number element to an array
3. Remove an element from an array
4. Add a string or number element to an array if it doesn't exist
5. Increment an attribute
6. Decrement an attribute
Example to update only the city attribute of an existing object:
.. code:: python
index.partial_update_object({"city": "San Francisco",
"objectID": "myID"})
Example to add a tag:
.. code:: python
index.partial_update_object({"_tags": { "value": "MyTag", "_operation": "Add"},
"objectID": "myID"})
Example to remove a tag:
.. code:: python
index.partial_update_object({"_tags": { "value": "MyTag", "_operation": "Remove"},
"objectID": "myID"})
Example to add a tag if it doesn't exist:
.. code:: python
index.partial_update_object({"_tags": { "value": "MyTag", "_operation": "AddUnique"},
"objectID": "myID"})
Example to increment a numeric value:
.. code:: python
index.partial_update_object({"price": { "value": 42, "_operation": "Increment"},
"objectID": "myID"})
Note: Here we are incrementing the value by ``42``. To increment just by
one, put ``value:1``.
Example to decrement a numeric value:
.. code:: python
index.partial_update_object({"price": { "value": 42, "_operation": "Decrement"},
"objectID": "myID"})
Note: Here we are decrementing the value by ``42``. To decrement just by
one, put ``value:1``.
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 for seo, you can use `Backup / Retrieve all
index content <#backup--export-an-index>`__
.. code:: python
index = client.init_index("contacts")
res = index.search("query string")
res = index.search("query string", { "attributesToRetrieve": "fistname,lastname", "hitsPerPage": 20})
The server response will look like:
.. code:: 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"
}
You can use the following optional arguments:
Full Text Search Parameters
---------------------------
.. raw:: html
<table>
.. raw:: html
<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>
</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>
.. raw:: html
<ul>
.. raw:: html
<li>
prefixAll: All query words are interpreted as prefixes. This option is
not recommended.
.. raw:: html
</li>
.. raw:: html
<li>
prefixLast: Only the last word is interpreted as a prefix (default
behavior).
.. raw:: html
</li>
.. raw:: html
<li>
prefixNone: No query word is interpreted as a prefix. This option is not
recommended.
.. raw:: html
</li>
.. raw:: html
</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>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>
.. raw:: html
<ul>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
none: No specific processing is done when a query does not return any
results (default behavior).
.. raw:: html
</li>
.. raw:: html
</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>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>
</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>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>
</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>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>
.. raw:: html
<ul>
.. raw:: html
<li>
true: The typo tolerance is enabled and all matching hits are retrieved
(default behavior).
.. raw:: html
</li>
.. raw:: html
<li>
false: The typo tolerance is disabled. All results with typos will be
hidden.
.. raw:: html
</li>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
strict: Hits matching with 2 typos are not retrieved if there are some
matching without typos.
.. raw:: html
</li>
.. raw:: html
</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>
</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>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't be considered as a typo. For example, car and cars, or foot and feet will be considered as equivalent. Defaults to false.</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>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>"name,address"</code>. You can also use JSON string array encoding such as <code>encodeURIComponent("[\"name\",\"address\"]")</code>. By default, this 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>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>"name,address"</code>. You can also use JSON string array encoding such as <code>encodeURIComponent("[\"name\",\"address\"]")</code>. By default, all attributes specified in the <code>attributesToIndex</code> settings are used to search.</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>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 the stop words from query before executing it. Defaults to false. Contains a list of stop words from 41 languages (Arabic, Armenian, Basque, Bengali, Brazilian, Bulgarian, Catalan, Chinese, Czech, Danish, Dutch, English, Finnish, French, Galician, German, Greek, Hindi, Hungarian, Indonesian, Irish, Italian, Japanese, Korean, Kurdish, Latvian, Lithuanian, Marathi, Norwegian, Persian, Polish, Portugese, Romanian, Russian, Slovak, Spanish, Swedish, Thai, Turkish, Ukranian, Urdu). In most use-cases, we don't recommend enabling this option.</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>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>
.. raw:: html
<ul>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
</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>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>
</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>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>
</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>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>
</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>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>
.. raw:: html
</tbody>
.. raw:: html
</table>
Pagination Parameters
---------------------
.. raw:: html
<table>
.. raw:: html
<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>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>
</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>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>
.. raw:: html
</tbody>
.. raw:: html
</table>
Geo-search Parameters
---------------------
.. raw:: html
<table>
.. raw:: html
<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>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>
.. raw:: html
<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
aroundRadius parameter. The precision for ranking can be set with
aroundPrecision 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 "geo"
ranking parameter.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, you can
also use the minimumAroundRadius query parameter to specify a minimum
radius in meters for the automatic computation of aroundRadius.
.. raw:: html
</p>
.. raw:: html
<p>
At indexing, you should specify geoloc of an object with the \_geoloc
attribute (in the form "\_geoloc":{"lat":48.853409, "lng":2.348800} or
"\_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456,
"lng":2.972075}] if you have several geo-locations in your record).
.. raw:: html
</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>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>
.. raw:: html
<p>
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).
.. raw:: html
</p>
.. raw:: html
<p>
At indexing, you should specify the geo location of an object with the
\_geoloc attribute in the form {"\_geoloc":{"lat":48.853409,
"lng":2.348800}}.
.. raw:: html
</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>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>"_geoloc":{"lat":48.853409, "lng":2.348800}</code> or <code>"_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456, "lng":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>
</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>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>"_geoloc":{"lat":48.853409, "lng":2.348800}</code> or <code>"_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456, "lng":2.972075}]</code> if you have several geo-locations in your record).</p>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Parameters to Control Results Content
-------------------------------------
.. raw:: html
<table>
.. raw:: html
<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>
.. raw:: html
<p>
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.
.. raw:: html
</p>
.. raw:: html
<p>
objectID is always retrieved even when not specified.
.. raw:: html
</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>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>["name","address"]</code>). If an attribute has no match for the query, the raw value is returned. By default, all indexed attributes are highlighted. You can use <code>*</code> if you want to highlight all attributes. A matchLevel is returned for each highlighted attribute and can contain:</p>
.. raw:: html
<ul>
.. raw:: html
<li>
full: If all the query terms were found in the attribute.
.. raw:: html
</li>
.. raw:: html
<li>
partial: If only some of the query terms were found.
.. raw:: html
</li>
.. raw:: html
<li>
none: If none of the query terms were found.
.. raw:: html
</li>
.. raw:: html
</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>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>
.. raw:: html
<p>
You can also use a string array encoding (Example: attributesToSnippet:
["name:10","content:10"]). By default, no snippet is computed.
.. raw:: html
</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>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>
</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><em>Default: <strong><em></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><em></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><em>Default: <strong></em></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></em></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>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>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Numeric Search Parameters
-------------------------
.. raw:: html
<table>
.. raw:: html
<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><</code>, <code><=</code>, <code>=</code>, <code>></code> and <code>>=</code>.</p>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</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``.
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"]``).
Category Search Parameters
--------------------------
.. raw:: html
<table>
.. raw:: html
<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: ["tag1",["tag2","tag3"]]</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>
.. raw:: html
<p>
At indexing, tags should be added in the \_tags attribute of objects.
For example {"\_tags":["tag1","tag2"]}.
.. raw:: html
</p>
::
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Faceting Parameters
-------------------
.. raw:: html
<table>
.. raw:: html
<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>[["category:Book","category:Movie"],"author:John%20Doe"]</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>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'll be able to retrieve a list of the most relevant facet values, and their associated count for the current query.</p>
.. raw:: html
<p>
Attributes are separated by a comma. For example, "category,author". You
can also use JSON string array encoding. For example,
["category","author"]. Only the 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.
.. raw:: html
</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>
</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>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Unified Filter Parameter (SQL - like)
-------------------------------------
.. raw:: html
<table>
.. raw:: html
<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>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:
available=1 AND (category:Book OR NOT category:Ebook) AND \_tags:public
date: 1441745506 TO 1441755506 AND inStock > 0 AND author:"John Doe"
.. raw:: html
</p>
.. raw:: html
<p>
If no attribute name is specified, the filter applies to \_tags. For
example: public OR user\_42 will translate to \_tags:public OR
\_tags:user\_42.
.. raw:: html
</p>
.. raw:: html
<p>
The list of keywords is:
.. raw:: html
</p>
.. raw:: html
<ul>
.. raw:: html
<li>
OR: create a disjunctive filter between two filters.
.. raw:: html
</li>
.. raw:: html
<li>
AND: create a conjunctive filter between two filters.
.. raw:: html
</li>
.. raw:: html
<li>
TO: used to specify a range for a numeric filter.
.. raw:: html
</li>
.. raw:: html
<li>
NOT: used to negate a filter. The syntax with the - isn’t allowed.
.. raw:: html
</li>
.. raw:: html
</ul>
::
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
*Note*: To specify a value with spaces or with a value equal to a
keyword, it's possible to add quotes.
**Warning:**
- 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.
Distinct Parameter
------------------
.. raw:: html
<table>
.. raw:: html
<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>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 "distinct" 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>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
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>`__.
Multiple queries
================
You can send multiple queries with a single API call using a batch of
queries:
.. code:: python
# perform 3 queries in a single API call:
# - 1st query targets index `categories`
# - 2nd and 3rd queries target index `products`
results = self.client.multiple_queries([{"indexName" : "categories", "query" : myQueryString, "hitsPerPage": 3}
, {"indexName" : "categories", "query" : myQueryString, "hitsPerPage": 3, "filters": "_tags:promotion"}
, {"indexName" : "categories", "query" : myQueryString, "hitsPerPage": 10}])
print results["results"]
The resulting JSON answer contains a ``results`` array storing the
underlying queries answers. The answers order is the same than the
requests order.
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.
Get an object
=============
You can easily retrieve an object using its ``objectID`` and optionally
specify a comma separated list of attributes you want:
.. code:: python
# 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:
.. code:: python
res = index.get_objects(["myID1", "myID2"])
Delete an object
================
You can delete an object using its ``objectID``:
.. code:: python
index.delete_object("myID")
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.
.. code:: python
params = {}
index.delete_by_query("John", params)
Index Settings
==============
You can easily retrieve or update settings:
.. code:: python
settings = index.get_settings()
print settings
.. code:: python
index.set_settings({"customRanking": ["desc(followers)"]})
Indexing parameters
-------------------
.. raw:: html
<table>
.. raw:: html
<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>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>
.. raw:: html
<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.
.. raw:: html
</p>
.. raw:: html
<p>
This parameter has two important uses:
.. raw:: html
</p>
.. raw:: html
<ul>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
Control part of the ranking. 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
unordered(AttributeName). For example, attributesToIndex: ["title",
"unordered(text)"]. 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 title and alternative\_title have the same
priority in this example, which is different than text priority:
attributesToIndex:["title,alternative\_title", "text"]. To get a full
description of how the Ranking works, you can have a look at our Ranking
guide.
.. raw:: html
</li>
.. raw:: html
<li>
numericAttributesToIndex: (array of strings) 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.
.. raw:: html
</li>
.. raw:: html
</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>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>
</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 "distinct" 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>
<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>
.. raw:: html
<p>
We have nine available criteria:
.. raw:: html
</p>
.. raw:: html
<ul>
.. raw:: html
<li>
typo: Sort according to number of typos.
.. raw:: html
</li>
.. raw:: html
<li>
geo: Sort according to decreasing distance when performing a geo
location based search.
.. raw:: html
</li>
.. raw:: html
<li>
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.
.. raw:: html
</li>
.. raw:: html
<li>
proximity: Sort according to the proximity of the query words in hits.
.. raw:: html
</li>
.. raw:: html
<li>
attribute: Sort according to the order of attributes defined by
attributesToIndex.
.. raw:: html
</li>
.. raw:: html
<li>
exact:
.. raw:: html
<ul>
.. raw:: html
<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 "V", you want to find it with the "V" query and avoid
getting all popular TV shows starting by the letter V before it.
.. raw:: html
</li>
.. raw:: html
<li>
If the user query contains multiple words: sort according to the number
of words that matched exactly (not as a prefix).
.. raw:: html
</li>
.. raw:: html
</ul>
.. raw:: html
</li>
.. raw:: html
<li>
custom: Sort according to a user defined formula set in the
customRanking attribute.
.. raw:: html
</li>
.. raw:: html
<li>
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).
.. raw:: html
</li>
.. raw:: html
<li>
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). The standard order is
["typo", "geo", "words", "proximity", "attribute", "exact", "custom"].
To get a full description of how the Ranking works, you can have a look
at our Ranking guide.
.. raw:: html
</li>
.. raw:: html
</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>
.. raw:: html
<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, "customRanking" => ["desc(population)",
"asc(name)"].
.. raw:: html
</p>
.. raw:: html
<p>
To get a full description of how the Custom Ranking works, you can have
a look at our Ranking guide.
.. raw:: html
</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>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>
.. raw:: html
<ul>
.. raw:: html
<li>
prefixAll: All query words are interpreted as prefixes.
.. raw:: html
</li>
.. raw:: html
<li>
prefixLast: Only the last word is interpreted as a prefix (default
behavior).
.. raw:: html
</li>
.. raw:: html
<li>
prefixNone: No query word is interpreted as a prefix. This option is not
recommended.
.. raw:: html
</li>
.. raw:: html
</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>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>
<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>
</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>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're using the ADMIN API Key.</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>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>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Query expansion
---------------
.. raw:: html
<table>
.. raw:: html
<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>"synomyms": [ [ "black", "dark" ], [ "small", "little", "mini" ], ... ]</code>. The Synonym feature also supports multi-words expressions like <code>"synonyms": [ ["NYC", "New York City"] ]</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>"placeholders": { "<streetnumber>": ["1", "2", "3", ..., "9999"]}</code> would allow it to be able to match all street numbers. We use the <code>< ></code> tag syntax to define placeholders in an attribute. For example:</p>
.. raw:: html
<ul>
.. raw:: html
<li>
Push a record with the placeholder: { "name" : "Apple Store", "address"
: "<streetnumber> Opera street, Paris" }.
.. raw:: html
</li>
.. raw:: html
<li>
Configure the placeholder in your index settings: "placeholders": {
"<streetnumber>" : ["1", "2", "3", "4", "5", ... ], ... }.
.. raw:: html
</li>
.. raw:: html
</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>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>
</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>
.. raw:: html
<ul>
.. raw:: html
<li>
word: The word to correct.
.. raw:: html
</li>
.. raw:: html
<li>
correction: The corrected word.
.. raw:: html
</li>
.. raw:: html
<li>
nbTypos The number of typos (1 or 2) that will be considered for the
ranking algorithm (1 typo is better than 2 typos).
.. raw:: html
</li>
.. raw:: html
</ul>
.. raw:: html
<p>
For example "altCorrections": [ { "word" : "foot", "correction": "feet",
"nbTypos": 1 }, { "word": "feet", "correction": "foot", "nbTypos": 1 }
].
.. raw:: html
</p>
::
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
Default query parameters (can be overwritten by queries)
--------------------------------------------------------
.. raw:: html
<table>
.. raw:: html
<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>
</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>
</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>
</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>
</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>
</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><em></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></em></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>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>
</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>"304"</code> will match with <code>"30450"</code>, but not with <code>"40450"</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>
</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>
</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>
.. raw:: html
<ul>
.. raw:: html
<li>
.. raw:: html
<p>
Phrase query: a phrase query defines a particular sequence of terms. A
phrase query is build 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.
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
<li>
.. raw:: html
<p>
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.
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
</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>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 "distinct" 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>
.. raw:: html
<p>
To get a full understanding of how Distinct works, you can have a look
at our guide on distinct.
.. raw:: html
</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>
.. raw:: html
<ul>
.. raw:: html
<li>
.. raw:: html
<p>
true: activate the typo-tolerance (default value).
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
<li>
.. raw:: html
<p>
false: disable the typo-tolerance
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
<li>
.. raw:: html
<p>
min: 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.
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
<li>
.. raw:: html
<p>
strict: if there is a match without typo, then all results with 2 typos
or more will be removed.
.. raw:: html
</p>
.. raw:: html
</li>
.. raw:: html
</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>removeStopWords</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>Remove stop words from query before executing it. Defaults to false. Contains stop words for 41 languages (Arabic, Armenian, Basque, Bengali, Brazilian, Bulgarian, Catalan, Chinese, Czech, Danish, Dutch, English, Finnish, French, Galician, German, Greek, Hindi, Hungarian, Indonesian, Irish, Italian, Japanese, Korean, Kurdish, Latvian, Lithuanian, Marathi, Norwegian, Persian, Polish, Portugese, Romanian, Russian, Slovak, Spanish, Swedish, Thai, Turkish, Ukranian, Urdu)</p>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
List indices
============
You can list all your indices along with their associated information
(number of entries, disk size, etc.) with the ``list_indexes`` method:
.. code:: python
print client.list_indexes()
Delete an index
===============
You can delete an index using its name:
.. code:: python
client.delete_index("contacts")
Clear an index
==============
You can delete the index contents without removing settings and index
specific API keys by using the clearIndex command:
.. code:: python
index.clear_index()
Wait indexing
=============
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 ``waitTask`` method on the
``taskID`` returned by a write operation.
For example, to wait for indexing of a new object:
.. code:: python
res = index.add_object({"firstname": "Jimmie",
"lastname": "Barninger"})
index.wait_task(res["taskID"])
If you want to ensure multiple objects have been indexed, you only need
to check the biggest ``taskID``.
Batch writes
============
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).
Example using automatic ``objectID`` assignment:
.. code:: python
res = index.add_objects([{"firstname": "Jimmie",
"lastname": "Barninger"},
{"firstname": "Warren",
"lastname": "Speach"}])
Example with user defined ``objectID`` (add or update):
.. code:: python
res = index.save_objects([{"firstname": "Jimmie",
"lastname": "Barninger",
"objectID": "myID1"},
{"firstname": "Warren",
"lastname": "Speach",
"objectID": "myID2"}])
Example that deletes a set of records:
.. code:: python
res = index.delete_objects(["myID1", "myID2"])
Example that updates only the ``firstname`` attribute:
.. code:: python
res = index.partial_update_objects([{"firstname": "Jimmie",
"objectID": "myID1"},
{"firstname": "Warren",
"objectID": "myID2"}])
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:
.. code:: python
res = index.batch([
{"action": "addObject", "indexName": "index1", {"firstname": "Jimmie", "lastname": "Barninger"}},
{"action": "addObject", "indexName": "index2", {"firstname": "Warren", "lastname": "Speach"}}])
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.
.. code:: python
# Rename MyIndex in MyIndexNewName
print client.move_index("MyIndex", "MyIndexNewName")
# Copy MyIndex in MyIndexCopy
print client.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.
.. code:: python
# Rename MyNewIndex in MyIndex (and overwrite it)
print client.move_index("MyNewIndex", "MyIndex")
Backup / Export an index
========================
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 a script on it), you should use the ``browse`` method
instead. This method lets you retrieve objects beyond the 1,000 limit.
This method is optimized for speed. To make it fast, distinct,
typo-tolerance, word proximity, geo distance and number of matched words
are disabled. Results are still returned ranked by attributes and custom
ranking.
It will return a ``cursor`` alongside your data, that you can then use
to retrieve the next chunk of your records.
You can specify custom parameters (like ``page`` or ``hitsPerPage``) on
your first ``browse`` call, and these parameters will then be included
in the ``cursor``. Note that it is not possible to access records beyond
the 1,000th on the first call.
Example:
.. code:: python
# Iterate with a filter over the index
res = self.index.browse_all({"query": "test", "filters": "i<42"})
for hit in res
# Do something
# Retrieve the next cursor from the browse method
res = self.index.browse_from({"query": "test", "filters": "i<42"}, None)
print res["cursor"]
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
-------------
To list existing keys, you can use:
.. code:: python
# Lists global API Keys
client.list_user_keys()
# Lists API Keys that can access only to this index
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
---------------
To create API keys:
.. code:: python
# Creates a new global API key that can only perform search actions
res = client.add_user_key(["search"])
print res["key"]
# Creates a new API key that can only perform search action on this index
res = index.add_user_key(["search"])
print res["key"]
You can also create an API Key with advanced settings:
.. raw:: html
<table>
.. raw:: html
<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>validity</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Add a validity period. The key will be valid for a specific period of time (in seconds).</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>maxQueriesPerIPPerHour</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the maximum number of API calls allowed from an IP address per hour. Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 403 code is returned. Defaults to 0 (no rate limit). This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.</p>
.. raw:: html
<p>
Note: If you are sending the query through your servers, you must use
the enable\_rate\_limit\_forward("TheAdminAPIKey", "EndUserIP",
"APIKeyWithRateLimit") function to enable rate-limit.
.. raw:: html
</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>maxHitsPerQuery</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited). This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.</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>indexes</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the list of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the '*' character. For example, "dev_*" matches all indices starting with "dev_" and "*_dev" matches all indices ending with "_dev". Defaults to all indices if empty or blank.</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>referers</code></div>
</div>
</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 '*' character. For example, "algolia.com/*" matches all referers starting with "algolia.com/" and "*.algolia.com" matches all referers ending with ".algolia.com". Defaults to all referers if empty or blank.</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>queryParameters</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the list of query parameters. You can force the query parameters for a query using the url string format (param1=X&param2=Y...).</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>description</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify a description to describe where the key is used.</p>
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
.. code:: python
# Creates a new index specific API key valid for 300 seconds, with a rate limit of 100 calls per hour per IP and a maximum of 20 hits
params = {
'validity': 300,
'maxQueriesPerIPPerHour': 100,
'maxHitsPerQuery': 20,
'indexes': ['dev_*'],
'referers': ['algolia.com/*'],
'queryParameters': 'typoTolerance=strict&ignorePlurals=false',
'description': 'Limited search only API key for algolia.com'
}
res = client.add_user_key(params)
print res["key"]
Update API keys
---------------
To update the permissions of an existing key:
.. code:: python
# Update an existing global API key that is valid for 300 seconds
res = client.update_user_key("myAPIKey", ["search"], 300)
print res["key"]
# Update an existing index specific API key valid for 300 seconds, with a rate limit of 100 calls per hour per IP and a maximum of 20 hits
res = index.update_user_key("myAPIKey", ["search"], 300, 100, 20)
print res["key"]
To get the permissions of a given key:
.. code:: python
# Gets the rights of a global key
print client.get_user_key_acl("f420238212c54dcfad07ea0aa6d5c45f")
# Gets the rights of an index specific key
print index.get_user_key_acl("71671c38001bf3ac857bc82052485107")
Delete API keys
---------------
To delete an existing key:
.. code:: python
# Deletes a global key
print client.delete_user_key("f420238212c54dcfad07ea0aa6d5c45f")
# Deletes an index specific key
print index.delete_user_key("71671c38001bf3ac857bc82052485107")
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:
.. code:: python
# generate a public API key for user 42. Here, records are tagged with:
# - 'user_XXXX' if they are visible by user XXXX
public_key = client.generate_secured_api_key('YourSearchOnlyApiKey', {'filters': '_tags:user_42'})
This public API key can then be used in your JavaScript code as follow:
.. code:: js
var client = algoliasearch('YourApplicationID', '<%= public_api_key %>');
var index = client.initIndex('indexName')
index.search('something', function(err, content) {
if (err) {
console.error(err);
return;
}
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.
.. code:: python
# generate a public API key for user 42. Here, records are tagged with:
# - 'user_XXXX' if they are visible by user XXXX
public_key = client.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:
.. code:: js
var client = algoliasearch('YourApplicationID', '<%= public_api_key %>');
var index = client.initIndex('indexName')
index.search('another query', function(err, content) {
if (err) {
console.error(err);
return;
}
console.log(content);
});
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
You can retrieve the logs of your last 1,000 API calls and browse them
using the offset/length parameters:
.. raw:: html
<table>
.. raw:: html
<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>offset</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the first entry to retrieve (0-based, 0 is the most recent log entry). Defaults to 0.</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>length</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the maximum number of entries to retrieve starting at the offset. Defaults to 10. Maximum allowed value: 1,000.</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>onlyErrors</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Retrieve only logs with an HTTP code different than 200 or 201. (deprecated)</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>type</code></div>
</div>
</div>
</td>
<td class='client-readme-param-content'>
<p>Specify the type of logs to retrieve:</p>
.. raw:: html
<ul>
.. raw:: html
<li>
query: Retrieve only the queries.
.. raw:: html
</li>
.. raw:: html
<li>
build: Retrieve only the build operations.
.. raw:: html
</li>
.. raw:: html
<li>
error: Retrieve only the errors (same as onlyErrors parameters).
.. raw:: html
</li>
.. raw:: html
</ul>
::
</td>
</tr>
.. raw:: html
</tbody>
.. raw:: html
</table>
.. code:: python
# Get last 10 log entries
print client.get_logs()
# Get last 100 log entries
print client.get_logs(0, 100)
**Unreachable hosts error?**
If you are seeing an error for ``Unreachable hosts`` when pushing data
to Algolia, this is caused by ``PyOpenSSL`` and older versions of
Python. You can see `more information
here <https://github.com/algolia/algoliasearch-client-python/issues/30>`__.
To fix, either upgrade your Python version or `your
urllib3 <https://github.com/algolia/algoliasearch-client-python/issues/30#issuecomment-151933567>`__.
.. |Build Status| image:: https://travis-ci.org/algolia/algoliasearch-client-python.svg?branch=master
:target: https://travis-ci.org/algolia/algoliasearch-client-python
.. |PyPI version| image:: https://badge.fury.io/py/algoliasearch.svg?branch=master
:target: http://badge.fury.io/py/algoliasearch
.. |Coverage Status| image:: https://coveralls.io/repos/algolia/algoliasearch-client-python/badge.svg?branch=master
:target: https://coveralls.io/r/algolia/algoliasearch-client-python
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
algoliasearch-1.9.0.tar.gz
(213.1 kB
view hashes)
Built Distribution
Close
Hashes for algoliasearch-1.9.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 680f824ef08819d6d2d6fd5e9b272b9eab038b4d917fc96c718821e6c2b38184 |
|
| MD5 | 80f68b8594f3590f7d96777cc70b0a90 |
|
| BLAKE2b-256 | 1a5c9a5e30297e4d900c4817970401f57c4972dcf2a36a0ed265963b2b4669b3 |
