Skip to content

Commit 0e1c309

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 <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com> Co-authored-by: shortcuts <vannicattec@gmail.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
1 parent df63482 commit 0e1c309

13 files changed

+298
-298
lines changed

lib/Model/Composition/Params.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ public function getRelevancyStrictness()
460460
/**
461461
* Sets relevancyStrictness.
462462
*
463-
* @param null|int $relevancyStrictness relevancyStrictness
463+
* @param null|int $relevancyStrictness 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.
464464
*
465465
* @return self
466466
*/
@@ -748,7 +748,7 @@ public function getQueryLanguages()
748748
/**
749749
* Sets queryLanguages.
750750
*
751-
* @param null|SupportedLanguage[] $queryLanguages 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/).
751+
* @param null|SupportedLanguage[] $queryLanguages 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/).
752752
*
753753
* @return self
754754
*/

lib/Model/Recommend/FallbackParams.php

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

lib/Model/Recommend/RecommendSearchParams.php

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

lib/Model/Search/BrowseParams.php

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

lib/Model/Search/BrowseParamsObject.php

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

lib/Model/Search/ConsequenceParams.php

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

lib/Model/Search/IndexSettings.php

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

lib/Model/Search/SearchForFacets.php

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

lib/Model/Search/SearchForHits.php

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

lib/Model/Search/SearchParams.php

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

0 commit comments

Comments
 (0)