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
Copy file name to clipboardExpand all lines: README.md
+14-23Lines changed: 14 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -310,27 +310,27 @@ The server response will look like:
310
310
311
311
Hits are made of the JSON objects that you stored in the index; therefore, they are mostly schema-less. However, Algolia does enrich them with a few additional fields:
312
312
313
-
-`_highlightResult` (object, optional): Highlighted attributes. *Note: Only returned when [`attributesToHighlight`](#attributestohighlight) is non-empty.*
313
+
-`_highlightResult` (object, optional): Highlighted attributes. *Note: Only returned when [attributesToHighlight](#attributestohighlight) is non-empty.*
314
314
315
315
- `${attribute_name}` (object): Highlighting for one attribute.
316
316
317
-
- `value` (string): Markup text with occurrences highlighted. The tags used for highlighting are specified via [`highlightPreTag`](#highlightpretag) and [`highlightPostTag`](#highlightposttag).
317
+
- `value` (string): Markup text with occurrences highlighted. The tags used for highlighting are specified via [highlightPreTag](#highlightpretag) and [highlightPostTag](#highlightposttag).
318
318
319
319
- `matchLevel` (string, enum) = {`none` | `partial` | `full`}: Indicates how well the attribute matched the search query.
320
320
321
321
- `matchedWords` (array): List of words *from the query* that matched the object.
322
322
323
323
- `fullyHighlighted` (boolean): Whether the entire attribute value is highlighted.
324
324
325
-
-`_snippetResult` (object, optional): Snippeted attributes. *Note: Only returned when [`attributesToSnippet`](#attributestosnippet) is non-empty.*
325
+
-`_snippetResult` (object, optional): Snippeted attributes. *Note: Only returned when [attributesToSnippet](#attributestosnippet) is non-empty.*
326
326
327
327
-`${attribute_name}` (object): Snippeting for the corresponding attribute.
328
328
329
-
- `value` (string): Markup text with occurrences highlighted and optional ellipsis indicators. The tags used for highlighting are specified via [`highlightPreTag`](#highlightpretag) and [`highlightPostTag`](#highlightposttag). The text used to indicate ellipsis is specified via [`snippetEllipsisText`](#snippetellipsistext).
329
+
- `value` (string): Markup text with occurrences highlighted and optional ellipsis indicators. The tags used for highlighting are specified via [highlightPreTag](#highlightpretag) and [highlightPostTag](#highlightposttag). The text used to indicate ellipsis is specified via [snippetEllipsisText](#snippetellipsistext).
330
330
331
331
- `matchLevel` (string, enum) = {`none` | `partial` | `full`}: Indicates how well the attribute matched the search query.
332
332
333
-
-`_rankingInfo` (object, optional): Ranking information. *Note: Only returned when [`getRankingInfo`](#getrankinginfo) is `true`.*
333
+
-`_rankingInfo` (object, optional): Ranking information. *Note: Only returned when [getRankingInfo](#getrankinginfo) is `true`.*
334
334
335
335
-`nbTypos` (integer): Number of typos encountered when matching the record. Corresponds to the `typos` ranking criterion in the ranking formula.
336
336
@@ -350,31 +350,31 @@ The server response will look like:
350
350
351
351
-`filters` (integer): *This field is reserved for advanced usage.* It will be zero in most cases.
352
352
353
-
-`_distinctSeqID` (integer): *Note: Only returned when [`distinct`](#distinct) is non-zero.* When two consecutive results have the same value for the attribute used for "distinct", this field is used to distinguish between them.
353
+
-`_distinctSeqID` (integer): *Note: Only returned when [distinct](#distinct) is non-zero.* When two consecutive results have the same value for the attribute used for "distinct", this field is used to distinguish between them.
354
354
355
355
-`nbHits` (integer): Number of hits that the search query matched.
356
356
357
-
-`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.*
357
+
-`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.*
358
358
359
-
-`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.*
359
+
-`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.*
360
360
361
361
-`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.*
362
362
363
363
-`processingTimeMS` (integer): Time that the server took to process the request, in milliseconds. *Note: This does not include network time.*
364
364
365
-
-`query` (string): An echo of the query text. See the [`query`](#query) search parameter.
365
+
-`query` (string): An echo of the query text. See the [query](#query) search parameter.
366
366
367
-
-`queryAfterRemoval` (string, optional): *Note: Only returned when [`removeWordsIfNoResults`](#removewordsifnoresults) is set to `lastWords` or `firstWords`.* A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. The removed parts are surrounded by `<em>` tags.
367
+
-`queryAfterRemoval` (string, optional): *Note: Only returned when [removeWordsIfNoResults](#removewordsifnoresults) is set to `lastWords` or `firstWords`.* A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. The removed parts are surrounded by `<em>` tags.
368
368
369
369
-`params` (string, URL-encoded): An echo of all search parameters.
370
370
371
371
-`message` (string, optional): Used to return warnings about the query.
372
372
373
-
-`aroundLatLng` (string, optional): *Note: Only returned when [`aroundLatLngViaIP`](#aroundlatlngviaip) is set.* The computed geo location. **Warning: for legacy reasons, this parameter is a string and not an object.** Format: `${lat},${lng}`, where the latitude and longitude are expressed as decimal floating point numbers.
373
+
-`aroundLatLng` (string, optional): *Note: Only returned when [aroundLatLngViaIP](#aroundlatlngviaip) is set.* The computed geo location. **Warning: for legacy reasons, this parameter is a string and not an object.** Format: `${lat},${lng}`, where the latitude and longitude are expressed as decimal floating point numbers.
374
374
375
375
-`automaticRadius` (integer, optional): *Note: Only returned for geo queries without an explicitly specified radius (see `aroundRadius`).* The automatically computed radius. **Warning: for legacy reasons, this parameter is a string and not an integer.**
376
376
377
-
When [`getRankingInfo`](#getrankinginfo) is set to `true`, the following additional fields are returned:
377
+
When [getRankingInfo](#getrankinginfo) is set to `true`, the following additional fields are returned:
378
378
379
379
-`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.)
380
380
@@ -386,7 +386,7 @@ When [`getRankingInfo`](#getrankinginfo) is set to `true`, the following additio
386
386
387
387
... and ranking information is also added to each of the hits (see above).
388
388
389
-
When [`facets`](#facets) is non-empty, the following additional fields are returned:
389
+
When [facets](#facets) is non-empty, the following additional fields are returned:
390
390
391
391
-`facets` (object): Maps each facet name to the corresponding facet counts:
392
392
@@ -406,12 +406,10 @@ When [`facets`](#facets) is non-empty, the following additional fields are retur
406
406
407
407
- `sum` (integer | float): The sum of all values in the result set.
408
408
409
-
-`exhaustiveFacetsCount` (boolean): Whether the counts are exhaustive (`true`) or approximate (`false`). *Note: When using [`distinct`](#distinct), the facet counts cannot be exhaustive.*
410
-
409
+
-`exhaustiveFacetsCount` (boolean): Whether the counts are exhaustive (`true`) or approximate (`false`). *Note: When using [distinct](#distinct), the facet counts cannot be exhaustive.*
411
410
412
411
### Search Parameters
413
412
414
-
<!--PARAMETERS_LINK-->
415
413
Here is the list of parameters you can use with the search method (`search`[scope](#scope)):
416
414
Parameters that can also be used in a setSettings also have the `indexing`[scope](#scope)
417
415
@@ -490,8 +488,6 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
0 commit comments