Skip to content

Commit 1b5806b

Browse files
Merge pull request #117 from algoliareadmebot/master
Update README
2 parents 7879e26 + ad7518f commit 1b5806b

File tree

1 file changed

+14
-23
lines changed

1 file changed

+14
-23
lines changed

README.md

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -310,27 +310,27 @@ The server response will look like:
310310

311311
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:
312312

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.*
314314

315315
- `${attribute_name}` (object): Highlighting for one attribute.
316316

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).
318318

319319
- `matchLevel` (string, enum) = {`none` | `partial` | `full`}: Indicates how well the attribute matched the search query.
320320

321321
- `matchedWords` (array): List of words *from the query* that matched the object.
322322

323323
- `fullyHighlighted` (boolean): Whether the entire attribute value is highlighted.
324324

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.*
326326

327327
- `${attribute_name}` (object): Snippeting for the corresponding attribute.
328328

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).
330330

331331
- `matchLevel` (string, enum) = {`none` | `partial` | `full`}: Indicates how well the attribute matched the search query.
332332

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`.*
334334

335335
- `nbTypos` (integer): Number of typos encountered when matching the record. Corresponds to the `typos` ranking criterion in the ranking formula.
336336

@@ -350,31 +350,31 @@ The server response will look like:
350350

351351
- `filters` (integer): *This field is reserved for advanced usage.* It will be zero in most cases.
352352

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.
354354

355355
- `nbHits` (integer): Number of hits that the search query matched.
356356

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.*
358358

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.*
360360

361361
- `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.*
362362

363363
- `processingTimeMS` (integer): Time that the server took to process the request, in milliseconds. *Note: This does not include network time.*
364364

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.
366366

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.
368368

369369
- `params` (string, URL-encoded): An echo of all search parameters.
370370

371371
- `message` (string, optional): Used to return warnings about the query.
372372

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.
374374

375375
- `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.**
376376

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:
378378

379379
- `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.)
380380

@@ -386,7 +386,7 @@ When [`getRankingInfo`](#getrankinginfo) is set to `true`, the following additio
386386

387387
... and ranking information is also added to each of the hits (see above).
388388

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:
390390

391391
- `facets` (object): Maps each facet name to the corresponding facet counts:
392392

@@ -406,12 +406,10 @@ When [`facets`](#facets) is non-empty, the following additional fields are retur
406406

407407
- `sum` (integer | float): The sum of all values in the result set.
408408

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.*
411410

412411
### Search Parameters
413412

414-
<!--PARAMETERS_LINK-->
415413
Here is the list of parameters you can use with the search method (`search` [scope](#scope)):
416414
Parameters that can also be used in a setSettings also have the `indexing` [scope](#scope)
417415

@@ -490,8 +488,6 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
490488
- [minProximity](#minproximity) `search`, `settings`
491489
- [responseFields](#responsefields) `search`, `settings`
492490

493-
<!--/PARAMETERS_LINK-->
494-
495491
### Multiple queries - `multiple_queries`
496492

497493
You can send multiple queries with a single API call using a batch of queries:
@@ -773,8 +769,6 @@ index.set_settings({"customRanking": ["desc(followers)"]}, True)
773769

774770
### Index settings parameters
775771

776-
<!--PARAMETERS_LINK-->
777-
778772
Here is the list of parameters you can use with the set settings method (`settings` [scope](#scope)).
779773

780774

@@ -840,9 +834,6 @@ Parameters that can be overridden at search time also have the `search` [scope](
840834
- [altCorrections](#altcorrections) `settings`
841835
- [placeholders](#placeholders) `settings`
842836

843-
<!--/PARAMETERS_LINK-->
844-
845-
846837
## Parameters
847838

848839
### Overview

0 commit comments

Comments
 (0)