Skip to content

Commit 70243d1

Browse files
algolia-botgazconroy
algolia-bot
and
gazconroy
committed
fix(specs): Increase optionalWords visibility in docs (generated)
algolia/api-clients-automation#4559 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: gazconroy <[email protected]>
1 parent f908a0a commit 70243d1

File tree

11 files changed

+58
-36
lines changed

11 files changed

+58
-36
lines changed

‎Sources/Abtesting/AbtestingClient.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ open class AbtestingClient {
103103
return body
104104
}
105105

106-
// This method allow you to send requests to the Algolia REST API.
106+
// This method lets you send requests to the Algolia REST API.
107107
//
108108
//
109109
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -168,7 +168,7 @@ open class AbtestingClient {
168168
return body
169169
}
170170

171-
// This method allow you to send requests to the Algolia REST API.
171+
// This method lets you send requests to the Algolia REST API.
172172
//
173173
//
174174
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -236,7 +236,7 @@ open class AbtestingClient {
236236
return body
237237
}
238238

239-
// This method allow you to send requests to the Algolia REST API.
239+
// This method lets you send requests to the Algolia REST API.
240240
//
241241
//
242242
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -307,7 +307,7 @@ open class AbtestingClient {
307307
return body
308308
}
309309

310-
// This method allow you to send requests to the Algolia REST API.
310+
// This method lets you send requests to the Algolia REST API.
311311
//
312312
//
313313
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.

‎Sources/Analytics/AnalyticsClient.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ open class AnalyticsClient {
5454
return body
5555
}
5656

57-
// This method allow you to send requests to the Algolia REST API.
57+
// This method lets you send requests to the Algolia REST API.
5858
//
5959
//
6060
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -119,7 +119,7 @@ open class AnalyticsClient {
119119
return body
120120
}
121121

122-
// This method allow you to send requests to the Algolia REST API.
122+
// This method lets you send requests to the Algolia REST API.
123123
//
124124
//
125125
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -187,7 +187,7 @@ open class AnalyticsClient {
187187
return body
188188
}
189189

190-
// This method allow you to send requests to the Algolia REST API.
190+
// This method lets you send requests to the Algolia REST API.
191191
//
192192
//
193193
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -258,7 +258,7 @@ open class AnalyticsClient {
258258
return body
259259
}
260260

261-
// This method allow you to send requests to the Algolia REST API.
261+
// This method lets you send requests to the Algolia REST API.
262262
//
263263
//
264264
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.

‎Sources/Ingestion/IngestionClient.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ open class IngestionClient {
353353
return body
354354
}
355355

356-
// This method allow you to send requests to the Algolia REST API.
356+
// This method lets you send requests to the Algolia REST API.
357357
//
358358
//
359359
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -418,7 +418,7 @@ open class IngestionClient {
418418
return body
419419
}
420420

421-
// This method allow you to send requests to the Algolia REST API.
421+
// This method lets you send requests to the Algolia REST API.
422422
//
423423
//
424424
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -486,7 +486,7 @@ open class IngestionClient {
486486
return body
487487
}
488488

489-
// This method allow you to send requests to the Algolia REST API.
489+
// This method lets you send requests to the Algolia REST API.
490490
//
491491
//
492492
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -557,7 +557,7 @@ open class IngestionClient {
557557
return body
558558
}
559559

560-
// This method allow you to send requests to the Algolia REST API.
560+
// This method lets you send requests to the Algolia REST API.
561561
//
562562
//
563563
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.

‎Sources/Insights/InsightsClient.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ open class InsightsClient {
5454
return body
5555
}
5656

57-
// This method allow you to send requests to the Algolia REST API.
57+
// This method lets you send requests to the Algolia REST API.
5858
//
5959
//
6060
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -119,7 +119,7 @@ open class InsightsClient {
119119
return body
120120
}
121121

122-
// This method allow you to send requests to the Algolia REST API.
122+
// This method lets you send requests to the Algolia REST API.
123123
//
124124
//
125125
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -187,7 +187,7 @@ open class InsightsClient {
187187
return body
188188
}
189189

190-
// This method allow you to send requests to the Algolia REST API.
190+
// This method lets you send requests to the Algolia REST API.
191191
//
192192
//
193193
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -258,7 +258,7 @@ open class InsightsClient {
258258
return body
259259
}
260260

261-
// This method allow you to send requests to the Algolia REST API.
261+
// This method lets you send requests to the Algolia REST API.
262262
//
263263
//
264264
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.

‎Sources/Monitoring/MonitoringClient.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ open class MonitoringClient {
5454
return body
5555
}
5656

57-
// This method allow you to send requests to the Algolia REST API.
57+
// This method lets you send requests to the Algolia REST API.
5858
//
5959
//
6060
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -119,7 +119,7 @@ open class MonitoringClient {
119119
return body
120120
}
121121

122-
// This method allow you to send requests to the Algolia REST API.
122+
// This method lets you send requests to the Algolia REST API.
123123
//
124124
//
125125
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -187,7 +187,7 @@ open class MonitoringClient {
187187
return body
188188
}
189189

190-
// This method allow you to send requests to the Algolia REST API.
190+
// This method lets you send requests to the Algolia REST API.
191191
//
192192
//
193193
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -258,7 +258,7 @@ open class MonitoringClient {
258258
return body
259259
}
260260

261-
// This method allow you to send requests to the Algolia REST API.
261+
// This method lets you send requests to the Algolia REST API.
262262
//
263263
//
264264
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.

‎Sources/Personalization/PersonalizationClient.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ open class PersonalizationClient {
5454
return body
5555
}
5656

57-
// This method allow you to send requests to the Algolia REST API.
57+
// This method lets you send requests to the Algolia REST API.
5858
//
5959
//
6060
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -119,7 +119,7 @@ open class PersonalizationClient {
119119
return body
120120
}
121121

122-
// This method allow you to send requests to the Algolia REST API.
122+
// This method lets you send requests to the Algolia REST API.
123123
//
124124
//
125125
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -187,7 +187,7 @@ open class PersonalizationClient {
187187
return body
188188
}
189189

190-
// This method allow you to send requests to the Algolia REST API.
190+
// This method lets you send requests to the Algolia REST API.
191191
//
192192
//
193193
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -258,7 +258,7 @@ open class PersonalizationClient {
258258
return body
259259
}
260260

261-
// This method allow you to send requests to the Algolia REST API.
261+
// This method lets you send requests to the Algolia REST API.
262262
//
263263
//
264264
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.

‎Sources/QuerySuggestions/QuerySuggestionsClient.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ open class QuerySuggestionsClient {
103103
return body
104104
}
105105

106-
// This method allow you to send requests to the Algolia REST API.
106+
// This method lets you send requests to the Algolia REST API.
107107
//
108108
//
109109
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -168,7 +168,7 @@ open class QuerySuggestionsClient {
168168
return body
169169
}
170170

171-
// This method allow you to send requests to the Algolia REST API.
171+
// This method lets you send requests to the Algolia REST API.
172172
//
173173
//
174174
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -236,7 +236,7 @@ open class QuerySuggestionsClient {
236236
return body
237237
}
238238

239-
// This method allow you to send requests to the Algolia REST API.
239+
// This method lets you send requests to the Algolia REST API.
240240
//
241241
//
242242
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -307,7 +307,7 @@ open class QuerySuggestionsClient {
307307
return body
308308
}
309309

310-
// This method allow you to send requests to the Algolia REST API.
310+
// This method lets you send requests to the Algolia REST API.
311311
//
312312
//
313313
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.

‎Sources/Recommend/Models/RecommendOptionalWords.swift‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ import Foundation
66
import Core
77
#endif
88

9+
/// Words that should be considered optional when found in the query. By default, records must match all words in the
10+
/// search query to be included in the search results. Adding optional words can help to increase the number of search
11+
/// results by running an additional search query that doesn't include the optional words. For example, if the search
12+
/// query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action
13+
/// video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more
14+
/// words **and** all its words are optional, the number of matched words required for a record to be included in the
15+
/// search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number
16+
/// of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched
17+
/// words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of
18+
/// optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1
19+
/// matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
920
public enum RecommendOptionalWords: Codable, JSONEncodable, AbstractEncodable {
1021
case string(String)
1122
case arrayOfString([String])

‎Sources/Recommend/RecommendClient.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ open class RecommendClient {
143143
return body
144144
}
145145

146-
// This method allow you to send requests to the Algolia REST API.
146+
// This method lets you send requests to the Algolia REST API.
147147
//
148148
//
149149
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -208,7 +208,7 @@ open class RecommendClient {
208208
return body
209209
}
210210

211-
// This method allow you to send requests to the Algolia REST API.
211+
// This method lets you send requests to the Algolia REST API.
212212
//
213213
//
214214
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -276,7 +276,7 @@ open class RecommendClient {
276276
return body
277277
}
278278

279-
// This method allow you to send requests to the Algolia REST API.
279+
// This method lets you send requests to the Algolia REST API.
280280
//
281281
//
282282
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
@@ -347,7 +347,7 @@ open class RecommendClient {
347347
return body
348348
}
349349

350-
// This method allow you to send requests to the Algolia REST API.
350+
// This method lets you send requests to the Algolia REST API.
351351
//
352352
//
353353
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.

‎Sources/Search/Models/SearchOptionalWords.swift‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ import Foundation
66
import Core
77
#endif
88

9+
/// Words that should be considered optional when found in the query. By default, records must match all words in the
10+
/// search query to be included in the search results. Adding optional words can help to increase the number of search
11+
/// results by running an additional search query that doesn't include the optional words. For example, if the search
12+
/// query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action
13+
/// video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more
14+
/// words **and** all its words are optional, the number of matched words required for a record to be included in the
15+
/// search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number
16+
/// of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched
17+
/// words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of
18+
/// optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1
19+
/// matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
920
public enum SearchOptionalWords: Codable, JSONEncodable, AbstractEncodable {
1021
case string(String)
1122
case arrayOfString([String])

0 commit comments

Comments
 (0)