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]>

Author: 3 people

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

@@ -55,7 +55,7 @@ import algoliasearch.composition.SupportedLanguage._
   * @param page
   *   Page of search results to retrieve.
   * @param getRankingInfo
-  *   Whether the search response should include detailed ranking information.
+  *   Whether the run response should include detailed ranking information.
   * @param hitsPerPage
   *   Number of hits per page.
   * @param aroundLatLng
@@ -75,31 +75,31 @@ import algoliasearch.composition.SupportedLanguage._
   *   This parameter is ignored if you also specify `insideBoundingBox`.
   * @param 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`
+  *   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
+  *   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/).
   * @param naturalLanguages
   *   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
+  *   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`.
   * @param enableRules
-  *   Whether to enable rules.
+  *   Whether to enable composition rules.
   * @param ruleContexts
-  *   Assigns a rule context to the search query. [Rule
+  *   Assigns a rule context to the run query [Rule
   *   contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context)
   *   are strings that you can use to trigger matching rules.
   * @param userToken
   *   Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For
   *   more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
   * @param clickAnalytics
-  *   Whether to include a `queryID` attribute in the response. The query ID is a unique identifier for a search query
+  *   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/guides/sending-events/getting-started/).
   * @param analytics
@@ -108,9 +108,10 @@ import algoliasearch.composition.SupportedLanguage._
   *   Tags to apply to the query for [segmenting analytics
   *   data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
   * @param enableABTest
-  *   Whether to enable A/B testing for this search.
+  *   Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B
+  *   test is ignored.
   * @param enableReRanking
-  *   Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This
+  *   Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This
   *   setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
   */
 case class Params(