@algolia/n8n-nodes-algolia 0.6.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/README.md +140 -68
  2. package/dist/credentials/AlgoliaApi.credentials.js +1 -41
  3. package/dist/nodes/Algolia/Algolia.node.js +854 -17999
  4. package/package.json +10 -11
  5. package/dist/nodes/Algolia/specs/abtesting-v3.json +0 -1701
  6. package/dist/nodes/Algolia/specs/abtesting.json +0 -1580
  7. package/dist/nodes/Algolia/specs/advanced-personalization.json +0 -1667
  8. package/dist/nodes/Algolia/specs/analytics.json +0 -3138
  9. package/dist/nodes/Algolia/specs/composition.json +0 -4193
  10. package/dist/nodes/Algolia/specs/crawler.json +0 -3354
  11. package/dist/nodes/Algolia/specs/ingestion.json +0 -6368
  12. package/dist/nodes/Algolia/specs/insights.json +0 -1843
  13. package/dist/nodes/Algolia/specs/monitoring.json +0 -1263
  14. package/dist/nodes/Algolia/specs/personalization.json +0 -716
  15. package/dist/nodes/Algolia/specs/query-suggestions.json +0 -1143
  16. package/dist/nodes/Algolia/specs/recommend.json +0 -3681
  17. package/dist/nodes/Algolia/specs/search.json +0 -9458
  18. /package/dist/{nodes/Algolia/algolia.svg → algolia.svg} +0 -0
package/dist/nodes/Algolia/specs/crawler.json DELETED
@@ -1,3354 +0,0 @@
1
- {
2
- "openapi": "3.0.2",
3
- "info": {
4
- "title": "Crawler API",
5
- "description": "The Crawler API lets you manage and run your crawlers.\n\n## Base URL\n\nThe base URL for making requests to the Crawler API is:\n\n- `https://crawler.algolia.com/api`\n\n**All requests must use HTTPS.**\n\n## Availability and authentication\n\nTo authenticate your API requests, use the **basic authentication** header:\n\n- `Authorization: Basic <credentials>`\n\nWhere `<credentials>` is a base64-encoded string `<user-id>:<api-key>`.\n\n- `<user-id>`. The Crawler user ID.\n- `<api-key>`. The Crawler API key.\n\nYou can find both on the [Crawler settings](https://dashboard.algolia.com/crawler/settings) page in the Algolia dashboard.\nThe Crawler credentials are different from your regular Algolia credentials.\n\n## Request format\n\nRequest bodies must be JSON objects.\n\n## Parameters\n\nParameters are passed as query parameters for GET requests,\nand in the request body for POST and PATCH requests.\n\nQuery parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding).\nNon-ASCII characters must be UTF-8 encoded.\n\n## Response status and errors\n\nThe Crawler API returns JSON responses.\nSince JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.\n\nSuccessful responses return a `2xx` status. Client errors return a `4xx` status.\nServer errors are indicated by a `5xx` status.\nError responses have a `message` property with more information.\n\n## Version\n\nThe current version of the Crawler API is version 1, as indicated by the `/1/` in each endpoint's URL.\n",
6
- "version": "1.0.0"
7
- },
8
- "servers": [
9
- {
10
- "url": "https://crawler.algolia.com/api",
11
- "description": "The URL of the Crawler API."
12
- }
13
- ],
14
- "security": [
15
- {
16
- "BasicAuth": []
17
- }
18
- ],
19
- "tags": [
20
- {
21
- "name": "actions",
22
- "x-displayName": "State",
23
- "description": "Change the state of crawlers, such as pausing crawl schedules or testing the crawler with specific URLs.\n"
24
- },
25
- {
26
- "name": "config",
27
- "x-displayName": "Configuration",
28
- "description": "In the Crawler configuration, you specify which URLs to crawl, when to crawl, how to extract records from the crawl, and where to index the extracted records.\n\nThe configuration is versioned, so you can always restore a previous version.\n\nIt's easiest to make configuration changes on the [Crawler page](https://dashboard.algolia.com/crawler) in the Algolia dashboard.\nThe editor has autocomplete and built-in validation so you can try your configuration changes before committing them.\n"
29
- },
30
- {
31
- "name": "crawlers",
32
- "x-displayName": "Manage",
33
- "description": "A crawler is an object with a name and a [configuration](#tag/config).\nUse these endpoints to create, rename, and delete crawlers.\n"
34
- },
35
- {
36
- "name": "domains",
37
- "x-displayName": "Domains",
38
- "description": "List registered domains."
39
- },
40
- {
41
- "name": "tasks",
42
- "x-displayName": "Tasks",
43
- "description": "Task operations."
44
- }
45
- ],
46
- "paths": {
47
- "/1/crawlers": {
48
- "get": {
49
- "operationId": "listCrawlers",
50
- "summary": "List crawlers",
51
- "description": "Lists all your crawlers.",
52
- "tags": [
53
- "crawlers"
54
- ],
55
- "parameters": [
56
- {
57
- "$ref": "#/components/parameters/ItemsPerPage"
58
- },
59
- {
60
- "$ref": "#/components/parameters/Page"
61
- },
62
- {
63
- "$ref": "#/components/parameters/Name"
64
- },
65
- {
66
- "$ref": "#/components/parameters/AppID"
67
- }
68
- ],
69
- "responses": {
70
- "200": {
71
- "description": "OK",
72
- "content": {
73
- "application/json": {
74
- "schema": {
75
- "$ref": "#/components/schemas/crawlersResponse"
76
- }
77
- }
78
- }
79
- },
80
- "400": {
81
- "$ref": "#/components/responses/InvalidRequest"
82
- },
83
- "401": {
84
- "$ref": "#/components/responses/MissingAuthorization"
85
- },
86
- "403": {
87
- "description": "Invalid credentials."
88
- },
89
- "404": {
90
- "description": "The call does not have results for this combinaison of query params."
91
- }
92
- }
93
- },
94
- "post": {
95
- "operationId": "createCrawler",
96
- "summary": "Create a crawler",
97
- "description": "Creates a new crawler with the provided configuration.",
98
- "tags": [
99
- "crawlers"
100
- ],
101
- "requestBody": {
102
- "content": {
103
- "application/json": {
104
- "schema": {
105
- "title": "crawlerCreate",
106
- "type": "object",
107
- "properties": {
108
- "name": {
109
- "$ref": "#/components/schemas/CrawlerName"
110
- },
111
- "config": {
112
- "$ref": "#/components/schemas/Configuration"
113
- }
114
- },
115
- "required": [
116
- "name",
117
- "config"
118
- ]
119
- }
120
- }
121
- }
122
- },
123
- "responses": {
124
- "200": {
125
- "description": "OK",
126
- "content": {
127
- "application/json": {
128
- "schema": {
129
- "title": "crawlerCreateResponse",
130
- "type": "object",
131
- "properties": {
132
- "id": {
133
- "$ref": "#/components/schemas/CrawlerID"
134
- }
135
- },
136
- "required": [
137
- "id"
138
- ]
139
- }
140
- }
141
- }
142
- },
143
- "400": {
144
- "$ref": "#/components/responses/InvalidRequest"
145
- },
146
- "401": {
147
- "$ref": "#/components/responses/MissingAuthorization"
148
- },
149
- "403": {
150
- "description": "The user doesn't have enough rights to create a Crawler."
151
- }
152
- }
153
- }
154
- },
155
- "/1/crawlers/{id}": {
156
- "get": {
157
- "operationId": "getCrawler",
158
- "summary": "Retrieve crawler details",
159
- "description": "Retrieves details about the specified crawler, optionally with its configuration.\n",
160
- "tags": [
161
- "crawlers"
162
- ],
163
- "parameters": [
164
- {
165
- "$ref": "#/components/parameters/CrawlerIdParameter"
166
- },
167
- {
168
- "in": "query",
169
- "name": "withConfig",
170
- "schema": {
171
- "type": "boolean"
172
- },
173
- "description": "Whether the response should include the crawler's configuration."
174
- }
175
- ],
176
- "responses": {
177
- "200": {
178
- "description": "OK",
179
- "content": {
180
- "application/json": {
181
- "schema": {
182
- "$ref": "#/components/schemas/GetCrawlerResponse"
183
- }
184
- }
185
- }
186
- },
187
- "400": {
188
- "$ref": "#/components/responses/InvalidRequest"
189
- },
190
- "401": {
191
- "$ref": "#/components/responses/MissingAuthorization"
192
- },
193
- "403": {
194
- "$ref": "#/components/responses/NoRightsOnCrawler"
195
- }
196
- }
197
- },
198
- "patch": {
199
- "operationId": "patchCrawler",
200
- "summary": "Change crawler name",
201
- "description": "Change the crawler's name.\n\nWhile you _could_ use this endpoint to replace the crawler configuration,\nyou should [update it](#tag/config/operation/patchConfig) instead since configuration changes made here aren't [versioned](#tag/config/operation/listConfigVersions).\n\nIf you replace the configuration, you must provide the full configuration,\nincluding any settings you want to keep.\n",
202
- "tags": [
203
- "crawlers"
204
- ],
205
- "parameters": [
206
- {
207
- "$ref": "#/components/parameters/CrawlerIdParameter"
208
- }
209
- ],
210
- "requestBody": {
211
- "content": {
212
- "application/json": {
213
- "schema": {
214
- "title": "patchCrawler",
215
- "type": "object",
216
- "properties": {
217
- "name": {
218
- "$ref": "#/components/schemas/CrawlerName"
219
- },
220
- "config": {
221
- "$ref": "#/components/schemas/Configuration"
222
- }
223
- }
224
- }
225
- }
226
- }
227
- },
228
- "responses": {
229
- "200": {
230
- "$ref": "#/components/responses/ActionAcknowledged"
231
- },
232
- "400": {
233
- "$ref": "#/components/responses/InvalidRequest"
234
- },
235
- "401": {
236
- "$ref": "#/components/responses/MissingAuthorization"
237
- },
238
- "403": {
239
- "$ref": "#/components/responses/NoRightsOnCrawler"
240
- }
241
- }
242
- },
243
- "delete": {
244
- "operationId": "deleteCrawler",
245
- "summary": "Delete a crawler",
246
- "description": "Delete the specified crawler.",
247
- "tags": [
248
- "crawlers"
249
- ],
250
- "parameters": [
251
- {
252
- "$ref": "#/components/parameters/CrawlerIdParameter"
253
- }
254
- ],
255
- "responses": {
256
- "200": {
257
- "$ref": "#/components/responses/ActionAcknowledged"
258
- },
259
- "400": {
260
- "$ref": "#/components/responses/InvalidRequest"
261
- },
262
- "401": {
263
- "$ref": "#/components/responses/MissingAuthorization"
264
- },
265
- "403": {
266
- "$ref": "#/components/responses/NoRightsOnCrawler"
267
- }
268
- }
269
- }
270
- },
271
- "/1/crawlers/{id}/run": {
272
- "post": {
273
- "operationId": "runCrawler",
274
- "summary": "Unpause a crawler",
275
- "description": "Unpauses the specified crawler.\nPreviously ongoing crawls will be resumed.\nOtherwise, the crawler waits for its next scheduled run.\n",
276
- "tags": [
277
- "actions"
278
- ],
279
- "parameters": [
280
- {
281
- "$ref": "#/components/parameters/CrawlerIdParameter"
282
- }
283
- ],
284
- "responses": {
285
- "200": {
286
- "$ref": "#/components/responses/ActionAcknowledged"
287
- },
288
- "400": {
289
- "$ref": "#/components/responses/InvalidRequest"
290
- },
291
- "401": {
292
- "$ref": "#/components/responses/MissingAuthorization"
293
- },
294
- "403": {
295
- "$ref": "#/components/responses/NoRightsOnCrawler"
296
- }
297
- }
298
- }
299
- },
300
- "/1/crawlers/{id}/pause": {
301
- "post": {
302
- "operationId": "pauseCrawler",
303
- "summary": "Pause a crawler",
304
- "description": "Pauses the specified crawler.",
305
- "tags": [
306
- "actions"
307
- ],
308
- "parameters": [
309
- {
310
- "$ref": "#/components/parameters/CrawlerIdParameter"
311
- }
312
- ],
313
- "responses": {
314
- "200": {
315
- "$ref": "#/components/responses/ActionAcknowledged"
316
- },
317
- "400": {
318
- "$ref": "#/components/responses/InvalidRequest"
319
- },
320
- "401": {
321
- "$ref": "#/components/responses/MissingAuthorization"
322
- },
323
- "403": {
324
- "$ref": "#/components/responses/NoRightsOnCrawler"
325
- }
326
- }
327
- }
328
- },
329
- "/1/crawlers/{id}/reindex": {
330
- "post": {
331
- "operationId": "startReindex",
332
- "summary": "Start a crawl",
333
- "description": "Starts or resumes a crawl.",
334
- "tags": [
335
- "actions"
336
- ],
337
- "parameters": [
338
- {
339
- "$ref": "#/components/parameters/CrawlerIdParameter"
340
- }
341
- ],
342
- "responses": {
343
- "200": {
344
- "$ref": "#/components/responses/ActionAcknowledged"
345
- },
346
- "400": {
347
- "$ref": "#/components/responses/InvalidRequest"
348
- },
349
- "401": {
350
- "$ref": "#/components/responses/MissingAuthorization"
351
- },
352
- "403": {
353
- "$ref": "#/components/responses/NoRightsOnCrawler"
354
- }
355
- }
356
- }
357
- },
358
- "/1/crawlers/{id}/test": {
359
- "post": {
360
- "operationId": "testUrl",
361
- "summary": "Test crawl a URL",
362
- "description": "Tests a URL with the crawler's configuration and shows the extracted records.\n\nYou can test configuration changes by overriding specific parts before updating the full configuration.\n",
363
- "tags": [
364
- "actions"
365
- ],
366
- "parameters": [
367
- {
368
- "$ref": "#/components/parameters/CrawlerIdParameter"
369
- }
370
- ],
371
- "requestBody": {
372
- "content": {
373
- "application/json": {
374
- "schema": {
375
- "title": "testUrl",
376
- "type": "object",
377
- "properties": {
378
- "url": {
379
- "type": "string",
380
- "description": "URL to test.",
381
- "example": "https://www.algolia.com/blog"
382
- },
383
- "config": {
384
- "$ref": "#/components/schemas/PartialConfig"
385
- }
386
- },
387
- "required": [
388
- "url"
389
- ]
390
- }
391
- }
392
- }
393
- },
394
- "responses": {
395
- "200": {
396
- "description": "OK",
397
- "content": {
398
- "application/json": {
399
- "schema": {
400
- "title": "urlTest",
401
- "type": "object",
402
- "properties": {
403
- "startDate": {
404
- "type": "string",
405
- "description": "Date and time when the test crawl started, in RFC 3339 format.",
406
- "example": "2024-04-02T15:34:29Z"
407
- },
408
- "endDate": {
409
- "type": "string",
410
- "description": "Date and time when the test crawl finished, in RFC 3339 format.",
411
- "example": "2024-04-02T15:34:29Z"
412
- },
413
- "logs": {
414
- "type": "array",
415
- "description": "Logs from the record extraction.",
416
- "items": {
417
- "type": "array",
418
- "description": "Parameters associated with each log.",
419
- "items": {
420
- "type": "string",
421
- "example": "Processing url 'https://www.algolia.com/blog'"
422
- }
423
- }
424
- },
425
- "records": {
426
- "type": "array",
427
- "description": "Extracted records from the URL.",
428
- "items": {
429
- "title": "extractedRecords",
430
- "type": "object",
431
- "properties": {
432
- "indexName": {
433
- "type": "string",
434
- "description": "Name of the index where this record will be stored.",
435
- "example": "testIndex"
436
- },
437
- "records": {
438
- "type": "array",
439
- "description": "Extracted records.",
440
- "items": {
441
- "type": "object",
442
- "description": "Algolia record.",
443
- "example": {
444
- "objectID": "https://www.algolia.com/blog",
445
- "numberOfLinks": 2
446
- }
447
- }
448
- },
449
- "recordsPerExtractor": {
450
- "type": "array",
451
- "description": "Partial records generated by each record extractor.",
452
- "items": {
453
- "title": "recordPerExtractor",
454
- "type": "object",
455
- "properties": {
456
- "index": {
457
- "type": "number",
458
- "description": "Index of the extractor.",
459
- "minimum": 0
460
- },
461
- "type": {
462
- "type": "string",
463
- "description": "Extractor type."
464
- },
465
- "records": {
466
- "type": "array",
467
- "description": "Extracted records.",
468
- "items": {
469
- "type": "object"
470
- }
471
- }
472
- }
473
- },
474
- "example": [
475
- {
476
- "index": 0,
477
- "type": "custom",
478
- "records": [
479
- {
480
- "objectID": "https://www.algolia.com/blog"
481
- }
482
- ]
483
- }
484
- ]
485
- }
486
- }
487
- }
488
- },
489
- "links": {
490
- "type": "array",
491
- "description": "Links found on the page, which match the configuration and would be processed.\n",
492
- "items": {
493
- "type": "string"
494
- },
495
- "example": [
496
- "https://blog.algolia.com/challenging-migration-heroku-google-kubernetes-engine/",
497
- "https://blog.algolia.com/tale-two-engines-algolia-unity/"
498
- ]
499
- },
500
- "externalData": {
501
- "type": "object",
502
- "description": "External data associated with the tested URL.\n\nExternal data is refreshed automatically at the beginning of the crawl.\n",
503
- "example": {
504
- "externalData1": {
505
- "data1": "val1",
506
- "data2": "val2"
507
- },
508
- "externalData2": {
509
- "data1": "val1",
510
- "data2": "val2"
511
- }
512
- }
513
- },
514
- "error": {
515
- "title": "urlTestError",
516
- "type": "object",
517
- "description": "An error.",
518
- "properties": {
519
- "code": {
520
- "type": "string",
521
- "example": "http_internal_server_error"
522
- },
523
- "message": {
524
- "type": "string",
525
- "example": "HTTP Internal Server Error (500)"
526
- }
527
- },
528
- "example": {}
529
- }
530
- },
531
- "required": [
532
- "startDate",
533
- "endDate",
534
- "logs",
535
- "records",
536
- "links"
537
- ]
538
- }
539
- }
540
- }
541
- },
542
- "400": {
543
- "$ref": "#/components/responses/InvalidRequest"
544
- },
545
- "401": {
546
- "$ref": "#/components/responses/MissingAuthorization"
547
- },
548
- "403": {
549
- "$ref": "#/components/responses/NoRightsOnCrawler"
550
- }
551
- }
552
- }
553
- },
554
- "/1/crawlers/{id}/urls/crawl": {
555
- "post": {
556
- "operationId": "crawlUrls",
557
- "summary": "Crawl URLs",
558
- "description": "Crawls the specified URLs, extracts records from them, and adds them to the index.\nIf a crawl is currently running (the crawler's `reindexing` property is `true`),\nthe records are added to a temporary index.\n\nThis operation is rate-limited to 500 requests every 24 hours.\n",
559
- "tags": [
560
- "actions"
561
- ],
562
- "parameters": [
563
- {
564
- "$ref": "#/components/parameters/CrawlerIdParameter"
565
- }
566
- ],
567
- "requestBody": {
568
- "content": {
569
- "application/json": {
570
- "schema": {
571
- "title": "crawlUrls",
572
- "type": "object",
573
- "properties": {
574
- "urls": {
575
- "type": "array",
576
- "description": "URLs to crawl.",
577
- "items": {
578
- "type": "string"
579
- },
580
- "example": [
581
- "https://www.algolia.com/products/crawler/"
582
- ]
583
- },
584
- "save": {
585
- "type": "boolean",
586
- "description": "Whether the specified URLs should be added to the `extraURLs` property of the crawler configuration.\nIf unspecified, the URLs are added to the `extraUrls` field only if they haven't been indexed during the last reindex.\n"
587
- }
588
- },
589
- "required": [
590
- "urls"
591
- ]
592
- }
593
- }
594
- }
595
- },
596
- "responses": {
597
- "200": {
598
- "$ref": "#/components/responses/ActionAcknowledged"
599
- },
600
- "400": {
601
- "$ref": "#/components/responses/InvalidRequest"
602
- },
603
- "401": {
604
- "$ref": "#/components/responses/MissingAuthorization"
605
- },
606
- "403": {
607
- "$ref": "#/components/responses/NoRightsOnCrawler"
608
- }
609
- }
610
- }
611
- },
612
- "/1/crawlers/{id}/stats/urls": {
613
- "get": {
614
- "operationId": "getStats",
615
- "summary": "Retrieve crawler stats",
616
- "description": "Retrieves information about the number of crawled, skipped, and failed URLs.",
617
- "tags": [
618
- "crawlers"
619
- ],
620
- "parameters": [
621
- {
622
- "$ref": "#/components/parameters/CrawlerIdParameter"
623
- }
624
- ],
625
- "responses": {
626
- "200": {
627
- "description": "OK",
628
- "content": {
629
- "application/json": {
630
- "schema": {
631
- "title": "crawlerStats",
632
- "type": "object",
633
- "properties": {
634
- "count": {
635
- "type": "integer",
636
- "minimum": 0,
637
- "description": "Total number of crawled URLs."
638
- },
639
- "data": {
640
- "type": "array",
641
- "default": [],
642
- "items": {
643
- "$ref": "#/components/schemas/UrlsCrawledGroup"
644
- }
645
- }
646
- },
647
- "required": [
648
- "count",
649
- "data"
650
- ]
651
- }
652
- }
653
- }
654
- },
655
- "401": {
656
- "$ref": "#/components/responses/MissingAuthorization"
657
- },
658
- "403": {
659
- "$ref": "#/components/responses/NoRightsOnCrawler"
660
- }
661
- }
662
- }
663
- },
664
- "/1/crawlers/{id}/config": {
665
- "patch": {
666
- "operationId": "patchConfig",
667
- "summary": "Update crawler configuration",
668
- "description": "Updates the configuration of the specified crawler.\nEvery time you update the configuration, a new version is created.\n",
669
- "tags": [
670
- "config"
671
- ],
672
- "parameters": [
673
- {
674
- "$ref": "#/components/parameters/CrawlerIdParameter"
675
- }
676
- ],
677
- "requestBody": {
678
- "content": {
679
- "application/json": {
680
- "schema": {
681
- "$ref": "#/components/schemas/PartialConfig"
682
- }
683
- }
684
- }
685
- },
686
- "responses": {
687
- "200": {
688
- "$ref": "#/components/responses/ActionAcknowledged"
689
- },
690
- "400": {
691
- "$ref": "#/components/responses/InvalidRequest"
692
- },
693
- "401": {
694
- "$ref": "#/components/responses/MissingAuthorization"
695
- },
696
- "403": {
697
- "$ref": "#/components/responses/NoRightsOnCrawler"
698
- }
699
- }
700
- }
701
- },
702
- "/1/crawlers/{id}/config/versions": {
703
- "get": {
704
- "operationId": "listConfigVersions",
705
- "summary": "List configuration versions",
706
- "description": "Lists previous versions of the specified crawler's configuration, including who authored the change.\nEvery time you update a crawler's [configuration](#tag/config/operation/patchConfig),\na new version is added.\n",
707
- "tags": [
708
- "config"
709
- ],
710
- "parameters": [
711
- {
712
- "$ref": "#/components/parameters/CrawlerIdParameter"
713
- },
714
- {
715
- "$ref": "#/components/parameters/ItemsPerPage"
716
- },
717
- {
718
- "$ref": "#/components/parameters/Page"
719
- }
720
- ],
721
- "responses": {
722
- "200": {
723
- "description": "OK",
724
- "content": {
725
- "application/json": {
726
- "schema": {
727
- "$ref": "#/components/schemas/crawlerConfigVersionsResponse"
728
- }
729
- }
730
- }
731
- },
732
- "404": {
733
- "description": "Not found."
734
- }
735
- }
736
- }
737
- },
738
- "/1/crawlers/{id}/config/versions/{version}": {
739
- "get": {
740
- "operationId": "getConfigVersion",
741
- "summary": "Retrieve a configuration version",
742
- "description": "Retrieves the specified version of the crawler configuration.\n\nYou can use this to restore a previous version of the configuration.\n",
743
- "tags": [
744
- "config"
745
- ],
746
- "parameters": [
747
- {
748
- "$ref": "#/components/parameters/CrawlerIdParameter"
749
- },
750
- {
751
- "$ref": "#/components/parameters/CrawlerVersionParameter"
752
- }
753
- ],
754
- "responses": {
755
- "200": {
756
- "description": "OK",
757
- "content": {
758
- "application/json": {
759
- "schema": {
760
- "title": "configVersion",
761
- "type": "object",
762
- "properties": {
763
- "version": {
764
- "$ref": "#/components/schemas/version"
765
- },
766
- "config": {
767
- "$ref": "#/components/schemas/Configuration"
768
- },
769
- "createdAt": {
770
- "$ref": "#/components/schemas/createdAt"
771
- },
772
- "authorId": {
773
- "$ref": "#/components/schemas/authorId"
774
- }
775
- },
776
- "required": [
777
- "version",
778
- "config",
779
- "createdAt",
780
- "authorId"
781
- ]
782
- }
783
- }
784
- }
785
- },
786
- "404": {
787
- "description": "Not found."
788
- }
789
- }
790
- }
791
- },
792
- "/1/crawlers/{id}/tasks/{taskID}": {
793
- "get": {
794
- "operationId": "getTaskStatus",
795
- "summary": "Retrieve task status",
796
- "description": "Retrieves the status of the specified tasks, whether they're pending or completed.",
797
- "tags": [
798
- "tasks"
799
- ],
800
- "parameters": [
801
- {
802
- "$ref": "#/components/parameters/CrawlerIdParameter"
803
- },
804
- {
805
- "$ref": "#/components/parameters/TaskIdParameter"
806
- }
807
- ],
808
- "responses": {
809
- "200": {
810
- "description": "OK",
811
- "content": {
812
- "application/json": {
813
- "schema": {
814
- "title": "taskStatus",
815
- "type": "object",
816
- "properties": {
817
- "pending": {
818
- "type": "boolean",
819
- "description": "Whether the task is pending."
820
- }
821
- },
822
- "required": [
823
- "pending"
824
- ]
825
- }
826
- }
827
- }
828
- },
829
- "401": {
830
- "$ref": "#/components/responses/MissingAuthorization"
831
- },
832
- "403": {
833
- "$ref": "#/components/responses/NoRightsOnCrawler"
834
- }
835
- }
836
- }
837
- },
838
- "/1/crawlers/{id}/tasks/{taskID}/cancel": {
839
- "post": {
840
- "operationId": "cancelBlockingAction",
841
- "summary": "Cancel a blocking task",
842
- "description": "Cancels a blocking task.\n\nTasks that ran into an error will block your crawler's schedule.\nTo unblock the crawler, cancel the blocking task.\n",
843
- "tags": [
844
- "tasks"
845
- ],
846
- "parameters": [
847
- {
848
- "$ref": "#/components/parameters/CrawlerIdParameter"
849
- },
850
- {
851
- "$ref": "#/components/parameters/TaskIdParameter"
852
- }
853
- ],
854
- "responses": {
855
- "200": {
856
- "description": "OK"
857
- },
858
- "400": {
859
- "$ref": "#/components/responses/InvalidRequest"
860
- },
861
- "401": {
862
- "$ref": "#/components/responses/MissingAuthorization"
863
- },
864
- "403": {
865
- "$ref": "#/components/responses/NoRightsOnCrawler"
866
- }
867
- }
868
- }
869
- },
870
- "/1/domains": {
871
- "get": {
872
- "operationId": "listDomains",
873
- "summary": "List registered domains",
874
- "description": "Lists registered domains.\n\nCrawlers will only run if the URLs match any of the registered domains.\n",
875
- "tags": [
876
- "domains"
877
- ],
878
- "parameters": [
879
- {
880
- "$ref": "#/components/parameters/ItemsPerPage"
881
- },
882
- {
883
- "$ref": "#/components/parameters/Page"
884
- },
885
- {
886
- "$ref": "#/components/parameters/AppID"
887
- }
888
- ],
889
- "responses": {
890
- "200": {
891
- "description": "Domains",
892
- "content": {
893
- "application/json": {
894
- "schema": {
895
- "$ref": "#/components/schemas/domainsResponse"
896
- }
897
- }
898
- }
899
- },
900
- "400": {
901
- "$ref": "#/components/responses/InvalidRequest"
902
- },
903
- "401": {
904
- "$ref": "#/components/responses/MissingAuthorization"
905
- },
906
- "403": {
907
- "$ref": "#/components/responses/Forbidden"
908
- }
909
- }
910
- }
911
- }
912
- },
913
- "components": {
914
- "securitySchemes": {
915
- "BasicAuth": {
916
- "type": "http",
917
- "scheme": "basic"
918
- }
919
- },
920
- "schemas": {
921
- "itemsPerPage": {
922
- "type": "integer",
923
- "description": "Number of items per page of the paginated API response.",
924
- "minimum": 1,
925
- "maximum": 100,
926
- "default": 20
927
- },
928
- "page": {
929
- "type": "integer",
930
- "description": "Current page of the paginated API response.",
931
- "minimum": 1,
932
- "maximum": 100,
933
- "default": 1
934
- },
935
- "CrawlerName": {
936
- "type": "string",
937
- "maxLength": 64,
938
- "description": "Name of the crawler.",
939
- "example": "test-crawler"
940
- },
941
- "applicationID": {
942
- "type": "string",
943
- "description": "Algolia application ID where the crawler creates and updates indices.\n"
944
- },
945
- "total": {
946
- "type": "integer",
947
- "description": "Total number of retrievable items.",
948
- "example": 100
949
- },
950
- "Pagination": {
951
- "type": "object",
952
- "description": "Pagination information.",
953
- "properties": {
954
- "itemsPerPage": {
955
- "$ref": "#/components/schemas/itemsPerPage"
956
- },
957
- "page": {
958
- "$ref": "#/components/schemas/page"
959
- },
960
- "total": {
961
- "$ref": "#/components/schemas/total"
962
- }
963
- }
964
- },
965
- "CrawlerID": {
966
- "type": "string",
967
- "description": "Universally unique identifier (UUID) of the crawler.",
968
- "example": "e0f6db8a-24f5-4092-83a4-1b2c6cb6d809"
969
- },
970
- "crawlersResponse": {
971
- "allOf": [
972
- {
973
- "$ref": "#/components/schemas/Pagination"
974
- },
975
- {
976
- "type": "object",
977
- "properties": {
978
- "items": {
979
- "type": "array",
980
- "description": "Crawlers.",
981
- "items": {
982
- "title": "crawlerResponse",
983
- "type": "object",
984
- "properties": {
985
- "id": {
986
- "$ref": "#/components/schemas/CrawlerID"
987
- },
988
- "name": {
989
- "$ref": "#/components/schemas/CrawlerName"
990
- }
991
- }
992
- }
993
- }
994
- }
995
- }
996
- ]
997
- },
998
- "cache": {
999
- "type": "object",
1000
- "description": "Whether the crawler should cache crawled pages.\n\nFor more information, see [Partial crawls with caching](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration/#partial-crawls-with-caching).\n",
1001
- "properties": {
1002
- "enabled": {
1003
- "type": "boolean",
1004
- "default": true,
1005
- "description": "Whether the crawler cache is active."
1006
- }
1007
- }
1008
- },
1009
- "urlPattern": {
1010
- "type": "string",
1011
- "description": "Use [micromatch](https://github.com/micromatch/micromatch) for negation, wildcards, and more.\n",
1012
- "example": "https://www.algolia.com/**"
1013
- },
1014
- "fileTypes": {
1015
- "type": "string",
1016
- "description": "For more information, see [Extract data from non-HTML documents](https://www.algolia.com/doc/tools/crawler/extracting-data/non-html-documents/).\n",
1017
- "enum": [
1018
- "doc",
1019
- "email",
1020
- "html",
1021
- "odp",
1022
- "ods",
1023
- "odt",
1024
- "pdf",
1025
- "ppt",
1026
- "xls"
1027
- ]
1028
- },
1029
- "hostnameAliases": {
1030
- "type": "object",
1031
- "example": {
1032
- "dev.example.com": "example.com"
1033
- },
1034
- "description": "Key-value pairs to replace matching hostnames found in a sitemap,\non a page, in canonical links, or redirects.\n\n\nDuring a crawl, this action maps one hostname to another whenever the crawler encounters specific URLs.\nThis helps with links to staging environments (like `dev.example.com`) or external hosting services (such as YouTube).\n\n\nFor example, with this `hostnameAliases` mapping:\n\n {\n hostnameAliases: {\n 'dev.example.com': 'example.com'\n }\n }\n\n1. The crawler encounters `https://dev.example.com/solutions/voice-search/`.\n\n1. `hostnameAliases` transforms the URL to `https://example.com/solutions/voice-search/`.\n\n1. The crawler follows the transformed URL (not the original).\n\n\n**`hostnameAliases` only changes URLs, not page text. In the preceding example, if the extracted text contains the string `dev.example.com`, it remains unchanged.**\n\n\nThe crawler can discover URLs in places such as:\n\n\n- Crawled pages\n\n- Sitemaps\n\n- [Canonical URLs](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration/#canonical-urls-and-crawler-behavior)\n\n- Redirects. \n\n\nHowever, `hostnameAliases` doesn't transform URLs you explicitly set in the `startUrls` or `sitemaps` parameters,\nnor does it affect the `pathsToMatch` action or other configuration elements.\n",
1035
- "additionalProperties": {
1036
- "type": "string",
1037
- "description": "Hostname that should be added in the records.",
1038
- "x-additionalPropertiesName": "hostname"
1039
- }
1040
- },
1041
- "pathAliases": {
1042
- "type": "object",
1043
- "example": {
1044
- "example.com": {
1045
- "/foo": "/bar"
1046
- }
1047
- },
1048
- "description": "Key-value pairs to replace matching paths with new values.\n\nIt doesn't replace:\n\n- URLs in the `startUrls`, `sitemaps`, `pathsToMatch`, and other settings.\n- Paths found in extracted text.\n\nThe crawl continues from the _transformed_ URLs.\n\n\nFor example, if you create a mapping for `{ \"dev.example.com\": { '/foo': '/bar' } }` and the crawler encounters `https://dev.example.com/foo/hello/`,\nit’s transformed to `https://dev.example.com/bar/hello/`.\n\n\n> Compare with the `hostnameAliases` action.\n",
1049
- "additionalProperties": {
1050
- "type": "object",
1051
- "description": "Hostname for which matching paths should be replaced.",
1052
- "x-additionalPropertiesName": "hostname",
1053
- "additionalProperties": {
1054
- "type": "string",
1055
- "description": "Key-value pair of a path that should be replaced.",
1056
- "x-additionalPropertiesName": "path"
1057
- }
1058
- }
1059
- },
1060
- "configurationRecordExtractorType": {
1061
- "type": "string",
1062
- "enum": [
1063
- "function"
1064
- ]
1065
- },
1066
- "Action": {
1067
- "type": "object",
1068
- "description": "How to process crawled URLs.\n\nEach action defines:\n\n- The targeted subset of URLs it processes.\n- What information to extract from the web pages.\n- The Algolia indices where the extracted records will be stored.\n\nIf a single web page matches several actions,\none record is generated for each action.\n",
1069
- "properties": {
1070
- "autoGenerateObjectIDs": {
1071
- "type": "boolean",
1072
- "description": "Whether to generate an `objectID` for records that don't have one.",
1073
- "default": true
1074
- },
1075
- "cache": {
1076
- "$ref": "#/components/schemas/cache"
1077
- },
1078
- "discoveryPatterns": {
1079
- "type": "array",
1080
- "description": "Which _intermediary_ web pages the crawler should visit.\nUse `discoveryPatterns` to define pages that should be visited _just_ for their links to other pages,\n_not_ their content.\nIt functions similarly to the `pathsToMatch` action but without record extraction.\n",
1081
- "items": {
1082
- "$ref": "#/components/schemas/urlPattern"
1083
- }
1084
- },
1085
- "fileTypesToMatch": {
1086
- "type": "array",
1087
- "description": "File types for crawling non-HTML documents.\n",
1088
- "maxItems": 100,
1089
- "items": {
1090
- "$ref": "#/components/schemas/fileTypes"
1091
- },
1092
- "default": [
1093
- "html"
1094
- ],
1095
- "example": [
1096
- "html",
1097
- "pdf"
1098
- ]
1099
- },
1100
- "hostnameAliases": {
1101
- "$ref": "#/components/schemas/hostnameAliases"
1102
- },
1103
- "indexName": {
1104
- "type": "string",
1105
- "maxLength": 256,
1106
- "description": "Reference to the index used to store the action's extracted records.\n`indexName` is combined with the prefix you specified in `indexPrefix`.\n",
1107
- "example": "algolia_website"
1108
- },
1109
- "name": {
1110
- "type": "string",
1111
- "description": "Unique identifier for the action. This option is required if `schedule` is set."
1112
- },
1113
- "pathAliases": {
1114
- "$ref": "#/components/schemas/pathAliases"
1115
- },
1116
- "pathsToMatch": {
1117
- "type": "array",
1118
- "description": "URLs to which this action should apply.\n\nUses [micromatch](https://github.com/micromatch/micromatch) for negation, wildcards, and more.\n",
1119
- "minItems": 1,
1120
- "maxItems": 100,
1121
- "items": {
1122
- "$ref": "#/components/schemas/urlPattern"
1123
- }
1124
- },
1125
- "recordExtractor": {
1126
- "title": "recordExtractor",
1127
- "type": "object",
1128
- "description": "Function for extracting information from a crawled page and transforming it into Algolia records for indexing.\n\nThe Crawler has an [editor](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration/#the-editor) with autocomplete and validation to help you update the `recordExtractor`.\nFor details, see the [`recordExtractor` documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/actions/#parameter-param-recordextractor).\n",
1129
- "properties": {
1130
- "__type": {
1131
- "$ref": "#/components/schemas/configurationRecordExtractorType"
1132
- },
1133
- "source": {
1134
- "type": "string",
1135
- "description": "A JavaScript function (as a string) that returns one or more Algolia records for each crawled page.\n"
1136
- }
1137
- }
1138
- },
1139
- "schedule": {
1140
- "type": "string",
1141
- "description": "How often to perform a complete crawl for this action.\n\nFor mopre information, consult the [`schedule` parameter documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/schedule/).\n"
1142
- },
1143
- "selectorsToMatch": {
1144
- "type": "array",
1145
- "description": "DOM selectors for nodes that must be present on the page to be processed.\nIf the page doesn't match any of the selectors, it's ignored.\n",
1146
- "maxItems": 100,
1147
- "items": {
1148
- "type": "string",
1149
- "description": "Prefix a selector with `!` to ignore matching pages. \n"
1150
- },
1151
- "example": [
1152
- ".products",
1153
- "!.featured"
1154
- ]
1155
- }
1156
- },
1157
- "required": [
1158
- "indexName",
1159
- "recordExtractor"
1160
- ]
1161
- },
1162
- "ignoreCanonicalTo": {
1163
- "oneOf": [
1164
- {
1165
- "type": "boolean",
1166
- "description": "Determines if the crawler should extract records from a page with a [canonical URL](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration/#canonical-urls-and-crawler-behavior).\n\nIf `ignoreCanonicalTo` is set to:\n\n- `true` all canonical URLs are ignored.\n- One or more URL patterns, the crawler will ignore the canonical URL if it matches a pattern.\n"
1167
- },
1168
- {
1169
- "type": "array",
1170
- "description": "Canonical URLs or URL patterns to ignore.\n",
1171
- "items": {
1172
- "type": "string",
1173
- "description": "Pattern or URL.\n\nCanonical URLs are only ignored if they match this pattern.\n"
1174
- }
1175
- }
1176
- ]
1177
- },
1178
- "supportedLanguage": {
1179
- "type": "string",
1180
- "description": "ISO code for a supported language.",
1181
- "enum": [
1182
- "af",
1183
- "ar",
1184
- "az",
1185
- "bg",
1186
- "bn",
1187
- "ca",
1188
- "cs",
1189
- "cy",
1190
- "da",
1191
- "de",
1192
- "el",
1193
- "en",
1194
- "eo",
1195
- "es",
1196
- "et",
1197
- "eu",
1198
- "fa",
1199
- "fi",
1200
- "fo",
1201
- "fr",
1202
- "ga",
1203
- "gl",
1204
- "he",
1205
- "hi",
1206
- "hu",
1207
- "hy",
1208
- "id",
1209
- "is",
1210
- "it",
1211
- "ja",
1212
- "ka",
1213
- "kk",
1214
- "ko",
1215
- "ku",
1216
- "ky",
1217
- "lt",
1218
- "lv",
1219
- "mi",
1220
- "mn",
1221
- "mr",
1222
- "ms",
1223
- "mt",
1224
- "nb",
1225
- "nl",
1226
- "no",
1227
- "ns",
1228
- "pl",
1229
- "ps",
1230
- "pt",
1231
- "pt-br",
1232
- "qu",
1233
- "ro",
1234
- "ru",
1235
- "sk",
1236
- "sq",
1237
- "sv",
1238
- "sw",
1239
- "ta",
1240
- "te",
1241
- "th",
1242
- "tl",
1243
- "tn",
1244
- "tr",
1245
- "tt",
1246
- "uk",
1247
- "ur",
1248
- "uz",
1249
- "zh"
1250
- ]
1251
- },
1252
- "userData": {
1253
- "example": {
1254
- "settingID": "f2a7b51e3503acc6a39b3784ffb84300",
1255
- "pluginVersion": "1.6.0"
1256
- },
1257
- "description": "An object with custom data.\n\nYou can store up to 32kB as custom data.\n",
1258
- "default": {},
1259
- "x-categories": [
1260
- "Advanced"
1261
- ]
1262
- },
1263
- "maxFacetHits": {
1264
- "type": "integer",
1265
- "description": "Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).",
1266
- "maximum": 100,
1267
- "default": 10,
1268
- "x-categories": [
1269
- "Advanced"
1270
- ]
1271
- },
1272
- "baseIndexSettings": {
1273
- "type": "object",
1274
- "additionalProperties": false,
1275
- "properties": {
1276
- "attributesForFaceting": {
1277
- "type": "array",
1278
- "items": {
1279
- "type": "string"
1280
- },
1281
- "example": [
1282
- "author",
1283
- "filterOnly(isbn)",
1284
- "searchable(edition)",
1285
- "afterDistinct(category)",
1286
- "afterDistinct(searchable(publisher))"
1287
- ],
1288
- "description": "Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).\n\nFacets are attributes that let you categorize search results.\nThey can be used for filtering search results.\nBy default, no attribute is used for faceting.\nAttribute names are case-sensitive.\n\n**Modifiers**\n\n- `filterOnly(\"ATTRIBUTE\")`.\n Allows the attribute to be used as a filter but doesn't evaluate the facet values.\n\n- `searchable(\"ATTRIBUTE\")`.\n Allows searching for facet values.\n\n- `afterDistinct(\"ATTRIBUTE\")`.\n Evaluates the facet count _after_ deduplication with `distinct`.\n This ensures accurate facet counts.\n You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.\n",
1289
- "default": [],
1290
- "x-categories": [
1291
- "Faceting"
1292
- ]
1293
- },
1294
- "replicas": {
1295
- "type": "array",
1296
- "items": {
1297
- "type": "string"
1298
- },
1299
- "example": [
1300
- "virtual(prod_products_price_asc)",
1301
- "dev_products_replica"
1302
- ],
1303
- "description": "Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).\n\nReplicas are copies of a primary index with the same records but different settings, synonyms, or rules.\nIf you want to offer a different ranking or sorting of your search results, you'll use replica indices.\nAll index operations on a primary index are automatically forwarded to its replicas.\nTo add a replica index, you must provide the complete set of replicas to this parameter.\nIf you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index.\n\n**Modifier**\n\n- `virtual(\"REPLICA\")`.\n Create a virtual replica,\n Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).\n",
1304
- "default": [],
1305
- "x-categories": [
1306
- "Ranking"
1307
- ]
1308
- },
1309
- "paginationLimitedTo": {
1310
- "type": "integer",
1311
- "example": 100,
1312
- "description": "Maximum number of search results that can be obtained through pagination.\n\nHigher pagination limits might slow down your search.\nFor pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.\n",
1313
- "default": 1000,
1314
- "maximum": 20000
1315
- },
1316
- "unretrievableAttributes": {
1317
- "type": "array",
1318
- "items": {
1319
- "type": "string"
1320
- },
1321
- "example": [
1322
- "total_sales"
1323
- ],
1324
- "description": "Attributes that can't be retrieved at query time.\n\nThis can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/),\nbut don't want to include it in the search results.\nAttribute names are case-sensitive.\n",
1325
- "default": [],
1326
- "x-categories": [
1327
- "Attributes"
1328
- ]
1329
- },
1330
- "disableTypoToleranceOnWords": {
1331
- "type": "array",
1332
- "items": {
1333
- "type": "string"
1334
- },
1335
- "example": [
1336
- "wheel",
1337
- "1X2BCD"
1338
- ],
1339
- "description": "Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words).\nThis also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.\n",
1340
- "default": [],
1341
- "x-categories": [
1342
- "Typos"
1343
- ]
1344
- },
1345
- "attributesToTransliterate": {
1346
- "description": "Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead).\n\nTransliteration supports searching in any of the Japanese writing systems.\nTo support transliteration, you must set the indexing language to Japanese.\nAttribute names are case-sensitive.\n",
1347
- "type": "array",
1348
- "items": {
1349
- "type": "string"
1350
- },
1351
- "example": [
1352
- "name",
1353
- "description"
1354
- ],
1355
- "x-categories": [
1356
- "Languages"
1357
- ]
1358
- },
1359
- "camelCaseAttributes": {
1360
- "type": "array",
1361
- "items": {
1362
- "type": "string"
1363
- },
1364
- "example": [
1365
- "description"
1366
- ],
1367
- "description": "Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.\nAttribute names are case-sensitive.\n",
1368
- "default": [],
1369
- "x-categories": [
1370
- "Languages"
1371
- ]
1372
- },
1373
- "decompoundedAttributes": {
1374
- "type": "object",
1375
- "example": {
1376
- "de": [
1377
- "name"
1378
- ]
1379
- },
1380
- "description": "Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding).\nAttribute names are case-sensitive.\n\nCompound words are formed by combining two or more individual words,\nand are particularly prevalent in Germanic languages—for example, \"firefighter\".\nWith decompounding, the individual components are indexed separately.\n\nYou can specify different lists for different languages.\nDecompounding is supported for these languages:\nDutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",
1381
- "default": {},
1382
- "x-categories": [
1383
- "Languages"
1384
- ]
1385
- },
1386
- "indexLanguages": {
1387
- "type": "array",
1388
- "items": {
1389
- "$ref": "#/components/schemas/supportedLanguage"
1390
- },
1391
- "example": [
1392
- "ja"
1393
- ],
1394
- "description": "Languages for language-specific processing steps, such as word detection and dictionary settings.\n\n**You should always specify an indexing language.**\nIf you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),\nor the languages you specified with the `ignorePlurals` or `removeStopWords` parameters.\nThis can lead to unexpected search results.\nFor more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).\n",
1395
- "default": [],
1396
- "x-categories": [
1397
- "Languages"
1398
- ]
1399
- },
1400
- "disablePrefixOnAttributes": {
1401
- "type": "array",
1402
- "items": {
1403
- "type": "string"
1404
- },
1405
- "example": [
1406
- "sku"
1407
- ],
1408
- "description": "Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).\nAttribute names are case-sensitive.\n",
1409
- "default": [],
1410
- "x-categories": [
1411
- "Query strategy"
1412
- ]
1413
- },
1414
- "allowCompressionOfIntegerArray": {
1415
- "type": "boolean",
1416
- "description": "Whether arrays with exclusively non-negative integers should be compressed for better performance.\nIf true, the compressed arrays may be reordered.\n",
1417
- "default": false,
1418
- "x-categories": [
1419
- "Performance"
1420
- ]
1421
- },
1422
- "numericAttributesForFiltering": {
1423
- "type": "array",
1424
- "items": {
1425
- "type": "string"
1426
- },
1427
- "description": "Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).\nAttribute names are case-sensitive.\n\nBy default, all numeric attributes are available as numerical filters.\nFor faster indexing, reduce the number of numeric attributes.\n\nTo turn off filtering for all numeric attributes, specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`.\n\n**Modifier**\n\n- `equalOnly(\"ATTRIBUTE\")`.\n Support only filtering based on equality comparisons `=` and `!=`.\n",
1428
- "example": [
1429
- "equalOnly(quantity)",
1430
- "popularity"
1431
- ],
1432
- "default": [],
1433
- "x-categories": [
1434
- "Performance"
1435
- ]
1436
- },
1437
- "separatorsToIndex": {
1438
- "type": "string",
1439
- "example": "+#",
1440
- "description": "Control which non-alphanumeric characters are indexed.\n\nBy 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) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`).\nTo include such characters, define them with `separatorsToIndex`.\n\nSeparators are all non-letter characters except spaces and currency characters, such as $€£¥.\n\nWith `separatorsToIndex`, Algolia treats separator characters as separate words.\nFor example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.\n",
1441
- "default": "",
1442
- "x-categories": [
1443
- "Typos"
1444
- ]
1445
- },
1446
- "searchableAttributes": {
1447
- "type": "array",
1448
- "items": {
1449
- "type": "string"
1450
- },
1451
- "example": [
1452
- "title,alternative_title",
1453
- "author",
1454
- "unordered(text)",
1455
- "emails.personal"
1456
- ],
1457
- "description": "Attributes used for searching. Attribute names are case-sensitive.\n\nBy default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off.\nWith a non-empty list, Algolia only returns results with matches in the selected attributes.\nIn addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first.\nTo make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`.\nAttributes with the same priority are always unordered.\n\nFor more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).\n\n**Modifier**\n\n- `unordered(\"ATTRIBUTE\")`.\n Ignore the position of a match within the attribute.\n\nWithout a modifier, matches at the beginning of an attribute rank higher than matches at the end.\n",
1458
- "default": [],
1459
- "x-categories": [
1460
- "Attributes"
1461
- ]
1462
- },
1463
- "userData": {
1464
- "$ref": "#/components/schemas/userData"
1465
- },
1466
- "customNormalization": {
1467
- "description": "Characters and their normalized replacements.\nThis overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).\n",
1468
- "type": "object",
1469
- "example": {
1470
- "default": {
1471
- "ä": "ae",
1472
- "ü": "ue"
1473
- }
1474
- },
1475
- "additionalProperties": {
1476
- "type": "object",
1477
- "additionalProperties": {
1478
- "type": "string"
1479
- }
1480
- },
1481
- "x-categories": [
1482
- "Languages"
1483
- ]
1484
- },
1485
- "attributeForDistinct": {
1486
- "description": "Attribute that should be used to establish groups of results.\nAttribute names are case-sensitive.\n\nAll records with the same value for this attribute are considered a group.\nYou can combine `attributeForDistinct` with the `distinct` search parameter to control\nhow many items per group are included in the search results.\n\nIf you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting.\nThis applies faceting _after_ deduplication, which will result in accurate facet counts.\n",
1487
- "example": "url",
1488
- "type": "string"
1489
- },
1490
- "maxFacetHits": {
1491
- "$ref": "#/components/schemas/maxFacetHits"
1492
- },
1493
- "keepDiacriticsOnCharacters": {
1494
- "type": "string",
1495
- "example": "øé",
1496
- "description": "Characters for which diacritics should be preserved.\n\nBy default, Algolia removes diacritics from letters.\nFor example, `é` becomes `e`. If this causes issues in your search,\nyou can specify characters that should keep their diacritics.\n",
1497
- "default": "",
1498
- "x-categories": [
1499
- "Languages"
1500
- ]
1501
- },
1502
- "customRanking": {
1503
- "type": "array",
1504
- "items": {
1505
- "type": "string"
1506
- },
1507
- "example": [
1508
- "desc(popularity)",
1509
- "asc(price)"
1510
- ],
1511
- "description": "Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).\nAttribute names are case-sensitive.\n\nThe custom ranking attributes decide which items are shown first if the other ranking criteria are equal.\n\nRecords with missing values for your selected custom ranking attributes are always sorted last.\nBoolean attributes are sorted based on their alphabetical order.\n\n**Modifiers**\n\n- `asc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in ascending order.\n\n- `desc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in descending order.\n\nIf you use two or more custom ranking attributes,\n[reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes,\nor the other attributes will never be applied.\n",
1512
- "default": [],
1513
- "x-categories": [
1514
- "Ranking"
1515
- ]
1516
- }
1517
- }
1518
- },
1519
- "attributesToRetrieve": {
1520
- "type": "array",
1521
- "items": {
1522
- "type": "string"
1523
- },
1524
- "example": [
1525
- "author",
1526
- "title",
1527
- "content"
1528
- ],
1529
- "description": "Attributes to include in the API response\nTo reduce the size of your response, you can retrieve only some of the attributes.\nAttribute names are case-sensitive\n- `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings.\n- To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`.\n- The `objectID` attribute is always included.\n",
1530
- "default": [
1531
- "*"
1532
- ],
1533
- "x-categories": [
1534
- "Attributes"
1535
- ]
1536
- },
1537
- "relevancyStrictness": {
1538
- "type": "integer",
1539
- "example": 90,
1540
- "description": "Relevancy threshold below which less relevant results aren't included in the results\nYou can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).\nUse this setting to strike a balance between the relevance and number of returned results.\n",
1541
- "default": 100,
1542
- "x-categories": [
1543
- "Ranking"
1544
- ]
1545
- },
1546
- "attributesToHighlight": {
1547
- "type": "array",
1548
- "items": {
1549
- "type": "string"
1550
- },
1551
- "example": [
1552
- "author",
1553
- "title",
1554
- "conten",
1555
- "content"
1556
- ],
1557
- "description": "Attributes to highlight\nBy default, all searchable attributes are highlighted.\nUse `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.\nAttribute names are case-sensitive\nWith highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`.\nYou can use this to visually highlight matching parts of a search query in your UI\nFor more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).\n",
1558
- "x-categories": [
1559
- "Highlighting and Snippeting"
1560
- ]
1561
- },
1562
- "attributesToSnippet": {
1563
- "type": "array",
1564
- "items": {
1565
- "type": "string"
1566
- },
1567
- "example": [
1568
- "content:80",
1569
- "description"
1570
- ],
1571
- "description": "Attributes for which to enable snippets.\nAttribute names are case-sensitive\nSnippets provide additional context to matched words.\nIf you enable snippets, they include 10 words, including the matched word.\nThe matched word will also be wrapped by HTML tags for highlighting.\nYou can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`,\nwhere `NUMBER` is the number of words to be extracted.\n",
1572
- "default": [],
1573
- "x-categories": [
1574
- "Highlighting and Snippeting"
1575
- ]
1576
- },
1577
- "highlightPreTag": {
1578
- "type": "string",
1579
- "description": "HTML tag to insert before the highlighted parts in all highlighted results and snippets.",
1580
- "default": "<em>",
1581
- "x-categories": [
1582
- "Highlighting and Snippeting"
1583
- ]
1584
- },
1585
- "highlightPostTag": {
1586
- "type": "string",
1587
- "description": "HTML tag to insert after the highlighted parts in all highlighted results and snippets.",
1588
- "default": "</em>",
1589
- "x-categories": [
1590
- "Highlighting and Snippeting"
1591
- ]
1592
- },
1593
- "snippetEllipsisText": {
1594
- "type": "string",
1595
- "description": "String used as an ellipsis indicator when a snippet is truncated.",
1596
- "default": "…",
1597
- "x-categories": [
1598
- "Highlighting and Snippeting"
1599
- ]
1600
- },
1601
- "restrictHighlightAndSnippetArrays": {
1602
- "type": "boolean",
1603
- "description": "Whether to restrict highlighting and snippeting to items that at least partially matched the search query.\nBy default, all items are highlighted and snippeted.\n",
1604
- "default": false,
1605
- "x-categories": [
1606
- "Highlighting and Snippeting"
1607
- ]
1608
- },
1609
- "hitsPerPage": {
1610
- "type": "integer",
1611
- "description": "Number of hits per page.",
1612
- "default": 20,
1613
- "minimum": 1,
1614
- "maximum": 1000,
1615
- "x-categories": [
1616
- "Pagination"
1617
- ]
1618
- },
1619
- "minWordSizefor1Typo": {
1620
- "type": "integer",
1621
- "description": "Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).",
1622
- "default": 4,
1623
- "x-categories": [
1624
- "Typos"
1625
- ]
1626
- },
1627
- "minWordSizefor2Typos": {
1628
- "type": "integer",
1629
- "description": "Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).",
1630
- "default": 8,
1631
- "x-categories": [
1632
- "Typos"
1633
- ]
1634
- },
1635
- "typoToleranceEnum": {
1636
- "type": "string",
1637
- "title": "typo tolerance",
1638
- "description": "- `min`. Return matches with the lowest number of typos.\n For example, if you have matches without typos, only include those.\n But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos).\n- `strict`. Return matches with the two lowest numbers of typos.\n With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.\n",
1639
- "enum": [
1640
- "min",
1641
- "strict",
1642
- "true",
1643
- "false"
1644
- ]
1645
- },
1646
- "typoTolerance": {
1647
- "description": "Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.\n\nIf typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.\n",
1648
- "oneOf": [
1649
- {
1650
- "type": "boolean",
1651
- "default": true,
1652
- "description": "Whether typo tolerance is active. If true, matches with typos are included in the search results and rank after exact matches."
1653
- },
1654
- {
1655
- "$ref": "#/components/schemas/typoToleranceEnum"
1656
- }
1657
- ],
1658
- "x-categories": [
1659
- "Typos"
1660
- ]
1661
- },
1662
- "allowTyposOnNumericTokens": {
1663
- "type": "boolean",
1664
- "description": "Whether to allow typos on numbers in the search query\nTurn off this setting to reduce the number of irrelevant matches\nwhen searching in large sets of similar numbers.\n",
1665
- "default": true,
1666
- "x-categories": [
1667
- "Typos"
1668
- ]
1669
- },
1670
- "disableTypoToleranceOnAttributes": {
1671
- "type": "array",
1672
- "items": {
1673
- "type": "string"
1674
- },
1675
- "example": [
1676
- "sku"
1677
- ],
1678
- "description": "Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).\nAttribute names are case-sensitive\nReturning only exact matches can help when\n- [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/).\n- Reducing the number of matches when you have too many.\n This can happen with attributes that are long blocks of text, such as product descriptions\nConsider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.\n",
1679
- "default": [],
1680
- "x-categories": [
1681
- "Typos"
1682
- ]
1683
- },
1684
- "booleanString": {
1685
- "type": "string",
1686
- "enum": [
1687
- "true",
1688
- "false"
1689
- ]
1690
- },
1691
- "ignorePlurals": {
1692
- "description": "Treat singular, plurals, and other forms of declensions as equivalent.\nYou should only use this feature for the languages used in your index.\n",
1693
- "example": [
1694
- "ca",
1695
- "es"
1696
- ],
1697
- "oneOf": [
1698
- {
1699
- "type": "array",
1700
- "description": "ISO code for languages for which this feature should be active.\nThis overrides languages you set with `queryLanguages`.\n",
1701
- "items": {
1702
- "$ref": "#/components/schemas/supportedLanguage"
1703
- }
1704
- },
1705
- {
1706
- "$ref": "#/components/schemas/booleanString"
1707
- },
1708
- {
1709
- "type": "boolean",
1710
- "description": "If true, `ignorePlurals` is active for all languages included in `queryLanguages`, or for all supported languages, if `queryLanguges` is empty.\nIf false, singulars, plurals, and other declensions won't be considered equivalent.\n",
1711
- "default": false
1712
- }
1713
- ],
1714
- "x-categories": [
1715
- "Languages"
1716
- ]
1717
- },
1718
- "removeStopWords": {
1719
- "description": "Removes stop words from the search query.\n\nStop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own.\nIn English, \"the\", \"a\", or \"and\" are stop words.\n\nYou should only use this feature for the languages used in your index.\n",
1720
- "example": [
1721
- "ca",
1722
- "es"
1723
- ],
1724
- "oneOf": [
1725
- {
1726
- "type": "array",
1727
- "description": "ISO code for languages for which stop words should be removed. This overrides languages you set in `queryLanguges`.",
1728
- "items": {
1729
- "$ref": "#/components/schemas/supportedLanguage"
1730
- }
1731
- },
1732
- {
1733
- "type": "boolean",
1734
- "default": false,
1735
- "description": "If true, stop words are removed for all languages you included in `queryLanguages`, or for all supported languages, if `queryLanguages` is empty.\nIf false, stop words are not removed.\n"
1736
- }
1737
- ],
1738
- "x-categories": [
1739
- "Languages"
1740
- ]
1741
- },
1742
- "queryLanguages": {
1743
- "type": "array",
1744
- "items": {
1745
- "$ref": "#/components/schemas/supportedLanguage"
1746
- },
1747
- "example": [
1748
- "es"
1749
- ],
1750
- "description": "Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries \nThis setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings.\nThis setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages.\nTo support this, you must place the CJK language **first** \n**You should always specify a query language.**\nIf you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),\nor the languages you specified with the `ignorePlurals` or `removeStopWords` parameters.\nThis can lead to unexpected search results.\nFor more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).\n",
1751
- "default": [],
1752
- "x-categories": [
1753
- "Languages"
1754
- ]
1755
- },
1756
- "decompoundQuery": {
1757
- "type": "boolean",
1758
- "description": "Whether to split compound words in the query into their building blocks\nFor more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words).\nWord segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",
1759
- "default": true,
1760
- "x-categories": [
1761
- "Languages"
1762
- ]
1763
- },
1764
- "enableRules": {
1765
- "type": "boolean",
1766
- "description": "Whether to enable rules.",
1767
- "default": true,
1768
- "x-categories": [
1769
- "Rules"
1770
- ]
1771
- },
1772
- "enablePersonalization": {
1773
- "type": "boolean",
1774
- "description": "Whether to enable Personalization.",
1775
- "default": false,
1776
- "x-categories": [
1777
- "Personalization"
1778
- ]
1779
- },
1780
- "queryType": {
1781
- "type": "string",
1782
- "enum": [
1783
- "prefixLast",
1784
- "prefixAll",
1785
- "prefixNone"
1786
- ],
1787
- "description": "Determines if and how query words are interpreted as prefixes.\n\nBy default, only the last query word is treated as a prefix (`prefixLast`).\nTo turn off prefix search, use `prefixNone`.\nAvoid `prefixAll`, which treats all query words as prefixes.\nThis might lead to counterintuitive results and makes your search slower.\n\nFor more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).\n",
1788
- "default": "prefixLast",
1789
- "x-categories": [
1790
- "Query strategy"
1791
- ]
1792
- },
1793
- "removeWordsIfNoResults": {
1794
- "type": "string",
1795
- "enum": [
1796
- "none",
1797
- "lastWords",
1798
- "firstWords",
1799
- "allOptional"
1800
- ],
1801
- "example": "firstWords",
1802
- "description": "Strategy for removing words from the query when it doesn't return any results.\nThis helps to avoid returning empty search results.\n\n- `none`.\n No words are removed when a query doesn't return results.\n\n- `lastWords`.\n Treat the last (then second to last, then third to last) word as optional,\n until there are results or at most 5 words have been removed.\n\n- `firstWords`.\n Treat the first (then second, then third) word as optional,\n until there are results or at most 5 words have been removed.\n\n- `allOptional`.\n Treat all words as optional.\n\nFor more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).\n",
1803
- "default": "none",
1804
- "x-categories": [
1805
- "Query strategy"
1806
- ]
1807
- },
1808
- "mode": {
1809
- "type": "string",
1810
- "enum": [
1811
- "neuralSearch",
1812
- "keywordSearch"
1813
- ],
1814
- "description": "Search mode the index will use to query for results.\n\nThis setting only applies to indices, for which Algolia enabled NeuralSearch for you.\n",
1815
- "default": "keywordSearch",
1816
- "x-categories": [
1817
- "Query strategy"
1818
- ]
1819
- },
1820
- "semanticSearch": {
1821
- "type": "object",
1822
- "description": "Settings for the semantic search part of NeuralSearch.\nOnly used when `mode` is `neuralSearch`.\n",
1823
- "properties": {
1824
- "eventSources": {
1825
- "oneOf": [
1826
- {
1827
- "type": "array",
1828
- "description": "Indices from which to collect click and conversion events.\n\nIf null, the current index and all its replicas are used.\n",
1829
- "items": {
1830
- "type": "string"
1831
- }
1832
- },
1833
- {
1834
- "type": "null"
1835
- }
1836
- ]
1837
- }
1838
- }
1839
- },
1840
- "advancedSyntax": {
1841
- "type": "boolean",
1842
- "description": "Whether to support phrase matching and excluding words from search queries\nUse the `advancedSyntaxFeatures` parameter to control which feature is supported.\n",
1843
- "default": false,
1844
- "x-categories": [
1845
- "Query strategy"
1846
- ]
1847
- },
1848
- "optionalWordsArray": {
1849
- "type": "array",
1850
- "items": {
1851
- "type": "string"
1852
- },
1853
- "example": [
1854
- "blue",
1855
- "iphone case"
1856
- ],
1857
- "description": "List of [optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).",
1858
- "default": [],
1859
- "x-categories": [
1860
- "Query strategy"
1861
- ]
1862
- },
1863
- "optionalWords": {
1864
- "description": "Words that should be considered optional when found in the query.\n\nBy default, records must match all words in the search query to be included in the search results.\nAdding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words.\nFor example, if the search query is \"action video\" and \"video\" is an optional word,\nthe search engine runs two queries. One for \"action video\" and one for \"action\".\nRecords that match all words are ranked higher.\n\nFor a search query with 4 or more words **and** all its words are optional,\nthe number of matched words required for a record to be included in the search results increases for every 1,000 records:\n\n- If `optionalWords` has less than 10 words, the required number of matched words increases by 1:\n results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.\n- 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).\n For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.\n\nFor 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).\n",
1865
- "oneOf": [
1866
- {
1867
- "type": "string"
1868
- },
1869
- {
1870
- "type": "null"
1871
- },
1872
- {
1873
- "$ref": "#/components/schemas/optionalWordsArray"
1874
- }
1875
- ]
1876
- },
1877
- "disableExactOnAttributes": {
1878
- "type": "array",
1879
- "items": {
1880
- "type": "string"
1881
- },
1882
- "example": [
1883
- "description"
1884
- ],
1885
- "description": "Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).\nAttribute names are case-sensitive\nThis can be useful for attributes with long values, where the likelihood of an exact match is high,\nsuch as product descriptions.\nTurning off the Exact ranking criterion for these attributes favors exact matching on other attributes.\nThis reduces the impact of individual attributes with a lot of content on ranking.\n",
1886
- "default": [],
1887
- "x-categories": [
1888
- "Query strategy"
1889
- ]
1890
- },
1891
- "exactOnSingleWordQuery": {
1892
- "type": "string",
1893
- "enum": [
1894
- "attribute",
1895
- "none",
1896
- "word"
1897
- ],
1898
- "description": "Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.\n\n- `attribute`.\n The Exact ranking criterion is 1 if the query word and attribute value are the same.\n For example, a search for \"road\" will match the value \"road\", but not \"road trip\".\n\n- `none`.\n The Exact ranking criterion is ignored on single-word searches.\n\n- `word`.\n The Exact ranking criterion is 1 if the query word is found in the attribute value.\n The query word must have at least 3 characters and must not be a stop word.\n Only exact matches will be highlighted,\n partial and prefix matches won't.\n",
1899
- "default": "attribute",
1900
- "x-categories": [
1901
- "Query strategy"
1902
- ]
1903
- },
1904
- "alternativesAsExact": {
1905
- "type": "string",
1906
- "enum": [
1907
- "ignorePlurals",
1908
- "singleWordSynonym",
1909
- "multiWordsSynonym",
1910
- "ignoreConjugations"
1911
- ],
1912
- "x-categories": [
1913
- "Query strategy"
1914
- ]
1915
- },
1916
- "IndexSettings_alternativesAsExact": {
1917
- "type": "array",
1918
- "items": {
1919
- "$ref": "#/components/schemas/alternativesAsExact"
1920
- },
1921
- "description": "Determine which plurals and synonyms should be considered an exact matches\nBy default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching.\nFor example\n- \"swimsuit\" and \"swimsuits\" are treated the same\n- \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms))\n- `ignorePlurals`.\n Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches\n- `singleWordSynonym`.\n Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches\n- `multiWordsSynonym`.\n Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.\n",
1922
- "default": [
1923
- "ignorePlurals",
1924
- "singleWordSynonym"
1925
- ],
1926
- "x-categories": [
1927
- "Query strategy"
1928
- ]
1929
- },
1930
- "advancedSyntaxFeatures": {
1931
- "type": "string",
1932
- "enum": [
1933
- "exactPhrase",
1934
- "excludeWords"
1935
- ],
1936
- "x-categories": [
1937
- "Query strategy"
1938
- ]
1939
- },
1940
- "IndexSettings_advancedSyntaxFeatures": {
1941
- "type": "array",
1942
- "items": {
1943
- "$ref": "#/components/schemas/advancedSyntaxFeatures"
1944
- },
1945
- "description": "Advanced search syntax features you want to support\n- `exactPhrase`.\n Phrases in quotes must match exactly.\n For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\"\n- `excludeWords`.\n Query words prefixed with a `-` must not occur in a record.\n For example, `search -engine` matches records that contain \"search\" but not \"engine\"\nThis setting only has an effect if `advancedSyntax` is true.\n",
1946
- "default": [
1947
- "exactPhrase",
1948
- "excludeWords"
1949
- ],
1950
- "x-categories": [
1951
- "Query strategy"
1952
- ]
1953
- },
1954
- "distinct": {
1955
- "description": "Determines how many records of a group are included in the search results.\n\nRecords with the same value for the `attributeForDistinct` attribute are considered a group.\nThe `distinct` setting controls how many members of the group are returned.\nThis is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).\n\nThe `distinct` setting is ignored if `attributeForDistinct` is not set.\n",
1956
- "example": 1,
1957
- "oneOf": [
1958
- {
1959
- "type": "boolean",
1960
- "description": "Whether deduplication is turned on. If true, only one member of a group is shown in the search results."
1961
- },
1962
- {
1963
- "type": "integer",
1964
- "description": "Number of members of a group of records to include in the search results.\n\n- Don't use `distinct > 1` for records that might be [promoted by rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits/).\n The number of hits won't be correct and faceting won't work as expected.\n- With `distinct > 1`, the `hitsPerPage` parameter controls the number of returned groups.\n For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned.\n Likewise, the `nbHits` response attribute contains the number of returned groups.\n",
1965
- "minimum": 0,
1966
- "maximum": 4,
1967
- "default": 0
1968
- }
1969
- ],
1970
- "x-categories": [
1971
- "Advanced"
1972
- ]
1973
- },
1974
- "replaceSynonymsInHighlight": {
1975
- "type": "boolean",
1976
- "description": "Whether to replace a highlighted word with the matched synonym\nBy default, the original words are highlighted even if a synonym matches.\nFor example, with `home` as a synonym for `house` and a search for `home`,\nrecords matching either \"home\" or \"house\" are included in the search results,\nand either \"home\" or \"house\" are highlighted\nWith `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records,\nbut all occurrences of \"house\" are replaced by \"home\" in the highlighted response.\n",
1977
- "default": false,
1978
- "x-categories": [
1979
- "Highlighting and Snippeting"
1980
- ]
1981
- },
1982
- "minProximity": {
1983
- "type": "integer",
1984
- "minimum": 1,
1985
- "maximum": 7,
1986
- "description": "Minimum proximity score for two matching words\nThis adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)\nby equally scoring matches that are farther apart\nFor example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.\n",
1987
- "default": 1,
1988
- "x-categories": [
1989
- "Advanced"
1990
- ]
1991
- },
1992
- "responseFields": {
1993
- "type": "array",
1994
- "items": {
1995
- "type": "string"
1996
- },
1997
- "description": "Properties to include in the API response of search and browse requests\nBy default, all response properties are included.\nTo reduce the response size, you can select which properties should be included\nAn empty list may lead to an empty API response (except properties you can't exclude)\nYou can't exclude these properties:\n`message`, `warning`, `cursor`, `abTestVariantID`,\nor any property added by setting `getRankingInfo` to true\nYour search depends on the `hits` field. If you omit this field, searches won't return any results.\nYour UI might also depend on other properties, for example, for pagination.\nBefore restricting the response size, check the impact on your search experience.\n",
1998
- "default": [
1999
- "*"
2000
- ],
2001
- "x-categories": [
2002
- "Advanced"
2003
- ]
2004
- },
2005
- "maxValuesPerFacet": {
2006
- "type": "integer",
2007
- "description": "Maximum number of facet values to return for each facet.",
2008
- "default": 100,
2009
- "maximum": 1000,
2010
- "x-categories": [
2011
- "Faceting"
2012
- ]
2013
- },
2014
- "sortFacetValuesBy": {
2015
- "type": "string",
2016
- "description": "Order in which to retrieve facet values\n- `count`.\n Facet values are retrieved by decreasing count.\n The count is the number of matching records containing this facet value\n- `alpha`.\n Retrieve facet values alphabetically\nThis setting doesn't influence how facet values are displayed in your UI (see `renderingContent`).\nFor more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).\n",
2017
- "default": "count",
2018
- "x-categories": [
2019
- "Faceting"
2020
- ]
2021
- },
2022
- "attributeCriteriaComputedByMinProximity": {
2023
- "type": "boolean",
2024
- "description": "Whether the best matching attribute should be determined by minimum proximity\nThis setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting.\nIf true, the best matching attribute is selected based on the minimum proximity of multiple matches.\nOtherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.\n",
2025
- "default": false,
2026
- "x-categories": [
2027
- "Advanced"
2028
- ]
2029
- },
2030
- "order": {
2031
- "description": "Explicit order of facets or facet values.\n\nThis setting lets you always show specific facets or facet values at the top of the list.\n",
2032
- "type": "array",
2033
- "items": {
2034
- "type": "string"
2035
- }
2036
- },
2037
- "facets": {
2038
- "description": "Order of facet names.",
2039
- "type": "object",
2040
- "additionalProperties": false,
2041
- "properties": {
2042
- "order": {
2043
- "$ref": "#/components/schemas/order"
2044
- }
2045
- }
2046
- },
2047
- "sortRemainingBy": {
2048
- "description": "Order of facet values that aren't explicitly positioned with the `order` setting.\n\n- `count`.\n Order remaining facet values by decreasing count.\n The count is the number of matching records containing this facet value.\n\n- `alpha`.\n Sort facet values alphabetically.\n\n- `hidden`.\n Don't show facet values that aren't explicitly positioned.\n",
2049
- "type": "string",
2050
- "enum": [
2051
- "count",
2052
- "alpha",
2053
- "hidden"
2054
- ]
2055
- },
2056
- "hide": {
2057
- "description": "Hide facet values.",
2058
- "type": "array",
2059
- "items": {
2060
- "type": "string"
2061
- }
2062
- },
2063
- "value": {
2064
- "type": "object",
2065
- "additionalProperties": false,
2066
- "properties": {
2067
- "order": {
2068
- "$ref": "#/components/schemas/order"
2069
- },
2070
- "sortRemainingBy": {
2071
- "$ref": "#/components/schemas/sortRemainingBy"
2072
- },
2073
- "hide": {
2074
- "$ref": "#/components/schemas/hide"
2075
- }
2076
- }
2077
- },
2078
- "values": {
2079
- "description": "Order of facet values. One object for each facet.",
2080
- "type": "object",
2081
- "additionalProperties": {
2082
- "x-additionalPropertiesName": "facet",
2083
- "$ref": "#/components/schemas/value"
2084
- }
2085
- },
2086
- "facetOrdering": {
2087
- "description": "Order of facet names and facet values in your UI.",
2088
- "type": "object",
2089
- "additionalProperties": false,
2090
- "properties": {
2091
- "facets": {
2092
- "$ref": "#/components/schemas/facets"
2093
- },
2094
- "values": {
2095
- "$ref": "#/components/schemas/values"
2096
- }
2097
- }
2098
- },
2099
- "redirectURL": {
2100
- "description": "The redirect rule container.",
2101
- "type": "object",
2102
- "additionalProperties": false,
2103
- "properties": {
2104
- "url": {
2105
- "type": "string"
2106
- }
2107
- }
2108
- },
2109
- "bannerImageUrl": {
2110
- "description": "URL for an image to show inside a banner.",
2111
- "type": "object",
2112
- "additionalProperties": false,
2113
- "properties": {
2114
- "url": {
2115
- "type": "string"
2116
- }
2117
- }
2118
- },
2119
- "bannerImage": {
2120
- "description": "Image to show inside a banner.",
2121
- "type": "object",
2122
- "additionalProperties": false,
2123
- "properties": {
2124
- "urls": {
2125
- "type": "array",
2126
- "items": {
2127
- "$ref": "#/components/schemas/bannerImageUrl"
2128
- }
2129
- },
2130
- "title": {
2131
- "type": "string"
2132
- }
2133
- }
2134
- },
2135
- "bannerLink": {
2136
- "description": "Link for a banner defined in the Merchandising Studio.",
2137
- "type": "object",
2138
- "additionalProperties": false,
2139
- "properties": {
2140
- "url": {
2141
- "type": "string"
2142
- }
2143
- }
2144
- },
2145
- "banner": {
2146
- "description": "Banner with image and link to redirect users.",
2147
- "type": "object",
2148
- "additionalProperties": false,
2149
- "properties": {
2150
- "image": {
2151
- "$ref": "#/components/schemas/bannerImage"
2152
- },
2153
- "link": {
2154
- "$ref": "#/components/schemas/bannerLink"
2155
- }
2156
- }
2157
- },
2158
- "banners": {
2159
- "description": "Banners defined in the Merchandising Studio for a given search.",
2160
- "type": "array",
2161
- "items": {
2162
- "$ref": "#/components/schemas/banner"
2163
- }
2164
- },
2165
- "widgets": {
2166
- "description": "Widgets returned from any rules that are applied to the current search.",
2167
- "type": "object",
2168
- "additionalProperties": false,
2169
- "properties": {
2170
- "banners": {
2171
- "$ref": "#/components/schemas/banners"
2172
- }
2173
- }
2174
- },
2175
- "renderingContent": {
2176
- "description": "Extra data that can be used in the search UI.\n\nYou can use this to control aspects of your search UI, such as the order of facet names and values\nwithout changing your frontend code.\n",
2177
- "type": "object",
2178
- "additionalProperties": false,
2179
- "properties": {
2180
- "facetOrdering": {
2181
- "$ref": "#/components/schemas/facetOrdering"
2182
- },
2183
- "redirect": {
2184
- "$ref": "#/components/schemas/redirectURL"
2185
- },
2186
- "widgets": {
2187
- "$ref": "#/components/schemas/widgets"
2188
- }
2189
- },
2190
- "x-categories": [
2191
- "Advanced"
2192
- ]
2193
- },
2194
- "enableReRanking": {
2195
- "type": "boolean",
2196
- "description": "Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/)\nThis setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.\n",
2197
- "default": true,
2198
- "x-categories": [
2199
- "Filtering"
2200
- ]
2201
- },
2202
- "reRankingApplyFilter": {
2203
- "description": "Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.\n",
2204
- "oneOf": [
2205
- {
2206
- "type": "array",
2207
- "items": {
2208
- "$ref": "#/components/schemas/reRankingApplyFilter"
2209
- }
2210
- },
2211
- {
2212
- "type": "string",
2213
- "x-categories": [
2214
- "Filtering"
2215
- ]
2216
- }
2217
- ]
2218
- },
2219
- "indexSettingsAsSearchParams": {
2220
- "type": "object",
2221
- "additionalProperties": false,
2222
- "properties": {
2223
- "attributesToRetrieve": {
2224
- "$ref": "#/components/schemas/attributesToRetrieve"
2225
- },
2226
- "ranking": {
2227
- "type": "array",
2228
- "items": {
2229
- "type": "string"
2230
- },
2231
- "description": "Determines the order in which Algolia returns your results.\n\nBy default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).\nThe tie-breaking algorithm sequentially applies each criterion in the order they're specified.\nIf you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/),\nyou put the sorting attribute at the top of the list.\n\n**Modifiers**\n\n- `asc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in ascending order.\n- `desc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in descending order.\n\nBefore you modify the default setting,\nyou should test your changes in the dashboard,\nand by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).\n",
2232
- "default": [
2233
- "typo",
2234
- "geo",
2235
- "words",
2236
- "filters",
2237
- "proximity",
2238
- "attribute",
2239
- "exact",
2240
- "custom"
2241
- ],
2242
- "x-categories": [
2243
- "Ranking"
2244
- ]
2245
- },
2246
- "relevancyStrictness": {
2247
- "$ref": "#/components/schemas/relevancyStrictness"
2248
- },
2249
- "attributesToHighlight": {
2250
- "$ref": "#/components/schemas/attributesToHighlight"
2251
- },
2252
- "attributesToSnippet": {
2253
- "$ref": "#/components/schemas/attributesToSnippet"
2254
- },
2255
- "highlightPreTag": {
2256
- "$ref": "#/components/schemas/highlightPreTag"
2257
- },
2258
- "highlightPostTag": {
2259
- "$ref": "#/components/schemas/highlightPostTag"
2260
- },
2261
- "snippetEllipsisText": {
2262
- "$ref": "#/components/schemas/snippetEllipsisText"
2263
- },
2264
- "restrictHighlightAndSnippetArrays": {
2265
- "$ref": "#/components/schemas/restrictHighlightAndSnippetArrays"
2266
- },
2267
- "hitsPerPage": {
2268
- "$ref": "#/components/schemas/hitsPerPage"
2269
- },
2270
- "minWordSizefor1Typo": {
2271
- "$ref": "#/components/schemas/minWordSizefor1Typo"
2272
- },
2273
- "minWordSizefor2Typos": {
2274
- "$ref": "#/components/schemas/minWordSizefor2Typos"
2275
- },
2276
- "typoTolerance": {
2277
- "$ref": "#/components/schemas/typoTolerance"
2278
- },
2279
- "allowTyposOnNumericTokens": {
2280
- "$ref": "#/components/schemas/allowTyposOnNumericTokens"
2281
- },
2282
- "disableTypoToleranceOnAttributes": {
2283
- "$ref": "#/components/schemas/disableTypoToleranceOnAttributes"
2284
- },
2285
- "ignorePlurals": {
2286
- "$ref": "#/components/schemas/ignorePlurals"
2287
- },
2288
- "removeStopWords": {
2289
- "$ref": "#/components/schemas/removeStopWords"
2290
- },
2291
- "queryLanguages": {
2292
- "$ref": "#/components/schemas/queryLanguages"
2293
- },
2294
- "decompoundQuery": {
2295
- "$ref": "#/components/schemas/decompoundQuery"
2296
- },
2297
- "enableRules": {
2298
- "$ref": "#/components/schemas/enableRules"
2299
- },
2300
- "enablePersonalization": {
2301
- "$ref": "#/components/schemas/enablePersonalization"
2302
- },
2303
- "queryType": {
2304
- "$ref": "#/components/schemas/queryType"
2305
- },
2306
- "removeWordsIfNoResults": {
2307
- "$ref": "#/components/schemas/removeWordsIfNoResults"
2308
- },
2309
- "mode": {
2310
- "$ref": "#/components/schemas/mode"
2311
- },
2312
- "semanticSearch": {
2313
- "$ref": "#/components/schemas/semanticSearch"
2314
- },
2315
- "advancedSyntax": {
2316
- "$ref": "#/components/schemas/advancedSyntax"
2317
- },
2318
- "optionalWords": {
2319
- "$ref": "#/components/schemas/optionalWords"
2320
- },
2321
- "disableExactOnAttributes": {
2322
- "$ref": "#/components/schemas/disableExactOnAttributes"
2323
- },
2324
- "exactOnSingleWordQuery": {
2325
- "$ref": "#/components/schemas/exactOnSingleWordQuery"
2326
- },
2327
- "alternativesAsExact": {
2328
- "$ref": "#/components/schemas/IndexSettings_alternativesAsExact"
2329
- },
2330
- "advancedSyntaxFeatures": {
2331
- "$ref": "#/components/schemas/IndexSettings_advancedSyntaxFeatures"
2332
- },
2333
- "distinct": {
2334
- "$ref": "#/components/schemas/distinct"
2335
- },
2336
- "replaceSynonymsInHighlight": {
2337
- "$ref": "#/components/schemas/replaceSynonymsInHighlight"
2338
- },
2339
- "minProximity": {
2340
- "$ref": "#/components/schemas/minProximity"
2341
- },
2342
- "responseFields": {
2343
- "$ref": "#/components/schemas/responseFields"
2344
- },
2345
- "maxValuesPerFacet": {
2346
- "$ref": "#/components/schemas/maxValuesPerFacet"
2347
- },
2348
- "sortFacetValuesBy": {
2349
- "$ref": "#/components/schemas/sortFacetValuesBy"
2350
- },
2351
- "attributeCriteriaComputedByMinProximity": {
2352
- "$ref": "#/components/schemas/attributeCriteriaComputedByMinProximity"
2353
- },
2354
- "renderingContent": {
2355
- "$ref": "#/components/schemas/renderingContent"
2356
- },
2357
- "enableReRanking": {
2358
- "$ref": "#/components/schemas/enableReRanking"
2359
- },
2360
- "reRankingApplyFilter": {
2361
- "oneOf": [
2362
- {
2363
- "$ref": "#/components/schemas/reRankingApplyFilter"
2364
- },
2365
- {
2366
- "type": "null"
2367
- }
2368
- ]
2369
- }
2370
- }
2371
- },
2372
- "indexSettings": {
2373
- "description": "Index settings.",
2374
- "allOf": [
2375
- {
2376
- "$ref": "#/components/schemas/baseIndexSettings"
2377
- },
2378
- {
2379
- "$ref": "#/components/schemas/indexSettingsAsSearchParams"
2380
- }
2381
- ]
2382
- },
2383
- "headers": {
2384
- "type": "object",
2385
- "description": "Headers to add to all requests.",
2386
- "properties": {
2387
- "Accept-Language": {
2388
- "type": "string",
2389
- "description": "Preferred natural language and locale.",
2390
- "example": "fr-FR"
2391
- },
2392
- "Authorization": {
2393
- "type": "string",
2394
- "description": "Basic authentication header.",
2395
- "example": "Bearer Aerehdf=="
2396
- },
2397
- "Cookie": {
2398
- "type": "string",
2399
- "description": "Cookie. The header will be replaced by the cookie retrieved when logging in.",
2400
- "example": "session=1234"
2401
- }
2402
- }
2403
- },
2404
- "loginRequestOptions": {
2405
- "type": "object",
2406
- "description": "Options for the HTTP request for logging in.",
2407
- "properties": {
2408
- "method": {
2409
- "type": "string",
2410
- "description": "HTTP method for sending the request.",
2411
- "default": "GET",
2412
- "example": "POST"
2413
- },
2414
- "headers": {
2415
- "$ref": "#/components/schemas/headers"
2416
- },
2417
- "body": {
2418
- "type": "string",
2419
- "description": "Form content.",
2420
- "example": "id=user&password=s3cr3t"
2421
- },
2422
- "timeout": {
2423
- "type": "integer",
2424
- "description": "Timeout for the request."
2425
- }
2426
- }
2427
- },
2428
- "fetchRequest": {
2429
- "title": "HTTP request",
2430
- "type": "object",
2431
- "description": "Information for making a HTTP request for authorization.",
2432
- "properties": {
2433
- "url": {
2434
- "type": "string",
2435
- "description": "URL with your login form.",
2436
- "example": "https://example.com/login"
2437
- },
2438
- "requestOptions": {
2439
- "$ref": "#/components/schemas/loginRequestOptions"
2440
- }
2441
- },
2442
- "required": [
2443
- "url"
2444
- ],
2445
- "example": {
2446
- "url": "https://example.com/secure/login-with-post",
2447
- "requestOptions": {
2448
- "method": "POST",
2449
- "headers": {
2450
- "Content-Type": "application/x-www-form-urlencoded"
2451
- },
2452
- "body": "id=my-id&password=my-password",
2453
- "timeout": 5000
2454
- }
2455
- }
2456
- },
2457
- "waitTime": {
2458
- "type": "object",
2459
- "description": "Timeout for the HTTP request.",
2460
- "properties": {
2461
- "min": {
2462
- "type": "integer",
2463
- "default": 0,
2464
- "description": "Minimum waiting time in milliseconds.",
2465
- "example": 7000
2466
- },
2467
- "max": {
2468
- "type": "integer",
2469
- "default": 20000,
2470
- "description": "Maximum waiting time in milliseconds.",
2471
- "example": 15000
2472
- }
2473
- }
2474
- },
2475
- "browserRequest": {
2476
- "title": "Browser-based",
2477
- "type": "object",
2478
- "description": "Information for using a web browser for authorization.\nThe browser loads a login page and enters the provided credentials.\n",
2479
- "properties": {
2480
- "url": {
2481
- "type": "string",
2482
- "description": "URL of your login page.\n\nThe crawler looks for an input matching the selector `input[type=text]` or `input[type=email]` for the username and `input[type=password]` for the password.\n",
2483
- "example": "https://example.com/login"
2484
- },
2485
- "username": {
2486
- "type": "string",
2487
- "description": "Username for signing in.",
2488
- "example": "crawler"
2489
- },
2490
- "password": {
2491
- "type": "string",
2492
- "description": "Password for signing in.",
2493
- "example": "s3cr3t"
2494
- },
2495
- "waitTime": {
2496
- "$ref": "#/components/schemas/waitTime"
2497
- }
2498
- },
2499
- "required": [
2500
- "url",
2501
- "username",
2502
- "password"
2503
- ],
2504
- "example": {
2505
- "url": "https://example.com/secure/login-page",
2506
- "username": "my-id",
2507
- "password": "my-password"
2508
- }
2509
- },
2510
- "grantType": {
2511
- "type": "string",
2512
- "description": "OAuth 2.0 grant type.",
2513
- "enum": [
2514
- "client_credentials"
2515
- ]
2516
- },
2517
- "extraParameters": {
2518
- "type": "object",
2519
- "description": "Extra parameters for the authorization request.",
2520
- "properties": {
2521
- "resource": {
2522
- "type": "string",
2523
- "description": "App ID URI of the receiving web service.\n\nFor more information, see [Azure Active Directory](https://learn.microsoft.com/en-us/previous-versions/azure/active-directory/azuread-dev/v1-oauth2-client-creds-grant-flow#first-case-access-token-request-with-a-shared-secret).\n"
2524
- }
2525
- }
2526
- },
2527
- "accessTokenRequest": {
2528
- "type": "object",
2529
- "description": "Parameters required to make the [access token request](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4.2).\n",
2530
- "properties": {
2531
- "url": {
2532
- "type": "string",
2533
- "description": "URL for the access token endpoint."
2534
- },
2535
- "grantType": {
2536
- "$ref": "#/components/schemas/grantType"
2537
- },
2538
- "clientId": {
2539
- "type": "string",
2540
- "description": "[Client identifier](https://datatracker.ietf.org/doc/html/rfc6749#section-2.2).\n"
2541
- },
2542
- "clientSecret": {
2543
- "type": "string",
2544
- "description": "Client secret."
2545
- },
2546
- "scope": {
2547
- "type": "string",
2548
- "description": "[Access token scope](https://datatracker.ietf.org/doc/html/rfc6749#section-3.3).\n"
2549
- },
2550
- "extraParameters": {
2551
- "$ref": "#/components/schemas/extraParameters"
2552
- }
2553
- },
2554
- "required": [
2555
- "url",
2556
- "grantType",
2557
- "clientId",
2558
- "clientSecret"
2559
- ]
2560
- },
2561
- "oauthRequest": {
2562
- "title": "OAuth 2.0",
2563
- "type": "object",
2564
- "description": "Authorization information for using the [OAuth 2.0 client credentials](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4) authorization grant.\n\nOAuth authorization is supported for [Azure Active Directory version 1](https://learn.microsoft.com/en-us/previous-versions/azure/active-directory/azuread-dev/v1-oauth2-client-creds-grant-flow) as provider.\n",
2565
- "properties": {
2566
- "accessTokenRequest": {
2567
- "$ref": "#/components/schemas/accessTokenRequest"
2568
- }
2569
- },
2570
- "required": [
2571
- "accessTokenRequest"
2572
- ],
2573
- "example": {
2574
- "accessTokenRequest": {
2575
- "url": "https://example.com/oauth2/token",
2576
- "grant_type": "client_credentials",
2577
- "client_id": "my-client-id",
2578
- "client_secret": "my-client-secret",
2579
- "extraParameters": {
2580
- "resource": "https://protected.example.com/"
2581
- }
2582
- }
2583
- }
2584
- },
2585
- "login": {
2586
- "description": "Authorization method and credentials for crawling protected content.\n\nThe Crawler supports these authentication methods:\n\n- **Basic authentication**.\n The Crawler obtains a session cookie from the login page.\n- **OAuth 2.0 authentication** (`oauthRequest`).\n The Crawler uses OAuth 2.0 client credentials to obtain an access token for authentication.\n\n**Basic authentication**\n\nThe Crawler extracts the `Set-Cookie` response header from the login page, stores that cookie,\nand sends it in the `Cookie` header when crawling all pages defined in the configuration.\n\nThis cookie is retrieved only at the start of each full crawl.\nIf it expires, it isn't automatically renewed.\n\nThe Crawler can obtain the session cookie in one of two ways:\n\n- **HTTP request authentication** (`fetchRequest`).\n The Crawler sends a direct request with your credentials to the login endpoint, similar to a `curl` command.\n- **Browser-based authentication** (`browserRequest`).\n The Crawler emulates a web browser by loading the login page, entering the credentials,\n and submitting the login form as a real user would.\n\n**OAuth 2.0**\n\nThe crawler supports [OAuth 2.0 client credentials grant flow](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4):\n\n1. It performs an access token request with the provided credentials\n1. Stores the fetched token in an `Authorization` header\n1. Sends the token when crawling site pages.\n\nThis token is only fetched at the beginning of each complete crawl.\nIf it expires, it isn't automatically renewed.\n\nClient authentication passes the credentials (`client_id` and `client_secret`) [in the request body](https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1).\nThe [Azure AD v1.0](https://learn.microsoft.com/en-us/previous-versions/azure/active-directory/azuread-dev/v1-oauth2-client-creds-grant-flow) provider is supported.\n",
2587
- "oneOf": [
2588
- {
2589
- "$ref": "#/components/schemas/fetchRequest"
2590
- },
2591
- {
2592
- "$ref": "#/components/schemas/browserRequest"
2593
- },
2594
- {
2595
- "$ref": "#/components/schemas/oauthRequest"
2596
- }
2597
- ]
2598
- },
2599
- "renderJavaScript": {
2600
- "description": "If `true`, use a Chrome headless browser to crawl pages.\n\nBecause crawling JavaScript-based web pages is slower than crawling regular HTML pages, you can apply this setting to a specific list of pages. \nUse [micromatch](https://github.com/micromatch/micromatch) to define URL patterns, including negations and wildcards.\n",
2601
- "oneOf": [
2602
- {
2603
- "type": "boolean",
2604
- "description": "Whether to render all pages."
2605
- },
2606
- {
2607
- "type": "array",
2608
- "description": "URLs or URL patterns to render.",
2609
- "items": {
2610
- "type": "string",
2611
- "description": "URL or URL pattern to render.",
2612
- "example": [
2613
- "http://www.mysite.com/dynamic-pages/**"
2614
- ]
2615
- }
2616
- },
2617
- {
2618
- "title": "headlessBrowserConfig",
2619
- "type": "object",
2620
- "description": "Configuration for rendering HTML.",
2621
- "properties": {
2622
- "enabled": {
2623
- "type": "boolean",
2624
- "description": "Whether to enable JavaScript rendering.",
2625
- "example": true
2626
- },
2627
- "patterns": {
2628
- "type": "array",
2629
- "description": "URLs or URL patterns to render.",
2630
- "items": {
2631
- "type": "string"
2632
- },
2633
- "example": [
2634
- "http://www.mysite.com/dynamic-pages/**"
2635
- ]
2636
- },
2637
- "adBlock": {
2638
- "type": "boolean",
2639
- "default": false,
2640
- "description": "Whether to use the Crawler's ad blocker.\nIt blocks most ads and tracking scripts but can break some sites.\n"
2641
- },
2642
- "waitTime": {
2643
- "$ref": "#/components/schemas/waitTime"
2644
- }
2645
- },
2646
- "required": [
2647
- "enabled",
2648
- "patterns"
2649
- ]
2650
- }
2651
- ]
2652
- },
2653
- "requestOptions": {
2654
- "type": "object",
2655
- "description": "Lets you add options to HTTP requests made by the crawler.",
2656
- "properties": {
2657
- "proxy": {
2658
- "type": "string",
2659
- "description": "Proxy for all crawler requests."
2660
- },
2661
- "timeout": {
2662
- "type": "integer",
2663
- "default": 30000,
2664
- "description": "Timeout in milliseconds for the crawl."
2665
- },
2666
- "retries": {
2667
- "type": "integer",
2668
- "default": 3,
2669
- "description": "Maximum number of retries to crawl one URL."
2670
- },
2671
- "headers": {
2672
- "$ref": "#/components/schemas/headers"
2673
- }
2674
- }
2675
- },
2676
- "beforeIndexPublishing": {
2677
- "type": "object",
2678
- "description": "Checks triggered after the crawl finishes but before the records are added to the Algolia index.",
2679
- "properties": {
2680
- "maxLostRecordsPercentage": {
2681
- "type": "integer",
2682
- "description": "Maximum difference in percent between the numbers of records between crawls.",
2683
- "minimum": 1,
2684
- "maximum": 100,
2685
- "default": 10
2686
- },
2687
- "maxFailedUrls": {
2688
- "type": "integer",
2689
- "description": "Stops the crawler if a specified number of pages fail to crawl."
2690
- }
2691
- }
2692
- },
2693
- "safetyChecks": {
2694
- "type": "object",
2695
- "description": "Checks to ensure the crawl was successful.\n\nFor more information, see the [Safety checks](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration/#safety-checks) documentation.\n",
2696
- "properties": {
2697
- "beforeIndexPublishing": {
2698
- "$ref": "#/components/schemas/beforeIndexPublishing"
2699
- }
2700
- }
2701
- },
2702
- "schedule": {
2703
- "type": "string",
2704
- "description": "Schedule for running the crawl.\n\nInstead of manually starting a crawl each time, you can set up a schedule for automatic crawls.\n[Use the visual UI](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration-visual/) or add the `schedule` parameter to [your configuration](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration/).\n\n`schedule` uses [Later.js syntax](https://bunkat.github.io/later/) to specify when to crawl your site.\nHere are some key things to keep in mind when using `Later.js` syntax with the Crawler:\n\n- The interval between two scheduled crawls must be at least 24 hours.\n- To crawl daily, use \"every 1 day\" instead of \"everyday\" or \"every day\".\n- If you don't specify a time, the crawl can happen any time during the scheduled day.\n- Specify times for the UTC (GMT+0) timezone\n- Include minutes when specifying a time. For example, \"at 3:00 pm\" instead of \"at 3pm\".\n- Use \"at 12:00 am\" to specify midnight, not \"at 00:00 am\".\n",
2705
- "example": "every weekday at 12:00 pm"
2706
- },
2707
- "Configuration": {
2708
- "type": "object",
2709
- "description": "Crawler configuration.",
2710
- "required": [
2711
- "applicationId",
2712
- "rateLimit",
2713
- "actions"
2714
- ],
2715
- "properties": {
2716
- "actions": {
2717
- "type": "array",
2718
- "description": "A list of actions.",
2719
- "minItems": 1,
2720
- "maxItems": 30,
2721
- "items": {
2722
- "$ref": "#/components/schemas/Action"
2723
- }
2724
- },
2725
- "apiKey": {
2726
- "type": "string",
2727
- "description": "The Algolia API key the crawler uses for indexing records.\nIf you don't provide an API key, one will be generated by the Crawler when you create a configuration.\n\nThe API key must have:\n\n- These [rights and restrictions](https://www.algolia.com/doc/guides/security/api-keys/#rights-and-restrictions): `search`, `addObject`, `deleteObject`, `deleteIndex`, `settings`, `editSettings`, `listIndexes`, `browse`\n- Access to the correct set of indices, based on the crawler's `indexPrefix`.\nFor example, if the prefix is `crawler_`, the API key must have access to `crawler_*`.\n\n**Don't use your [Admin API key](https://www.algolia.com/doc/guides/security/api-keys/#predefined-api-keys)**.\n"
2728
- },
2729
- "applicationId": {
2730
- "$ref": "#/components/schemas/applicationID"
2731
- },
2732
- "exclusionPatterns": {
2733
- "type": "array",
2734
- "description": "URLs to exclude from crawling.",
2735
- "maxItems": 100,
2736
- "example": [
2737
- "https://www.example.com/excluded",
2738
- "!https://www.example.com/this-one-url",
2739
- "https://www.example.com/exclude/**"
2740
- ],
2741
- "items": {
2742
- "type": "string",
2743
- "description": "Use [micromatch](https://github.com/micromatch/micromatch) for negation, wildcards, and more.\n"
2744
- }
2745
- },
2746
- "externalData": {
2747
- "type": "array",
2748
- "description": "References to external data sources for enriching the extracted records.\n",
2749
- "maxItems": 10,
2750
- "items": {
2751
- "type": "string",
2752
- "description": "For more information, see [Enrich extracted records with external data](https://www.algolia.com/doc/tools/crawler/guides/enriching-extraction-with-external-data/).",
2753
- "example": "testCSV"
2754
- }
2755
- },
2756
- "extraUrls": {
2757
- "type": "array",
2758
- "maxItems": 9999,
2759
- "description": "The Crawler treats `extraUrls` the same as `startUrls`.\nSpecify `extraUrls` if you want to differentiate between URLs you manually added to fix site crawling from those you initially specified in `startUrls`.\n",
2760
- "items": {
2761
- "type": "string"
2762
- }
2763
- },
2764
- "ignoreCanonicalTo": {
2765
- "$ref": "#/components/schemas/ignoreCanonicalTo"
2766
- },
2767
- "ignoreNoFollowTo": {
2768
- "type": "boolean",
2769
- "description": "Determines if the crawler should follow links with a `nofollow` directive.\nIf `true`, the crawler will ignore the `nofollow` directive and crawl links on the page.\n\nThe crawler always ignores links that don't match your [configuration settings](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration/#exclude-and-include-content).\n`ignoreNoFollowTo` applies to:\n\n- Links that are ignored because the [`robots` meta tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta/name#Other_metadata_names) contains `nofollow` or `none`.\n- Links with a [`rel` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel) containing the `nofollow` directive.\n"
2770
- },
2771
- "ignoreNoIndex": {
2772
- "type": "boolean",
2773
- "description": "Whether to ignore the `noindex` robots meta tag.\nIf `true`, pages with this meta tag _will_ be crawled.\n"
2774
- },
2775
- "ignorePaginationAttributes": {
2776
- "type": "boolean",
2777
- "description": "Whether the crawler should follow `rel=\"prev\"` and `rel=\"next\"` pagination links in the `<head>` section of an HTML page.\n\n- If `true`, the crawler ignores the pagination links.\n- If `false`, the crawler follows the pagination links.\n",
2778
- "default": true
2779
- },
2780
- "ignoreQueryParams": {
2781
- "type": "array",
2782
- "description": "Query parameters to ignore while crawling.\n\nAll URLs with the matching query parameters are treated as identical.\nThis prevents indexing URLs that just differ by their query parameters.\n",
2783
- "maxItems": 9999,
2784
- "example": [
2785
- "ref",
2786
- "utm_*"
2787
- ],
2788
- "items": {
2789
- "type": "string",
2790
- "description": "Use wildcards to match multiple query parameters."
2791
- }
2792
- },
2793
- "ignoreRobotsTxtRules": {
2794
- "type": "boolean",
2795
- "description": "Whether to ignore rules defined in your `robots.txt` file."
2796
- },
2797
- "indexPrefix": {
2798
- "type": "string",
2799
- "description": "A prefix for all indices created by this crawler. It's combined with the `indexName` for each action to form the complete index name.",
2800
- "maxLength": 64,
2801
- "example": "crawler_"
2802
- },
2803
- "initialIndexSettings": {
2804
- "type": "object",
2805
- "description": "Crawler index settings.\n\nThese index settings are only applied during the first crawl of an index.\n\nAny subsequent changes won't be applied to the index.\nInstead, make changes to your index settings in the [Algolia dashboard](https://dashboard.algolia.com/explorer/configuration/).\n",
2806
- "additionalProperties": {
2807
- "$ref": "#/components/schemas/indexSettings",
2808
- "x-additionalPropertiesName": "indexName"
2809
- }
2810
- },
2811
- "linkExtractor": {
2812
- "title": "linkExtractor",
2813
- "type": "object",
2814
- "description": "Function for extracting URLs from links on crawled pages.\n\nFor more information, see the [`linkExtractor` documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/link-extractor/).\n",
2815
- "properties": {
2816
- "__type": {
2817
- "$ref": "#/components/schemas/configurationRecordExtractorType"
2818
- },
2819
- "source": {
2820
- "type": "string",
2821
- "example": "({ $, url, defaultExtractor }) => {\n if (/example.com\\/doc\\//.test(url.href)) {\n // For all pages under `/doc`, only extract the first found URL.\n return defaultExtractor().slice(0, 1)\n }\n // For all other pages, use the default.\n return defaultExtractor()\n}\n"
2822
- }
2823
- }
2824
- },
2825
- "login": {
2826
- "$ref": "#/components/schemas/login"
2827
- },
2828
- "maxDepth": {
2829
- "type": "integer",
2830
- "description": "Determines the maximum path depth of crawled URLs.\n\nPath depth is calculated based on the number of slash characters (`/`) after the domain (starting at 1).\nFor example:\n\n- **1** `http://example.com`\n- **1** `http://example.com/`\n- **1** `http://example.com/foo`\n- **2** `http://example.com/foo/`\n- **2** `http://example.com/foo/bar`\n- **3** `http://example.com/foo/bar/`\n\n**URLs added with `startUrls` and `sitemaps` aren't checked for `maxDepth`.**.\n",
2831
- "minimum": 1,
2832
- "maximum": 100,
2833
- "example": 5
2834
- },
2835
- "maxUrls": {
2836
- "type": "integer",
2837
- "description": "Limits the number of URLs your crawler processes.\n\nChange it to a low value, such as 100, for quick crawling tests.\nChange it to a higher explicit value for full crawls to prevent it from getting \"lost\" in complex site structures.\nBecause the Crawler works on many pages simultaneously, `maxUrls` doesn't guarantee finding the same pages each time it runs.\n",
2838
- "minimum": 1,
2839
- "maximum": 15000000,
2840
- "example": 250
2841
- },
2842
- "rateLimit": {
2843
- "type": "integer",
2844
- "description": "Determines the number of concurrent tasks per second that can run for this configuration.\n\nA higher rate limit means more crawls per second.\nAlgolia prevents system overload by ensuring the number of URLs added in the last second and the number of URLs being processed is less than the rate limit:\n\n\n```\nmax(new_urls_added, active_urls_processing) <= rateLimit\n```\n\nStart with a low value (for example, 2) and increase it if you need faster crawling.\nBe aware that a high `rateLimit` can have a huge impact on bandwidth cost and server resource consumption.\n\nThe number of pages processed per second depends on the average time it takes to fetch, process, and upload a URL. \nFor a given `rateLimit` if fetching, processing, and uploading URLs takes (on average):\n\n- Less than a second, your crawler processes up to `rateLimit` pages per second.\n- Four seconds, your crawler processes up to `rateLimit / 4` pages per second.\n\nIn the latter case, increasing `rateLimit` improves performance, up to a point. \nHowever, if the processing time remains at four seconds, increasing `rateLimit` won't increase the number of pages processed per second.\n",
2845
- "minimum": 1,
2846
- "maximum": 100,
2847
- "example": 4
2848
- },
2849
- "renderJavaScript": {
2850
- "$ref": "#/components/schemas/renderJavaScript"
2851
- },
2852
- "requestOptions": {
2853
- "$ref": "#/components/schemas/requestOptions"
2854
- },
2855
- "safetyChecks": {
2856
- "$ref": "#/components/schemas/safetyChecks"
2857
- },
2858
- "saveBackup": {
2859
- "type": "boolean",
2860
- "description": "Whether to back up your index before the crawler overwrites it with new records.\n"
2861
- },
2862
- "schedule": {
2863
- "$ref": "#/components/schemas/schedule"
2864
- },
2865
- "sitemaps": {
2866
- "type": "array",
2867
- "description": "Sitemaps with URLs from where to start crawling.",
2868
- "maxItems": 9999,
2869
- "items": {
2870
- "type": "string",
2871
- "example": "https://example.com/sitemap.xyz"
2872
- }
2873
- },
2874
- "startUrls": {
2875
- "type": "array",
2876
- "description": "URLs from where to start crawling.",
2877
- "maxItems": 9999,
2878
- "items": {
2879
- "type": "string",
2880
- "example": "https://www.example.com"
2881
- }
2882
- }
2883
- }
2884
- },
2885
- "createdAt": {
2886
- "type": "string",
2887
- "example": "2023-07-04T12:49:15Z",
2888
- "description": "Date and time when the object was created, in RFC 3339 format."
2889
- },
2890
- "updatedAt": {
2891
- "type": "string",
2892
- "example": "2023-07-04T12:49:15Z",
2893
- "description": "Date and time when the object was updated, in RFC 3339 format."
2894
- },
2895
- "BaseResponse": {
2896
- "title": "Without configuration",
2897
- "type": "object",
2898
- "properties": {
2899
- "name": {
2900
- "$ref": "#/components/schemas/CrawlerName"
2901
- },
2902
- "createdAt": {
2903
- "$ref": "#/components/schemas/createdAt"
2904
- },
2905
- "updatedAt": {
2906
- "$ref": "#/components/schemas/updatedAt"
2907
- },
2908
- "running": {
2909
- "type": "boolean",
2910
- "description": "Whether this crawler is active."
2911
- },
2912
- "reindexing": {
2913
- "type": "boolean",
2914
- "description": "Whether this crawler is completely reindexing your content."
2915
- },
2916
- "blocked": {
2917
- "type": "boolean",
2918
- "description": "Whether this crawler is currently blocked.\n\nIf `true`, you can unblock it from the [Crawler page](https://dashboard.algolia.com/crawler) in the Algolia dashboard\nor by [cancelling the blocking task](#tag/tasks/operation/cancelBlockingAction).\n"
2919
- },
2920
- "blockingError": {
2921
- "type": "string",
2922
- "description": "Reason why the crawler is blocked.",
2923
- "example": "Error: Failed to fetch external data for source 'testCSV': 404\n"
2924
- },
2925
- "blockingTaskId": {
2926
- "type": "string",
2927
- "description": "ID of the task that's blocking the crawler."
2928
- },
2929
- "lastReindexStartAt": {
2930
- "default": null,
2931
- "oneOf": [
2932
- {
2933
- "type": "string",
2934
- "description": "Date and time when the last crawl started, in RFC 3339 format.",
2935
- "example": "2024-04-07T09:16:04Z"
2936
- },
2937
- {
2938
- "type": "null"
2939
- }
2940
- ]
2941
- },
2942
- "lastReindexEndedAt": {
2943
- "default": null,
2944
- "oneOf": [
2945
- {
2946
- "type": "string",
2947
- "description": "Date and time when the last crawl finished, in RFC 3339 format."
2948
- },
2949
- {
2950
- "type": "null"
2951
- }
2952
- ]
2953
- }
2954
- },
2955
- "required": [
2956
- "name",
2957
- "createdAt",
2958
- "updatedAt",
2959
- "running",
2960
- "reindexing",
2961
- "blocked",
2962
- "lastReindexStartAt",
2963
- "lastReindexEndedAt"
2964
- ]
2965
- },
2966
- "WithConfiguration": {
2967
- "title": "With configuration",
2968
- "allOf": [
2969
- {
2970
- "$ref": "#/components/schemas/BaseResponse"
2971
- },
2972
- {
2973
- "type": "object",
2974
- "properties": {
2975
- "config": {
2976
- "$ref": "#/components/schemas/Configuration"
2977
- }
2978
- }
2979
- }
2980
- ],
2981
- "required": [
2982
- "name",
2983
- "createdAt",
2984
- "updatedAt",
2985
- "running",
2986
- "reindexing",
2987
- "blocked",
2988
- "lastReindexStartAt",
2989
- "lastReindexEndedAt",
2990
- "config"
2991
- ]
2992
- },
2993
- "GetCrawlerResponse": {
2994
- "title": "API response for retrieving crawler information",
2995
- "oneOf": [
2996
- {
2997
- "$ref": "#/components/schemas/BaseResponse"
2998
- },
2999
- {
3000
- "$ref": "#/components/schemas/WithConfiguration"
3001
- }
3002
- ]
3003
- },
3004
- "TaskID": {
3005
- "type": "string",
3006
- "description": "Universally unique identifier (UUID) of the task.",
3007
- "example": "98458796-b7bb-4703-8b1b-785c1080b110"
3008
- },
3009
- "PartialConfig": {
3010
- "description": "Crawler configuration to update.\nYou can only update top-level configuration properties.\nTo update a nested configuration, such as `actions.recordExtractor`,\nyou must provide the complete top-level object such as `actions`.\n",
3011
- "allOf": [
3012
- {
3013
- "$ref": "#/components/schemas/Configuration"
3014
- }
3015
- ]
3016
- },
3017
- "urlsCrawledGroupStatus": {
3018
- "type": "string",
3019
- "description": "Crawled URL status.\n\nFor more information, see [Troubleshooting by crawl status](https://www.algolia.com/doc/tools/crawler/troubleshooting/crawl-status/).\n",
3020
- "enum": [
3021
- "DONE",
3022
- "SKIPPED",
3023
- "FAILED"
3024
- ]
3025
- },
3026
- "urlsCrawledGroupCategory": {
3027
- "type": "string",
3028
- "description": "Step where the status information was generated.\n\nFor more information, see [Troubleshooting by crawl status](https://www.algolia.com/doc/tools/crawler/troubleshooting/crawl-status/).\n",
3029
- "enum": [
3030
- "fetch",
3031
- "extraction",
3032
- "indexing",
3033
- "success"
3034
- ]
3035
- },
3036
- "UrlsCrawledGroup": {
3037
- "type": "object",
3038
- "description": "Processed URLs and their status.",
3039
- "properties": {
3040
- "status": {
3041
- "$ref": "#/components/schemas/urlsCrawledGroupStatus"
3042
- },
3043
- "reason": {
3044
- "type": "string",
3045
- "description": "Reason for this status."
3046
- },
3047
- "category": {
3048
- "$ref": "#/components/schemas/urlsCrawledGroupCategory"
3049
- },
3050
- "count": {
3051
- "type": "integer",
3052
- "description": "Number of URLs with this status."
3053
- },
3054
- "readable": {
3055
- "type": "string",
3056
- "description": "Reason for this status."
3057
- }
3058
- },
3059
- "example": {
3060
- "status": "SKIPPED",
3061
- "reason": "forbidden_by_robotstxt",
3062
- "category": "fetch",
3063
- "count": 3,
3064
- "readable": "Forbidden by robots.txt"
3065
- }
3066
- },
3067
- "version": {
3068
- "type": "integer",
3069
- "description": "Version of the configuration. Version 1 is the initial configuration you used when creating the crawler.",
3070
- "minimum": 1
3071
- },
3072
- "authorId": {
3073
- "type": "string",
3074
- "description": "Universally unique identifier (UUID) of the user who created this version of the configuration.",
3075
- "example": "7d79f0dd-2dab-4296-8098-957a1fdc0637"
3076
- },
3077
- "crawlerConfigVersionsResponse": {
3078
- "allOf": [
3079
- {
3080
- "$ref": "#/components/schemas/Pagination"
3081
- },
3082
- {
3083
- "type": "object",
3084
- "properties": {
3085
- "items": {
3086
- "type": "array",
3087
- "description": "Configuration changes.",
3088
- "items": {
3089
- "title": "crawlerConfigVersionsResponse",
3090
- "type": "object",
3091
- "properties": {
3092
- "version": {
3093
- "$ref": "#/components/schemas/version"
3094
- },
3095
- "createdAt": {
3096
- "$ref": "#/components/schemas/createdAt"
3097
- },
3098
- "authorId": {
3099
- "$ref": "#/components/schemas/authorId"
3100
- }
3101
- },
3102
- "required": [
3103
- "version",
3104
- "createdAt",
3105
- "authorId"
3106
- ]
3107
- }
3108
- }
3109
- }
3110
- }
3111
- ]
3112
- },
3113
- "domainsResponse": {
3114
- "allOf": [
3115
- {
3116
- "$ref": "#/components/schemas/Pagination"
3117
- },
3118
- {
3119
- "type": "object",
3120
- "properties": {
3121
- "items": {
3122
- "type": "array",
3123
- "items": {
3124
- "title": "domainResponse",
3125
- "type": "object",
3126
- "properties": {
3127
- "applicationId": {
3128
- "$ref": "#/components/schemas/applicationID"
3129
- },
3130
- "domain": {
3131
- "type": "string",
3132
- "description": "Domain name which crawlers can access.",
3133
- "example": "wwww.algolia.com"
3134
- },
3135
- "validated": {
3136
- "type": "boolean",
3137
- "description": "Whether the domain is validated."
3138
- }
3139
- }
3140
- }
3141
- }
3142
- }
3143
- }
3144
- ]
3145
- }
3146
- },
3147
- "parameters": {
3148
- "ItemsPerPage": {
3149
- "name": "itemsPerPage",
3150
- "in": "query",
3151
- "description": "Number of items per page to retrieve.",
3152
- "schema": {
3153
- "$ref": "#/components/schemas/itemsPerPage"
3154
- }
3155
- },
3156
- "Page": {
3157
- "name": "page",
3158
- "in": "query",
3159
- "description": "Page to retrieve.",
3160
- "schema": {
3161
- "$ref": "#/components/schemas/page"
3162
- }
3163
- },
3164
- "Name": {
3165
- "name": "name",
3166
- "in": "query",
3167
- "description": "Name of the crawler for filtering the API response.",
3168
- "schema": {
3169
- "$ref": "#/components/schemas/CrawlerName"
3170
- }
3171
- },
3172
- "AppID": {
3173
- "name": "appID",
3174
- "in": "query",
3175
- "description": "Algolia application ID for filtering the API response.",
3176
- "schema": {
3177
- "$ref": "#/components/schemas/applicationID"
3178
- }
3179
- },
3180
- "CrawlerIdParameter": {
3181
- "name": "id",
3182
- "in": "path",
3183
- "description": "Crawler ID.",
3184
- "required": true,
3185
- "schema": {
3186
- "$ref": "#/components/schemas/CrawlerID"
3187
- }
3188
- },
3189
- "CrawlerVersionParameter": {
3190
- "name": "version",
3191
- "in": "path",
3192
- "description": "This crawler's version nmber.",
3193
- "required": true,
3194
- "schema": {
3195
- "type": "integer"
3196
- }
3197
- },
3198
- "TaskIdParameter": {
3199
- "name": "taskID",
3200
- "in": "path",
3201
- "description": "Task ID.",
3202
- "required": true,
3203
- "schema": {
3204
- "$ref": "#/components/schemas/TaskID"
3205
- }
3206
- }
3207
- },
3208
- "responses": {
3209
- "InvalidRequest": {
3210
- "description": "Invalid request.",
3211
- "content": {
3212
- "application/json": {
3213
- "schema": {
3214
- "title": "invalidRequest",
3215
- "type": "object",
3216
- "properties": {
3217
- "error": {
3218
- "title": "invalidRequestError",
3219
- "type": "object",
3220
- "properties": {
3221
- "code": {
3222
- "type": "string"
3223
- },
3224
- "message": {
3225
- "type": "string"
3226
- },
3227
- "errors": {
3228
- "type": "array",
3229
- "items": {
3230
- "title": "errorItem",
3231
- "type": "object",
3232
- "properties": {
3233
- "code": {
3234
- "type": "string"
3235
- },
3236
- "message": {
3237
- "type": "string"
3238
- },
3239
- "line": {
3240
- "type": "integer"
3241
- },
3242
- "position": {
3243
- "type": "integer"
3244
- }
3245
- },
3246
- "required": [
3247
- "message"
3248
- ],
3249
- "example": {
3250
- "message": "url is not defined",
3251
- "line": 5
3252
- }
3253
- }
3254
- }
3255
- },
3256
- "example": {
3257
- "code": "malformed_id"
3258
- }
3259
- }
3260
- },
3261
- "required": [
3262
- "error"
3263
- ]
3264
- }
3265
- }
3266
- }
3267
- },
3268
- "MissingAuthorization": {
3269
- "description": "Authorization information is missing or invalid."
3270
- },
3271
- "NoRightsOnCrawler": {
3272
- "description": "The user doesn't have enough rights on the specified Crawler, or it doesn't exists."
3273
- },
3274
- "ActionAcknowledged": {
3275
- "description": "OK",
3276
- "content": {
3277
- "application/json": {
3278
- "schema": {
3279
- "title": "actionAcknowledged",
3280
- "type": "object",
3281
- "properties": {
3282
- "taskId": {
3283
- "$ref": "#/components/schemas/TaskID"
3284
- }
3285
- },
3286
- "required": [
3287
- "taskId"
3288
- ]
3289
- }
3290
- }
3291
- }
3292
- },
3293
- "Forbidden": {
3294
- "description": "Invalid credentials.",
3295
- "content": {
3296
- "application/json": {
3297
- "schema": {
3298
- "title": "forbidden",
3299
- "type": "object",
3300
- "properties": {
3301
- "error": {
3302
- "title": "forbiddenError",
3303
- "type": "object",
3304
- "properties": {
3305
- "code": {
3306
- "type": "string"
3307
- },
3308
- "message": {
3309
- "type": "string"
3310
- },
3311
- "errors": {
3312
- "type": "array",
3313
- "items": {
3314
- "title": "errorItem",
3315
- "type": "object",
3316
- "properties": {
3317
- "code": {
3318
- "type": "string"
3319
- },
3320
- "message": {
3321
- "type": "string"
3322
- },
3323
- "line": {
3324
- "type": "integer"
3325
- },
3326
- "position": {
3327
- "type": "integer"
3328
- }
3329
- },
3330
- "required": [
3331
- "message"
3332
- ],
3333
- "example": {
3334
- "message": "url is not defined",
3335
- "line": 5
3336
- }
3337
- }
3338
- }
3339
- },
3340
- "example": {
3341
- "code": "malformed_id"
3342
- }
3343
- }
3344
- },
3345
- "required": [
3346
- "error"
3347
- ]
3348
- }
3349
- }
3350
- }
3351
- }
3352
- }
3353
- }
3354
- }