Skip to content

Commit a066ab9

Browse files
algolia-botalgolia-bot
committed
fix(specs): Separators are non-alphanumeric characters (generated)
algolia/api-clients-automation#3978 Co-authored-by: algolia-bot <[email protected]>
1 parent a56f22e commit a066ab9

File tree

7 files changed

+35
-21
lines changed

7 files changed

+35
-21
lines changed

‎Sources/Recommend/Models/FallbackParams.swift

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,11 @@ public struct FallbackParams: Codable, JSONEncodable {
163163
/// specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
164164
/// `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
165165
public var numericAttributesForFiltering: [String]?
166-
/// Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
167-
/// characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
168-
/// treats separator characters as separate words. For example, a search for `C#` would report two matches.
166+
/// Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
167+
/// like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
168+
/// `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as
169+
/// $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search
170+
/// for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
169171
public var separatorsToIndex: String?
170172
/// Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable
171173
/// and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute)

‎Sources/Recommend/Models/RecommendBaseIndexSettings.swift

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,11 @@ public struct RecommendBaseIndexSettings: Codable, JSONEncodable {
7373
/// specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
7474
/// `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
7575
public var numericAttributesForFiltering: [String]?
76-
/// Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
77-
/// characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
78-
/// treats separator characters as separate words. For example, a search for `C#` would report two matches.
76+
/// Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
77+
/// like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
78+
/// `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as
79+
/// $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search
80+
/// for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
7981
public var separatorsToIndex: String?
8082
/// Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable
8183
/// and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute)

‎Sources/Recommend/Models/RecommendIndexSettings.swift

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,11 @@ public struct RecommendIndexSettings: Codable, JSONEncodable {
7474
/// specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
7575
/// `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
7676
public var numericAttributesForFiltering: [String]?
77-
/// Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
78-
/// characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
79-
/// treats separator characters as separate words. For example, a search for `C#` would report two matches.
77+
/// Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
78+
/// like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
79+
/// `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as
80+
/// $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search
81+
/// for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
8082
public var separatorsToIndex: String?
8183
/// Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable
8284
/// and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute)

‎Sources/Recommend/Models/RecommendSearchParams.swift

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,11 @@ public struct RecommendSearchParams: Codable, JSONEncodable {
164164
/// specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
165165
/// `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
166166
public var numericAttributesForFiltering: [String]?
167-
/// Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
168-
/// characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
169-
/// treats separator characters as separate words. For example, a search for `C#` would report two matches.
167+
/// Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
168+
/// like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
169+
/// `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as
170+
/// $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search
171+
/// for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
170172
public var separatorsToIndex: String?
171173
/// Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable
172174
/// and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute)

‎Sources/Search/Models/IndexSettings.swift

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,11 @@ public struct IndexSettings: Codable, JSONEncodable {
7474
/// specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
7575
/// `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
7676
public var numericAttributesForFiltering: [String]?
77-
/// Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
78-
/// characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
79-
/// treats separator characters as separate words. For example, a search for `C#` would report two matches.
77+
/// Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
78+
/// like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
79+
/// `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as
80+
/// $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search
81+
/// for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
8082
public var separatorsToIndex: String?
8183
/// Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable
8284
/// and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute)

‎Sources/Search/Models/SearchBaseIndexSettings.swift

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,11 @@ public struct SearchBaseIndexSettings: Codable, JSONEncodable {
7373
/// specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
7474
/// `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
7575
public var numericAttributesForFiltering: [String]?
76-
/// Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
77-
/// characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
78-
/// treats separator characters as separate words. For example, a search for `C#` would report two matches.
76+
/// Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
77+
/// like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
78+
/// `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as
79+
/// $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search
80+
/// for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
7981
public var separatorsToIndex: String?
8082
/// Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable
8183
/// and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute)

‎Sources/Search/Models/SettingsResponse.swift

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,11 @@ public struct SettingsResponse: Codable, JSONEncodable {
7373
/// specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
7474
/// `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
7575
public var numericAttributesForFiltering: [String]?
76-
/// Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
77-
/// characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
78-
/// treats separator characters as separate words. For example, a search for `C#` would report two matches.
76+
/// Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
77+
/// like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
78+
/// `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as
79+
/// $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search
80+
/// for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
7981
public var separatorsToIndex: String?
8082
/// Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable
8183
/// and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute)

0 commit comments

Comments
 (0)