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

Commit 63f699b

Browse files
algoliareadmebotPLNech
authored andcommitted
Update README [skip ci] (#253)
1 parent 5b9009f commit 63f699b

File tree

1 file changed

+44
-57
lines changed

1 file changed

+44
-57
lines changed

README.md

Lines changed: 44 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -424,16 +424,16 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
424424

425425
**Advanced**
426426

427-
- [analyticsTags](#analyticstags) `search`
428-
- [synonyms](#synonyms) `search`
429-
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `settings`, `search`
430427
- [minProximity](#minproximity) `settings`, `search`
431428
- [responseFields](#responsefields) `settings`, `search`
432429
- [distinct](#distinct) `settings`, `search`
433430
- [getRankingInfo](#getrankinginfo) `search`
434431
- [numericFilters](#numericfilters) `search`
435432
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
436433
- [analytics](#analytics) `search`
434+
- [analyticsTags](#analyticstags) `search`
435+
- [synonyms](#synonyms) `search`
436+
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `settings`, `search`
437437

438438
## Search in indices - `multipleQueriesAsync`
439439

@@ -842,7 +842,7 @@ index.getSettingsAsync(new CompletionHandler() {
842842
index.setSettingsAsync(new JSONObject().append("customRanking", "desc(followers)"), null);
843843
```
844844
845-
You can find the list of parameters you can set in the [Settings Parameters](#settings-parameters) section
845+
You can find the list of parameters you can set in the [Settings Parameters](#index-settings-parameters) section
846846
847847
**Warning**
848848
@@ -918,19 +918,18 @@ Parameters that can be overridden at search time also have the `search` [scope](
918918

919919
**performance**
920920

921-
- [numericAttributesToIndex](#numericattributestoindex) `settings`
921+
- [numericAttributesForFiltering](#numericattributesforfiltering) `settings`
922922
- [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
923923

924924
**Advanced**
925925

926926
- [attributeForDistinct](#attributefordistinct) `settings`
927-
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `settings`, `search`
928927
- [placeholders](#placeholders) `settings`
929928
- [altCorrections](#altcorrections) `settings`
930929
- [minProximity](#minproximity) `settings`, `search`
931930
- [responseFields](#responsefields) `settings`, `search`
932931
- [distinct](#distinct) `settings`, `search`
933-
- [numericAttributesForFiltering](#numericattributesforfiltering) `settings`
932+
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `settings`, `search`
934933

935934

936935
# Parameters
@@ -1029,25 +1028,24 @@ They are three scopes:
10291028

10301029
**performance**
10311030

1032-
- [numericAttributesToIndex](#numericattributestoindex) `settings`
1031+
- [numericAttributesForFiltering](#numericattributesforfiltering) `settings`
10331032
- [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
10341033

10351034
**Advanced**
10361035

10371036
- [attributeForDistinct](#attributefordistinct) `settings`
1038-
- [analyticsTags](#analyticstags) `search`
1039-
- [synonyms](#synonyms) `search`
1040-
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `settings`, `search`
10411037
- [placeholders](#placeholders) `settings`
10421038
- [altCorrections](#altcorrections) `settings`
10431039
- [minProximity](#minproximity) `settings`, `search`
10441040
- [responseFields](#responsefields) `settings`, `search`
10451041
- [distinct](#distinct) `settings`, `search`
10461042
- [getRankingInfo](#getrankinginfo) `search`
1047-
- [numericAttributesForFiltering](#numericattributesforfiltering) `settings`
10481043
- [numericFilters](#numericfilters) `search`
10491044
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
10501045
- [analytics](#analytics) `search`
1046+
- [analyticsTags](#analyticstags) `search`
1047+
- [synonyms](#synonyms) `search`
1048+
- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `settings`, `search`
10511049

10521050
## Search
10531051

@@ -1066,7 +1064,7 @@ If no query parameter is set, the textual search will match with all the objects
10661064

10671065
- scope: `settings`
10681066
- type: `array of strings`
1069-
- default: *
1067+
- default: * (all string attributes)
10701068
- formerly known as: `attributesToIndex`
10711069

10721070
The list of attributes you want index (i.e. to make searchable).
@@ -1090,7 +1088,7 @@ This parameter has two important uses:
10901088
will consider all positions inside the `text` attribute as equal, but positions inside the `title` attribute will still matter.
10911089
10921090
You can decide to have the same priority for several attributes by passing them in the same string using comma as separator.
1093-
For example: \n`title` and `alternative_title` have the same priority in this example: `attributesToIndex:["title,alternative_title", "text"]`
1091+
For example: \n`title` and `alternative_title` have the same priority in this example: `searchableAttributes:["title,alternative_title", "text"]`
10941092
10951093
To get a full description of how the ranking works, you can have a look at our [Ranking guide](https://www.algolia.com/doc/guides/relevance/ranking).
10961094
@@ -1236,7 +1234,7 @@ Like for the other filter for performance reason, it's not possible to have FILT
12361234

12371235
It's not possible to mix different category of filter inside a OR like num=3 OR tag1 OR facet:value
12381236
1239-
It's not possible to negate an group, it's only possible to negate a filters: NOT(FILTER1 OR (FILTER2) is not allowed.
1237+
It's not possible to negate an group, it's only possible to negate a filter: NOT(FILTER1 OR FILTER2) is not allowed.
12401238
12411239
#### facets
12421240
@@ -1799,16 +1797,20 @@ Specify the list of approximation that should be considered as an exact match in
17991797
18001798
## performance
18011799
1802-
#### numericAttributesToIndex
1800+
#### numericAttributesForFiltering
18031801
18041802
- scope: `settings`
18051803
- type: `array of strings`
18061804
- default: []
1805+
- formerly known as: `numericAttributesToIndex`
18071806
1808-
All numerical attributes are automatically indexed as numerical filters.
1809-
If you don't need filtering on some of your numerical attributes, please consider sending them as strings to speed up the indexing.
1807+
All numerical attributes are automatically indexed as numerical filters
1808+
(allowing filtering operations like `<` and `<=`).
1809+
If you don't need filtering on some of your numerical attributes,
1810+
you can specify this list to speed up the indexing.
18101811
1811-
If you only need to filter on a numeric value with the operator `=` or `!=`, you can speed up the indexing by specifying the attribute with `equalOnly(AttributeName)`.
1812+
If you only need to filter on a numeric value with the operator `=` or `!=`,
1813+
you can speed up the indexing by specifying the attribute with `equalOnly(AttributeName)`.
18121814
The other operators will be disabled.
18131815
18141816
#### allowCompressionOfIntegerArray
@@ -1842,29 +1844,6 @@ then only the first one is kept and the others are removed from the results.
18421844
To get a full understanding of how `Distinct` works,
18431845
you can have a look at our [guide on distinct](https://www.algolia.com/doc/search/distinct).
18441846
1845-
#### analyticsTags
1846-
1847-
- scope: `search`
1848-
- type: `array of strings`
1849-
1850-
If set, tag your query with the specified identifiers. Tags can then be used in the Analytics to analyze a subset of searches only.
1851-
1852-
#### synonyms
1853-
1854-
- scope: `search`
1855-
- type: `boolean`
1856-
- default: true
1857-
1858-
If set to `false`, the search will not use the synonyms defined for the targeted index.
1859-
1860-
#### replaceSynonymsInHighlight
1861-
1862-
- scope: `settings` `search`
1863-
- type: `boolean`
1864-
- default: true
1865-
1866-
If set to `false`, words matched via synonyms expansion will not be replaced by the matched synonym in the highlighted result.
1867-
18681847
#### placeholders
18691848
18701849
- scope: `settings`
@@ -2000,21 +1979,6 @@ you can have a look at our [guide on distinct](https://www.algolia.com/doc/searc
20001979
If set to YES,
20011980
the result hits will contain ranking information in the **_rankingInfo** attribute.
20021981
2003-
#### numericAttributesForFiltering
2004-
2005-
- scope: `settings`
2006-
- type: `array of strings`
2007-
- default: []
2008-
2009-
All numerical attributes are automatically indexed as numerical filters
2010-
(allowing filtering operations like `<` and `<=`).
2011-
If you don't need filtering on some of your numerical attributes,
2012-
you can specify this list to speed up the indexing.
2013-
2014-
If you only need to filter on a numeric value with the `=` operator,
2015-
you can speed up the indexing by specifying the attribute with `equalOnly(AttributeName)`.
2016-
The other operators will be disabled.
2017-
20181982
#### numericFilters
20191983
20201984
- scope: `search`
@@ -2067,6 +2031,29 @@ For example `{"_tags":["tag1","tag2"]}`.
20672031
20682032
If set to false, this query will not be taken into account in the analytics.
20692033
2034+
#### analyticsTags
2035+
2036+
- scope: `search`
2037+
- type: `array of strings`
2038+
2039+
If set, tag your query with the specified identifiers. Tags can then be used in the Analytics to analyze a subset of searches only.
2040+
2041+
#### synonyms
2042+
2043+
- scope: `search`
2044+
- type: `boolean`
2045+
- default: true
2046+
2047+
If set to `false`, the search will not use the synonyms defined for the targeted index.
2048+
2049+
#### replaceSynonymsInHighlight
2050+
2051+
- scope: `settings` `search`
2052+
- type: `boolean`
2053+
- default: true
2054+
2055+
If set to `false`, words matched via synonyms expansion will not be replaced by the matched synonym in the highlighted result.
2056+
20702057
20712058
# Manage Indices
20722059

0 commit comments

Comments
 (0)