Skip to content

Commit 640555c

Browse files
fix(specs): remove query parameter that are not accepted by the Composition API (generated)
algolia/api-clients-automation#6128 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
1 parent af19cbf commit 640555c

2 files changed

Lines changed: 0 additions & 18 deletions

File tree

algoliasearch/composition/models/base_injection_query_parameters.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,11 @@
4444
"advanced_syntax_features": "advancedSyntaxFeatures",
4545
"allow_typos_on_numeric_tokens": "allowTyposOnNumericTokens",
4646
"alternatives_as_exact": "alternativesAsExact",
47-
"analytics": "analytics",
4847
"attribute_criteria_computed_by_min_proximity": "attributeCriteriaComputedByMinProximity",
4948
"attributes_to_highlight": "attributesToHighlight",
5049
"attributes_to_retrieve": "attributesToRetrieve",
5150
"attributes_to_snippet": "attributesToSnippet",
5251
"click_analytics": "clickAnalytics",
53-
"decompound_query": "decompoundQuery",
5452
"disable_exact_on_attributes": "disableExactOnAttributes",
5553
"disable_typo_tolerance_on_attributes": "disableTypoToleranceOnAttributes",
5654
"distinct": "distinct",
@@ -65,7 +63,6 @@
6563
"highlight_post_tag": "highlightPostTag",
6664
"highlight_pre_tag": "highlightPreTag",
6765
"ignore_plurals": "ignorePlurals",
68-
"max_facet_hits": "maxFacetHits",
6966
"min_proximity": "minProximity",
7067
"min_word_sizefor1_typo": "minWordSizefor1Typo",
7168
"min_word_sizefor2_typos": "minWordSizefor2Typos",
@@ -107,8 +104,6 @@ class BaseInjectionQueryParameters(BaseModel):
107104
""" Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers. """
108105
alternatives_as_exact: Optional[List[AlternativesAsExact]] = None
109106
""" Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)) - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches. """
110-
analytics: Optional[bool] = None
111-
""" Whether this search will be included in Analytics. """
112107
attribute_criteria_computed_by_min_proximity: Optional[bool] = None
113108
""" Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting. """
114109
attributes_to_highlight: Optional[List[str]] = None
@@ -119,8 +114,6 @@ class BaseInjectionQueryParameters(BaseModel):
119114
""" Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted. """
120115
click_analytics: Optional[bool] = None
121116
""" Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started). """
122-
decompound_query: Optional[bool] = None
123-
""" Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). """
124117
disable_exact_on_attributes: Optional[List[str]] = None
125118
""" Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking. """
126119
disable_typo_tolerance_on_attributes: Optional[List[str]] = None
@@ -145,8 +138,6 @@ class BaseInjectionQueryParameters(BaseModel):
145138
highlight_pre_tag: Optional[str] = None
146139
""" HTML tag to insert before the highlighted parts in all highlighted results and snippets. """
147140
ignore_plurals: Optional[IgnorePlurals] = None
148-
max_facet_hits: Optional[int] = None
149-
""" Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). """
150141
min_proximity: Optional[int] = None
151142
""" Minimum proximity score for two matching words This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score. """
152143
min_word_sizefor1_typo: Optional[int] = None

algoliasearch/composition/models/main_injection_query_parameters.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,11 @@
4545
"advanced_syntax_features": "advancedSyntaxFeatures",
4646
"allow_typos_on_numeric_tokens": "allowTyposOnNumericTokens",
4747
"alternatives_as_exact": "alternativesAsExact",
48-
"analytics": "analytics",
4948
"attribute_criteria_computed_by_min_proximity": "attributeCriteriaComputedByMinProximity",
5049
"attributes_to_highlight": "attributesToHighlight",
5150
"attributes_to_retrieve": "attributesToRetrieve",
5251
"attributes_to_snippet": "attributesToSnippet",
5352
"click_analytics": "clickAnalytics",
54-
"decompound_query": "decompoundQuery",
5553
"disable_exact_on_attributes": "disableExactOnAttributes",
5654
"disable_typo_tolerance_on_attributes": "disableTypoToleranceOnAttributes",
5755
"distinct": "distinct",
@@ -66,7 +64,6 @@
6664
"highlight_post_tag": "highlightPostTag",
6765
"highlight_pre_tag": "highlightPreTag",
6866
"ignore_plurals": "ignorePlurals",
69-
"max_facet_hits": "maxFacetHits",
7067
"min_proximity": "minProximity",
7168
"min_word_sizefor1_typo": "minWordSizefor1Typo",
7269
"min_word_sizefor2_typos": "minWordSizefor2Typos",
@@ -115,8 +112,6 @@ class MainInjectionQueryParameters(BaseModel):
115112
""" Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers. """
116113
alternatives_as_exact: Optional[List[AlternativesAsExact]] = None
117114
""" Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)) - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches. """
118-
analytics: Optional[bool] = None
119-
""" Whether this search will be included in Analytics. """
120115
attribute_criteria_computed_by_min_proximity: Optional[bool] = None
121116
""" Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting. """
122117
attributes_to_highlight: Optional[List[str]] = None
@@ -127,8 +122,6 @@ class MainInjectionQueryParameters(BaseModel):
127122
""" Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted. """
128123
click_analytics: Optional[bool] = None
129124
""" Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started). """
130-
decompound_query: Optional[bool] = None
131-
""" Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). """
132125
disable_exact_on_attributes: Optional[List[str]] = None
133126
""" Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking. """
134127
disable_typo_tolerance_on_attributes: Optional[List[str]] = None
@@ -153,8 +146,6 @@ class MainInjectionQueryParameters(BaseModel):
153146
highlight_pre_tag: Optional[str] = None
154147
""" HTML tag to insert before the highlighted parts in all highlighted results and snippets. """
155148
ignore_plurals: Optional[IgnorePlurals] = None
156-
max_facet_hits: Optional[int] = None
157-
""" Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). """
158149
min_proximity: Optional[int] = None
159150
""" Minimum proximity score for two matching words This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score. """
160151
min_word_sizefor1_typo: Optional[int] = None

0 commit comments

Comments
 (0)