@@ -280,58 +280,58 @@ Here is the list of parameters you can use with the search method (`search` [sco
280
280
Parameters that can also be used in a setSettings also have the ` indexing ` [ scope] ( #scope )
281
281
282
282
** Search**
283
- - [ query] ( #query ) ` search `
283
+ [ query] ( #query ) ` search `
284
284
285
285
** Attributes**
286
- - [ attributesToRetrieve] ( #attributestoretrieve ) ` settings ` , ` search `
286
+ [ attributesToRetrieve] ( #attributestoretrieve ) ` settings ` , ` search `
287
287
288
288
** Filtering / Faceting**
289
- - [ filters] ( #filters ) ` search `
290
- - [ facets] ( #facets ) ` search `
291
- - [ maxValuesPerFacet] ( #maxvaluesperfacet ) ` settings ` , ` search `
289
+ [ filters] ( #filters ) ` search `
290
+ [ facets] ( #facets ) ` search `
291
+ [ maxValuesPerFacet] ( #maxvaluesperfacet ) ` settings ` , ` search `
292
292
293
293
** Highlighting / Snippeting**
294
- - [ attributesToHighlight] ( #attributestohighlight ) ` settings ` , ` search `
295
- - [ attributesToSnippet] ( #attributestosnippet ) ` settings ` , ` search `
296
- - [ highlightPreTag] ( #highlightpretag ) ` settings ` , ` search `
297
- - [ highlightPostTag] ( #highlightposttag ) ` settings ` , ` search `
298
- - [ snippetEllipsisText] ( #snippetellipsistext ) ` settings ` , ` search `
294
+ [ attributesToHighlight] ( #attributestohighlight ) ` settings ` , ` search `
295
+ [ attributesToSnippet] ( #attributestosnippet ) ` settings ` , ` search `
296
+ [ highlightPreTag] ( #highlightpretag ) ` settings ` , ` search `
297
+ [ highlightPostTag] ( #highlightposttag ) ` settings ` , ` search `
298
+ [ snippetEllipsisText] ( #snippetellipsistext ) ` settings ` , ` search `
299
299
300
300
** Pagination**
301
- - [ page] ( #page ) ` search `
302
- - [ hitsPerPage] ( #hitsperpage ) ` settings ` , ` search `
301
+ [ page] ( #page ) ` search `
302
+ [ hitsPerPage] ( #hitsperpage ) ` settings ` , ` search `
303
303
304
304
** Typos**
305
- - [ minWordSizefor1Typo] ( #minwordsizefor1typo ) ` settings ` , ` search `
306
- - [ minWordSizefor2Typos] ( #minwordsizefor2typos ) ` settings ` , ` search `
307
- - [ typoTolerance] ( #typotolerance ) ` settings ` , ` search `
308
- - [ allowTyposOnNumericTokens] ( #allowtyposonnumerictokens ) ` settings ` , ` search `
309
- - [ ignorePlurals] ( #ignoreplurals ) ` settings ` , ` search `
310
- - [ disableTypoToleranceOnAttributes] ( #disabletypotoleranceonattributes ) ` settings ` , ` search `
305
+ [ minWordSizefor1Typo] ( #minwordsizefor1typo ) ` settings ` , ` search `
306
+ [ minWordSizefor2Typos] ( #minwordsizefor2typos ) ` settings ` , ` search `
307
+ [ typoTolerance] ( #typotolerance ) ` settings ` , ` search `
308
+ [ allowTyposOnNumericTokens] ( #allowtyposonnumerictokens ) ` settings ` , ` search `
309
+ [ ignorePlurals] ( #ignoreplurals ) ` settings ` , ` search `
310
+ [ disableTypoToleranceOnAttributes] ( #disabletypotoleranceonattributes ) ` settings ` , ` search `
311
311
312
312
** Geo-Search**
313
- - [ aroundLatLng] ( #aroundlatlng ) ` search `
314
- - [ aroundLatLngViaIP] ( #aroundlatlngviaip ) ` search `
315
- - [ insideBoundingBox] ( #insideboundingbox ) ` search `
316
- - [ insidePolygon] ( #insidepolygon ) ` search `
313
+ [ aroundLatLng] ( #aroundlatlng ) ` search `
314
+ [ aroundLatLngViaIP] ( #aroundlatlngviaip ) ` search `
315
+ [ insideBoundingBox] ( #insideboundingbox ) ` search `
316
+ [ insidePolygon] ( #insidepolygon ) ` search `
317
317
318
318
319
319
** Query Strategy**
320
- - [ queryType] ( #querytype ) ` settings ` , ` search `
321
- - [ removeWordsIfNoResults] ( #removewordsifnoresults ) ` settings ` , ` search `
322
- - [ advancedSyntax] ( #advancedsyntax ) ` settings ` , ` search `
323
- - [ optionalWords] ( #optionalwords ) ` settings ` , ` search `
324
- - [ removeStopWords] ( #removestopwords ) ` settings ` , ` search `
325
- - [ exactOnSingleWordQuery] ( #exactonsinglewordquery ) ` settings ` , ` search `
326
- - [ alternativesAsExact] ( #alternativesasexact ) ` settings ` , ` search `
320
+ [ queryType] ( #querytype ) ` settings ` , ` search `
321
+ [ removeWordsIfNoResults] ( #removewordsifnoresults ) ` settings ` , ` search `
322
+ [ advancedSyntax] ( #advancedsyntax ) ` settings ` , ` search `
323
+ [ optionalWords] ( #optionalwords ) ` settings ` , ` search `
324
+ [ removeStopWords] ( #removestopwords ) ` settings ` , ` search `
325
+ [ exactOnSingleWordQuery] ( #exactonsinglewordquery ) ` settings ` , ` search `
326
+ [ alternativesAsExact] ( #alternativesasexact ) ` settings ` , ` search `
327
327
328
328
** Advanced**
329
- - [ distinct] ( #distinct ) ` settings ` , ` search `
330
- - [ rankingInfo] ( #rankinginfo ) ` search `
331
- - [ numericFilters (deprecated)] ( #numericfilters-deprecated ) ` search `
332
- - [ tagFilters (deprecated)] ( #tagfilters-deprecated ) ` search `
333
- - [ facetFilters (deprecated)] ( #facetfilters-deprecated ) ` search `
334
- - [ analytics] ( #analytics ) ` search `
329
+ [ distinct] ( #distinct ) ` settings ` , ` search `
330
+ [ rankingInfo] ( #rankinginfo ) ` search `
331
+ [ numericFilters (deprecated)] ( #numericfilters-deprecated ) ` search `
332
+ [ tagFilters (deprecated)] ( #tagfilters-deprecated ) ` search `
333
+ [ facetFilters (deprecated)] ( #facetfilters-deprecated ) ` search `
334
+ [ analytics] ( #analytics ) ` search `
335
335
336
336
<!-- /PARAMETERS_LINK-->
337
337
@@ -614,56 +614,56 @@ Here is the list of parameters you can use with the set settings method (`indexi
614
614
Parameters that can be override at search time also have the `indexing` [scope](#scope)
615
615
616
616
**Attributes**
617
- - [attributesToIndex](#attributestoindex) `settings`
618
- - [attributesForFaceting](#attributesforfaceting) `settings`
619
- - [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
620
- - [unretrievableAttributes](#unretrievableattributes) `settings`
617
+ [attributesToIndex](#attributestoindex) `settings`
618
+ [attributesForFaceting](#attributesforfaceting) `settings`
619
+ [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
620
+ [unretrievableAttributes](#unretrievableattributes) `settings`
621
621
622
622
**Ranking**
623
- - [ranking](#ranking) `settings`
624
- - [customRanking](#customranking) `settings`
625
- - [slaves](#slaves) `settings`
623
+ [ranking](#ranking) `settings`
624
+ [customRanking](#customranking) `settings`
625
+ [slaves](#slaves) `settings`
626
626
627
627
**Filtering / Faceting**
628
- - [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
628
+ [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
629
629
630
630
**Highlighting / Snippeting**
631
- - [attributesToHighlight](#attributestohighlight) `settings`, `search`
632
- - [attributesToSnippet](#attributestosnippet) `settings`, `search`
633
- - [highlightPreTag](#highlightpretag) `settings`, `search`
634
- - [highlightPostTag](#highlightposttag) `settings`, `search`
635
- - [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
631
+ [attributesToHighlight](#attributestohighlight) `settings`, `search`
632
+ [attributesToSnippet](#attributestosnippet) `settings`, `search`
633
+ [highlightPreTag](#highlightpretag) `settings`, `search`
634
+ [highlightPostTag](#highlightposttag) `settings`, `search`
635
+ [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
636
636
637
637
**Pagination**
638
- - [hitsPerPage](#hitsperpage) `settings`, `search`
638
+ [hitsPerPage](#hitsperpage) `settings`, `search`
639
639
640
640
**Typos**
641
- - [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
642
- - [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
643
- - [typoTolerance](#typotolerance) `settings`, `search`
644
- - [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
645
- - [ignorePlurals](#ignoreplurals) `settings`, `search`
646
- - [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
647
- - [separatorsToIndex](#separatorstoindex) `settings`
641
+ [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
642
+ [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
643
+ [typoTolerance](#typotolerance) `settings`, `search`
644
+ [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
645
+ [ignorePlurals](#ignoreplurals) `settings`, `search`
646
+ [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
647
+ [separatorsToIndex](#separatorstoindex) `settings`
648
648
649
649
**Query Strategy**
650
- - [queryType](#querytype) `settings`, `search`
651
- - [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
652
- - [advancedSyntax](#advancedsyntax) `settings`, `search`
653
- - [optionalWords](#optionalwords) `settings`, `search`
654
- - [removeStopWords](#removestopwords) `settings`, `search`
655
- - [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
656
- - [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
657
- - [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
658
- - [alternativesAsExact](#alternativesasexact) `settings`, `search`
650
+ [queryType](#querytype) `settings`, `search`
651
+ [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
652
+ [advancedSyntax](#advancedsyntax) `settings`, `search`
653
+ [optionalWords](#optionalwords) `settings`, `search`
654
+ [removeStopWords](#removestopwords) `settings`, `search`
655
+ [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
656
+ [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
657
+ [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
658
+ [alternativesAsExact](#alternativesasexact) `settings`, `search`
659
659
660
660
**Advanced**
661
- - [attributeForDistinct](#attributefordistinct) `settings`
662
- - [distinct](#distinct) `settings`, `search`
663
- - [numericAttributesToIndex](#numericattributestoindex) `settings`
664
- - [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
665
- - [altCorrections](#altcorrections) `settings`
666
- - [placeholders](#placeholders) `settings`
661
+ [attributeForDistinct](#attributefordistinct) `settings`
662
+ [distinct](#distinct) `settings`, `search`
663
+ [numericAttributesToIndex](#numericattributestoindex) `settings`
664
+ [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
665
+ [altCorrections](#altcorrections) `settings`
666
+ [placeholders](#placeholders) `settings`
667
667
668
668
<!--/PARAMETERS_LINK-->
669
669
@@ -686,77 +686,77 @@ They are three scopes:
686
686
#### Parameters List
687
687
688
688
**Search**
689
- - [query](#query) `search`
689
+ [query](#query) `search`
690
690
691
691
**Attributes**
692
- - [attributesForFaceting](#attributesforfaceting) `settings`
693
- - [attributesToIndex](#attributestoindex) `settings`
694
- - [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
695
- - [unretrievableAttributes](#unretrievableattributes) `settings`
692
+ [attributesForFaceting](#attributesforfaceting) `settings`
693
+ [attributesToIndex](#attributestoindex) `settings`
694
+ [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
695
+ [unretrievableAttributes](#unretrievableattributes) `settings`
696
696
697
697
698
698
**Ranking**
699
- - [ranking](#ranking) `settings`
700
- - [customRanking](#customranking) `settings`
701
- - [slaves](#slaves) `settings`
699
+ [ranking](#ranking) `settings`
700
+ [customRanking](#customranking) `settings`
701
+ [slaves](#slaves) `settings`
702
702
703
703
**Filtering / Faceting**
704
- - [filters](#filters) `search`
705
- - [facets](#facets) `search`
706
- - [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
704
+ [filters](#filters) `search`
705
+ [facets](#facets) `search`
706
+ [maxValuesPerFacet](#maxvaluesperfacet) `settings`, `search`
707
707
708
708
**Highlighting / Snippeting**
709
- - [attributesToHighlight](#attributestohighlight) `settings`, `search`
710
- - [attributesToSnippet](#attributestosnippet) `settings`, `search`
711
- - [highlightPreTag](#highlightpretag) `settings`, `search`
712
- - [highlightPostTag](#highlightposttag) `settings`, `search`
713
- - [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
714
- - [restrictHighlightAndSnippetArrays](#restricthighlightandsnippetarrays) `settings`, `search`
709
+ [attributesToHighlight](#attributestohighlight) `settings`, `search`
710
+ [attributesToSnippet](#attributestosnippet) `settings`, `search`
711
+ [highlightPreTag](#highlightpretag) `settings`, `search`
712
+ [highlightPostTag](#highlightposttag) `settings`, `search`
713
+ [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
714
+ [restrictHighlightAndSnippetArrays](#restricthighlightandsnippetarrays) `settings`, `search`
715
715
716
716
**Pagination**
717
- - [page](#page) `search`
718
- - [hitsPerPage](#hitsperpage) `settings`, `search`
717
+ [page](#page) `search`
718
+ [hitsPerPage](#hitsperpage) `settings`, `search`
719
719
720
720
**Typos**
721
- - [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
722
- - [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
723
- - [typoTolerance](#typotolerance) `settings`, `search`
724
- - [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
725
- - [ignorePlurals](#ignoreplurals) `settings`, `search`
726
- - [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
727
- - [separatorsToIndex](#separatorstoindex) `settings`
721
+ [minWordSizefor1Typo](#minwordsizefor1typo) `settings`, `search`
722
+ [minWordSizefor2Typos](#minwordsizefor2typos) `settings`, `search`
723
+ [typoTolerance](#typotolerance) `settings`, `search`
724
+ [allowTyposOnNumericTokens](#allowtyposonnumerictokens) `settings`, `search`
725
+ [ignorePlurals](#ignoreplurals) `settings`, `search`
726
+ [disableTypoToleranceOnAttributes](#disabletypotoleranceonattributes) `settings`, `search`
727
+ [separatorsToIndex](#separatorstoindex) `settings`
728
728
729
729
**Geo-Search**
730
730
731
- - [aroundLatLng](#aroundlatlng) `search`
732
- - [aroundLatLngViaIP](#aroundlatlngviaip) `search`
733
- - [insideBoundingBox](#insideboundingbox) `search`
734
- - [insidePolygon](#insidepolygon) `search`
731
+ [aroundLatLng](#aroundlatlng) `search`
732
+ [aroundLatLngViaIP](#aroundlatlngviaip) `search`
733
+ [insideBoundingBox](#insideboundingbox) `search`
734
+ [insidePolygon](#insidepolygon) `search`
735
735
736
736
737
737
**Query Strategy**
738
- - [queryType](#querytype) `settings`, `search`
739
- - [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
740
- - [advancedSyntax](#advancedsyntax) `settings`, `search`
741
- - [optionalWords](#optionalwords) `settings`, `search`
742
- - [removeStopWords](#removestopwords) `settings`, `search`
743
- - [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
744
- - [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
745
- - [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
746
- - [alternativesAsExact](#alternativesasexact) `settings`, `search`
738
+ [queryType](#querytype) `settings`, `search`
739
+ [removeWordsIfNoResults](#removewordsifnoresults) `settings`, `search`
740
+ [advancedSyntax](#advancedsyntax) `settings`, `search`
741
+ [optionalWords](#optionalwords) `settings`, `search`
742
+ [removeStopWords](#removestopwords) `settings`, `search`
743
+ [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
744
+ [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
745
+ [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
746
+ [alternativesAsExact](#alternativesasexact) `settings`, `search`
747
747
748
748
**Advanced**
749
- - [attributeForDistinct](#attributefordistinct) `settings`
750
- - [distinct](#distinct) `settings`, `search`
751
- - [rankingInfo](#rankinginfo) `search`
752
- - [numericAttributesToIndex](#numericattributestoindex) `settings`
753
- - [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
754
- - [numericFilters (deprecated)](#numericfilters-deprecated) `search`
755
- - [tagFilters (deprecated)](#tagfilters-deprecated) `search`
756
- - [facetFilters (deprecated)](#facetfilters-deprecated) `search`
757
- - [analytics](#analytics) `search`
758
- - [altCorrections](#altcorrections) `settings`
759
- - [placeholders](#placeholders) `settings`
749
+ [attributeForDistinct](#attributefordistinct) `settings`
750
+ [distinct](#distinct) `settings`, `search`
751
+ [rankingInfo](#rankinginfo) `search`
752
+ [numericAttributesToIndex](#numericattributestoindex) `settings`
753
+ [allowCompressionOfIntegerArray](#allowcompressionofintegerarray) `settings`
754
+ [numericFilters (deprecated)](#numericfilters-deprecated) `search`
755
+ [tagFilters (deprecated)](#tagfilters-deprecated) `search`
756
+ [facetFilters (deprecated)](#facetfilters-deprecated) `search`
757
+ [analytics](#analytics) `search`
758
+ [altCorrections](#altcorrections) `settings`
759
+ [placeholders](#placeholders) `settings`
760
760
761
761
### Search
762
762
@@ -962,16 +962,16 @@ The list of keywords is:
962
962
- default : `" " `
963
963
964
964
965
- You can use - [facets](#facets) to retrieve only a part of your attributes declared in
966
- **- [attributesForFaceting](#attributesforfaceting)** attributes.
967
- It will not filter your results, if you want to filter results you should use - [filters](#filters).
965
+ You can use [facets](#facets) to retrieve only a part of your attributes declared in
966
+ ** [attributesForFaceting](#attributesforfaceting)** attributes.
967
+ It will not filter your results, if you want to filter results you should use [filters](#filters).
968
968
969
969
For each of the declared attributes, you' ll be able to retrieve a list of the most relevant facet values,
970
970
and their associated count for the current query.
971
971
972
972
** Example **
973
973
974
- If you have defined in your **- [attributesForFaceting](#attributesforfaceting)**:
974
+ If you have defined in your **[attributesForFaceting](#attributesforfaceting)**:
975
975
976
976
[' category' , ' author' , ' nb_views' , ' nb_downloads' ]
977
977
@@ -987,7 +987,7 @@ For this example: `["category","author"]`.
987
987
988
988
**Warnings**
989
989
990
- - When using - [facets](#facets) in a search query, only attributes that have been added in **attributesForFaceting** index setting can be used in this parameter.
990
+ - When using [facets](#facets) in a search query, only attributes that have been added in **attributesForFaceting** index setting can be used in this parameter.
991
991
You can also use `*` to perform faceting on all attributes specified in `attributesForFaceting`.
992
992
If the number of results is important, the count can be approximate,
993
993
the attribute `exhaustiveFacetsCount` in the response is true when the count is exact.
0 commit comments