Skip to content

Commit a0bcf77

Browse files
algolia-botClaraMullershortcutsgavinwade12
committed
refactor(specs): mutualise code between Search API & Comp API for search query parameters (generated)
algolia/api-clients-automation#5125 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: shortcuts <[email protected]> Co-authored-by: Gavin Wade <[email protected]>
1 parent f829d2c commit a0bcf77

File tree

10 files changed

+220
-219
lines changed

10 files changed

+220
-219
lines changed

algoliasearch/composition/models/params.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ class Params(BaseModel):
7474
get_ranking_info: Optional[bool] = None
7575
""" Whether the run response should include detailed ranking information. """
7676
relevancy_strictness: Optional[int] = None
77+
""" 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. """
7778
facet_filters: Optional[FacetFilters] = None
7879
optional_filters: Optional[OptionalFilters] = None
7980
numeric_filters: Optional[NumericFilters] = None
@@ -91,7 +92,7 @@ class Params(BaseModel):
9192
inside_polygon: Optional[List[List[float]]] = None
9293
""" Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`. """
9394
query_languages: Optional[List[SupportedLanguage]] = None
94-
""" Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first** **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). """
95+
""" Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first** **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). """
9596
natural_languages: Optional[List[SupportedLanguage]] = None
9697
""" ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`. """
9798
enable_rules: Optional[bool] = None

algoliasearch/recommend/models/fallback_params.py

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

algoliasearch/recommend/models/recommend_search_params.py

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

algoliasearch/search/models/browse_params_object.py

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

algoliasearch/search/models/consequence_params.py

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

algoliasearch/search/models/index_settings.py

Lines changed: 18 additions & 18 deletions
Large diffs are not rendered by default.

algoliasearch/search/models/search_for_facets.py

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

algoliasearch/search/models/search_for_hits.py

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

algoliasearch/search/models/search_params_object.py

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

algoliasearch/search/models/settings_response.py

Lines changed: 18 additions & 18 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)