Skip to content

Commit 1b6e72b

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 b2351bf commit 1b6e72b

12 files changed

+61
-41
lines changed

‎src/main/scala/algoliasearch/api/AbtestingClient.scala

+4-4
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ class AbtestingClient(
110110
execute[ABTestResponse](request, requestOptions)
111111
}
112112

113-
/** This method allow you to send requests to the Algolia REST API.
113+
/** This method lets you send requests to the Algolia REST API.
114114
*
115115
* @param path
116116
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -133,7 +133,7 @@ class AbtestingClient(
133133
execute[T](request, requestOptions)
134134
}
135135

136-
/** This method allow you to send requests to the Algolia REST API.
136+
/** This method lets you send requests to the Algolia REST API.
137137
*
138138
* @param path
139139
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -156,7 +156,7 @@ class AbtestingClient(
156156
execute[T](request, requestOptions)
157157
}
158158

159-
/** This method allow you to send requests to the Algolia REST API.
159+
/** This method lets you send requests to the Algolia REST API.
160160
*
161161
* @param path
162162
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -183,7 +183,7 @@ class AbtestingClient(
183183
execute[T](request, requestOptions)
184184
}
185185

186-
/** This method allow you to send requests to the Algolia REST API.
186+
/** This method lets you send requests to the Algolia REST API.
187187
*
188188
* @param path
189189
* Path of the endpoint, anything after \"/1\" must be specified.

‎src/main/scala/algoliasearch/api/AnalyticsClient.scala

+4-4
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ class AnalyticsClient(
105105
options = clientOptions
106106
) {
107107

108-
/** This method allow you to send requests to the Algolia REST API.
108+
/** This method lets you send requests to the Algolia REST API.
109109
*
110110
* @param path
111111
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -128,7 +128,7 @@ class AnalyticsClient(
128128
execute[T](request, requestOptions)
129129
}
130130

131-
/** This method allow you to send requests to the Algolia REST API.
131+
/** This method lets you send requests to the Algolia REST API.
132132
*
133133
* @param path
134134
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -151,7 +151,7 @@ class AnalyticsClient(
151151
execute[T](request, requestOptions)
152152
}
153153

154-
/** This method allow you to send requests to the Algolia REST API.
154+
/** This method lets you send requests to the Algolia REST API.
155155
*
156156
* @param path
157157
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -178,7 +178,7 @@ class AnalyticsClient(
178178
execute[T](request, requestOptions)
179179
}
180180

181-
/** This method allow you to send requests to the Algolia REST API.
181+
/** This method lets you send requests to the Algolia REST API.
182182
*
183183
* @param path
184184
* Path of the endpoint, anything after \"/1\" must be specified.

‎src/main/scala/algoliasearch/api/IngestionClient.scala

+4-4
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ class IngestionClient(
284284
execute[TransformationCreateResponse](request, requestOptions)
285285
}
286286

287-
/** This method allow you to send requests to the Algolia REST API.
287+
/** This method lets you send requests to the Algolia REST API.
288288
*
289289
* @param path
290290
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -307,7 +307,7 @@ class IngestionClient(
307307
execute[T](request, requestOptions)
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
* @param path
313313
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -330,7 +330,7 @@ class IngestionClient(
330330
execute[T](request, requestOptions)
331331
}
332332

333-
/** This method allow you to send requests to the Algolia REST API.
333+
/** This method lets you send requests to the Algolia REST API.
334334
*
335335
* @param path
336336
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -357,7 +357,7 @@ class IngestionClient(
357357
execute[T](request, requestOptions)
358358
}
359359

360-
/** This method allow you to send requests to the Algolia REST API.
360+
/** This method lets you send requests to the Algolia REST API.
361361
*
362362
* @param path
363363
* Path of the endpoint, anything after \"/1\" must be specified.

‎src/main/scala/algoliasearch/api/InsightsClient.scala

+4-4
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ class InsightsClient(
8585
options = clientOptions
8686
) {
8787

88-
/** This method allow you to send requests to the Algolia REST API.
88+
/** This method lets you send requests to the Algolia REST API.
8989
*
9090
* @param path
9191
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -108,7 +108,7 @@ class InsightsClient(
108108
execute[T](request, requestOptions)
109109
}
110110

111-
/** This method allow you to send requests to the Algolia REST API.
111+
/** This method lets you send requests to the Algolia REST API.
112112
*
113113
* @param path
114114
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -131,7 +131,7 @@ class InsightsClient(
131131
execute[T](request, requestOptions)
132132
}
133133

134-
/** This method allow you to send requests to the Algolia REST API.
134+
/** This method lets you send requests to the Algolia REST API.
135135
*
136136
* @param path
137137
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -158,7 +158,7 @@ class InsightsClient(
158158
execute[T](request, requestOptions)
159159
}
160160

161-
/** This method allow you to send requests to the Algolia REST API.
161+
/** This method lets you send requests to the Algolia REST API.
162162
*
163163
* @param path
164164
* Path of the endpoint, anything after \"/1\" must be specified.

‎src/main/scala/algoliasearch/api/MonitoringClient.scala

+4-4
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ class MonitoringClient(
8686
options = clientOptions
8787
) {
8888

89-
/** This method allow you to send requests to the Algolia REST API.
89+
/** This method lets you send requests to the Algolia REST API.
9090
*
9191
* @param path
9292
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -109,7 +109,7 @@ class MonitoringClient(
109109
execute[T](request, requestOptions)
110110
}
111111

112-
/** This method allow you to send requests to the Algolia REST API.
112+
/** This method lets you send requests to the Algolia REST API.
113113
*
114114
* @param path
115115
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -132,7 +132,7 @@ class MonitoringClient(
132132
execute[T](request, requestOptions)
133133
}
134134

135-
/** This method allow you to send requests to the Algolia REST API.
135+
/** This method lets you send requests to the Algolia REST API.
136136
*
137137
* @param path
138138
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -159,7 +159,7 @@ class MonitoringClient(
159159
execute[T](request, requestOptions)
160160
}
161161

162-
/** This method allow you to send requests to the Algolia REST API.
162+
/** This method lets you send requests to the Algolia REST API.
163163
*
164164
* @param path
165165
* Path of the endpoint, anything after \"/1\" must be specified.

‎src/main/scala/algoliasearch/api/PersonalizationClient.scala

+4-4
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class PersonalizationClient(
8888
options = clientOptions
8989
) {
9090

91-
/** This method allow you to send requests to the Algolia REST API.
91+
/** This method lets you send requests to the Algolia REST API.
9292
*
9393
* @param path
9494
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -111,7 +111,7 @@ class PersonalizationClient(
111111
execute[T](request, requestOptions)
112112
}
113113

114-
/** This method allow you to send requests to the Algolia REST API.
114+
/** This method lets you send requests to the Algolia REST API.
115115
*
116116
* @param path
117117
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -134,7 +134,7 @@ class PersonalizationClient(
134134
execute[T](request, requestOptions)
135135
}
136136

137-
/** This method allow you to send requests to the Algolia REST API.
137+
/** This method lets you send requests to the Algolia REST API.
138138
*
139139
* @param path
140140
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -161,7 +161,7 @@ class PersonalizationClient(
161161
execute[T](request, requestOptions)
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
*
166166
* @param path
167167
* Path of the endpoint, anything after \"/1\" must be specified.

‎src/main/scala/algoliasearch/api/QuerySuggestionsClient.scala

+4-4
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ class QuerySuggestionsClient(
112112
execute[BaseResponse](request, requestOptions)
113113
}
114114

115-
/** This method allow you to send requests to the Algolia REST API.
115+
/** This method lets you send requests to the Algolia REST API.
116116
*
117117
* @param path
118118
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -135,7 +135,7 @@ class QuerySuggestionsClient(
135135
execute[T](request, requestOptions)
136136
}
137137

138-
/** This method allow you to send requests to the Algolia REST API.
138+
/** This method lets you send requests to the Algolia REST API.
139139
*
140140
* @param path
141141
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -158,7 +158,7 @@ class QuerySuggestionsClient(
158158
execute[T](request, requestOptions)
159159
}
160160

161-
/** This method allow you to send requests to the Algolia REST API.
161+
/** This method lets you send requests to the Algolia REST API.
162162
*
163163
* @param path
164164
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -185,7 +185,7 @@ class QuerySuggestionsClient(
185185
execute[T](request, requestOptions)
186186
}
187187

188-
/** This method allow you to send requests to the Algolia REST API.
188+
/** This method lets you send requests to the Algolia REST API.
189189
*
190190
* @param path
191191
* Path of the endpoint, anything after \"/1\" must be specified.

‎src/main/scala/algoliasearch/api/RecommendClient.scala

+4-4
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ class RecommendClient(
128128
execute[RecommendUpdatedAtResponse](request, requestOptions)
129129
}
130130

131-
/** This method allow you to send requests to the Algolia REST API.
131+
/** This method lets you send requests to the Algolia REST API.
132132
*
133133
* @param path
134134
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -151,7 +151,7 @@ class RecommendClient(
151151
execute[T](request, requestOptions)
152152
}
153153

154-
/** This method allow you to send requests to the Algolia REST API.
154+
/** This method lets you send requests to the Algolia REST API.
155155
*
156156
* @param path
157157
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -174,7 +174,7 @@ class RecommendClient(
174174
execute[T](request, requestOptions)
175175
}
176176

177-
/** This method allow you to send requests to the Algolia REST API.
177+
/** This method lets you send requests to the Algolia REST API.
178178
*
179179
* @param path
180180
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -201,7 +201,7 @@ class RecommendClient(
201201
execute[T](request, requestOptions)
202202
}
203203

204-
/** This method allow you to send requests to the Algolia REST API.
204+
/** This method lets you send requests to the Algolia REST API.
205205
*
206206
* @param path
207207
* Path of the endpoint, anything after \"/1\" must be specified.

‎src/main/scala/algoliasearch/api/SearchClient.scala

+4-4
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ class SearchClient(
437437
execute[UpdatedAtResponse](request, requestOptions)
438438
}
439439

440-
/** This method allow you to send requests to the Algolia REST API.
440+
/** This method lets you send requests to the Algolia REST API.
441441
*
442442
* @param path
443443
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -460,7 +460,7 @@ class SearchClient(
460460
execute[T](request, requestOptions)
461461
}
462462

463-
/** This method allow you to send requests to the Algolia REST API.
463+
/** This method lets you send requests to the Algolia REST API.
464464
*
465465
* @param path
466466
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -483,7 +483,7 @@ class SearchClient(
483483
execute[T](request, requestOptions)
484484
}
485485

486-
/** This method allow you to send requests to the Algolia REST API.
486+
/** This method lets you send requests to the Algolia REST API.
487487
*
488488
* @param path
489489
* Path of the endpoint, anything after \"/1\" must be specified.
@@ -510,7 +510,7 @@ class SearchClient(
510510
execute[T](request, requestOptions)
511511
}
512512

513-
/** This method allow you to send requests to the Algolia REST API.
513+
/** This method lets you send requests to the Algolia REST API.
514514
*
515515
* @param path
516516
* Path of the endpoint, anything after \"/1\" must be specified.

‎src/main/scala/algoliasearch/recommend/OptionalWords.scala

+12-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,18 @@ package algoliasearch.recommend
3131

3232
import org.json4s._
3333

34-
/** OptionalWords
34+
/** Words that should be considered optional when found in the query. By default, records must match all words in the
35+
* search query to be included in the search results. Adding optional words can help to increase the number of search
36+
* results by running an additional search query that doesn't include the optional words. For example, if the search
37+
* query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action
38+
* video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more
39+
* words **and** all its words are optional, the number of matched words required for a record to be included in the
40+
* search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number
41+
* of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched
42+
* words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of
43+
* optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1
44+
* matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional
45+
* words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
3546
*/
3647
sealed trait OptionalWords
3748

‎src/main/scala/algoliasearch/search/Log.scala

+1-3
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@
3333
*/
3434
package algoliasearch.search
3535

36-
import java.net.URI
37-
3836
import org.json4s._
3937

4038
/** Log
@@ -76,7 +74,7 @@ case class Log(
7674
answerCode /* answer_code */: String,
7775
queryBody /* query_body */: String,
7876
answer: String,
79-
url: URI,
77+
url: String,
8078
ip: String,
8179
queryHeaders /* query_headers */: String,
8280
sha1: String,

‎src/main/scala/algoliasearch/search/OptionalWords.scala

+12-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,18 @@ package algoliasearch.search
3535

3636
import org.json4s._
3737

38-
/** OptionalWords
38+
/** Words that should be considered optional when found in the query. By default, records must match all words in the
39+
* search query to be included in the search results. Adding optional words can help to increase the number of search
40+
* results by running an additional search query that doesn't include the optional words. For example, if the search
41+
* query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action
42+
* video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more
43+
* words **and** all its words are optional, the number of matched words required for a record to be included in the
44+
* search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number
45+
* of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched
46+
* words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of
47+
* optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1
48+
* matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional
49+
* words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
3950
*/
4051
sealed trait OptionalWords
4152

0 commit comments

Comments
 (0)