Skip to content

Commit 0879bb8

Browse files
feat(specs): add specific documentation for facets query parameter in Composition API (generated)
algolia/api-clients-automation#5477 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]>
1 parent c570fdb commit 0879bb8

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

algoliasearch/composition/models/main_injection_query_parameters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ class MainInjectionQueryParameters(BaseModel):
193193
faceting_after_distinct: Optional[bool] = None
194194
""" Whether faceting should be applied after deduplication with `distinct` This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`. """
195195
facets: Optional[List[str]] = None
196-
""" Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts). """
196+
""" Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts) and [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting). """
197197
hits_per_page: Optional[int] = None
198198
""" Number of hits per page. """
199199
max_values_per_facet: Optional[int] = None

algoliasearch/composition/models/params.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
"page": "page",
3434
"get_ranking_info": "getRankingInfo",
3535
"relevancy_strictness": "relevancyStrictness",
36-
"facets": "facets",
3736
"facet_filters": "facetFilters",
37+
"facets": "facets",
3838
"optional_filters": "optionalFilters",
3939
"numeric_filters": "numericFilters",
4040
"hits_per_page": "hitsPerPage",
@@ -78,9 +78,9 @@ class Params(BaseModel):
7878
""" Whether the run response should include detailed ranking information. """
7979
relevancy_strictness: Optional[int] = None
8080
""" Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. """
81-
facets: Optional[List[str]] = None
82-
""" Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts). """
8381
facet_filters: Optional[FacetFilters] = None
82+
facets: Optional[List[str]] = None
83+
""" Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts) and [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting). """
8484
optional_filters: Optional[OptionalFilters] = None
8585
numeric_filters: Optional[NumericFilters] = None
8686
hits_per_page: Optional[int] = None

0 commit comments

Comments
 (0)