Skip to content

Commit e7b5393

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 <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: gazconroy <gazconroyster@gmail.com>
1 parent 60d8506 commit e7b5393

15 files changed

Lines changed: 53 additions & 41 deletions

File tree

‎packages/algoliasearch/lite/model/optionalWords.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
22

3+
/**
4+
* Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn\'t include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 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).
5+
*/
36
export type OptionalWords = string | Array<string>;

‎packages/algoliasearch/lite/src/liteClient.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ export function createLiteClient({
171171
}>;
172172
},
173173
/**
174-
* This method allow you to send requests to the Algolia REST API.
174+
* This method lets you send requests to the Algolia REST API.
175175
* @param customPost - The customPost object.
176176
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
177177
* @param customPost.parameters - Query parameters to apply to the current query.

‎packages/client-abtesting/src/abtestingClient.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ export function createAbtestingClient({
161161
},
162162

163163
/**
164-
* This method allow you to send requests to the Algolia REST API.
164+
* This method lets you send requests to the Algolia REST API.
165165
* @param customDelete - The customDelete object.
166166
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
167167
* @param customDelete.parameters - Query parameters to apply to the current query.
@@ -190,7 +190,7 @@ export function createAbtestingClient({
190190
},
191191

192192
/**
193-
* This method allow you to send requests to the Algolia REST API.
193+
* This method lets you send requests to the Algolia REST API.
194194
* @param customGet - The customGet object.
195195
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
196196
* @param customGet.parameters - Query parameters to apply to the current query.
@@ -216,7 +216,7 @@ export function createAbtestingClient({
216216
},
217217

218218
/**
219-
* This method allow you to send requests to the Algolia REST API.
219+
* This method lets you send requests to the Algolia REST API.
220220
* @param customPost - The customPost object.
221221
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
222222
* @param customPost.parameters - Query parameters to apply to the current query.
@@ -247,7 +247,7 @@ export function createAbtestingClient({
247247
},
248248

249249
/**
250-
* This method allow you to send requests to the Algolia REST API.
250+
* This method lets you send requests to the Algolia REST API.
251251
* @param customPut - The customPut object.
252252
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
253253
* @param customPut.parameters - Query parameters to apply to the current query.

‎packages/client-analytics/src/analyticsClient.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ export function createAnalyticsClient({
150150
},
151151

152152
/**
153-
* This method allow you to send requests to the Algolia REST API.
153+
* This method lets you send requests to the Algolia REST API.
154154
* @param customDelete - The customDelete object.
155155
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
156156
* @param customDelete.parameters - Query parameters to apply to the current query.
@@ -179,7 +179,7 @@ export function createAnalyticsClient({
179179
},
180180

181181
/**
182-
* This method allow you to send requests to the Algolia REST API.
182+
* This method lets you send requests to the Algolia REST API.
183183
* @param customGet - The customGet object.
184184
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
185185
* @param customGet.parameters - Query parameters to apply to the current query.
@@ -205,7 +205,7 @@ export function createAnalyticsClient({
205205
},
206206

207207
/**
208-
* This method allow you to send requests to the Algolia REST API.
208+
* This method lets you send requests to the Algolia REST API.
209209
* @param customPost - The customPost object.
210210
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
211211
* @param customPost.parameters - Query parameters to apply to the current query.
@@ -236,7 +236,7 @@ export function createAnalyticsClient({
236236
},
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
* @param customPut - The customPut object.
241241
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
242242
* @param customPut.parameters - Query parameters to apply to the current query.

‎packages/client-composition/model/optionalWords.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
22

3+
/**
4+
* Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn\'t include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 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).
5+
*/
36
export type OptionalWords = string | Array<string>;

‎packages/client-composition/src/compositionFullClient.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ export function createCompositionClient({
191191
},
192192

193193
/**
194-
* This method allow you to send requests to the Algolia REST API.
194+
* This method lets you send requests to the Algolia REST API.
195195
* @param customDelete - The customDelete object.
196196
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
197197
* @param customDelete.parameters - Query parameters to apply to the current query.
@@ -220,7 +220,7 @@ export function createCompositionClient({
220220
},
221221

222222
/**
223-
* This method allow you to send requests to the Algolia REST API.
223+
* This method lets you send requests to the Algolia REST API.
224224
* @param customGet - The customGet object.
225225
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
226226
* @param customGet.parameters - Query parameters to apply to the current query.
@@ -246,7 +246,7 @@ export function createCompositionClient({
246246
},
247247

248248
/**
249-
* This method allow you to send requests to the Algolia REST API.
249+
* This method lets you send requests to the Algolia REST API.
250250
* @param customPost - The customPost object.
251251
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
252252
* @param customPost.parameters - Query parameters to apply to the current query.
@@ -277,7 +277,7 @@ export function createCompositionClient({
277277
},
278278

279279
/**
280-
* This method allow you to send requests to the Algolia REST API.
280+
* This method lets you send requests to the Algolia REST API.
281281
* @param customPut - The customPut object.
282282
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
283283
* @param customPut.parameters - Query parameters to apply to the current query.

‎packages/client-insights/src/insightsClient.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ export function createInsightsClient({
113113
},
114114

115115
/**
116-
* This method allow you to send requests to the Algolia REST API.
116+
* This method lets you send requests to the Algolia REST API.
117117
* @param customDelete - The customDelete object.
118118
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
119119
* @param customDelete.parameters - Query parameters to apply to the current query.
@@ -142,7 +142,7 @@ export function createInsightsClient({
142142
},
143143

144144
/**
145-
* This method allow you to send requests to the Algolia REST API.
145+
* This method lets you send requests to the Algolia REST API.
146146
* @param customGet - The customGet object.
147147
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
148148
* @param customGet.parameters - Query parameters to apply to the current query.
@@ -168,7 +168,7 @@ export function createInsightsClient({
168168
},
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
* @param customPost - The customPost object.
173173
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
174174
* @param customPost.parameters - Query parameters to apply to the current query.
@@ -199,7 +199,7 @@ export function createInsightsClient({
199199
},
200200

201201
/**
202-
* This method allow you to send requests to the Algolia REST API.
202+
* This method lets you send requests to the Algolia REST API.
203203
* @param customPut - The customPut object.
204204
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
205205
* @param customPut.parameters - Query parameters to apply to the current query.

‎packages/client-personalization/src/personalizationClient.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ export function createPersonalizationClient({
117117
},
118118

119119
/**
120-
* This method allow you to send requests to the Algolia REST API.
120+
* This method lets you send requests to the Algolia REST API.
121121
* @param customDelete - The customDelete object.
122122
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
123123
* @param customDelete.parameters - Query parameters to apply to the current query.
@@ -146,7 +146,7 @@ export function createPersonalizationClient({
146146
},
147147

148148
/**
149-
* This method allow you to send requests to the Algolia REST API.
149+
* This method lets you send requests to the Algolia REST API.
150150
* @param customGet - The customGet object.
151151
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
152152
* @param customGet.parameters - Query parameters to apply to the current query.
@@ -172,7 +172,7 @@ export function createPersonalizationClient({
172172
},
173173

174174
/**
175-
* This method allow you to send requests to the Algolia REST API.
175+
* This method lets you send requests to the Algolia REST API.
176176
* @param customPost - The customPost object.
177177
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
178178
* @param customPost.parameters - Query parameters to apply to the current query.
@@ -203,7 +203,7 @@ export function createPersonalizationClient({
203203
},
204204

205205
/**
206-
* This method allow you to send requests to the Algolia REST API.
206+
* This method lets you send requests to the Algolia REST API.
207207
* @param customPut - The customPut object.
208208
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
209209
* @param customPut.parameters - Query parameters to apply to the current query.

‎packages/client-query-suggestions/src/querySuggestionsClient.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ export function createQuerySuggestionsClient({
153153
},
154154

155155
/**
156-
* This method allow you to send requests to the Algolia REST API.
156+
* This method lets you send requests to the Algolia REST API.
157157
* @param customDelete - The customDelete object.
158158
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
159159
* @param customDelete.parameters - Query parameters to apply to the current query.
@@ -182,7 +182,7 @@ export function createQuerySuggestionsClient({
182182
},
183183

184184
/**
185-
* This method allow you to send requests to the Algolia REST API.
185+
* This method lets you send requests to the Algolia REST API.
186186
* @param customGet - The customGet object.
187187
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
188188
* @param customGet.parameters - Query parameters to apply to the current query.
@@ -208,7 +208,7 @@ export function createQuerySuggestionsClient({
208208
},
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
* @param customPost - The customPost object.
213213
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
214214
* @param customPost.parameters - Query parameters to apply to the current query.
@@ -239,7 +239,7 @@ export function createQuerySuggestionsClient({
239239
},
240240

241241
/**
242-
* This method allow you to send requests to the Algolia REST API.
242+
* This method lets you send requests to the Algolia REST API.
243243
* @param customPut - The customPut object.
244244
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
245245
* @param customPut.parameters - Query parameters to apply to the current query.

‎packages/client-search/model/optionalWords.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
22

3+
/**
4+
* Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn\'t include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 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).
5+
*/
36
export type OptionalWords = string | Array<string>;

0 commit comments

Comments
 (0)