@@ -55,7 +55,7 @@ import algoliasearch.composition.SupportedLanguage._
55
55
* @param page
56
56
* Page of search results to retrieve.
57
57
* @param getRankingInfo
58
- * Whether the search response should include detailed ranking information.
58
+ * Whether the run response should include detailed ranking information.
59
59
* @param hitsPerPage
60
60
* Number of hits per page.
61
61
* @param aroundLatLng
@@ -75,31 +75,31 @@ import algoliasearch.composition.SupportedLanguage._
75
75
* This parameter is ignored if you also specify `insideBoundingBox`.
76
76
* @param queryLanguages
77
77
* 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`
79
79
* settings. This setting also sets a dictionary for word detection in the logogram-based
80
80
* [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
82
82
* language.** If you don't specify an indexing language, the search engine uses all [supported
83
83
* languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),
84
84
* or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to
85
85
* unexpected search results. For more information, see [Language-specific
86
86
* configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
87
87
* @param naturalLanguages
88
88
* 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
90
90
* `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and
91
91
* `analyticsTags`.
92
92
* @param enableRules
93
- * Whether to enable rules.
93
+ * Whether to enable composition rules.
94
94
* @param ruleContexts
95
- * Assigns a rule context to the search query. [Rule
95
+ * Assigns a rule context to the run query [Rule
96
96
* contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context)
97
97
* are strings that you can use to trigger matching rules.
98
98
* @param userToken
99
99
* Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For
100
100
* more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
101
101
* @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
103
103
* and is required for tracking [click and conversion
104
104
* events](https://www.algolia.com/guides/sending-events/getting-started/).
105
105
* @param analytics
@@ -108,9 +108,10 @@ import algoliasearch.composition.SupportedLanguage._
108
108
* Tags to apply to the query for [segmenting analytics
109
109
* data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
110
110
* @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.
112
113
* @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
114
115
* setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
115
116
*/
116
117
case class Params (
0 commit comments