fix(specs): alternativesAsExact is plurals and synonyms (generated)

algolia/api-clients-automation#3974

Co-authored-by: algolia-bot <[email protected]>

Sources/Recommend/Models/BaseRecommendIndexSettings.swift

@@ -106,10 +106,14 @@ public struct BaseRecommendIndexSettings: Codable, JSONEncodable {
     /// lot of content on ranking.
     public var disableExactOnAttributes: [String]?
     public var exactOnSingleWordQuery: RecommendExactOnSingleWordQuery?
-    /// 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.
     public var alternativesAsExact: [RecommendAlternativesAsExact]?
     /// 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\".  -

Sources/Recommend/Models/FallbackParams.swift

@@ -286,10 +286,14 @@ public struct FallbackParams: Codable, JSONEncodable {
     /// lot of content on ranking.
     public var disableExactOnAttributes: [String]?
     public var exactOnSingleWordQuery: RecommendExactOnSingleWordQuery?
-    /// 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.
     public var alternativesAsExact: [RecommendAlternativesAsExact]?
     /// 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\".  -

Sources/Recommend/Models/RecommendIndexSettings.swift

@@ -197,10 +197,14 @@ public struct RecommendIndexSettings: Codable, JSONEncodable {
     /// lot of content on ranking.
     public var disableExactOnAttributes: [String]?
     public var exactOnSingleWordQuery: RecommendExactOnSingleWordQuery?
-    /// 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.
     public var alternativesAsExact: [RecommendAlternativesAsExact]?
     /// 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\".  -

Sources/Recommend/Models/RecommendSearchParams.swift

@@ -287,10 +287,14 @@ public struct RecommendSearchParams: Codable, JSONEncodable {
     /// lot of content on ranking.
     public var disableExactOnAttributes: [String]?
     public var exactOnSingleWordQuery: RecommendExactOnSingleWordQuery?
-    /// 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.
     public var alternativesAsExact: [RecommendAlternativesAsExact]?
     /// 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\".  -

Sources/Search/Models/BrowseParamsObject.swift

@@ -219,10 +219,14 @@ public struct BrowseParamsObject: Codable, JSONEncodable {
     /// lot of content on ranking.
     public var disableExactOnAttributes: [String]?
     public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
-    /// 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.
     public var alternativesAsExact: [SearchAlternativesAsExact]?
     /// 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\".  -

Sources/Search/Models/IndexSettings.swift

@@ -214,10 +214,14 @@ public struct IndexSettings: Codable, JSONEncodable {
     /// lot of content on ranking.
     public var disableExactOnAttributes: [String]?
     public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
-    /// 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.
     public var alternativesAsExact: [SearchAlternativesAsExact]?
     /// 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\".  -

Sources/Search/Models/SearchConsequenceParams.swift

@@ -217,10 +217,14 @@ public struct SearchConsequenceParams: Codable, JSONEncodable {
     /// lot of content on ranking.
     public var disableExactOnAttributes: [String]?
     public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
-    /// 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.
     public var alternativesAsExact: [SearchAlternativesAsExact]?
     /// 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\".  -

Sources/Search/Models/SearchForFacets.swift

@@ -221,10 +221,14 @@ public struct SearchForFacets: Codable, JSONEncodable {
     /// lot of content on ranking.
     public var disableExactOnAttributes: [String]?
     public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
-    /// 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.
     public var alternativesAsExact: [SearchAlternativesAsExact]?
     /// 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\".  -

Sources/Search/Models/SearchForHits.swift

@@ -221,10 +221,14 @@ public struct SearchForHits: Codable, JSONEncodable {
     /// lot of content on ranking.
     public var disableExactOnAttributes: [String]?
     public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
-    /// 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.
     public var alternativesAsExact: [SearchAlternativesAsExact]?
     /// 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\".  -

Sources/Search/Models/SearchIndexSettingsAsSearchParams.swift

@@ -123,10 +123,14 @@ public struct SearchIndexSettingsAsSearchParams: Codable, JSONEncodable {
     /// lot of content on ranking.
     public var disableExactOnAttributes: [String]?
     public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
-    /// 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.
     public var alternativesAsExact: [SearchAlternativesAsExact]?
     /// 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\".  -