Skip to content
This repository was archived by the owner on Jan 31, 2022. It is now read-only.

Commit 981b1b0

Browse files
algoliareadmebotPLNech
authored andcommitted
Update README [skip ci] (#203)
1 parent 48c1573 commit 981b1b0

File tree

1 file changed

+62
-29
lines changed

1 file changed

+62
-29
lines changed

README.md

Lines changed: 62 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,31 @@ This project is open-source under the [MIT License](./LICENSE). [Your contributi
1515
**Getting Started**
1616

1717
1. [Install](#install)
18-
1. [Init index - `initIndex`](#init-index)
18+
1. [Init index - `initIndex`](#init-index---initindex)
1919
1. [Quick Start](#quick-start)
2020

2121
**Search**
2222

23-
1. [Search in an index - `searchAsync`](#search-in-an-index)
23+
1. [Search in an index - `searchAsync`](#search-in-an-index---searchasync)
2424
1. [Search Response Format](#search-response-format)
2525
1. [Search Parameters](#search-parameters)
26-
1. [Search in indices - `multipleQueriesAsync`](#search-in-indices)
27-
1. [Get Objects - `getObjectsAsync`](#get-objects)
26+
1. [Search in indices - `multipleQueriesAsync`](#search-in-indices---multiplequeriesasync)
27+
1. [Get Objects - `getObjectsAsync`](#get-objects---getobjectsasync)
2828
1. [Search cache](#search-cache)
2929

3030
**Indexing**
3131

32-
1. [Add Objects - `addObjectsAsync`](#add-objects)
33-
1. [Update objects - `saveObjectsAsync`](#update-objects)
34-
1. [Partial update objects - `partialUpdateObjectsAsync`](#partial-update-objects)
35-
1. [Delete objects - `deleteObjectsAsync`](#delete-objects)
36-
1. [Delete by query - `deleteByQueryAsync`](#delete-by-query)
37-
1. [Wait for operations - `waitTaskAsync`](#wait-for-operations)
32+
1. [Add Objects - `addObjectsAsync`](#add-objects---addobjectsasync)
33+
1. [Update objects - `saveObjectsAsync`](#update-objects---saveobjectsasync)
34+
1. [Partial update objects - `partialUpdateObjectsAsync`](#partial-update-objects---partialupdateobjectsasync)
35+
1. [Delete objects - `deleteObjectsAsync`](#delete-objects---deleteobjectsasync)
36+
1. [Delete by query - `deleteByQueryAsync`](#delete-by-query---deletebyqueryasync)
37+
1. [Wait for operations - `waitTaskAsync`](#wait-for-operations---waittaskasync)
3838

3939
**Settings**
4040

41-
1. [Get settings - `getSettingsAsync`](#get-settings)
42-
1. [Set settings - `setSettingsAsync`](#set-settings)
41+
1. [Get settings - `getSettingsAsync`](#get-settings---getsettingsasync)
42+
1. [Set settings - `setSettingsAsync`](#set-settings---setsettingsasync)
4343
1. [Index settings parameters](#index-settings-parameters)
4444

4545
**Parameters**
@@ -59,12 +59,12 @@ This project is open-source under the [MIT License](./LICENSE). [Your contributi
5959
**Manage Indices**
6060

6161
1. [Create an index](#create-an-index)
62-
1. [List indices - `listIndexesAsync`](#list-indices)
62+
1. [List indices - `listIndexesAsync`](#list-indices---listindexesasync)
6363

6464
**Advanced**
6565

66-
1. [Custom batch - `batchAsync`](#custom-batch)
67-
1. [Backup / Export an index - `browseAsync`](#backup--export-an-index)
66+
1. [Custom batch - `batchAsync`](#custom-batch---batchasync)
67+
1. [Backup / Export an index - `browseAsync`](#backup--export-an-index---browseasync)
6868

6969

7070
# Guides & Tutorials
@@ -420,16 +420,17 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
420420

421421
**Advanced**
422422

423+
- [analyticsTags](#analyticstags) `search`
423424
- [synonyms](#synonyms) `search`
424425
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `settings`, `search`
425426
- [minProximity](#minproximity) `settings`, `search`
426427
- [responseFields](#responsefields) `settings`, `search`
427428
- [distinct](#distinct) `settings`, `search`
428429
- [getRankingInfo](#getrankinginfo) `search`
429430
- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
431+
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
430432
- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
431433
- [analytics](#analytics) `search`
432-
- [analyticsTags](#analyticstags) `search`
433434

434435
## Search in indices - `multipleQueriesAsync`
435436

@@ -556,7 +557,7 @@ array.add(new JSONObject().put("objectID", "2").put("firstname", "Warren").put("
556557
index.addObjectsAsync(new JSONArray(array), null);
557558
```
558559

559-
To add a single object, use the `[Add Objects](/doc/api-client/android/indexing#add-objects)` method:
560+
To add a single object, use the [Add Objects](/doc/api-client/android/indexing#add-objects) method:
560561

561562
```java
562563
JSONObject object = new JSONObject()
@@ -924,6 +925,7 @@ They are three scopes:
924925
**Advanced**
925926

926927
- [attributeForDistinct](#attributefordistinct) `settings`
928+
- [analyticsTags](#analyticstags) `search`
927929
- [synonyms](#synonyms) `search`
928930
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `settings`, `search`
929931
- [placeholders](#placeholders) `settings`
@@ -935,9 +937,9 @@ They are three scopes:
935937
- [numericAttributesForFiltering](#numericattributesforfiltering) `settings`
936938
- [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
937939
- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
940+
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
938941
- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
939942
- [analytics](#analytics) `search`
940-
- [analyticsTags](#analyticstags) `search`
941943

942944
## Search
943945

@@ -1818,6 +1820,17 @@ you can have a look at our [guide on distinct](https://www.algolia.com/doc/searc
18181820
18191821
<div class='api-client-parameter'>
18201822
1823+
### analyticsTags
1824+
1825+
- scope: `search`
1826+
- type: `array of strings`
1827+
1828+
If set, tag your query with the specified identifiers. Tags can then be used in the Analytics to analyze a subset of searches only.
1829+
1830+
</div>
1831+
1832+
<div class='api-client-parameter'>
1833+
18211834
### synonyms
18221835
18231836
- scope: `search`
@@ -2036,6 +2049,37 @@ You can also use a string array encoding (for example `numericFilters: ["price>1
20362049
20372050
<div class='api-client-parameter'>
20382051
2052+
### tagFilters (deprecated)
2053+
2054+
- scope: `search`
2055+
- type: `string`
2056+
- default: ""
2057+
2058+
**This parameter is deprecated. You should use [filters](#filters) instead.**
2059+
2060+
Filter the query by a set of tags.
2061+
2062+
You can AND tags by separating them with commas.
2063+
To OR tags, you must add parentheses.
2064+
2065+
For example, `tagFilters=tag1,(tag2,tag3)` means *tag1 AND (tag2 OR tag3)*.
2066+
2067+
You can also use a string array encoding.
2068+
2069+
For example, `tagFilters: ["tag1",["tag2","tag3"]]` means *tag1 AND (tag2 OR tag3)*.
2070+
2071+
Negations are supported via the `-` operator, prefixing the value.
2072+
2073+
For example: `tagFilters=tag1,-tag2`.
2074+
2075+
At indexing, tags should be added in the **_tags** attribute of objects.
2076+
2077+
For example `{"_tags":["tag1","tag2"]}`.
2078+
2079+
</div>
2080+
2081+
<div class='api-client-parameter'>
2082+
20392083
### facetFilters (deprecated)
20402084
20412085
- scope: `search`
@@ -2067,17 +2111,6 @@ If set to false, this query will not be taken into account in the analytics feat
20672111
20682112
</div>
20692113
2070-
<div class='api-client-parameter'>
2071-
2072-
### analyticsTags
2073-
2074-
- scope: `search`
2075-
- type: `array of strings`
2076-
2077-
If set, tag your query with the specified identifiers. Tags can then be used in the Analytics to analyze a subset of searches only.
2078-
2079-
</div>
2080-
20812114
20822115
# Manage Indices
20832116

0 commit comments

Comments
 (0)