Skip to content

Commit 9d28313

Browse files
algolia-botClaraMullershortcuts
committed
refactor(specs): add interface to manipulate query parameter between composition API & Search API (generated)
algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
1 parent 0b5d263 commit 9d28313

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

src/main/scala/algoliasearch/composition/Params.scala

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ import algoliasearch.composition.SupportedLanguage._
5555
* @param page
5656
* Page of search results to retrieve.
5757
* @param getRankingInfo
58-
* Whether the search response should include detailed ranking information.
58+
* Whether the run response should include detailed ranking information.
5959
* @param hitsPerPage
6060
* Number of hits per page.
6161
* @param aroundLatLng
@@ -75,31 +75,31 @@ import algoliasearch.composition.SupportedLanguage._
7575
* This parameter is ignored if you also specify `insideBoundingBox`.
7676
* @param queryLanguages
7777
* Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection
78-
* dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals`
78+
* dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals`
7979
* settings. This setting also sets a dictionary for word detection in the logogram-based
8080
* [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)
81-
* languages. To support this, you must place the CJK language **first**. **You should always specify a query
81+
* languages. To support this, you must place the CJK language **first** **You should always specify a query
8282
* language.** If you don't specify an indexing language, the search engine uses all [supported
8383
* languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),
8484
* or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to
8585
* unexpected search results. For more information, see [Language-specific
8686
* configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
8787
* @param naturalLanguages
8888
* ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to
89-
* keyword searches): - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets
89+
* keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets
9090
* `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and
9191
* `analyticsTags`.
9292
* @param enableRules
93-
* Whether to enable rules.
93+
* Whether to enable composition rules.
9494
* @param ruleContexts
95-
* Assigns a rule context to the search query. [Rule
95+
* Assigns a rule context to the run query [Rule
9696
* contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context)
9797
* are strings that you can use to trigger matching rules.
9898
* @param userToken
9999
* Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For
100100
* more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
101101
* @param clickAnalytics
102-
* Whether to include a `queryID` attribute in the response. The query ID is a unique identifier for a search query
102+
* Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query
103103
* and is required for tracking [click and conversion
104104
* events](https://www.algolia.com/guides/sending-events/getting-started/).
105105
* @param analytics
@@ -108,9 +108,10 @@ import algoliasearch.composition.SupportedLanguage._
108108
* Tags to apply to the query for [segmenting analytics
109109
* data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
110110
* @param enableABTest
111-
* Whether to enable A/B testing for this search.
111+
* Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B
112+
* test is ignored.
112113
* @param enableReRanking
113-
* Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This
114+
* Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This
114115
* setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
115116
*/
116117
case class Params(

0 commit comments

Comments
 (0)