Skip to content

Commit d28a6a0

Browse files
docs(README): automatic update
Update README Swift [ci skip]
1 parent 70b2f99 commit d28a6a0

File tree

1 file changed

+126
-126
lines changed

1 file changed

+126
-126
lines changed

README.md

Lines changed: 126 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -306,58 +306,58 @@ Here is the list of parameters you can use with the search method (`search` [sco
306306
Parameters that can also be used in a setSettings also have the `indexing` [scope](#scope)
307307

308308
**Search**
309-
- [query](#query) `search`
309+
[query](#query) `search`
310310

311311
**Attributes**
312-
- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
312+
[attributesToRetrieve](#attributestoretrieve) `settings`, `search`
313313

314314
**Filtering / Faceting**
315-
- [filters](#filters) `search`
316-
- [facets](#facets) `search`
317-
- [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
315+
[filters](#filters) `search`
316+
[facets](#facets) `search`
317+
[maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
318318

319319
**Highlighting / Snippeting**
320-
- [attributesToHighlight](#attributestohighlight) `settings`, `search`
321-
- [attributesToSnippet](#attributestosnippet) `settings`, `search`
322-
- [highlightPreTag](#highlightpretag) `settings`, `search`
323-
- [highlightPostTag](#highlightposttag) `settings`, `search`
324-
- [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
320+
[attributesToHighlight](#attributestohighlight) `settings`, `search`
321+
[attributesToSnippet](#attributestosnippet) `settings`, `search`
322+
[highlightPreTag](#highlightpretag) `settings`, `search`
323+
[highlightPostTag](#highlightposttag) `settings`, `search`
324+
[snippetEllipsisText](#snippetellipsistext) `settings`, `search`
325325

326326
**Pagination**
327-
- [page](#page) `search`
328-
- [hitsPerPage](#hitsperpage) `settings`, `search`
327+
[page](#page) `search`
328+
[hitsPerPage](#hitsperpage) `settings`, `search`
329329

330330
**Typos**
331-
- [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
332-
- [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
333-
- [typoTolerance](#typotolerance) `settings`, `search`
334-
- [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
335-
- [ignorePlurals](#ignoreplurals) `settings`, `search`
336-
- [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
331+
[minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
332+
[minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
333+
[typoTolerance](#typotolerance) `settings`, `search`
334+
[allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
335+
[ignorePlurals](#ignoreplurals) `settings`, `search`
336+
[disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
337337

338338
**Geo-Search**
339-
- [aroundLatLng](#aroundlatlng) `search`
340-
- [aroundLatLngViaIP](#aroundlatlngviaip) `search`
341-
- [insideBoundingBox](#insideboundingbox) `search`
342-
- [insidePolygon](#insidepolygon) `search`
339+
[aroundLatLng](#aroundlatlng) `search`
340+
[aroundLatLngViaIP](#aroundlatlngviaip) `search`
341+
[insideBoundingBox](#insideboundingbox) `search`
342+
[insidePolygon](#insidepolygon) `search`
343343

344344

345345
**Query Strategy**
346-
- [queryType](#querytype) `settings`, `search`
347-
- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
348-
- [advancedSyntax](#advancedsyntax) `settings`, `search`
349-
- [optionalWords](#optionalwords) `settings`, `search`
350-
- [removeStopWords](#removestopwords) `settings`, `search`
351-
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
352-
- [alternativesAsExact](#alternativesasexact) `settings`, `search`
346+
[queryType](#querytype) `settings`, `search`
347+
[removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
348+
[advancedSyntax](#advancedsyntax) `settings`, `search`
349+
[optionalWords](#optionalwords) `settings`, `search`
350+
[removeStopWords](#removestopwords) `settings`, `search`
351+
[exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
352+
[alternativesAsExact](#alternativesasexact) `settings`, `search`
353353

354354
**Advanced**
355-
- [distinct](#distinct) `settings`, `search`
356-
- [rankingInfo](#rankinginfo) `search`
357-
- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
358-
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
359-
- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
360-
- [analytics](#analytics) `search`
355+
[distinct](#distinct) `settings`, `search`
356+
[rankingInfo](#rankinginfo) `search`
357+
[numericFilters (deprecated)](#numericfilters-deprecated) `search`
358+
[tagFilters (deprecated)](#tagfilters-deprecated) `search`
359+
[facetFilters (deprecated)](#facetfilters-deprecated) `search`
360+
[analytics](#analytics) `search`
361361

362362
<!--/PARAMETERS_LINK-->
363363

@@ -655,56 +655,56 @@ Here is the list of parameters you can use with the set settings method (`indexi
655655
Parameters that can be override at search time also have the `indexing` [scope](#scope)
656656

657657
**Attributes**
658-
- [attributesToIndex](#attributestoindex) `settings`
659-
- [attributesForFaceting](#attributesforfaceting) `settings`
660-
- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
661-
- [unretrievableAttributes](#unretrievableattributes) `settings`
658+
[attributesToIndex](#attributestoindex) `settings`
659+
[attributesForFaceting](#attributesforfaceting) `settings`
660+
[attributesToRetrieve](#attributestoretrieve) `settings`, `search`
661+
[unretrievableAttributes](#unretrievableattributes) `settings`
662662

663663
**Ranking**
664-
- [ranking](#ranking) `settings`
665-
- [customRanking](#customranking) `settings`
666-
- [slaves](#slaves) `settings`
664+
[ranking](#ranking) `settings`
665+
[customRanking](#customranking) `settings`
666+
[slaves](#slaves) `settings`
667667

668668
**Filtering / Faceting**
669-
- [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
669+
[maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
670670

671671
**Highlighting / Snippeting**
672-
- [attributesToHighlight](#attributestohighlight) `settings`, `search`
673-
- [attributesToSnippet](#attributestosnippet) `settings`, `search`
674-
- [highlightPreTag](#highlightpretag) `settings`, `search`
675-
- [highlightPostTag](#highlightposttag) `settings`, `search`
676-
- [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
672+
[attributesToHighlight](#attributestohighlight) `settings`, `search`
673+
[attributesToSnippet](#attributestosnippet) `settings`, `search`
674+
[highlightPreTag](#highlightpretag) `settings`, `search`
675+
[highlightPostTag](#highlightposttag) `settings`, `search`
676+
[snippetEllipsisText](#snippetellipsistext) `settings`, `search`
677677

678678
**Pagination**
679-
- [hitsPerPage](#hitsperpage) `settings`, `search`
679+
[hitsPerPage](#hitsperpage) `settings`, `search`
680680

681681
**Typos**
682-
- [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
683-
- [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
684-
- [typoTolerance](#typotolerance) `settings`, `search`
685-
- [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
686-
- [ignorePlurals](#ignoreplurals) `settings`, `search`
687-
- [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
688-
- [separatorsToIndex](#separatorstoindex) `settings`
682+
[minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
683+
[minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
684+
[typoTolerance](#typotolerance) `settings`, `search`
685+
[allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
686+
[ignorePlurals](#ignoreplurals) `settings`, `search`
687+
[disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
688+
[separatorsToIndex](#separatorstoindex) `settings`
689689

690690
**Query Strategy**
691-
- [queryType](#querytype) `settings`, `search`
692-
- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
693-
- [advancedSyntax](#advancedsyntax) `settings`, `search`
694-
- [optionalWords](#optionalwords) `settings`, `search`
695-
- [removeStopWords](#removestopwords) `settings`, `search`
696-
- [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
697-
- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
698-
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
699-
- [alternativesAsExact](#alternativesasexact) `settings`, `search`
691+
[queryType](#querytype) `settings`, `search`
692+
[removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
693+
[advancedSyntax](#advancedsyntax) `settings`, `search`
694+
[optionalWords](#optionalwords) `settings`, `search`
695+
[removeStopWords](#removestopwords) `settings`, `search`
696+
[disablePrefixOnAttributes](#disableprefixonattributes) `settings`
697+
[disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
698+
[exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
699+
[alternativesAsExact](#alternativesasexact) `settings`, `search`
700700

701701
**Advanced**
702-
- [attributeForDistinct](#attributefordistinct) `settings`
703-
- [distinct](#distinct) `settings`, `search`
704-
- [numericAttributesToIndex](#numericattributestoindex) `settings`
705-
- [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
706-
- [altCorrections](#altcorrections) `settings`
707-
- [placeholders](#placeholders) `settings`
702+
[attributeForDistinct](#attributefordistinct) `settings`
703+
[distinct](#distinct) `settings`, `search`
704+
[numericAttributesToIndex](#numericattributestoindex) `settings`
705+
[allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
706+
[altCorrections](#altcorrections) `settings`
707+
[placeholders](#placeholders) `settings`
708708

709709
<!--/PARAMETERS_LINK-->
710710

@@ -727,77 +727,77 @@ They are three scopes:
727727
#### Parameters List
728728

729729
**Search**
730-
- [query](#query) `search`
730+
[query](#query) `search`
731731

732732
**Attributes**
733-
- [attributesForFaceting](#attributesforfaceting) `settings`
734-
- [attributesToIndex](#attributestoindex) `settings`
735-
- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
736-
- [unretrievableAttributes](#unretrievableattributes) `settings`
733+
[attributesForFaceting](#attributesforfaceting) `settings`
734+
[attributesToIndex](#attributestoindex) `settings`
735+
[attributesToRetrieve](#attributestoretrieve) `settings`, `search`
736+
[unretrievableAttributes](#unretrievableattributes) `settings`
737737

738738

739739
**Ranking**
740-
- [ranking](#ranking) `settings`
741-
- [customRanking](#customranking) `settings`
742-
- [slaves](#slaves) `settings`
740+
[ranking](#ranking) `settings`
741+
[customRanking](#customranking) `settings`
742+
[slaves](#slaves) `settings`
743743

744744
**Filtering / Faceting**
745-
- [filters](#filters) `search`
746-
- [facets](#facets) `search`
747-
- [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
745+
[filters](#filters) `search`
746+
[facets](#facets) `search`
747+
[maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
748748

749749
**Highlighting / Snippeting**
750-
- [attributesToHighlight](#attributestohighlight) `settings`, `search`
751-
- [attributesToSnippet](#attributestosnippet) `settings`, `search`
752-
- [highlightPreTag](#highlightpretag) `settings`, `search`
753-
- [highlightPostTag](#highlightposttag) `settings`, `search`
754-
- [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
755-
- [restrictHighlightAndSnippetArrays](#restricthighlightandsnippetarrays) `settings`, `search`
750+
[attributesToHighlight](#attributestohighlight) `settings`, `search`
751+
[attributesToSnippet](#attributestosnippet) `settings`, `search`
752+
[highlightPreTag](#highlightpretag) `settings`, `search`
753+
[highlightPostTag](#highlightposttag) `settings`, `search`
754+
[snippetEllipsisText](#snippetellipsistext) `settings`, `search`
755+
[restrictHighlightAndSnippetArrays](#restricthighlightandsnippetarrays) `settings`, `search`
756756

757757
**Pagination**
758-
- [page](#page) `search`
759-
- [hitsPerPage](#hitsperpage) `settings`, `search`
758+
[page](#page) `search`
759+
[hitsPerPage](#hitsperpage) `settings`, `search`
760760

761761
**Typos**
762-
- [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
763-
- [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
764-
- [typoTolerance](#typotolerance) `settings`, `search`
765-
- [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
766-
- [ignorePlurals](#ignoreplurals) `settings`, `search`
767-
- [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
768-
- [separatorsToIndex](#separatorstoindex) `settings`
762+
[minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
763+
[minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
764+
[typoTolerance](#typotolerance) `settings`, `search`
765+
[allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
766+
[ignorePlurals](#ignoreplurals) `settings`, `search`
767+
[disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
768+
[separatorsToIndex](#separatorstoindex) `settings`
769769

770770
**Geo-Search**
771771

772-
- [aroundLatLng](#aroundlatlng) `search`
773-
- [aroundLatLngViaIP](#aroundlatlngviaip) `search`
774-
- [insideBoundingBox](#insideboundingbox) `search`
775-
- [insidePolygon](#insidepolygon) `search`
772+
[aroundLatLng](#aroundlatlng) `search`
773+
[aroundLatLngViaIP](#aroundlatlngviaip) `search`
774+
[insideBoundingBox](#insideboundingbox) `search`
775+
[insidePolygon](#insidepolygon) `search`
776776

777777

778778
**Query Strategy**
779-
- [queryType](#querytype) `settings`, `search`
780-
- [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
781-
- [advancedSyntax](#advancedsyntax) `settings`, `search`
782-
- [optionalWords](#optionalwords) `settings`, `search`
783-
- [removeStopWords](#removestopwords) `settings`, `search`
784-
- [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
785-
- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
786-
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
787-
- [alternativesAsExact](#alternativesasexact) `settings`, `search`
779+
[queryType](#querytype) `settings`, `search`
780+
[removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
781+
[advancedSyntax](#advancedsyntax) `settings`, `search`
782+
[optionalWords](#optionalwords) `settings`, `search`
783+
[removeStopWords](#removestopwords) `settings`, `search`
784+
[disablePrefixOnAttributes](#disableprefixonattributes) `settings`
785+
[disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
786+
[exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
787+
[alternativesAsExact](#alternativesasexact) `settings`, `search`
788788

789789
**Advanced**
790-
- [attributeForDistinct](#attributefordistinct) `settings`
791-
- [distinct](#distinct) `settings`, `search`
792-
- [rankingInfo](#rankinginfo) `search`
793-
- [numericAttributesToIndex](#numericattributestoindex) `settings`
794-
- [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
795-
- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
796-
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
797-
- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
798-
- [analytics](#analytics) `search`
799-
- [altCorrections](#altcorrections) `settings`
800-
- [placeholders](#placeholders) `settings`
790+
[attributeForDistinct](#attributefordistinct) `settings`
791+
[distinct](#distinct) `settings`, `search`
792+
[rankingInfo](#rankinginfo) `search`
793+
[numericAttributesToIndex](#numericattributestoindex) `settings`
794+
[allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
795+
[numericFilters (deprecated)](#numericfilters-deprecated) `search`
796+
[tagFilters (deprecated)](#tagfilters-deprecated) `search`
797+
[facetFilters (deprecated)](#facetfilters-deprecated) `search`
798+
[analytics](#analytics) `search`
799+
[altCorrections](#altcorrections) `settings`
800+
[placeholders](#placeholders) `settings`
801801

802802
### Search
803803

@@ -1003,16 +1003,16 @@ The list of keywords is:
10031003
- default: `""`
10041004

10051005

1006-
You can use - [facets](#facets) to retrieve only a part of your attributes declared in
1007-
**- [attributesForFaceting](#attributesforfaceting)** attributes.
1008-
It will not filter your results, if you want to filter results you should use - [filters](#filters).
1006+
You can use [facets](#facets) to retrieve only a part of your attributes declared in
1007+
**[attributesForFaceting](#attributesforfaceting)** attributes.
1008+
It will not filter your results, if you want to filter results you should use [filters](#filters).
10091009

10101010
For each of the declared attributes, you'll be able to retrieve a list of the most relevant facet values,
10111011
and their associated count for the current query.
10121012

10131013
** Example **
10141014

1015-
If you have defined in your **- [attributesForFaceting](#attributesforfaceting)**:
1015+
If you have defined in your **[attributesForFaceting](#attributesforfaceting)**:
10161016

10171017
['category', 'author', 'nb_views', 'nb_downloads']
10181018

@@ -1028,7 +1028,7 @@ For this example: `["category","author"]`.
10281028

10291029
**Warnings**
10301030

1031-
- When using - [facets](#facets) in a search query, only attributes that have been added in **attributesForFaceting** index setting can be used in this parameter.
1031+
- When using [facets](#facets) in a search query, only attributes that have been added in **attributesForFaceting** index setting can be used in this parameter.
10321032
You can also use `*` to perform faceting on all attributes specified in `attributesForFaceting`.
10331033
If the number of results is important, the count can be approximate,
10341034
the attribute `exhaustiveFacetsCount` in the response is true when the count is exact.

0 commit comments

Comments
 (0)