Skip to content

Commit

Permalink
fix(specs): alternativesAsExact is plurals and synonyms (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3974

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
  • Loading branch information
algolia-bot committed Oct 15, 2024
1 parent 8f09056 commit fa164a9
Show file tree
Hide file tree
Showing 12 changed files with 108 additions and 48 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -143,10 +143,15 @@ import algoliasearch.recommend.SupportedLanguage._
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
* on ranking.
* @param alternativesAsExact
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
* and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
* \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
* @param advancedSyntaxFeatures
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
Expand Down
13 changes: 9 additions & 4 deletions src/main/scala/algoliasearch/recommend/FallbackParams.scala
Original file line number Diff line number Diff line change
Expand Up @@ -332,10 +332,15 @@ import algoliasearch.recommend.SupportedLanguage._
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
* on ranking.
* @param alternativesAsExact
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
* and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
* \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
* @param advancedSyntaxFeatures
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -242,10 +242,15 @@ import algoliasearch.recommend.SupportedLanguage._
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
* on ranking.
* @param alternativesAsExact
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
* and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
* \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
* @param advancedSyntaxFeatures
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -332,10 +332,15 @@ import algoliasearch.recommend.SupportedLanguage._
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
* on ranking.
* @param alternativesAsExact
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
* and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
* \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
* @param advancedSyntaxFeatures
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
Expand Down
13 changes: 9 additions & 4 deletions src/main/scala/algoliasearch/search/BrowseParamsObject.scala
Original file line number Diff line number Diff line change
Expand Up @@ -260,10 +260,15 @@ import algoliasearch.search.SupportedLanguage._
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
* on ranking.
* @param alternativesAsExact
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
* and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
* \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
* @param advancedSyntaxFeatures
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
Expand Down
13 changes: 9 additions & 4 deletions src/main/scala/algoliasearch/search/ConsequenceParams.scala
Original file line number Diff line number Diff line change
Expand Up @@ -258,10 +258,15 @@ import algoliasearch.search.SupportedLanguage._
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
* on ranking.
* @param alternativesAsExact
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
* and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
* \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
* @param advancedSyntaxFeatures
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
Expand Down
13 changes: 9 additions & 4 deletions src/main/scala/algoliasearch/search/IndexSettings.scala
Original file line number Diff line number Diff line change
Expand Up @@ -263,10 +263,15 @@ import algoliasearch.search.SupportedLanguage._
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
* on ranking.
* @param alternativesAsExact
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
* and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
* \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
* @param advancedSyntaxFeatures
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,15 @@ import algoliasearch.search.SupportedLanguage._
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
* on ranking.
* @param alternativesAsExact
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
* and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
* \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
* @param advancedSyntaxFeatures
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
Expand Down
13 changes: 9 additions & 4 deletions src/main/scala/algoliasearch/search/SearchForFacets.scala
Original file line number Diff line number Diff line change
Expand Up @@ -263,10 +263,15 @@ import algoliasearch.search.SupportedLanguage._
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
* on ranking.
* @param alternativesAsExact
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
* and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
* \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
* @param advancedSyntaxFeatures
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
Expand Down
13 changes: 9 additions & 4 deletions src/main/scala/algoliasearch/search/SearchForHits.scala
Original file line number Diff line number Diff line change
Expand Up @@ -263,10 +263,15 @@ import algoliasearch.search.SupportedLanguage._
* favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
* on ranking.
* @param alternativesAsExact
* Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
* `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
* and plural forms of a word, and single-word synonyms, as
* [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
* matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
* \"swimwear\" are treated the same (if they are
* [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
* \- `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
* matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. -
* `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
* @param advancedSyntaxFeatures
* Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For
* example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
Expand Down
Loading

0 comments on commit fa164a9

Please sign in to comment.