Skip to content

Commit 8a7b0a7

Browse files
algolia-botalgolia-bot
committed
fix(specs): alternativesAsExact is plurals and synonyms (generated)
algolia/api-clients-automation#3974 Co-authored-by: algolia-bot <[email protected]>
1 parent 2f6911d commit 8a7b0a7

File tree

9 files changed

+90
-45
lines changed

9 files changed

+90
-45
lines changed

‎algoliasearch/src/main/java/com/algolia/model/recommend/FallbackParams.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1589,11 +1589,16 @@ public FallbackParams addAlternativesAsExact(AlternativesAsExact alternativesAsE
15891589
}
15901590

15911591
/**
1592-
* Alternatives of query words that should be considered as exact matches by the Exact ranking
1593-
* criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals`
1594-
* setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as
1595-
* \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1596-
* \"NY/New York\" are considered exact matches.
1592+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia
1593+
* treats singular and plural forms of a word, and single-word synonyms, as
1594+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
1595+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same -
1596+
* \"swimsuit\" and \"swimwear\" are treated the same (if they are
1597+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
1598+
* - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are
1599+
* considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" =
1600+
* \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1601+
* \"NY\" = \"New York\", are considered exact matches.
15971602
*/
15981603
@javax.annotation.Nullable
15991604
public List<AlternativesAsExact> getAlternativesAsExact() {

‎algoliasearch/src/main/java/com/algolia/model/recommend/RecommendSearchParams.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1589,11 +1589,16 @@ public RecommendSearchParams addAlternativesAsExact(AlternativesAsExact alternat
15891589
}
15901590

15911591
/**
1592-
* Alternatives of query words that should be considered as exact matches by the Exact ranking
1593-
* criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals`
1594-
* setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as
1595-
* \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1596-
* \"NY/New York\" are considered exact matches.
1592+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia
1593+
* treats singular and plural forms of a word, and single-word synonyms, as
1594+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
1595+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same -
1596+
* \"swimsuit\" and \"swimwear\" are treated the same (if they are
1597+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
1598+
* - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are
1599+
* considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" =
1600+
* \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1601+
* \"NY\" = \"New York\", are considered exact matches.
15971602
*/
15981603
@javax.annotation.Nullable
15991604
public List<AlternativesAsExact> getAlternativesAsExact() {

‎algoliasearch/src/main/java/com/algolia/model/search/BrowseParamsObject.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1291,11 +1291,16 @@ public BrowseParamsObject addAlternativesAsExact(AlternativesAsExact alternative
12911291
}
12921292

12931293
/**
1294-
* Alternatives of query words that should be considered as exact matches by the Exact ranking
1295-
* criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals`
1296-
* setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as
1297-
* \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1298-
* \"NY/New York\" are considered exact matches.
1294+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia
1295+
* treats singular and plural forms of a word, and single-word synonyms, as
1296+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
1297+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same -
1298+
* \"swimsuit\" and \"swimwear\" are treated the same (if they are
1299+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
1300+
* - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are
1301+
* considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" =
1302+
* \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1303+
* \"NY\" = \"New York\", are considered exact matches.
12991304
*/
13001305
@javax.annotation.Nullable
13011306
public List<AlternativesAsExact> getAlternativesAsExact() {

‎algoliasearch/src/main/java/com/algolia/model/search/ConsequenceParams.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1282,11 +1282,16 @@ public ConsequenceParams addAlternativesAsExact(AlternativesAsExact alternatives
12821282
}
12831283

12841284
/**
1285-
* Alternatives of query words that should be considered as exact matches by the Exact ranking
1286-
* criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals`
1287-
* setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as
1288-
* \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1289-
* \"NY/New York\" are considered exact matches.
1285+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia
1286+
* treats singular and plural forms of a word, and single-word synonyms, as
1287+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
1288+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same -
1289+
* \"swimsuit\" and \"swimwear\" are treated the same (if they are
1290+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
1291+
* - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are
1292+
* considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" =
1293+
* \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1294+
* \"NY\" = \"New York\", are considered exact matches.
12901295
*/
12911296
@javax.annotation.Nullable
12921297
public List<AlternativesAsExact> getAlternativesAsExact() {

‎algoliasearch/src/main/java/com/algolia/model/search/IndexSettings.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1132,11 +1132,16 @@ public IndexSettings addAlternativesAsExact(AlternativesAsExact alternativesAsEx
11321132
}
11331133

11341134
/**
1135-
* Alternatives of query words that should be considered as exact matches by the Exact ranking
1136-
* criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals`
1137-
* setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as
1138-
* \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1139-
* \"NY/New York\" are considered exact matches.
1135+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia
1136+
* treats singular and plural forms of a word, and single-word synonyms, as
1137+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
1138+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same -
1139+
* \"swimsuit\" and \"swimwear\" are treated the same (if they are
1140+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
1141+
* - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are
1142+
* considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" =
1143+
* \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1144+
* \"NY\" = \"New York\", are considered exact matches.
11401145
*/
11411146
@javax.annotation.Nullable
11421147
public List<AlternativesAsExact> getAlternativesAsExact() {

‎algoliasearch/src/main/java/com/algolia/model/search/SearchForFacets.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1314,11 +1314,16 @@ public SearchForFacets addAlternativesAsExact(AlternativesAsExact alternativesAs
13141314
}
13151315

13161316
/**
1317-
* Alternatives of query words that should be considered as exact matches by the Exact ranking
1318-
* criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals`
1319-
* setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as
1320-
* \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1321-
* \"NY/New York\" are considered exact matches.
1317+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia
1318+
* treats singular and plural forms of a word, and single-word synonyms, as
1319+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
1320+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same -
1321+
* \"swimsuit\" and \"swimwear\" are treated the same (if they are
1322+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
1323+
* - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are
1324+
* considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" =
1325+
* \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1326+
* \"NY\" = \"New York\", are considered exact matches.
13221327
*/
13231328
@javax.annotation.Nullable
13241329
public List<AlternativesAsExact> getAlternativesAsExact() {

‎algoliasearch/src/main/java/com/algolia/model/search/SearchForHits.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1308,11 +1308,16 @@ public SearchForHits addAlternativesAsExact(AlternativesAsExact alternativesAsEx
13081308
}
13091309

13101310
/**
1311-
* Alternatives of query words that should be considered as exact matches by the Exact ranking
1312-
* criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals`
1313-
* setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as
1314-
* \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1315-
* \"NY/New York\" are considered exact matches.
1311+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia
1312+
* treats singular and plural forms of a word, and single-word synonyms, as
1313+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
1314+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same -
1315+
* \"swimsuit\" and \"swimwear\" are treated the same (if they are
1316+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
1317+
* - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are
1318+
* considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" =
1319+
* \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1320+
* \"NY\" = \"New York\", are considered exact matches.
13161321
*/
13171322
@javax.annotation.Nullable
13181323
public List<AlternativesAsExact> getAlternativesAsExact() {

‎algoliasearch/src/main/java/com/algolia/model/search/SearchParamsObject.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1288,11 +1288,16 @@ public SearchParamsObject addAlternativesAsExact(AlternativesAsExact alternative
12881288
}
12891289

12901290
/**
1291-
* Alternatives of query words that should be considered as exact matches by the Exact ranking
1292-
* criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals`
1293-
* setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as
1294-
* \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1295-
* \"NY/New York\" are considered exact matches.
1291+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia
1292+
* treats singular and plural forms of a word, and single-word synonyms, as
1293+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
1294+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same -
1295+
* \"swimsuit\" and \"swimwear\" are treated the same (if they are
1296+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
1297+
* - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are
1298+
* considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" =
1299+
* \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1300+
* \"NY\" = \"New York\", are considered exact matches.
12961301
*/
12971302
@javax.annotation.Nullable
12981303
public List<AlternativesAsExact> getAlternativesAsExact() {

‎algoliasearch/src/main/java/com/algolia/model/search/SettingsResponse.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1135,11 +1135,16 @@ public SettingsResponse addAlternativesAsExact(AlternativesAsExact alternativesA
11351135
}
11361136

11371137
/**
1138-
* Alternatives of query words that should be considered as exact matches by the Exact ranking
1139-
* criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals`
1140-
* setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as
1141-
* \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1142-
* \"NY/New York\" are considered exact matches.
1138+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia
1139+
* treats singular and plural forms of a word, and single-word synonyms, as
1140+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
1141+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same -
1142+
* \"swimsuit\" and \"swimwear\" are treated the same (if they are
1143+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
1144+
* - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are
1145+
* considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" =
1146+
* \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as
1147+
* \"NY\" = \"New York\", are considered exact matches.
11431148
*/
11441149
@javax.annotation.Nullable
11451150
public List<AlternativesAsExact> getAlternativesAsExact() {

0 commit comments

Comments
 (0)