@@ -15,31 +15,31 @@ This project is open-source under the [MIT License](./LICENSE). [Your contributi
15
15
** Getting Started**
16
16
17
17
1 . [ Install] ( #install )
18
- 1 . [ Init index - ` initIndex ` ] ( #init-index )
18
+ 1 . [ Init index - ` initIndex ` ] ( #init-index---initindex )
19
19
1 . [ Quick Start] ( #quick-start )
20
20
21
21
** Search**
22
22
23
- 1 . [ Search in an index - ` searchAsync ` ] ( #search-in-an-index )
23
+ 1 . [ Search in an index - ` searchAsync ` ] ( #search-in-an-index---searchasync )
24
24
1 . [ Search Response Format] ( #search-response-format )
25
25
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 )
28
28
1 . [ Search cache] ( #search-cache )
29
29
30
30
** Indexing**
31
31
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 )
38
38
39
39
** Settings**
40
40
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 )
43
43
1 . [ Index settings parameters] ( #index-settings-parameters )
44
44
45
45
** Parameters**
@@ -59,12 +59,12 @@ This project is open-source under the [MIT License](./LICENSE). [Your contributi
59
59
** Manage Indices**
60
60
61
61
1 . [ Create an index] ( #create-an-index )
62
- 1 . [ List indices - ` listIndexesAsync ` ] ( #list-indices )
62
+ 1 . [ List indices - ` listIndexesAsync ` ] ( #list-indices---listindexesasync )
63
63
64
64
** Advanced**
65
65
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 )
68
68
69
69
70
70
# Guides & Tutorials
@@ -420,16 +420,17 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
420
420
421
421
** Advanced**
422
422
423
+ - [ analyticsTags] ( #analyticstags ) ` search `
423
424
- [ synonyms] ( #synonyms ) ` search `
424
425
- [ replaceSynonymsInHighlight] ( #replacesynonymsinhighlight ) ` settings ` , ` search `
425
426
- [ minProximity] ( #minproximity ) ` settings ` , ` search `
426
427
- [ responseFields] ( #responsefields ) ` settings ` , ` search `
427
428
- [ distinct] ( #distinct ) ` settings ` , ` search `
428
429
- [ getRankingInfo] ( #getrankinginfo ) ` search `
429
430
- [ numericFilters (deprecated)] ( #numericfilters-deprecated ) ` search `
431
+ - [ tagFilters (deprecated)] ( #tagfilters-deprecated ) ` search `
430
432
- [ facetFilters (deprecated)] ( #facetfilters-deprecated ) ` search `
431
433
- [ analytics] ( #analytics ) ` search `
432
- - [ analyticsTags] ( #analyticstags ) ` search `
433
434
434
435
## Search in indices - ` multipleQueriesAsync `
435
436
@@ -556,7 +557,7 @@ array.add(new JSONObject().put("objectID", "2").put("firstname", "Warren").put("
556
557
index. addObjectsAsync(new JSONArray (array), null );
557
558
```
558
559
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:
560
561
561
562
```java
562
563
JSONObject object = new JSONObject ()
@@ -924,6 +925,7 @@ They are three scopes:
924
925
** Advanced **
925
926
926
927
- [attributeForDistinct](#attributefordistinct) `settings`
928
+ - [analyticsTags](#analyticstags) `search`
927
929
- [synonyms](#synonyms) `search`
928
930
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `settings`, `search`
929
931
- [placeholders](#placeholders) `settings`
@@ -935,9 +937,9 @@ They are three scopes:
935
937
- [numericAttributesForFiltering](#numericattributesforfiltering) `settings`
936
938
- [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
937
939
- [numericFilters (deprecated)](#numericfilters- deprecated) `search`
940
+ - [tagFilters (deprecated)](#tagfilters- deprecated) `search`
938
941
- [facetFilters (deprecated)](#facetfilters- deprecated) `search`
939
942
- [analytics](#analytics) `search`
940
- - [analyticsTags](#analyticstags) `search`
941
943
942
944
## Search
943
945
@@ -1818,6 +1820,17 @@ you can have a look at our [guide on distinct](https://www.algolia.com/doc/searc
1818
1820
1819
1821
<div class=' api- client- parameter' >
1820
1822
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
+
1821
1834
### synonyms
1822
1835
1823
1836
- scope: `search`
@@ -2036,6 +2049,37 @@ You can also use a string array encoding (for example `numericFilters: ["price>1
2036
2049
2037
2050
<div class=' api- client- parameter' >
2038
2051
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
+
2039
2083
### facetFilters (deprecated)
2040
2084
2041
2085
- scope: `search`
@@ -2067,17 +2111,6 @@ If set to false, this query will not be taken into account in the analytics feat
2067
2111
2068
2112
</div>
2069
2113
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
-
2081
2114
2082
2115
# Manage Indices
2083
2116
0 commit comments