Skip to content

Commit dbbeb6d

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 4fffc7d commit dbbeb6d

File tree

1 file changed

+13
-10
lines changed
  • algoliasearch/src/main/java/com/algolia/model/composition

1 file changed

+13
-10
lines changed

algoliasearch/src/main/java/com/algolia/model/composition/Params.java

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ public Params setGetRankingInfo(Boolean getRankingInfo) {
144144
return this;
145145
}
146146

147-
/** Whether the search response should include detailed ranking information. */
147+
/** Whether the run response should include detailed ranking information. */
148148
@javax.annotation.Nullable
149149
public Boolean getGetRankingInfo() {
150150
return getRankingInfo;
@@ -320,11 +320,11 @@ public Params addQueryLanguages(SupportedLanguage queryLanguagesItem) {
320320

321321
/**
322322
* Languages for language-specific query processing steps such as plurals, stop-word removal, and
323-
* word-detection dictionaries. This setting sets a default list of languages used by the
323+
* word-detection dictionaries This setting sets a default list of languages used by the
324324
* `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word
325325
* detection in the logogram-based
326326
* [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)
327-
* languages. To support this, you must place the CJK language **first**. **You should always
327+
* languages. To support this, you must place the CJK language **first** **You should always
328328
* specify a query language.** If you don't specify an indexing language, the search engine uses
329329
* all [supported
330330
* languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),
@@ -352,7 +352,7 @@ public Params addNaturalLanguages(SupportedLanguage naturalLanguagesItem) {
352352

353353
/**
354354
* ISO language codes that adjust settings that are useful for processing natural language queries
355-
* (as opposed to keyword searches): - Sets `removeStopWords` and `ignorePlurals` to the list of
355+
* (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of
356356
* provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a
357357
* `natural_language` attribute to `ruleContexts` and `analyticsTags`.
358358
*/
@@ -366,7 +366,7 @@ public Params setEnableRules(Boolean enableRules) {
366366
return this;
367367
}
368368

369-
/** Whether to enable rules. */
369+
/** Whether to enable composition rules. */
370370
@javax.annotation.Nullable
371371
public Boolean getEnableRules() {
372372
return enableRules;
@@ -386,7 +386,7 @@ public Params addRuleContexts(String ruleContextsItem) {
386386
}
387387

388388
/**
389-
* Assigns a rule context to the search query. [Rule
389+
* Assigns a rule context to the run query [Rule
390390
* contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context)
391391
* are strings that you can use to trigger matching rules.
392392
*/
@@ -416,7 +416,7 @@ public Params setClickAnalytics(Boolean clickAnalytics) {
416416
}
417417

418418
/**
419-
* Whether to include a `queryID` attribute in the response. The query ID is a unique identifier
419+
* Whether to include a `queryID` attribute in the response The query ID is a unique identifier
420420
* for a search query and is required for tracking [click and conversion
421421
* events](https://www.algolia.com/guides/sending-events/getting-started/).
422422
*/
@@ -463,7 +463,10 @@ public Params setEnableABTest(Boolean enableABTest) {
463463
return this;
464464
}
465465

466-
/** Whether to enable A/B testing for this search. */
466+
/**
467+
* Whether to enable index level A/B testing for this run request. If the composition mixes
468+
* multiple indices, the A/B test is ignored.
469+
*/
467470
@javax.annotation.Nullable
468471
public Boolean getEnableABTest() {
469472
return enableABTest;
@@ -476,8 +479,8 @@ public Params setEnableReRanking(Boolean enableReRanking) {
476479

477480
/**
478481
* Whether this search will use [Dynamic
479-
* Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has
480-
* an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
482+
* Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This setting only has an
483+
* effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
481484
*/
482485
@javax.annotation.Nullable
483486
public Boolean getEnableReRanking() {

0 commit comments

Comments
 (0)