Skip to content

Commit a56f22e

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 be2804f commit a56f22e

12 files changed

+96
-48
lines changed

‎Sources/Recommend/Models/BaseRecommendIndexSettings.swift‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,14 @@ public struct BaseRecommendIndexSettings: Codable, JSONEncodable {
106106
/// lot of content on ranking.
107107
public var disableExactOnAttributes: [String]?
108108
public var exactOnSingleWordQuery: RecommendExactOnSingleWordQuery?
109-
/// Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
110-
/// `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
111-
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
112-
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
109+
/// Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
110+
/// and plural forms of a word, and single-word synonyms, as
111+
/// [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
112+
/// matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
113+
/// \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
114+
/// - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
115+
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.
116+
/// - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
113117
public var alternativesAsExact: [RecommendAlternativesAsExact]?
114118
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
115119
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎Sources/Recommend/Models/FallbackParams.swift‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -286,10 +286,14 @@ public struct FallbackParams: Codable, JSONEncodable {
286286
/// lot of content on ranking.
287287
public var disableExactOnAttributes: [String]?
288288
public var exactOnSingleWordQuery: RecommendExactOnSingleWordQuery?
289-
/// Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
290-
/// `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
291-
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
292-
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
289+
/// Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
290+
/// and plural forms of a word, and single-word synonyms, as
291+
/// [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
292+
/// matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
293+
/// \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
294+
/// - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
295+
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.
296+
/// - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
293297
public var alternativesAsExact: [RecommendAlternativesAsExact]?
294298
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
295299
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎Sources/Recommend/Models/RecommendIndexSettings.swift‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,10 +197,14 @@ public struct RecommendIndexSettings: Codable, JSONEncodable {
197197
/// lot of content on ranking.
198198
public var disableExactOnAttributes: [String]?
199199
public var exactOnSingleWordQuery: RecommendExactOnSingleWordQuery?
200-
/// Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
201-
/// `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
202-
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
203-
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
200+
/// Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
201+
/// and plural forms of a word, and single-word synonyms, as
202+
/// [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
203+
/// matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
204+
/// \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
205+
/// - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
206+
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.
207+
/// - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
204208
public var alternativesAsExact: [RecommendAlternativesAsExact]?
205209
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
206210
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎Sources/Recommend/Models/RecommendSearchParams.swift‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -287,10 +287,14 @@ public struct RecommendSearchParams: Codable, JSONEncodable {
287287
/// lot of content on ranking.
288288
public var disableExactOnAttributes: [String]?
289289
public var exactOnSingleWordQuery: RecommendExactOnSingleWordQuery?
290-
/// Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
291-
/// `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
292-
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
293-
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
290+
/// Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
291+
/// and plural forms of a word, and single-word synonyms, as
292+
/// [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
293+
/// matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
294+
/// \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
295+
/// - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
296+
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.
297+
/// - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
294298
public var alternativesAsExact: [RecommendAlternativesAsExact]?
295299
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
296300
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎Sources/Search/Models/BrowseParamsObject.swift‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -219,10 +219,14 @@ public struct BrowseParamsObject: Codable, JSONEncodable {
219219
/// lot of content on ranking.
220220
public var disableExactOnAttributes: [String]?
221221
public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
222-
/// Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
223-
/// `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
224-
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
225-
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
222+
/// Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
223+
/// and plural forms of a word, and single-word synonyms, as
224+
/// [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
225+
/// matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
226+
/// \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
227+
/// - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
228+
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.
229+
/// - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
226230
public var alternativesAsExact: [SearchAlternativesAsExact]?
227231
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
228232
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎Sources/Search/Models/IndexSettings.swift‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -214,10 +214,14 @@ public struct IndexSettings: Codable, JSONEncodable {
214214
/// lot of content on ranking.
215215
public var disableExactOnAttributes: [String]?
216216
public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
217-
/// Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
218-
/// `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
219-
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
220-
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
217+
/// Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
218+
/// and plural forms of a word, and single-word synonyms, as
219+
/// [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
220+
/// matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
221+
/// \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
222+
/// - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
223+
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.
224+
/// - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
221225
public var alternativesAsExact: [SearchAlternativesAsExact]?
222226
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
223227
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎Sources/Search/Models/SearchConsequenceParams.swift‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -217,10 +217,14 @@ public struct SearchConsequenceParams: Codable, JSONEncodable {
217217
/// lot of content on ranking.
218218
public var disableExactOnAttributes: [String]?
219219
public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
220-
/// Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
221-
/// `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
222-
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
223-
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
220+
/// Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
221+
/// and plural forms of a word, and single-word synonyms, as
222+
/// [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
223+
/// matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
224+
/// \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
225+
/// - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
226+
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.
227+
/// - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
224228
public var alternativesAsExact: [SearchAlternativesAsExact]?
225229
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
226230
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎Sources/Search/Models/SearchForFacets.swift‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -221,10 +221,14 @@ public struct SearchForFacets: Codable, JSONEncodable {
221221
/// lot of content on ranking.
222222
public var disableExactOnAttributes: [String]?
223223
public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
224-
/// Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
225-
/// `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
226-
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
227-
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
224+
/// Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
225+
/// and plural forms of a word, and single-word synonyms, as
226+
/// [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
227+
/// matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
228+
/// \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
229+
/// - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
230+
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.
231+
/// - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
228232
public var alternativesAsExact: [SearchAlternativesAsExact]?
229233
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
230234
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎Sources/Search/Models/SearchForHits.swift‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -221,10 +221,14 @@ public struct SearchForHits: Codable, JSONEncodable {
221221
/// lot of content on ranking.
222222
public var disableExactOnAttributes: [String]?
223223
public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
224-
/// Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
225-
/// `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
226-
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
227-
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
224+
/// Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
225+
/// and plural forms of a word, and single-word synonyms, as
226+
/// [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
227+
/// matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
228+
/// \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
229+
/// - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
230+
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.
231+
/// - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
228232
public var alternativesAsExact: [SearchAlternativesAsExact]?
229233
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
230234
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

‎Sources/Search/Models/SearchIndexSettingsAsSearchParams.swift‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,14 @@ public struct SearchIndexSettingsAsSearchParams: Codable, JSONEncodable {
123123
/// lot of content on ranking.
124124
public var disableExactOnAttributes: [String]?
125125
public var exactOnSingleWordQuery: SearchExactOnSingleWordQuery?
126-
/// Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. -
127-
/// `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
128-
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
129-
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
126+
/// Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular
127+
/// and plural forms of a word, and single-word synonyms, as
128+
/// [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact)
129+
/// matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and
130+
/// \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
131+
/// - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact
132+
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.
133+
/// - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
130134
public var alternativesAsExact: [SearchAlternativesAsExact]?
131135
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
132136
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -

0 commit comments

Comments
 (0)