Skip to content

Commit d6531de

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 15180b8 commit d6531de

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

packages/client_composition/lib/src/model/params.dart

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ final class Params {
5151
@JsonKey(name: r'page')
5252
final int? page;
5353

54-
/// Whether the search response should include detailed ranking information.
54+
/// Whether the run response should include detailed ranking information.
5555
@JsonKey(name: r'getRankingInfo')
5656
final bool? getRankingInfo;
5757

@@ -120,27 +120,27 @@ final class Params {
120120
@JsonKey(name: r'insidePolygon')
121121
final List<List<double>>? insidePolygon;
122122

123-
/// 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/).
123+
/// 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/).
124124
@JsonKey(name: r'queryLanguages')
125125
final List<SupportedLanguage>? queryLanguages;
126126

127-
/// 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`.
127+
/// 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`.
128128
@JsonKey(name: r'naturalLanguages')
129129
final List<SupportedLanguage>? naturalLanguages;
130130

131-
/// Whether to enable rules.
131+
/// Whether to enable composition rules.
132132
@JsonKey(name: r'enableRules')
133133
final bool? enableRules;
134134

135-
/// Assigns a rule context to the search 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.
135+
/// 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.
136136
@JsonKey(name: r'ruleContexts')
137137
final List<String>? ruleContexts;
138138

139139
/// 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/).
140140
@JsonKey(name: r'userToken')
141141
final String? userToken;
142142

143-
/// 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/).
143+
/// 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/).
144144
@JsonKey(name: r'clickAnalytics')
145145
final bool? clickAnalytics;
146146

@@ -152,11 +152,11 @@ final class Params {
152152
@JsonKey(name: r'analyticsTags')
153153
final List<String>? analyticsTags;
154154

155-
/// Whether to enable A/B testing for this search.
155+
/// Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored.
156156
@JsonKey(name: r'enableABTest')
157157
final bool? enableABTest;
158158

159-
/// 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.
159+
/// 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.
160160
@JsonKey(name: r'enableReRanking')
161161
final bool? enableReRanking;
162162

0 commit comments

Comments
 (0)