Skip to content
This repository was archived by the owner on Jan 31, 2022. It is now read-only.

Commit 3f07138

Browse files
docs(README): automatic update
Update README Android [This list might not be relevant] facets improvement again fix scope for facets Add restrictHighlightAndSnippetArrays (#101) Depracated parameters explanation (#103) [ci skip]
1 parent 8ea47f0 commit 3f07138

File tree

1 file changed

+41
-13
lines changed

1 file changed

+41
-13
lines changed

README.md

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
331331
- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
332332
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
333333
- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
334-
- [analytics](#analytics) `settings`, `search`
334+
- [analytics](#analytics) `search`
335335

336336
<!--/PARAMETERS_LINK-->
337337

@@ -653,7 +653,7 @@ Parameters that can be override at search time also have the `indexing` [scope](
653653
- [optionalWords](#optionalwords) `settings`, `search`
654654
- [removeStopWords](#removestopwords) `settings`, `search`
655655
- [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
656-
- [disableExactOnAttributes](#disableexactonattributes) `settings`
656+
- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
657657
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
658658
- [alternativesAsExact](#alternativesasexact) `settings`, `search`
659659
@@ -711,6 +711,7 @@ They are three scopes:
711711
- [highlightPreTag](#highlightpretag) `settings`, `search`
712712
- [highlightPostTag](#highlightposttag) `settings`, `search`
713713
- [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
714+
- [restrictHighlightAndSnippetArrays](#restricthighlightandsnippetarrays) `settings`, `search`
714715
715716
**Pagination**
716717
- [page](#page) `search`
@@ -740,7 +741,7 @@ They are three scopes:
740741
- [optionalWords](#optionalwords) `settings`, `search`
741742
- [removeStopWords](#removestopwords) `settings`, `search`
742743
- [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
743-
- [disableExactOnAttributes](#disableexactonattributes) `settings`
744+
- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
744745
- [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
745746
- [alternativesAsExact](#alternativesasexact) `settings`, `search`
746747
@@ -753,7 +754,7 @@ They are three scopes:
753754
- [numericFilters (deprecated)](#numericfilters-deprecated) `search`
754755
- [tagFilters (deprecated)](#tagfilters-deprecated) `search`
755756
- [facetFilters (deprecated)](#facetfilters-deprecated) `search`
756-
- [analytics](#analytics) `settings`, `search`
757+
- [analytics](#analytics) `search`
757758
- [altCorrections](#altcorrections) `settings`
758759
- [placeholders](#placeholders) `settings`
759760
@@ -961,20 +962,32 @@ The list of keywords is:
961962
- default: `""`
962963

963964

964-
List of object attributes that you want to use for faceting.
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).
965968

966969
For each of the declared attributes, you'll be able to retrieve a list of the most relevant facet values,
967970
and their associated count for the current query.
968971
969-
Attributes are separated by a comma.
972+
** Example **
970973
971-
For example, `"category,author"`.
974+
If you have defined in your **- [attributesForFaceting](#attributesforfaceting)**:
975+
976+
['category', 'author', 'nb_views', 'nb_downloads']
977+
978+
But for the current search want to retrieve only facet values for `category` and `author` you can
979+
980+
you can specify your attributes coma separated.
981+
982+
For this example: `"category,author"`.
972983
973984
You can also use JSON string array encoding.
974985
975-
For example, `["category","author"]`.
986+
For this example: `["category","author"]`.
987+
988+
**Warnings**
976989
977-
Only the 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.
978991
You can also use `*` to perform faceting on all attributes specified in `attributesForFaceting`.
979992
If the number of results is important, the count can be approximate,
980993
the attribute `exhaustiveFacetsCount` in the response is true when the count is exact.
@@ -1056,6 +1069,15 @@ Specify the string that is inserted after the highlighted parts in the query res
10561069
String used as an ellipsis indicator when a snippet is truncated.
10571070
Defaults to an empty string for all accounts created before 10/2/2016, and to … (UTF-8 U+2026) for accounts created after that date.
10581071
1072+
#### restrictHighlightAndSnippetArrays
1073+
1074+
- scope: `settings`, `search`
1075+
- type: `boolean`
1076+
- default: `false`
1077+
1078+
1079+
If set to true, restrict arrays in highlights and snippets to items that matched the query at least partially else return all array items in highlights and snippets.
1080+
10591081
### Pagination
10601082
10611083
#### page
@@ -1367,7 +1389,7 @@ This setting is useful on attributes that contain string that should not be matc
13671389
13681390
#### disableExactOnAttributes
13691391
1370-
- scope: `settings`
1392+
- scope: `settings`, `search`
13711393
- type: `array of strings`
13721394
- default: `[]`
13731395
@@ -1487,6 +1509,8 @@ When enabled, the integer array is reordered to reach a better compression ratio
14871509
- default: `[]`
14881510

14891511

1512+
*This parameter is deprecated. Please use [Filters](#filters) instead.*
1513+
14901514
A string that contains the comma separated list of numeric filters you want to apply.
14911515
The filter syntax is `attributeName` followed by `operand` followed by `value`.
14921516
Supported operands are `<`, `<=`, `=`, `>` and `>=`.
@@ -1511,6 +1535,8 @@ You can also use a string array encoding (for example `numericFilters: ["price>1
15111535
- default: `""`
15121536

15131537

1538+
*This parameter is deprecated. Please use [Filters](#filters) instead.*
1539+
15141540
Filter the query by a set of tags.
15151541

15161542
You can AND tags by separating them with commas.
@@ -1537,6 +1563,8 @@ For example `{"_tags":["tag1","tag2"]}`.
15371563
- default: `""`
15381564

15391565

1566+
*This parameter is deprecated. Please use [Filters](#filters) instead.*
1567+
15401568
Filter the query with a list of facets. Facets are separated by commas and is encoded as `attributeName:value`.
15411569
To OR facets, you must add parentheses.
15421570

@@ -1548,9 +1576,9 @@ For example, `[["category:Book","category:Movie"],"author:John%20Doe"]`.
15481576

15491577
#### analytics
15501578

1551-
- scope: `settings`, `search`
1552-
- type: `string`
1553-
- default: `['ignorePlurals', 'singleWordSynonym']`
1579+
- scope: `search`
1580+
- type: `boolean`
1581+
- default: `true`
15541582

15551583

15561584
If set to false, this query will not be taken into account in the analytics feature.

0 commit comments

Comments
 (0)