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
@@ -313,27 +313,27 @@ The server response will look like:
313
313
314
314
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:
315
315
316
-
-`_highlightResult` (object, optional): Highlighted attributes. *Note: Only returned when [`attributesToHighlight`](#attributestohighlight) is non-empty.*
316
+
-`_highlightResult` (object, optional): Highlighted attributes. *Note: Only returned when [attributesToHighlight](#attributestohighlight) is non-empty.*
317
317
318
318
- `${attribute_name}` (object): Highlighting for one attribute.
319
319
320
-
- `value` (string): Markup text with occurrences highlighted. The tags used for highlighting are specified via [`highlightPreTag`](#highlightpretag) and [`highlightPostTag`](#highlightposttag).
320
+
- `value` (string): Markup text with occurrences highlighted. The tags used for highlighting are specified via [highlightPreTag](#highlightpretag) and [highlightPostTag](#highlightposttag).
321
321
322
322
- `matchLevel` (string, enum) = {`none` | `partial` | `full`}: Indicates how well the attribute matched the search query.
323
323
324
324
- `matchedWords` (array): List of words *from the query* that matched the object.
325
325
326
326
- `fullyHighlighted` (boolean): Whether the entire attribute value is highlighted.
327
327
328
-
-`_snippetResult` (object, optional): Snippeted attributes. *Note: Only returned when [`attributesToSnippet`](#attributestosnippet) is non-empty.*
328
+
-`_snippetResult` (object, optional): Snippeted attributes. *Note: Only returned when [attributesToSnippet](#attributestosnippet) is non-empty.*
329
329
330
330
-`${attribute_name}` (object): Snippeting for the corresponding attribute.
331
331
332
-
- `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).
332
+
- `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).
333
333
334
334
- `matchLevel` (string, enum) = {`none` | `partial` | `full`}: Indicates how well the attribute matched the search query.
335
335
336
-
-`_rankingInfo` (object, optional): Ranking information. *Note: Only returned when [`getRankingInfo`](#getrankinginfo) is `true`.*
336
+
-`_rankingInfo` (object, optional): Ranking information. *Note: Only returned when [getRankingInfo](#getrankinginfo) is `true`.*
337
337
338
338
-`nbTypos` (integer): Number of typos encountered when matching the record. Corresponds to the `typos` ranking criterion in the ranking formula.
339
339
@@ -353,31 +353,31 @@ The server response will look like:
353
353
354
354
-`filters` (integer): *This field is reserved for advanced usage.* It will be zero in most cases.
355
355
356
-
-`_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.
356
+
-`_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.
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. *Note: Not returned if you use `offset`/`length` for pagination.*
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. *Note: Not returned if you use `offset`/`length` for pagination.*
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
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
368
-
-`query` (string): An echo of the query text. See the [`query`](#query) search parameter.
368
+
-`query` (string): An echo of the query text. See the [query](#query) search parameter.
369
369
370
-
-`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.
370
+
-`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.
371
371
372
372
-`params` (string, URL-encoded): An echo of all search parameters.
373
373
374
374
-`message` (string, optional): Used to return warnings about the query.
375
375
376
-
-`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.
376
+
-`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.
377
377
378
378
-`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.**
379
379
380
-
When [`getRankingInfo`](#getrankinginfo) is set to `true`, the following additional fields are returned:
380
+
When [getRankingInfo](#getrankinginfo) is set to `true`, the following additional fields are returned:
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
@@ -389,7 +389,7 @@ When [`getRankingInfo`](#getrankinginfo) is set to `true`, the following additio
389
389
390
390
... and ranking information is also added to each of the hits (see above).
391
391
392
-
When [`facets`](#facets) is non-empty, the following additional fields are returned:
392
+
When [facets](#facets) is non-empty, the following additional fields are returned:
393
393
394
394
-`facets` (object): Maps each facet name to the corresponding facet counts:
395
395
@@ -409,12 +409,10 @@ When [`facets`](#facets) is non-empty, the following additional fields are retur
409
409
410
410
- `sum` (integer | float): The sum of all values in the result set.
411
411
412
-
-`exhaustiveFacetsCount` (boolean): Whether the counts are exhaustive (`true`) or approximate (`false`). *Note: When using [`distinct`](#distinct), the facet counts cannot be exhaustive.*
413
-
412
+
-`exhaustiveFacetsCount` (boolean): Whether the counts are exhaustive (`true`) or approximate (`false`). *Note: When using [distinct](#distinct), the facet counts cannot be exhaustive.*
414
413
415
414
### Search Parameters
416
415
417
-
<!--PARAMETERS_LINK-->
418
416
Here is the list of parameters you can use with the search method (`search`[scope](#scope)):
419
417
Parameters that can also be used in a setSettings also have the `indexing`[scope](#scope)
420
418
@@ -493,8 +491,6 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
0 commit comments