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
@@ -357,11 +357,11 @@ The server response will look like:
357
357
358
358
-`nbHits` (integer): Number of hits that the search query matched.
359
359
360
-
-`page` (integer): Index of the current page (zero-based). See the [`page`](#page) search parameter.
360
+
-`page` (integer): Index of the current page (zero-based). See the [`page`](#page) search parameter.*Note: Not returned if you use `offset`/`length` for pagination.*
361
361
362
-
-`hitsPerPage` (integer): Maximum number of hits returned per page. See the [`hitsPerPage`](#hitsperpage) search parameter.
362
+
-`hitsPerPage` (integer): Maximum number of hits returned per page. See the [`hitsPerPage`](#hitsperpage) search parameter.*Note: Not returned if you use `offset`/`length` for pagination.*
363
363
364
-
-`nbPages` (integer): Number of pages corresponding to the number of hits. Basically, `ceil(nbHits / hitsPerPage)`.
364
+
-`nbPages` (integer): Number of pages corresponding to the number of hits. Basically, `ceil(nbHits / hitsPerPage)`.*Note: Not returned if you use `offset`/`length` for pagination.*
365
365
366
366
-`processingTimeMS` (integer): Time that the server took to process the request, in milliseconds. *Note: This does not include network time.*
367
367
@@ -381,7 +381,7 @@ When [`getRankingInfo`](#getrankinginfo) is set to `true`, the following additio
381
381
382
382
-`serverUsed` (string): Actual host name of the server that processed the request. (Our DNS supports automatic failover and load balancing, so this may differ from the host name used in the request.)
383
383
384
-
-`parsedQuery` (string): The query string that will be searched, after normalization.
384
+
-`parsedQuery` (string): The query string that will be searched, after normalization. Normalization includes removing stop words (if [removeStopWords](#removestopwords) is enabled), and transforming portions of the query string into phrase queries (see [advancedSyntax](#advancedsyntax)).
385
385
386
386
-`timeoutCounts` (boolean): Whether a timeout was hit when computing the facet counts. When `true`, the counts will be interpolated (i.e. approximate). See also `exhaustiveFacetsCount`.
387
387
@@ -425,6 +425,7 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
You can specify a `strategy` parameter to optimize your multiple queries:
518
+
519
+
-`none`: Execute the sequence of queries until the end.
520
+
-`stopIfEnoughMatches`: Execute the sequence of queries until the number of hits is reached by the sum of hits.
521
+
522
+
#### Response
523
+
524
+
The resulting JSON contains the following fields:
525
+
526
+
-`results` (array): The results for each request, in the order they were submitted. The contents are the same as in [Search in an index](#search-in-an-index---search).
527
+
528
+
Each result also includes the following additional fields:
529
+
530
+
-`index` (string): The name of the targeted index.
531
+
532
+
-`processed` (boolean, optional): *Note: Only returned when `strategy` is `stopIfEnoughmatches`.* Whether the query was processed.
533
+
534
+
535
+
488
536
### Find by IDs - `getObjects`
489
537
490
538
You can easily retrieve an object using its `objectID` and optionally specify a comma separated list of attributes you want:
@@ -1188,6 +1242,10 @@ Limit the number of facet values returned for each facet.
1188
1242
1189
1243
For example, `maxValuesPerFacet=10` will retrieve a maximum of10 values per facet.
1190
1244
1245
+
**Warnings**
1246
+
1247
+
- The engine has a hard limit on the `maxValuesPerFacet` of `1000`. Any value above that will be interpreted by the engine as being `1000`.
1248
+
1191
1249
### Highlighting / Snippeting
1192
1250
1193
1251
#### attributesToHighlight
@@ -1287,6 +1345,28 @@ Pagination parameter used to select the page to retrieve.
1287
1345
1288
1346
Pagination parameter used to select the number of hits per page.
1289
1347
1348
+
#### offset
1349
+
1350
+
- scope: `search`
1351
+
- type: `integer`
1352
+
-default: `null`
1353
+
1354
+
1355
+
Offset of the first hit to return (zero-based).
1356
+
1357
+
**Warning:** In most cases, `page`/`hitsPerPage` is the recommended method for pagination; `offset`/`length` is reserved for advanced use.
1358
+
1359
+
#### length
1360
+
1361
+
- scope: `search`
1362
+
- type: `integer`
1363
+
-default: `null`
1364
+
1365
+
1366
+
Number of hits to return.
1367
+
1368
+
**Warning:** In most cases, `page`/`hitsPerPage` is the recommended method for pagination; `offset`/`length` is reserved for advanced use.
1369
+
1290
1370
### Typos
1291
1371
1292
1372
#### minWordSizefor1Typo
@@ -1810,6 +1890,33 @@ For example, `[["category:Book","category:Movie"],"author:John%20Doe"]`.
1810
1890
1811
1891
If set to false, this query will not be taken into account in the analytics feature.
1812
1892
1893
+
#### analyticsTags
1894
+
1895
+
- scope: `search`
1896
+
- type: `array of strings`
1897
+
- default: `null`
1898
+
1899
+
1900
+
If set, tag your query with the specified identifiers. Tags can then be used in the Analytics to analyze a subset of searches only.
1901
+
1902
+
#### synonyms
1903
+
1904
+
- scope: `search`
1905
+
- type: `boolean`
1906
+
- default: `true`
1907
+
1908
+
1909
+
If set to `false`, the search will not use the synonyms defined for the targeted index.
1910
+
1911
+
#### replaceSynonymsInHighlight
1912
+
1913
+
- scope: `search`, `settings`
1914
+
- type: `boolean`
1915
+
- default: `true`
1916
+
1917
+
1918
+
If set to `false`, words matched via synonym expansion will not be replaced by the matched synonym in the highlighted result.
1919
+
1813
1920
#### placeholders
1814
1921
1815
1922
- scope: `settings`
@@ -1857,6 +1964,19 @@ For example:
1857
1964
]
1858
1965
```
1859
1966
1967
+
#### minProximity
1968
+
1969
+
- scope: `search`, `settings`
1970
+
- type: `integer`
1971
+
- default: `1`
1972
+
1973
+
1974
+
Configure the precision of the `proximity` ranking criterion. By default, the minimum (and best) proximity value distance between 2 matching words is 1. Setting it to 2 (or 3) would allow 1 (or 2) words to be found between the matching words without degrading the proximity ranking value.
1975
+
1976
+
Considering the query *“javascript framework”*, if you set `minProximity=2`, the records *“JavaScript framework”* and *“JavaScript charting framework”* will get the same proximity score, even if the second contains a word between the two matching words.
1977
+
1978
+
**Note:** the maximum `minProximity` that can be set is 7. Any higher value will disable the `proximity` criterion from the ranking formula.
1979
+
1860
1980
1861
1981
## Manage Indices
1862
1982
@@ -2049,44 +2169,6 @@ iterator.start()
2049
2169
```
2050
2170
2051
2171
2052
-
### Multiple queries - `multipleQueries`
2053
-
2054
-
You can send multiple queries with a single API call using a batch of queries:
client.multipleQueries(queries, completionHandler: { (content, error) -> Void in
2066
-
if error == nil {
2067
-
print("Result: \(content!)")
2068
-
}
2069
-
})
2070
-
```
2071
-
2072
-
You can specify a `strategy` parameter to optimize your multiple queries:
2073
-
2074
-
- `none`: Execute the sequence of queries until the end.
2075
-
- `stopIfEnoughMatches`: Execute the sequence of queries until the number of hits is reached by the sum of hits.
2076
-
2077
-
#### Response
2078
-
2079
-
The resulting JSON contains the following fields:
2080
-
2081
-
- `results` (array): The results for each request, in the order they were submitted. The contents are the same as in [Search in an index](#search-in-an-index---search).
2082
-
2083
-
Each result also includes the following additional fields:
2084
-
2085
-
- `index` (string): The name of the targeted index.
2086
-
2087
-
- `processed` (boolean, optional): *Note: Only returned when `strategy` is `stopIfEnoughmatches`.* Whether the query was processed.
0 commit comments