Skip to content

Commit fa164a9

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 8f09056 commit fa164a9

12 files changed

+108
-48
lines changed

‎src/main/scala/algoliasearch/recommend/BaseRecommendIndexSettings.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,10 +143,15 @@ import algoliasearch.recommend.SupportedLanguage._
143143
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
144144
* on ranking.
145145
* @param alternativesAsExact
146-
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
147-
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
148-
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
149-
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
146+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
147+
* and plural forms of a word, and single-word synonyms, as
148+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
149+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
150+
* \"swimwear\" are treated the same (if they are
151+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
152+
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
153+
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
154+
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
150155
* @param advancedSyntaxFeatures
151156
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
152157
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎src/main/scala/algoliasearch/recommend/FallbackParams.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -332,10 +332,15 @@ import algoliasearch.recommend.SupportedLanguage._
332332
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
333333
* on ranking.
334334
* @param alternativesAsExact
335-
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
336-
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
337-
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
338-
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
335+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
336+
* and plural forms of a word, and single-word synonyms, as
337+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
338+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
339+
* \"swimwear\" are treated the same (if they are
340+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
341+
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
342+
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
343+
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
339344
* @param advancedSyntaxFeatures
340345
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
341346
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎src/main/scala/algoliasearch/recommend/RecommendIndexSettings.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -242,10 +242,15 @@ import algoliasearch.recommend.SupportedLanguage._
242242
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
243243
* on ranking.
244244
* @param alternativesAsExact
245-
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
246-
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
247-
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
248-
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
245+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
246+
* and plural forms of a word, and single-word synonyms, as
247+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
248+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
249+
* \"swimwear\" are treated the same (if they are
250+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
251+
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
252+
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
253+
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
249254
* @param advancedSyntaxFeatures
250255
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
251256
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎src/main/scala/algoliasearch/recommend/RecommendSearchParams.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -332,10 +332,15 @@ import algoliasearch.recommend.SupportedLanguage._
332332
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
333333
* on ranking.
334334
* @param alternativesAsExact
335-
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
336-
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
337-
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
338-
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
335+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
336+
* and plural forms of a word, and single-word synonyms, as
337+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
338+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
339+
* \"swimwear\" are treated the same (if they are
340+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
341+
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
342+
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
343+
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
339344
* @param advancedSyntaxFeatures
340345
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
341346
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎src/main/scala/algoliasearch/search/BrowseParamsObject.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -260,10 +260,15 @@ import algoliasearch.search.SupportedLanguage._
260260
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
261261
* on ranking.
262262
* @param alternativesAsExact
263-
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
264-
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
265-
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
266-
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
263+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
264+
* and plural forms of a word, and single-word synonyms, as
265+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
266+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
267+
* \"swimwear\" are treated the same (if they are
268+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
269+
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
270+
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
271+
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
267272
* @param advancedSyntaxFeatures
268273
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
269274
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎src/main/scala/algoliasearch/search/ConsequenceParams.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -258,10 +258,15 @@ import algoliasearch.search.SupportedLanguage._
258258
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
259259
* on ranking.
260260
* @param alternativesAsExact
261-
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
262-
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
263-
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
264-
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
261+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
262+
* and plural forms of a word, and single-word synonyms, as
263+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
264+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
265+
* \"swimwear\" are treated the same (if they are
266+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
267+
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
268+
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
269+
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
265270
* @param advancedSyntaxFeatures
266271
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
267272
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎src/main/scala/algoliasearch/search/IndexSettings.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -263,10 +263,15 @@ import algoliasearch.search.SupportedLanguage._
263263
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
264264
* on ranking.
265265
* @param alternativesAsExact
266-
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
267-
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
268-
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
269-
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
266+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
267+
* and plural forms of a word, and single-word synonyms, as
268+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
269+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
270+
* \"swimwear\" are treated the same (if they are
271+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
272+
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
273+
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
274+
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
270275
* @param advancedSyntaxFeatures
271276
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
272277
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎src/main/scala/algoliasearch/search/IndexSettingsAsSearchParams.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,10 +164,15 @@ import algoliasearch.search.SupportedLanguage._
164164
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
165165
* on ranking.
166166
* @param alternativesAsExact
167-
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
168-
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
169-
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
170-
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
167+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
168+
* and plural forms of a word, and single-word synonyms, as
169+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
170+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
171+
* \"swimwear\" are treated the same (if they are
172+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
173+
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
174+
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
175+
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
171176
* @param advancedSyntaxFeatures
172177
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
173178
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎src/main/scala/algoliasearch/search/SearchForFacets.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -263,10 +263,15 @@ import algoliasearch.search.SupportedLanguage._
263263
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
264264
* on ranking.
265265
* @param alternativesAsExact
266-
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
267-
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
268-
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
269-
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
266+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
267+
* and plural forms of a word, and single-word synonyms, as
268+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
269+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
270+
* \"swimwear\" are treated the same (if they are
271+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
272+
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
273+
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
274+
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
270275
* @param advancedSyntaxFeatures
271276
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
272277
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎src/main/scala/algoliasearch/search/SearchForHits.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -263,10 +263,15 @@ import algoliasearch.search.SupportedLanguage._
263263
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
264264
* on ranking.
265265
* @param alternativesAsExact
266-
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
267-
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
268-
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
269-
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
266+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
267+
* and plural forms of a word, and single-word synonyms, as
268+
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
269+
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
270+
* \"swimwear\" are treated the same (if they are
271+
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
272+
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
273+
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
274+
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
270275
* @param advancedSyntaxFeatures
271276
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
272277
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

0 commit comments

Comments
 (0)