Skip to content

Commit 4706b28

Browse files
author
maxiloc
authored
Merge pull request #150 from algoliareadmebot/master
Update README
2 parents ad7d9f7 + b759a08 commit 4706b28

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
@@ -313,27 +313,27 @@ The server response will look like:
313313

314314
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:
315315

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

318318
- `${attribute_name}` (object): Highlighting for one attribute.
319319

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

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

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

326326
- `fullyHighlighted` (boolean): Whether the entire attribute value is highlighted.
327327

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

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

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

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

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

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

@@ -353,31 +353,31 @@ The server response will look like:
353353

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

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

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

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

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

364364
- `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.*
365365

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

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

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

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

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

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

378378
- `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.**
379379

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

382382
- `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.)
383383

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

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

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

394394
- `facets` (object): Maps each facet name to the corresponding facet counts:
395395

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

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

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

415414
### Search Parameters
416415

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

@@ -493,8 +491,6 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
493491
- [minProximity](#minproximity) `search`, `settings`
494492
- [responseFields](#responsefields) `search`, `settings`
495493

496-
<!--/PARAMETERS_LINK-->
497-
498494
### Multiple queries - `multipleQueries`
499495

500496
You can send multiple queries with a single API call using a batch of queries:
@@ -872,8 +868,6 @@ index.setSettings(settings, forwardToReplicas: true, completionHandler: { (conte
872868
873869
### Index settings parameters
874870
875-
<!--PARAMETERS_LINK-->
876-
877871
Here is the list of parameters you can use with the set settings method (`settings` [scope](#scope)).
878872
879873
@@ -939,9 +933,6 @@ Parameters that can be overridden at search time also have the `search` [scope](
939933
- [altCorrections](#altcorrections) `settings`
940934
- [placeholders](#placeholders) `settings`
941935
942-
<!--/PARAMETERS_LINK-->
943-
944-
945936
## Parameters
946937
947938
### Overview

0 commit comments

Comments
 (0)