You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 31, 2022. It is now read-only.
@@ -1004,11 +1004,12 @@ The instant search query string, used to set the string you want to search in yo
1004
1004
1005
1005
### Attributes
1006
1006
1007
-
#### attributesToIndex
1007
+
#### searchableAttributes
1008
1008
1009
1009
- scope: `settings`
1010
1010
- type: `array of strings`
1011
1011
-default: `*`
1012
+
- formerly known as: `attributesToIndex`
1012
1013
1013
1014
1014
1015
The list of attributes you want index (i.e. to make searchable).
@@ -1020,7 +1021,7 @@ This parameter has two important uses:
1020
1021
1021
1022
1.**Limit the attributes to index.**For example, if you store the URL of a picture, you want to store it and be able to retrieve it, but you probably don't want to search in the URL.
1022
1023
1023
-
2. **Control part of the ranking.** The contents of the `attributesToIndex` parameter impacts ranking in two complementary ways:
1024
+
2. **Control part of the ranking.** The contents of the `searchableAttributes` parameter impacts ranking in two complementary ways:
1024
1025
1025
1026
First, the order in which attributes are listed defines their ranking priority: matches in attributes at the beginning of the list will be considered more important than matches in attributes further down the list. To assign the same priority to several attributes, pass them within the same string, separated by commas. For example, by specifying `["title,"alternative_title", "text"]`, `title` and `alternative_title` will have the same priority, but a higher priority than `text`.
1026
1027
@@ -1075,13 +1076,13 @@ You can also use `*` to retrieve all values when an **attributesToRetrieve** set
1075
1076
1076
1077
- scope: `search`
1077
1078
- type: `array of strings`
1078
-
-default: `attributesToIndex`
1079
+
-default: `searchableAttributes`
1079
1080
1080
1081
1081
-
List of attributes you want to use for textual search (must be a subset of the `attributesToIndex` index setting).
1082
+
List of attributes you want to use for textual search (must be a subset of the `searchableAttributes` index setting).
1082
1083
Attributes are separated with a comma such as `"name,address"`.
1083
1084
You can also use JSON string array encoding such as `encodeURIComponent("[\"name\",\"address\"]")`.
1084
-
Bydefault, all attributes specified in the `attributesToIndex` settings are used to search.
1085
+
Bydefault, all attributes specified in the `searchableAttributes` settings are used to search.
1085
1086
1086
1087
1087
1088
### Ranking
@@ -1101,7 +1102,7 @@ We have nine available criterion:
1101
1102
* `geo`:Sort according to decreasing distance when performing a geo location based search.
1102
1103
* `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.
1103
1104
* `proximity`:Sort according to the proximity of the query words in hits.
1104
-
* `attribute`:Sort according to the order of attributes defined by attributesToIndex.
1105
+
* `attribute`:Sort according to the order of attributes defined by searchableAttributes.
1105
1106
* `exact`:
1106
1107
*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.
1107
1108
*If the user query contains multiple words: sort according to the number of words that matched exactly (not as a prefix).
@@ -1134,6 +1135,7 @@ you can have a look at our [Ranking guide](https://www.algolia.com/doc/guides/re
1134
1135
- scope: `settings`
1135
1136
- type: `array of strings`
1136
1137
-default: `[]`
1138
+
- formerly known as: `slaves`
1137
1139
1138
1140
1139
1141
The list of indices on which you want to replicate all write operations.
@@ -1416,7 +1418,7 @@ If set to true, plural won't be considered as a typo. For example, car and cars,
1416
1418
1417
1419
1418
1420
List of attributes on which you want to disable typo tolerance
1419
-
(must be a subset of the `attributesToIndex` index setting).
1421
+
(must be a subset of the `searchableAttributes` index setting).
1420
1422
1421
1423
Attributes are separated with a comma such as `"name,address"`.
1422
1424
You can also use JSON string array encoding such as `encodeURIComponent("[\"name\",\"address\"]")`.
@@ -1674,7 +1676,7 @@ For most use cases, it is better to not use this feature as people search by key
1674
1676
1675
1677
1676
1678
List of attributes on which you want to disable prefix matching
1677
-
(must be a subset of the `attributesToIndex` index setting).
1679
+
(must be a subset of the `searchableAttributes` index setting).
1678
1680
1679
1681
This setting is useful on attributes that contain string that should not be matched as a prefix
1680
1682
(for example a product SKU).
@@ -1688,7 +1690,7 @@ This setting is useful on attributes that contain string that should not be matc
1688
1690
1689
1691
1690
1692
List of attributes on which you want to disable the computation of `exact` criteria
1691
-
(must be a subset of the `attributesToIndex` index setting).
1693
+
(must be a subset of the `searchableAttributes` index setting).
1692
1694
1693
1695
#### exactOnSingleWordQuery
1694
1696
@@ -1768,11 +1770,12 @@ you can have a look at our [guide on distinct](https://www.algolia.com/doc/searc
1768
1770
If set to true,
1769
1771
the result hits will contain ranking information in the **_rankingInfo** attribute.
1770
1772
1771
-
#### numericAttributesToIndex
1773
+
#### numericAttributesForFiltering
1772
1774
1773
1775
- scope: `settings`
1774
1776
- type: `array of strings`
1775
1777
- default: ``
1778
+
- formerly known as: `numericAttributesToIndex`
1776
1779
1777
1780
1778
1781
All numerical attributes are automatically indexed as numerical filters
@@ -2152,3 +2155,4 @@ The REST API lets your interact directly with Algolia platforms from anything th
0 commit comments