@algolia/n8n-nodes-algolia 0.5.2 → 0.6.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.
- package/README.md +80 -8
- package/dist/nodes/Algolia/Algolia.node.js +1 -1
- package/dist/nodes/Algolia/specs/abtesting-v3.json +1701 -0
- package/dist/nodes/Algolia/specs/abtesting.json +1580 -0
- package/dist/nodes/Algolia/specs/advanced-personalization.json +1667 -0
- package/dist/nodes/Algolia/specs/analytics.json +3138 -0
- package/dist/nodes/Algolia/specs/composition.json +4193 -0
- package/dist/nodes/Algolia/specs/crawler.json +3354 -0
- package/dist/nodes/Algolia/specs/ingestion.json +6368 -0
- package/dist/nodes/Algolia/specs/insights.json +1843 -0
- package/dist/nodes/Algolia/specs/monitoring.json +1263 -0
- package/dist/nodes/Algolia/specs/personalization.json +716 -0
- package/dist/nodes/Algolia/specs/query-suggestions.json +1143 -0
- package/dist/nodes/Algolia/specs/recommend.json +3681 -0
- package/dist/nodes/Algolia/specs/search.json +1365 -397
- package/package.json +5 -4
|
@@ -7,41 +7,41 @@
|
|
|
7
7
|
},
|
|
8
8
|
"servers": [
|
|
9
9
|
{
|
|
10
|
-
"url": "https://{
|
|
10
|
+
"url": "https://{applicationId}.algolia.net",
|
|
11
11
|
"variables": {
|
|
12
|
-
"
|
|
12
|
+
"applicationId": {
|
|
13
13
|
"default": "ALGOLIA_APPLICATION_ID"
|
|
14
14
|
}
|
|
15
15
|
}
|
|
16
16
|
},
|
|
17
17
|
{
|
|
18
|
-
"url": "https://{
|
|
18
|
+
"url": "https://{applicationId}-1.algolianet.com",
|
|
19
19
|
"variables": {
|
|
20
|
-
"
|
|
20
|
+
"applicationId": {
|
|
21
21
|
"default": "ALGOLIA_APPLICATION_ID"
|
|
22
22
|
}
|
|
23
23
|
}
|
|
24
24
|
},
|
|
25
25
|
{
|
|
26
|
-
"url": "https://{
|
|
26
|
+
"url": "https://{applicationId}-2.algolianet.com",
|
|
27
27
|
"variables": {
|
|
28
|
-
"
|
|
28
|
+
"applicationId": {
|
|
29
29
|
"default": "ALGOLIA_APPLICATION_ID"
|
|
30
30
|
}
|
|
31
31
|
}
|
|
32
32
|
},
|
|
33
33
|
{
|
|
34
|
-
"url": "https://{
|
|
34
|
+
"url": "https://{applicationId}-3.algolianet.com",
|
|
35
35
|
"variables": {
|
|
36
|
-
"
|
|
36
|
+
"applicationId": {
|
|
37
37
|
"default": "ALGOLIA_APPLICATION_ID"
|
|
38
38
|
}
|
|
39
39
|
}
|
|
40
40
|
},
|
|
41
41
|
{
|
|
42
|
-
"url": "https://{
|
|
42
|
+
"url": "https://{applicationId}-dsn.algolia.net",
|
|
43
43
|
"variables": {
|
|
44
|
-
"
|
|
44
|
+
"applicationId": {
|
|
45
45
|
"default": "ALGOLIA_APPLICATION_ID"
|
|
46
46
|
}
|
|
47
47
|
}
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
],
|
|
50
50
|
"security": [
|
|
51
51
|
{
|
|
52
|
-
"
|
|
52
|
+
"applicationId": [],
|
|
53
53
|
"apiKey": []
|
|
54
54
|
}
|
|
55
55
|
],
|
|
@@ -302,12 +302,16 @@
|
|
|
302
302
|
},
|
|
303
303
|
"/1/indexes/{indexName}/query": {
|
|
304
304
|
"post": {
|
|
305
|
-
"tags": [
|
|
305
|
+
"tags": [
|
|
306
|
+
"Search"
|
|
307
|
+
],
|
|
306
308
|
"operationId": "searchSingleIndex",
|
|
307
309
|
"x-mcp-tool": true,
|
|
308
310
|
"x-use-read-transporter": true,
|
|
309
311
|
"x-cacheable": true,
|
|
310
|
-
"x-acl": [
|
|
312
|
+
"x-acl": [
|
|
313
|
+
"search"
|
|
314
|
+
],
|
|
311
315
|
"summary": "Search an index",
|
|
312
316
|
"description": "Searches a single index and returns matching search results (_hits_).\n\nThis method lets you retrieve up to 1,000 hits.\nIf you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.\n",
|
|
313
317
|
"parameters": [
|
|
@@ -352,12 +356,16 @@
|
|
|
352
356
|
},
|
|
353
357
|
"/1/indexes/*/queries": {
|
|
354
358
|
"post": {
|
|
355
|
-
"tags": [
|
|
359
|
+
"tags": [
|
|
360
|
+
"Search"
|
|
361
|
+
],
|
|
356
362
|
"operationId": "search",
|
|
357
363
|
"x-use-read-transporter": true,
|
|
358
364
|
"x-cacheable": true,
|
|
359
365
|
"x-legacy-signature": true,
|
|
360
|
-
"x-acl": [
|
|
366
|
+
"x-acl": [
|
|
367
|
+
"search"
|
|
368
|
+
],
|
|
361
369
|
"summary": "Search multiple indices",
|
|
362
370
|
"description": "Sends multiple search requests to one or more indices.\n\nThis can be useful in these cases:\n\n- Different indices for different purposes, such as, one index for products, another one for marketing content.\n- Multiple searches to the same index—for example, with different filters.\n\nUse the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.\n",
|
|
363
371
|
"requestBody": {
|
|
@@ -380,7 +388,9 @@
|
|
|
380
388
|
"$ref": "#/components/schemas/searchStrategy"
|
|
381
389
|
}
|
|
382
390
|
},
|
|
383
|
-
"required": [
|
|
391
|
+
"required": [
|
|
392
|
+
"requests"
|
|
393
|
+
]
|
|
384
394
|
}
|
|
385
395
|
}
|
|
386
396
|
}
|
|
@@ -402,7 +412,9 @@
|
|
|
402
412
|
}
|
|
403
413
|
}
|
|
404
414
|
},
|
|
405
|
-
"required": [
|
|
415
|
+
"required": [
|
|
416
|
+
"results"
|
|
417
|
+
]
|
|
406
418
|
}
|
|
407
419
|
}
|
|
408
420
|
}
|
|
@@ -424,11 +436,15 @@
|
|
|
424
436
|
},
|
|
425
437
|
"/1/indexes/{indexName}/facets/{facetName}/query": {
|
|
426
438
|
"post": {
|
|
427
|
-
"tags": [
|
|
439
|
+
"tags": [
|
|
440
|
+
"Search"
|
|
441
|
+
],
|
|
428
442
|
"operationId": "searchForFacetValues",
|
|
429
443
|
"x-use-read-transporter": true,
|
|
430
444
|
"x-cacheable": true,
|
|
431
|
-
"x-acl": [
|
|
445
|
+
"x-acl": [
|
|
446
|
+
"search"
|
|
447
|
+
],
|
|
432
448
|
"summary": "Search for facet values",
|
|
433
449
|
"description": "Searches for values of a specified facet attribute.\n\n- By default, facet values are sorted by decreasing count.\n You can adjust this with the `sortFacetValueBy` parameter.\n- Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.\n",
|
|
434
450
|
"parameters": [
|
|
@@ -495,10 +511,14 @@
|
|
|
495
511
|
},
|
|
496
512
|
"/1/indexes/{indexName}/browse": {
|
|
497
513
|
"post": {
|
|
498
|
-
"tags": [
|
|
514
|
+
"tags": [
|
|
515
|
+
"Search"
|
|
516
|
+
],
|
|
499
517
|
"operationId": "browse",
|
|
500
518
|
"x-use-read-transporter": true,
|
|
501
|
-
"x-acl": [
|
|
519
|
+
"x-acl": [
|
|
520
|
+
"browse"
|
|
521
|
+
],
|
|
502
522
|
"summary": "Browse for records",
|
|
503
523
|
"description": "Retrieves records from an index, up to 1,000 per request.\n\nWhile searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details),\nbrowsing _just_ returns matching records.\nThis can be useful if you want to export your indices.\n\n- The Analytics API doesn't collect data when using `browse`.\n- Records are ranked by attributes and custom ranking.\n- There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.\n\nBrowse requests automatically apply these settings:\n\n- `advancedSyntax`: `false`\n- `attributesToHighlight`: `[]`\n- `attributesToSnippet`: `[]`\n- `distinct`: `false`\n- `enablePersonalization`: `false`\n- `enableRules`: `false`\n- `facets`: `[]`\n- `getRankingInfo`: `false`\n- `ignorePlurals`: `false`\n- `optionalFilters`: `[]`\n- `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`)\n\nIf you send these parameters with your browse requests, they'll be ignored.\n",
|
|
504
524
|
"parameters": [
|
|
@@ -543,10 +563,14 @@
|
|
|
543
563
|
},
|
|
544
564
|
"/1/indexes/{indexName}": {
|
|
545
565
|
"post": {
|
|
546
|
-
"tags": [
|
|
566
|
+
"tags": [
|
|
567
|
+
"Records"
|
|
568
|
+
],
|
|
547
569
|
"operationId": "saveObject",
|
|
548
570
|
"x-mcp-tool": true,
|
|
549
|
-
"x-acl": [
|
|
571
|
+
"x-acl": [
|
|
572
|
+
"addObject"
|
|
573
|
+
],
|
|
550
574
|
"description": "Adds a record to an index or replaces it.\n\n- If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index.\n- If a record with the specified object ID exists, the existing record is replaced.\n- If a record with the specified object ID doesn't exist, a new record is added to your index.\n- If you add a record to an index that doesn't exist yet, a new index is created.\n\nTo update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject).\nTo add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).\n\nThis operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).\n",
|
|
551
575
|
"summary": "Add a new record (with auto-generated object ID)",
|
|
552
576
|
"parameters": [
|
|
@@ -591,7 +615,10 @@
|
|
|
591
615
|
"$ref": "#/components/schemas/objectID"
|
|
592
616
|
}
|
|
593
617
|
},
|
|
594
|
-
"required": [
|
|
618
|
+
"required": [
|
|
619
|
+
"taskID",
|
|
620
|
+
"createdAt"
|
|
621
|
+
]
|
|
595
622
|
}
|
|
596
623
|
}
|
|
597
624
|
}
|
|
@@ -611,9 +638,13 @@
|
|
|
611
638
|
}
|
|
612
639
|
},
|
|
613
640
|
"delete": {
|
|
614
|
-
"tags": [
|
|
641
|
+
"tags": [
|
|
642
|
+
"Indices"
|
|
643
|
+
],
|
|
615
644
|
"operationId": "deleteIndex",
|
|
616
|
-
"x-acl": [
|
|
645
|
+
"x-acl": [
|
|
646
|
+
"deleteIndex"
|
|
647
|
+
],
|
|
617
648
|
"summary": "Delete an index",
|
|
618
649
|
"description": "Deletes an index and all its settings.\n\n- Deleting an index doesn't delete its analytics data.\n- If you try to delete a non-existing index, the operation is ignored without warning.\n- If the index you want to delete has replica indices, the replicas become independent indices.\n- If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it.\n For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).\n",
|
|
619
650
|
"externalDocs": {
|
|
@@ -646,9 +677,13 @@
|
|
|
646
677
|
},
|
|
647
678
|
"/1/indexes/{indexName}/{objectID}": {
|
|
648
679
|
"get": {
|
|
649
|
-
"tags": [
|
|
680
|
+
"tags": [
|
|
681
|
+
"Records"
|
|
682
|
+
],
|
|
650
683
|
"operationId": "getObject",
|
|
651
|
-
"x-acl": [
|
|
684
|
+
"x-acl": [
|
|
685
|
+
"search"
|
|
686
|
+
],
|
|
652
687
|
"summary": "Retrieve a record",
|
|
653
688
|
"description": "Retrieves one record by its object ID.\n\nTo retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).\n",
|
|
654
689
|
"parameters": [
|
|
@@ -697,9 +732,13 @@
|
|
|
697
732
|
}
|
|
698
733
|
},
|
|
699
734
|
"put": {
|
|
700
|
-
"tags": [
|
|
735
|
+
"tags": [
|
|
736
|
+
"Records"
|
|
737
|
+
],
|
|
701
738
|
"operationId": "addOrUpdateObject",
|
|
702
|
-
"x-acl": [
|
|
739
|
+
"x-acl": [
|
|
740
|
+
"addObject"
|
|
741
|
+
],
|
|
703
742
|
"summary": "Add or replace a record",
|
|
704
743
|
"description": "If a record with the specified object ID exists, the existing record is replaced.\nOtherwise, a new record is added to the index.\n\nIf you want to use auto-generated object IDs, use the [`saveObject` operation](#tag/Records/operation/saveObject).\nTo update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead.\nTo add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).\n",
|
|
705
744
|
"parameters": [
|
|
@@ -746,9 +785,13 @@
|
|
|
746
785
|
}
|
|
747
786
|
},
|
|
748
787
|
"delete": {
|
|
749
|
-
"tags": [
|
|
788
|
+
"tags": [
|
|
789
|
+
"Records"
|
|
790
|
+
],
|
|
750
791
|
"operationId": "deleteObject",
|
|
751
|
-
"x-acl": [
|
|
792
|
+
"x-acl": [
|
|
793
|
+
"deleteObject"
|
|
794
|
+
],
|
|
752
795
|
"summary": "Delete a record",
|
|
753
796
|
"description": "Deletes a record by its object ID.\n\nTo delete more than one record, use the [`batch` operation](#tag/Records/operation/batch).\nTo delete records matching a query, use the [`deleteBy` operation](#tag/Records/operation/deleteBy).\n",
|
|
754
797
|
"parameters": [
|
|
@@ -780,10 +823,14 @@
|
|
|
780
823
|
},
|
|
781
824
|
"/1/indexes/{indexName}/deleteByQuery": {
|
|
782
825
|
"post": {
|
|
783
|
-
"tags": [
|
|
826
|
+
"tags": [
|
|
827
|
+
"Records"
|
|
828
|
+
],
|
|
784
829
|
"operationId": "deleteBy",
|
|
785
830
|
"x-mcp-tool": true,
|
|
786
|
-
"x-acl": [
|
|
831
|
+
"x-acl": [
|
|
832
|
+
"deleteIndex"
|
|
833
|
+
],
|
|
787
834
|
"summary": "Delete records matching a filter",
|
|
788
835
|
"description": "This operation doesn't accept empty filters.\n\nThis operation is resource-intensive.\nYou should only use it if you can't get the object IDs of the records you want to delete.\nIt's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse),\nand then delete the records using the [`batch` operation](#tag/Records/operation/batch).\n\nThis operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).\n",
|
|
789
836
|
"externalDocs": {
|
|
@@ -826,9 +873,13 @@
|
|
|
826
873
|
},
|
|
827
874
|
"/1/indexes/{indexName}/clear": {
|
|
828
875
|
"post": {
|
|
829
|
-
"tags": [
|
|
876
|
+
"tags": [
|
|
877
|
+
"Records"
|
|
878
|
+
],
|
|
830
879
|
"operationId": "clearObjects",
|
|
831
|
-
"x-acl": [
|
|
880
|
+
"x-acl": [
|
|
881
|
+
"deleteIndex"
|
|
882
|
+
],
|
|
832
883
|
"summary": "Delete all records from an index",
|
|
833
884
|
"description": "Deletes only the records from an index while keeping settings, synonyms, and rules.\nThis operation is resource-intensive and subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).\n",
|
|
834
885
|
"parameters": [
|
|
@@ -857,10 +908,14 @@
|
|
|
857
908
|
},
|
|
858
909
|
"/1/indexes/{indexName}/{objectID}/partial": {
|
|
859
910
|
"post": {
|
|
860
|
-
"tags": [
|
|
911
|
+
"tags": [
|
|
912
|
+
"Records"
|
|
913
|
+
],
|
|
861
914
|
"operationId": "partialUpdateObject",
|
|
862
915
|
"x-mcp-tool": true,
|
|
863
|
-
"x-acl": [
|
|
916
|
+
"x-acl": [
|
|
917
|
+
"addObject"
|
|
918
|
+
],
|
|
864
919
|
"summary": "Add or update attributes",
|
|
865
920
|
"x-codegen-request-body-name": "attributesToUpdate",
|
|
866
921
|
"description": "Adds new attributes to a record, or updates existing ones.\n\n- If a record with the specified object ID doesn't exist,\n a new record is added to the index **if** `createIfNotExists` is true.\n- If the index doesn't exist yet, this method creates a new index.\n- You can use any first-level attribute but not nested attributes.\n If you specify a nested attribute, this operation replaces its first-level ancestor.\n\nTo update an attribute without pushing the entire record, you can use these built-in operations.\nThese operations can be helpful if you don't have access to your initial data.\n\n- Increment: increment a numeric attribute\n- Decrement: decrement a numeric attribute\n- Add: append a number or string element to an array attribute\n- Remove: remove all matching number or string elements from an array attribute made of numbers or strings\n- AddUnique: add a number or string element to an array attribute made of numbers or strings only if it's not already present\n- IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn't exist, the engine only creates it if you pass an IncrementFrom value of 0.\n- IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet value greater than 0.\n\nYou can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties:\n\n- _operation: the operation to apply on the attribute\n- value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.\n\nWhen updating multiple attributes or using multiple operations targeting the same record, you should use a single partial update for faster processing.\n\nThis operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).\n",
|
|
@@ -914,7 +969,9 @@
|
|
|
914
969
|
},
|
|
915
970
|
"/1/indexes/{indexName}/batch": {
|
|
916
971
|
"post": {
|
|
917
|
-
"tags": [
|
|
972
|
+
"tags": [
|
|
973
|
+
"Records"
|
|
974
|
+
],
|
|
918
975
|
"operationId": "batch",
|
|
919
976
|
"x-mcp-tool": true,
|
|
920
977
|
"summary": "Batch indexing operations on one index",
|
|
@@ -963,7 +1020,9 @@
|
|
|
963
1020
|
},
|
|
964
1021
|
"/1/indexes/*/batch": {
|
|
965
1022
|
"post": {
|
|
966
|
-
"tags": [
|
|
1023
|
+
"tags": [
|
|
1024
|
+
"Records"
|
|
1025
|
+
],
|
|
967
1026
|
"operationId": "multipleBatch",
|
|
968
1027
|
"x-mcp-tool": true,
|
|
969
1028
|
"description": "Adds, updates, or deletes records in multiple indices with a single API request.\n\n- Actions are applied in the order they are specified.\n- Actions are equivalent to the individual API requests of the same name.\n\nThis operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).\n",
|
|
@@ -996,11 +1055,16 @@
|
|
|
996
1055
|
"$ref": "#/components/schemas/indexName"
|
|
997
1056
|
}
|
|
998
1057
|
},
|
|
999
|
-
"required": [
|
|
1058
|
+
"required": [
|
|
1059
|
+
"action",
|
|
1060
|
+
"indexName"
|
|
1061
|
+
]
|
|
1000
1062
|
}
|
|
1001
1063
|
}
|
|
1002
1064
|
},
|
|
1003
|
-
"required": [
|
|
1065
|
+
"required": [
|
|
1066
|
+
"requests"
|
|
1067
|
+
]
|
|
1004
1068
|
},
|
|
1005
1069
|
"examples": {
|
|
1006
1070
|
"batch": {
|
|
@@ -1053,7 +1117,10 @@
|
|
|
1053
1117
|
"$ref": "#/components/schemas/objectIDs"
|
|
1054
1118
|
}
|
|
1055
1119
|
},
|
|
1056
|
-
"required": [
|
|
1120
|
+
"required": [
|
|
1121
|
+
"taskID",
|
|
1122
|
+
"objectIDs"
|
|
1123
|
+
]
|
|
1057
1124
|
}
|
|
1058
1125
|
}
|
|
1059
1126
|
}
|
|
@@ -1075,11 +1142,15 @@
|
|
|
1075
1142
|
},
|
|
1076
1143
|
"/1/indexes/*/objects": {
|
|
1077
1144
|
"post": {
|
|
1078
|
-
"tags": [
|
|
1145
|
+
"tags": [
|
|
1146
|
+
"Records"
|
|
1147
|
+
],
|
|
1079
1148
|
"operationId": "getObjects",
|
|
1080
1149
|
"x-use-read-transporter": true,
|
|
1081
1150
|
"x-cacheable": true,
|
|
1082
|
-
"x-acl": [
|
|
1151
|
+
"x-acl": [
|
|
1152
|
+
"search"
|
|
1153
|
+
],
|
|
1083
1154
|
"summary": "Retrieve records",
|
|
1084
1155
|
"description": "Retrieves one or more records, potentially from different indices.\n\nRecords are returned in the same order as the requests.\n",
|
|
1085
1156
|
"requestBody": {
|
|
@@ -1100,7 +1171,10 @@
|
|
|
1100
1171
|
"description": "Request body for retrieving records.",
|
|
1101
1172
|
"type": "object",
|
|
1102
1173
|
"additionalProperties": false,
|
|
1103
|
-
"required": [
|
|
1174
|
+
"required": [
|
|
1175
|
+
"objectID",
|
|
1176
|
+
"indexName"
|
|
1177
|
+
],
|
|
1104
1178
|
"properties": {
|
|
1105
1179
|
"attributesToRetrieve": {
|
|
1106
1180
|
"type": "array",
|
|
@@ -1108,7 +1182,11 @@
|
|
|
1108
1182
|
"type": "string"
|
|
1109
1183
|
},
|
|
1110
1184
|
"description": "Attributes to retrieve.\nIf not specified, all retrievable attributes are returned.\n",
|
|
1111
|
-
"example": [
|
|
1185
|
+
"example": [
|
|
1186
|
+
"author",
|
|
1187
|
+
"title",
|
|
1188
|
+
"content"
|
|
1189
|
+
]
|
|
1112
1190
|
},
|
|
1113
1191
|
"objectID": {
|
|
1114
1192
|
"type": "string",
|
|
@@ -1124,7 +1202,9 @@
|
|
|
1124
1202
|
}
|
|
1125
1203
|
}
|
|
1126
1204
|
},
|
|
1127
|
-
"required": [
|
|
1205
|
+
"required": [
|
|
1206
|
+
"requests"
|
|
1207
|
+
]
|
|
1128
1208
|
}
|
|
1129
1209
|
}
|
|
1130
1210
|
}
|
|
@@ -1154,7 +1234,9 @@
|
|
|
1154
1234
|
}
|
|
1155
1235
|
}
|
|
1156
1236
|
},
|
|
1157
|
-
"required": [
|
|
1237
|
+
"required": [
|
|
1238
|
+
"results"
|
|
1239
|
+
]
|
|
1158
1240
|
}
|
|
1159
1241
|
}
|
|
1160
1242
|
}
|
|
@@ -1176,10 +1258,14 @@
|
|
|
1176
1258
|
},
|
|
1177
1259
|
"/1/indexes/{indexName}/settings": {
|
|
1178
1260
|
"get": {
|
|
1179
|
-
"tags": [
|
|
1261
|
+
"tags": [
|
|
1262
|
+
"Indices"
|
|
1263
|
+
],
|
|
1180
1264
|
"operationId": "getSettings",
|
|
1181
1265
|
"x-mcp-tool": true,
|
|
1182
|
-
"x-acl": [
|
|
1266
|
+
"x-acl": [
|
|
1267
|
+
"settings"
|
|
1268
|
+
],
|
|
1183
1269
|
"description": "Retrieves an object with non-null index settings.",
|
|
1184
1270
|
"summary": "Retrieve index settings",
|
|
1185
1271
|
"parameters": [
|
|
@@ -1216,9 +1302,13 @@
|
|
|
1216
1302
|
}
|
|
1217
1303
|
},
|
|
1218
1304
|
"put": {
|
|
1219
|
-
"tags": [
|
|
1305
|
+
"tags": [
|
|
1306
|
+
"Indices"
|
|
1307
|
+
],
|
|
1220
1308
|
"operationId": "setSettings",
|
|
1221
|
-
"x-acl": [
|
|
1309
|
+
"x-acl": [
|
|
1310
|
+
"editSettings"
|
|
1311
|
+
],
|
|
1222
1312
|
"description": "Update the specified index settings.\n\nIndex settings that you don't specify are left unchanged.\nSpecify `null` to reset a setting to its default value.\n\nFor best performance, update the index settings before you add new records to your index.\n",
|
|
1223
1313
|
"summary": "Update index settings",
|
|
1224
1314
|
"parameters": [
|
|
@@ -1260,9 +1350,13 @@
|
|
|
1260
1350
|
},
|
|
1261
1351
|
"/1/indexes/{indexName}/synonyms/{objectID}": {
|
|
1262
1352
|
"get": {
|
|
1263
|
-
"tags": [
|
|
1353
|
+
"tags": [
|
|
1354
|
+
"Synonyms"
|
|
1355
|
+
],
|
|
1264
1356
|
"operationId": "getSynonym",
|
|
1265
|
-
"x-acl": [
|
|
1357
|
+
"x-acl": [
|
|
1358
|
+
"settings"
|
|
1359
|
+
],
|
|
1266
1360
|
"summary": "Retrieve a synonym",
|
|
1267
1361
|
"description": "Retrieves a synonym by its ID.\nTo find the object IDs for your synonyms,\nuse the [`search` operation](#tag/Synonyms/operation/searchSynonyms).\n",
|
|
1268
1362
|
"parameters": [
|
|
@@ -1299,9 +1393,13 @@
|
|
|
1299
1393
|
}
|
|
1300
1394
|
},
|
|
1301
1395
|
"put": {
|
|
1302
|
-
"tags": [
|
|
1396
|
+
"tags": [
|
|
1397
|
+
"Synonyms"
|
|
1398
|
+
],
|
|
1303
1399
|
"operationId": "saveSynonym",
|
|
1304
|
-
"x-acl": [
|
|
1400
|
+
"x-acl": [
|
|
1401
|
+
"editSettings"
|
|
1402
|
+
],
|
|
1305
1403
|
"summary": "Create or replace a synonym",
|
|
1306
1404
|
"description": "If a synonym with the specified object ID doesn't exist, Algolia adds a new one.\nOtherwise, the existing synonym is replaced.\nTo add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).\n",
|
|
1307
1405
|
"parameters": [
|
|
@@ -1345,7 +1443,11 @@
|
|
|
1345
1443
|
"$ref": "#/components/schemas/id"
|
|
1346
1444
|
}
|
|
1347
1445
|
},
|
|
1348
|
-
"required": [
|
|
1446
|
+
"required": [
|
|
1447
|
+
"taskID",
|
|
1448
|
+
"updatedAt",
|
|
1449
|
+
"id"
|
|
1450
|
+
]
|
|
1349
1451
|
}
|
|
1350
1452
|
}
|
|
1351
1453
|
}
|
|
@@ -1365,9 +1467,13 @@
|
|
|
1365
1467
|
}
|
|
1366
1468
|
},
|
|
1367
1469
|
"delete": {
|
|
1368
|
-
"tags": [
|
|
1470
|
+
"tags": [
|
|
1471
|
+
"Synonyms"
|
|
1472
|
+
],
|
|
1369
1473
|
"operationId": "deleteSynonym",
|
|
1370
|
-
"x-acl": [
|
|
1474
|
+
"x-acl": [
|
|
1475
|
+
"editSettings"
|
|
1476
|
+
],
|
|
1371
1477
|
"summary": "Delete a synonym",
|
|
1372
1478
|
"description": "Deletes a synonym by its ID.\nTo find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).\n",
|
|
1373
1479
|
"parameters": [
|
|
@@ -1402,9 +1508,13 @@
|
|
|
1402
1508
|
},
|
|
1403
1509
|
"/1/indexes/{indexName}/synonyms/batch": {
|
|
1404
1510
|
"post": {
|
|
1405
|
-
"tags": [
|
|
1511
|
+
"tags": [
|
|
1512
|
+
"Synonyms"
|
|
1513
|
+
],
|
|
1406
1514
|
"operationId": "saveSynonyms",
|
|
1407
|
-
"x-acl": [
|
|
1515
|
+
"x-acl": [
|
|
1516
|
+
"editSettings"
|
|
1517
|
+
],
|
|
1408
1518
|
"summary": "Create or replace synonyms",
|
|
1409
1519
|
"description": "If a synonym with the `objectID` doesn't exist, Algolia adds a new one.\nOtherwise, existing synonyms are replaced.\n\nThis operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).\n",
|
|
1410
1520
|
"parameters": [
|
|
@@ -1449,9 +1559,13 @@
|
|
|
1449
1559
|
},
|
|
1450
1560
|
"/1/indexes/{indexName}/synonyms/clear": {
|
|
1451
1561
|
"post": {
|
|
1452
|
-
"tags": [
|
|
1562
|
+
"tags": [
|
|
1563
|
+
"Synonyms"
|
|
1564
|
+
],
|
|
1453
1565
|
"operationId": "clearSynonyms",
|
|
1454
|
-
"x-acl": [
|
|
1566
|
+
"x-acl": [
|
|
1567
|
+
"editSettings"
|
|
1568
|
+
],
|
|
1455
1569
|
"summary": "Delete all synonyms",
|
|
1456
1570
|
"description": "Deletes all synonyms from the index.",
|
|
1457
1571
|
"parameters": [
|
|
@@ -1483,12 +1597,16 @@
|
|
|
1483
1597
|
},
|
|
1484
1598
|
"/1/indexes/{indexName}/synonyms/search": {
|
|
1485
1599
|
"post": {
|
|
1486
|
-
"tags": [
|
|
1600
|
+
"tags": [
|
|
1601
|
+
"Synonyms"
|
|
1602
|
+
],
|
|
1487
1603
|
"operationId": "searchSynonyms",
|
|
1488
1604
|
"x-mcp-tool": true,
|
|
1489
1605
|
"x-use-read-transporter": true,
|
|
1490
1606
|
"x-cacheable": true,
|
|
1491
|
-
"x-acl": [
|
|
1607
|
+
"x-acl": [
|
|
1608
|
+
"settings"
|
|
1609
|
+
],
|
|
1492
1610
|
"summary": "Search for synonyms",
|
|
1493
1611
|
"description": "Searches for synonyms in your index.",
|
|
1494
1612
|
"parameters": [
|
|
@@ -1550,9 +1668,13 @@
|
|
|
1550
1668
|
},
|
|
1551
1669
|
"/1/keys": {
|
|
1552
1670
|
"get": {
|
|
1553
|
-
"tags": [
|
|
1671
|
+
"tags": [
|
|
1672
|
+
"Api Keys"
|
|
1673
|
+
],
|
|
1554
1674
|
"operationId": "listApiKeys",
|
|
1555
|
-
"x-acl": [
|
|
1675
|
+
"x-acl": [
|
|
1676
|
+
"admin"
|
|
1677
|
+
],
|
|
1556
1678
|
"summary": "List API keys",
|
|
1557
1679
|
"description": "Lists all API keys associated with your Algolia application, including their permissions and restrictions.",
|
|
1558
1680
|
"responses": {
|
|
@@ -1564,7 +1686,9 @@
|
|
|
1564
1686
|
"title": "listApiKeysResponse",
|
|
1565
1687
|
"type": "object",
|
|
1566
1688
|
"additionalProperties": false,
|
|
1567
|
-
"required": [
|
|
1689
|
+
"required": [
|
|
1690
|
+
"keys"
|
|
1691
|
+
],
|
|
1568
1692
|
"properties": {
|
|
1569
1693
|
"keys": {
|
|
1570
1694
|
"type": "array",
|
|
@@ -1593,9 +1717,13 @@
|
|
|
1593
1717
|
}
|
|
1594
1718
|
},
|
|
1595
1719
|
"post": {
|
|
1596
|
-
"tags": [
|
|
1720
|
+
"tags": [
|
|
1721
|
+
"Api Keys"
|
|
1722
|
+
],
|
|
1597
1723
|
"operationId": "addApiKey",
|
|
1598
|
-
"x-acl": [
|
|
1724
|
+
"x-acl": [
|
|
1725
|
+
"admin"
|
|
1726
|
+
],
|
|
1599
1727
|
"summary": "Create an API key",
|
|
1600
1728
|
"description": "Creates a new API key with specific permissions and restrictions.",
|
|
1601
1729
|
"requestBody": {
|
|
@@ -1636,7 +1764,9 @@
|
|
|
1636
1764
|
},
|
|
1637
1765
|
"/1/keys/{key}": {
|
|
1638
1766
|
"get": {
|
|
1639
|
-
"tags": [
|
|
1767
|
+
"tags": [
|
|
1768
|
+
"Api Keys"
|
|
1769
|
+
],
|
|
1640
1770
|
"operationId": "getApiKey",
|
|
1641
1771
|
"summary": "Retrieve API key permissions",
|
|
1642
1772
|
"description": "Gets the permissions and restrictions of an API key.\n\nWhen authenticating with the admin API key, you can request information for any of your application's keys.\nWhen authenticating with other API keys, you can only retrieve information for that key,\nwith the description replaced by `<redacted>`.\n",
|
|
@@ -1671,9 +1801,13 @@
|
|
|
1671
1801
|
}
|
|
1672
1802
|
},
|
|
1673
1803
|
"put": {
|
|
1674
|
-
"tags": [
|
|
1804
|
+
"tags": [
|
|
1805
|
+
"Api Keys"
|
|
1806
|
+
],
|
|
1675
1807
|
"operationId": "updateApiKey",
|
|
1676
|
-
"x-acl": [
|
|
1808
|
+
"x-acl": [
|
|
1809
|
+
"admin"
|
|
1810
|
+
],
|
|
1677
1811
|
"summary": "Update an API key",
|
|
1678
1812
|
"description": "Replaces the permissions of an existing API key.\n\nAny unspecified attribute resets that attribute to its default value.\n",
|
|
1679
1813
|
"parameters": [
|
|
@@ -1700,7 +1834,10 @@
|
|
|
1700
1834
|
"title": "updateApiKeyResponse",
|
|
1701
1835
|
"type": "object",
|
|
1702
1836
|
"additionalProperties": false,
|
|
1703
|
-
"required": [
|
|
1837
|
+
"required": [
|
|
1838
|
+
"key",
|
|
1839
|
+
"updatedAt"
|
|
1840
|
+
],
|
|
1704
1841
|
"properties": {
|
|
1705
1842
|
"key": {
|
|
1706
1843
|
"$ref": "#/components/schemas/keyString"
|
|
@@ -1728,9 +1865,13 @@
|
|
|
1728
1865
|
}
|
|
1729
1866
|
},
|
|
1730
1867
|
"delete": {
|
|
1731
|
-
"tags": [
|
|
1868
|
+
"tags": [
|
|
1869
|
+
"Api Keys"
|
|
1870
|
+
],
|
|
1732
1871
|
"operationId": "deleteApiKey",
|
|
1733
|
-
"x-acl": [
|
|
1872
|
+
"x-acl": [
|
|
1873
|
+
"admin"
|
|
1874
|
+
],
|
|
1734
1875
|
"summary": "Delete an API key",
|
|
1735
1876
|
"description": "Deletes the API key.",
|
|
1736
1877
|
"parameters": [
|
|
@@ -1747,7 +1888,9 @@
|
|
|
1747
1888
|
"title": "deleteApiKeyResponse",
|
|
1748
1889
|
"type": "object",
|
|
1749
1890
|
"additionalProperties": false,
|
|
1750
|
-
"required": [
|
|
1891
|
+
"required": [
|
|
1892
|
+
"deletedAt"
|
|
1893
|
+
],
|
|
1751
1894
|
"properties": {
|
|
1752
1895
|
"deletedAt": {
|
|
1753
1896
|
"$ref": "#/components/schemas/deletedAt"
|
|
@@ -1774,9 +1917,13 @@
|
|
|
1774
1917
|
},
|
|
1775
1918
|
"/1/keys/{key}/restore": {
|
|
1776
1919
|
"post": {
|
|
1777
|
-
"tags": [
|
|
1920
|
+
"tags": [
|
|
1921
|
+
"Api Keys"
|
|
1922
|
+
],
|
|
1778
1923
|
"operationId": "restoreApiKey",
|
|
1779
|
-
"x-acl": [
|
|
1924
|
+
"x-acl": [
|
|
1925
|
+
"admin"
|
|
1926
|
+
],
|
|
1780
1927
|
"summary": "Restore an API key",
|
|
1781
1928
|
"description": "Restores a deleted API key.\n\nRestoring resets the `validity` attribute to `0`.\n\nAlgolia stores up to 1,000 API keys per application.\nIf you create more, the oldest API keys are deleted and can't be restored.\n",
|
|
1782
1929
|
"parameters": [
|
|
@@ -1812,9 +1959,13 @@
|
|
|
1812
1959
|
},
|
|
1813
1960
|
"/1/indexes/{indexName}/rules/{objectID}": {
|
|
1814
1961
|
"get": {
|
|
1815
|
-
"tags": [
|
|
1962
|
+
"tags": [
|
|
1963
|
+
"Rules"
|
|
1964
|
+
],
|
|
1816
1965
|
"operationId": "getRule",
|
|
1817
|
-
"x-acl": [
|
|
1966
|
+
"x-acl": [
|
|
1967
|
+
"settings"
|
|
1968
|
+
],
|
|
1818
1969
|
"summary": "Retrieve a rule",
|
|
1819
1970
|
"description": "Retrieves a rule by its ID.\nTo find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).\n",
|
|
1820
1971
|
"parameters": [
|
|
@@ -1851,9 +2002,13 @@
|
|
|
1851
2002
|
}
|
|
1852
2003
|
},
|
|
1853
2004
|
"put": {
|
|
1854
|
-
"tags": [
|
|
2005
|
+
"tags": [
|
|
2006
|
+
"Rules"
|
|
2007
|
+
],
|
|
1855
2008
|
"operationId": "saveRule",
|
|
1856
|
-
"x-acl": [
|
|
2009
|
+
"x-acl": [
|
|
2010
|
+
"editSettings"
|
|
2011
|
+
],
|
|
1857
2012
|
"summary": "Create or replace a rule",
|
|
1858
2013
|
"description": "If a rule with the specified object ID doesn't exist, it's created.\nOtherwise, the existing rule is replaced.\n\nTo create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).\n",
|
|
1859
2014
|
"parameters": [
|
|
@@ -1896,9 +2051,13 @@
|
|
|
1896
2051
|
}
|
|
1897
2052
|
},
|
|
1898
2053
|
"delete": {
|
|
1899
|
-
"tags": [
|
|
2054
|
+
"tags": [
|
|
2055
|
+
"Rules"
|
|
2056
|
+
],
|
|
1900
2057
|
"operationId": "deleteRule",
|
|
1901
|
-
"x-acl": [
|
|
2058
|
+
"x-acl": [
|
|
2059
|
+
"editSettings"
|
|
2060
|
+
],
|
|
1902
2061
|
"summary": "Delete a rule",
|
|
1903
2062
|
"description": "Deletes a rule by its ID.\nTo find the object ID for rules,\nuse the [`search` operation](#tag/Rules/operation/searchRules).\n",
|
|
1904
2063
|
"parameters": [
|
|
@@ -1933,9 +2092,13 @@
|
|
|
1933
2092
|
},
|
|
1934
2093
|
"/1/indexes/{indexName}/rules/batch": {
|
|
1935
2094
|
"post": {
|
|
1936
|
-
"tags": [
|
|
2095
|
+
"tags": [
|
|
2096
|
+
"Rules"
|
|
2097
|
+
],
|
|
1937
2098
|
"operationId": "saveRules",
|
|
1938
|
-
"x-acl": [
|
|
2099
|
+
"x-acl": [
|
|
2100
|
+
"editSettings"
|
|
2101
|
+
],
|
|
1939
2102
|
"summary": "Create or update rules",
|
|
1940
2103
|
"description": "Create or update multiple rules.\n\nIf a rule with the specified object ID doesn't exist, Algolia creates a new one.\nOtherwise, existing rules are replaced.\n\nThis operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).\n",
|
|
1941
2104
|
"x-codegen-request-body-name": "rules",
|
|
@@ -1985,9 +2148,13 @@
|
|
|
1985
2148
|
},
|
|
1986
2149
|
"/1/indexes/{indexName}/rules/clear": {
|
|
1987
2150
|
"post": {
|
|
1988
|
-
"tags": [
|
|
2151
|
+
"tags": [
|
|
2152
|
+
"Rules"
|
|
2153
|
+
],
|
|
1989
2154
|
"operationId": "clearRules",
|
|
1990
|
-
"x-acl": [
|
|
2155
|
+
"x-acl": [
|
|
2156
|
+
"editSettings"
|
|
2157
|
+
],
|
|
1991
2158
|
"summary": "Delete all rules",
|
|
1992
2159
|
"description": "Deletes all rules from the index.",
|
|
1993
2160
|
"parameters": [
|
|
@@ -2019,12 +2186,16 @@
|
|
|
2019
2186
|
},
|
|
2020
2187
|
"/1/indexes/{indexName}/rules/search": {
|
|
2021
2188
|
"post": {
|
|
2022
|
-
"tags": [
|
|
2189
|
+
"tags": [
|
|
2190
|
+
"Rules"
|
|
2191
|
+
],
|
|
2023
2192
|
"operationId": "searchRules",
|
|
2024
2193
|
"x-mcp-tool": true,
|
|
2025
2194
|
"x-use-read-transporter": true,
|
|
2026
2195
|
"x-cacheable": true,
|
|
2027
|
-
"x-acl": [
|
|
2196
|
+
"x-acl": [
|
|
2197
|
+
"settings"
|
|
2198
|
+
],
|
|
2028
2199
|
"summary": "Search for rules",
|
|
2029
2200
|
"description": "Searches for rules in your index.",
|
|
2030
2201
|
"parameters": [
|
|
@@ -2084,7 +2255,12 @@
|
|
|
2084
2255
|
"title": "searchRulesResponse",
|
|
2085
2256
|
"type": "object",
|
|
2086
2257
|
"additionalProperties": false,
|
|
2087
|
-
"required": [
|
|
2258
|
+
"required": [
|
|
2259
|
+
"hits",
|
|
2260
|
+
"nbHits",
|
|
2261
|
+
"page",
|
|
2262
|
+
"nbPages"
|
|
2263
|
+
],
|
|
2088
2264
|
"properties": {
|
|
2089
2265
|
"hits": {
|
|
2090
2266
|
"type": "array",
|
|
@@ -2127,9 +2303,13 @@
|
|
|
2127
2303
|
},
|
|
2128
2304
|
"/1/dictionaries/{dictionaryName}/batch": {
|
|
2129
2305
|
"post": {
|
|
2130
|
-
"tags": [
|
|
2306
|
+
"tags": [
|
|
2307
|
+
"Dictionaries"
|
|
2308
|
+
],
|
|
2131
2309
|
"operationId": "batchDictionaryEntries",
|
|
2132
|
-
"x-acl": [
|
|
2310
|
+
"x-acl": [
|
|
2311
|
+
"editSettings"
|
|
2312
|
+
],
|
|
2133
2313
|
"description": "Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.",
|
|
2134
2314
|
"summary": "Add or delete dictionary entries",
|
|
2135
2315
|
"parameters": [
|
|
@@ -2145,7 +2325,9 @@
|
|
|
2145
2325
|
"title": "batchDictionaryEntriesParams",
|
|
2146
2326
|
"description": "Request body for updating dictionary entries.",
|
|
2147
2327
|
"type": "object",
|
|
2148
|
-
"required": [
|
|
2328
|
+
"required": [
|
|
2329
|
+
"requests"
|
|
2330
|
+
],
|
|
2149
2331
|
"additionalProperties": false,
|
|
2150
2332
|
"properties": {
|
|
2151
2333
|
"clearExistingDictionaryEntries": {
|
|
@@ -2160,7 +2342,10 @@
|
|
|
2160
2342
|
"title": "batchDictionaryEntriesRequest",
|
|
2161
2343
|
"type": "object",
|
|
2162
2344
|
"additionalProperties": false,
|
|
2163
|
-
"required": [
|
|
2345
|
+
"required": [
|
|
2346
|
+
"action",
|
|
2347
|
+
"body"
|
|
2348
|
+
],
|
|
2164
2349
|
"properties": {
|
|
2165
2350
|
"action": {
|
|
2166
2351
|
"$ref": "#/components/schemas/dictionaryAction"
|
|
@@ -2197,11 +2382,15 @@
|
|
|
2197
2382
|
},
|
|
2198
2383
|
"/1/dictionaries/{dictionaryName}/search": {
|
|
2199
2384
|
"post": {
|
|
2200
|
-
"tags": [
|
|
2385
|
+
"tags": [
|
|
2386
|
+
"Dictionaries"
|
|
2387
|
+
],
|
|
2201
2388
|
"operationId": "searchDictionaryEntries",
|
|
2202
2389
|
"x-use-read-transporter": true,
|
|
2203
2390
|
"x-cacheable": true,
|
|
2204
|
-
"x-acl": [
|
|
2391
|
+
"x-acl": [
|
|
2392
|
+
"settings"
|
|
2393
|
+
],
|
|
2205
2394
|
"description": "Searches for standard and custom dictionary entries.",
|
|
2206
2395
|
"summary": "Search dictionary entries",
|
|
2207
2396
|
"parameters": [
|
|
@@ -2217,7 +2406,9 @@
|
|
|
2217
2406
|
"title": "searchDictionaryEntriesParams",
|
|
2218
2407
|
"description": "Search parameter.",
|
|
2219
2408
|
"type": "object",
|
|
2220
|
-
"required": [
|
|
2409
|
+
"required": [
|
|
2410
|
+
"query"
|
|
2411
|
+
],
|
|
2221
2412
|
"additionalProperties": false,
|
|
2222
2413
|
"properties": {
|
|
2223
2414
|
"query": {
|
|
@@ -2265,9 +2456,13 @@
|
|
|
2265
2456
|
},
|
|
2266
2457
|
"/1/dictionaries/*/settings": {
|
|
2267
2458
|
"get": {
|
|
2268
|
-
"tags": [
|
|
2459
|
+
"tags": [
|
|
2460
|
+
"Dictionaries"
|
|
2461
|
+
],
|
|
2269
2462
|
"operationId": "getDictionarySettings",
|
|
2270
|
-
"x-acl": [
|
|
2463
|
+
"x-acl": [
|
|
2464
|
+
"settings"
|
|
2465
|
+
],
|
|
2271
2466
|
"summary": "Retrieve dictionary settings",
|
|
2272
2467
|
"description": "Retrieves the languages for which standard dictionary entries are turned off.",
|
|
2273
2468
|
"responses": {
|
|
@@ -2279,7 +2474,9 @@
|
|
|
2279
2474
|
"title": "getDictionarySettingsResponse",
|
|
2280
2475
|
"additionalProperties": false,
|
|
2281
2476
|
"type": "object",
|
|
2282
|
-
"required": [
|
|
2477
|
+
"required": [
|
|
2478
|
+
"disableStandardEntries"
|
|
2479
|
+
],
|
|
2283
2480
|
"properties": {
|
|
2284
2481
|
"disableStandardEntries": {
|
|
2285
2482
|
"$ref": "#/components/schemas/standardEntries"
|
|
@@ -2304,9 +2501,13 @@
|
|
|
2304
2501
|
}
|
|
2305
2502
|
},
|
|
2306
2503
|
"put": {
|
|
2307
|
-
"tags": [
|
|
2504
|
+
"tags": [
|
|
2505
|
+
"Dictionaries"
|
|
2506
|
+
],
|
|
2308
2507
|
"operationId": "setDictionarySettings",
|
|
2309
|
-
"x-acl": [
|
|
2508
|
+
"x-acl": [
|
|
2509
|
+
"editSettings"
|
|
2510
|
+
],
|
|
2310
2511
|
"description": "Turns standard stop word dictionary entries on or off for a given language.",
|
|
2311
2512
|
"summary": "Update dictionary settings",
|
|
2312
2513
|
"requestBody": {
|
|
@@ -2318,7 +2519,9 @@
|
|
|
2318
2519
|
"type": "object",
|
|
2319
2520
|
"additionalProperties": false,
|
|
2320
2521
|
"description": "Turn on or off the built-in Algolia stop words for a specific language.\n",
|
|
2321
|
-
"required": [
|
|
2522
|
+
"required": [
|
|
2523
|
+
"disableStandardEntries"
|
|
2524
|
+
],
|
|
2322
2525
|
"properties": {
|
|
2323
2526
|
"disableStandardEntries": {
|
|
2324
2527
|
"$ref": "#/components/schemas/standardEntries"
|
|
@@ -2349,9 +2552,13 @@
|
|
|
2349
2552
|
},
|
|
2350
2553
|
"/1/dictionaries/*/languages": {
|
|
2351
2554
|
"get": {
|
|
2352
|
-
"tags": [
|
|
2555
|
+
"tags": [
|
|
2556
|
+
"Dictionaries"
|
|
2557
|
+
],
|
|
2353
2558
|
"operationId": "getDictionaryLanguages",
|
|
2354
|
-
"x-acl": [
|
|
2559
|
+
"x-acl": [
|
|
2560
|
+
"settings"
|
|
2561
|
+
],
|
|
2355
2562
|
"description": "Lists supported languages with their supported dictionary types and number of custom entries.\n",
|
|
2356
2563
|
"summary": "List available languages",
|
|
2357
2564
|
"externalDocs": {
|
|
@@ -2391,10 +2598,14 @@
|
|
|
2391
2598
|
},
|
|
2392
2599
|
"/1/clusters/mapping": {
|
|
2393
2600
|
"post": {
|
|
2394
|
-
"tags": [
|
|
2601
|
+
"tags": [
|
|
2602
|
+
"Clusters"
|
|
2603
|
+
],
|
|
2395
2604
|
"operationId": "assignUserId",
|
|
2396
2605
|
"deprecated": true,
|
|
2397
|
-
"x-acl": [
|
|
2606
|
+
"x-acl": [
|
|
2607
|
+
"admin"
|
|
2608
|
+
],
|
|
2398
2609
|
"summary": "Assign or move a user ID",
|
|
2399
2610
|
"description": "Assigns or moves a user ID to a cluster.\n\nThe time it takes to move a user is proportional to the amount of data linked to the user ID.\n",
|
|
2400
2611
|
"parameters": [
|
|
@@ -2416,7 +2627,9 @@
|
|
|
2416
2627
|
"$ref": "#/components/schemas/clusterName"
|
|
2417
2628
|
}
|
|
2418
2629
|
},
|
|
2419
|
-
"required": [
|
|
2630
|
+
"required": [
|
|
2631
|
+
"cluster"
|
|
2632
|
+
]
|
|
2420
2633
|
}
|
|
2421
2634
|
}
|
|
2422
2635
|
}
|
|
@@ -2440,10 +2653,14 @@
|
|
|
2440
2653
|
}
|
|
2441
2654
|
},
|
|
2442
2655
|
"get": {
|
|
2443
|
-
"tags": [
|
|
2656
|
+
"tags": [
|
|
2657
|
+
"Clusters"
|
|
2658
|
+
],
|
|
2444
2659
|
"operationId": "listUserIds",
|
|
2445
2660
|
"deprecated": true,
|
|
2446
|
-
"x-acl": [
|
|
2661
|
+
"x-acl": [
|
|
2662
|
+
"admin"
|
|
2663
|
+
],
|
|
2447
2664
|
"summary": "List user IDs",
|
|
2448
2665
|
"description": "Lists the userIDs assigned to a multi-cluster application.\n\nSince it can take a few seconds to get the data from the different clusters,\nthe response isn't real-time.\n",
|
|
2449
2666
|
"parameters": [
|
|
@@ -2472,7 +2689,9 @@
|
|
|
2472
2689
|
}
|
|
2473
2690
|
}
|
|
2474
2691
|
},
|
|
2475
|
-
"required": [
|
|
2692
|
+
"required": [
|
|
2693
|
+
"userIDs"
|
|
2694
|
+
]
|
|
2476
2695
|
}
|
|
2477
2696
|
}
|
|
2478
2697
|
}
|
|
@@ -2494,10 +2713,14 @@
|
|
|
2494
2713
|
},
|
|
2495
2714
|
"/1/clusters/mapping/batch": {
|
|
2496
2715
|
"post": {
|
|
2497
|
-
"tags": [
|
|
2716
|
+
"tags": [
|
|
2717
|
+
"Clusters"
|
|
2718
|
+
],
|
|
2498
2719
|
"operationId": "batchAssignUserIds",
|
|
2499
2720
|
"deprecated": true,
|
|
2500
|
-
"x-acl": [
|
|
2721
|
+
"x-acl": [
|
|
2722
|
+
"admin"
|
|
2723
|
+
],
|
|
2501
2724
|
"summary": "Assign multiple userIDs",
|
|
2502
2725
|
"description": "Assigns multiple user IDs to a cluster.\n\n**You can't move users with this operation**.\n",
|
|
2503
2726
|
"parameters": [
|
|
@@ -2521,13 +2744,20 @@
|
|
|
2521
2744
|
"users": {
|
|
2522
2745
|
"type": "array",
|
|
2523
2746
|
"description": "User IDs to assign.",
|
|
2524
|
-
"example": [
|
|
2747
|
+
"example": [
|
|
2748
|
+
"einstein",
|
|
2749
|
+
"bohr",
|
|
2750
|
+
"feynman"
|
|
2751
|
+
],
|
|
2525
2752
|
"items": {
|
|
2526
2753
|
"type": "string"
|
|
2527
2754
|
}
|
|
2528
2755
|
}
|
|
2529
2756
|
},
|
|
2530
|
-
"required": [
|
|
2757
|
+
"required": [
|
|
2758
|
+
"cluster",
|
|
2759
|
+
"users"
|
|
2760
|
+
]
|
|
2531
2761
|
}
|
|
2532
2762
|
}
|
|
2533
2763
|
}
|
|
@@ -2553,10 +2783,14 @@
|
|
|
2553
2783
|
},
|
|
2554
2784
|
"/1/clusters/mapping/top": {
|
|
2555
2785
|
"get": {
|
|
2556
|
-
"tags": [
|
|
2786
|
+
"tags": [
|
|
2787
|
+
"Clusters"
|
|
2788
|
+
],
|
|
2557
2789
|
"operationId": "getTopUserIds",
|
|
2558
2790
|
"deprecated": true,
|
|
2559
|
-
"x-acl": [
|
|
2791
|
+
"x-acl": [
|
|
2792
|
+
"admin"
|
|
2793
|
+
],
|
|
2560
2794
|
"summary": "Get top user IDs",
|
|
2561
2795
|
"description": "Get the IDs of the 10 users with the highest number of records per cluster.\n\nSince it can take a few seconds to get the data from the different clusters,\nthe response isn't real-time.\n",
|
|
2562
2796
|
"responses": {
|
|
@@ -2584,7 +2818,9 @@
|
|
|
2584
2818
|
}
|
|
2585
2819
|
}
|
|
2586
2820
|
},
|
|
2587
|
-
"required": [
|
|
2821
|
+
"required": [
|
|
2822
|
+
"topUsers"
|
|
2823
|
+
]
|
|
2588
2824
|
}
|
|
2589
2825
|
}
|
|
2590
2826
|
}
|
|
@@ -2606,10 +2842,14 @@
|
|
|
2606
2842
|
},
|
|
2607
2843
|
"/1/clusters/mapping/{userID}": {
|
|
2608
2844
|
"get": {
|
|
2609
|
-
"tags": [
|
|
2845
|
+
"tags": [
|
|
2846
|
+
"Clusters"
|
|
2847
|
+
],
|
|
2610
2848
|
"operationId": "getUserId",
|
|
2611
2849
|
"deprecated": true,
|
|
2612
|
-
"x-acl": [
|
|
2850
|
+
"x-acl": [
|
|
2851
|
+
"admin"
|
|
2852
|
+
],
|
|
2613
2853
|
"summary": "Retrieve user ID",
|
|
2614
2854
|
"description": "Returns the user ID data stored in the mapping.\n\nSince it can take a few seconds to get the data from the different clusters,\nthe response isn't real-time.\n",
|
|
2615
2855
|
"parameters": [
|
|
@@ -2643,10 +2883,14 @@
|
|
|
2643
2883
|
}
|
|
2644
2884
|
},
|
|
2645
2885
|
"delete": {
|
|
2646
|
-
"tags": [
|
|
2886
|
+
"tags": [
|
|
2887
|
+
"Clusters"
|
|
2888
|
+
],
|
|
2647
2889
|
"operationId": "removeUserId",
|
|
2648
2890
|
"deprecated": true,
|
|
2649
|
-
"x-acl": [
|
|
2891
|
+
"x-acl": [
|
|
2892
|
+
"admin"
|
|
2893
|
+
],
|
|
2650
2894
|
"summary": "Delete user ID",
|
|
2651
2895
|
"description": "Deletes a user ID and its associated data from the clusters.",
|
|
2652
2896
|
"parameters": [
|
|
@@ -2668,7 +2912,9 @@
|
|
|
2668
2912
|
"$ref": "#/components/schemas/deletedAt"
|
|
2669
2913
|
}
|
|
2670
2914
|
},
|
|
2671
|
-
"required": [
|
|
2915
|
+
"required": [
|
|
2916
|
+
"deletedAt"
|
|
2917
|
+
]
|
|
2672
2918
|
}
|
|
2673
2919
|
}
|
|
2674
2920
|
}
|
|
@@ -2690,10 +2936,14 @@
|
|
|
2690
2936
|
},
|
|
2691
2937
|
"/1/clusters": {
|
|
2692
2938
|
"get": {
|
|
2693
|
-
"tags": [
|
|
2939
|
+
"tags": [
|
|
2940
|
+
"Clusters"
|
|
2941
|
+
],
|
|
2694
2942
|
"operationId": "listClusters",
|
|
2695
2943
|
"deprecated": true,
|
|
2696
|
-
"x-acl": [
|
|
2944
|
+
"x-acl": [
|
|
2945
|
+
"admin"
|
|
2946
|
+
],
|
|
2697
2947
|
"summary": "List clusters",
|
|
2698
2948
|
"description": "Lists the available clusters in a multi-cluster setup.",
|
|
2699
2949
|
"responses": {
|
|
@@ -2714,7 +2964,9 @@
|
|
|
2714
2964
|
}
|
|
2715
2965
|
}
|
|
2716
2966
|
},
|
|
2717
|
-
"required": [
|
|
2967
|
+
"required": [
|
|
2968
|
+
"topUsers"
|
|
2969
|
+
]
|
|
2718
2970
|
}
|
|
2719
2971
|
}
|
|
2720
2972
|
}
|
|
@@ -2736,12 +2988,16 @@
|
|
|
2736
2988
|
},
|
|
2737
2989
|
"/1/clusters/mapping/search": {
|
|
2738
2990
|
"post": {
|
|
2739
|
-
"tags": [
|
|
2991
|
+
"tags": [
|
|
2992
|
+
"Clusters"
|
|
2993
|
+
],
|
|
2740
2994
|
"operationId": "searchUserIds",
|
|
2741
2995
|
"deprecated": true,
|
|
2742
2996
|
"x-use-read-transporter": true,
|
|
2743
2997
|
"x-cacheable": true,
|
|
2744
|
-
"x-acl": [
|
|
2998
|
+
"x-acl": [
|
|
2999
|
+
"admin"
|
|
3000
|
+
],
|
|
2745
3001
|
"summary": "Search for user IDs",
|
|
2746
3002
|
"description": "Since it can take a few seconds to get the data from the different clusters,\nthe response isn't real-time.\n\nTo ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).\n",
|
|
2747
3003
|
"requestBody": {
|
|
@@ -2768,7 +3024,9 @@
|
|
|
2768
3024
|
"$ref": "#/components/schemas/hitsPerPage"
|
|
2769
3025
|
}
|
|
2770
3026
|
},
|
|
2771
|
-
"required": [
|
|
3027
|
+
"required": [
|
|
3028
|
+
"query"
|
|
3029
|
+
]
|
|
2772
3030
|
}
|
|
2773
3031
|
}
|
|
2774
3032
|
}
|
|
@@ -2817,7 +3075,10 @@
|
|
|
2817
3075
|
"$ref": "#/components/schemas/highlightResult"
|
|
2818
3076
|
}
|
|
2819
3077
|
},
|
|
2820
|
-
"required": [
|
|
3078
|
+
"required": [
|
|
3079
|
+
"userID",
|
|
3080
|
+
"clusterName"
|
|
3081
|
+
]
|
|
2821
3082
|
}
|
|
2822
3083
|
},
|
|
2823
3084
|
"required": [
|
|
@@ -2843,7 +3104,13 @@
|
|
|
2843
3104
|
"$ref": "#/components/schemas/updatedAt"
|
|
2844
3105
|
}
|
|
2845
3106
|
},
|
|
2846
|
-
"required": [
|
|
3107
|
+
"required": [
|
|
3108
|
+
"hits",
|
|
3109
|
+
"nbHits",
|
|
3110
|
+
"page",
|
|
3111
|
+
"hitsPerPage",
|
|
3112
|
+
"updatedAt"
|
|
3113
|
+
]
|
|
2847
3114
|
}
|
|
2848
3115
|
}
|
|
2849
3116
|
}
|
|
@@ -2865,10 +3132,14 @@
|
|
|
2865
3132
|
},
|
|
2866
3133
|
"/1/clusters/mapping/pending": {
|
|
2867
3134
|
"get": {
|
|
2868
|
-
"tags": [
|
|
3135
|
+
"tags": [
|
|
3136
|
+
"Clusters"
|
|
3137
|
+
],
|
|
2869
3138
|
"operationId": "hasPendingMappings",
|
|
2870
3139
|
"deprecated": true,
|
|
2871
|
-
"x-acl": [
|
|
3140
|
+
"x-acl": [
|
|
3141
|
+
"admin"
|
|
3142
|
+
],
|
|
2872
3143
|
"summary": "Get migration and user mapping status",
|
|
2873
3144
|
"description": "To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.\n",
|
|
2874
3145
|
"parameters": [
|
|
@@ -2906,7 +3177,9 @@
|
|
|
2906
3177
|
}
|
|
2907
3178
|
}
|
|
2908
3179
|
},
|
|
2909
|
-
"required": [
|
|
3180
|
+
"required": [
|
|
3181
|
+
"pending"
|
|
3182
|
+
]
|
|
2910
3183
|
}
|
|
2911
3184
|
}
|
|
2912
3185
|
}
|
|
@@ -2928,9 +3201,13 @@
|
|
|
2928
3201
|
},
|
|
2929
3202
|
"/1/security/sources": {
|
|
2930
3203
|
"get": {
|
|
2931
|
-
"tags": [
|
|
3204
|
+
"tags": [
|
|
3205
|
+
"Vaults"
|
|
3206
|
+
],
|
|
2932
3207
|
"operationId": "getSources",
|
|
2933
|
-
"x-acl": [
|
|
3208
|
+
"x-acl": [
|
|
3209
|
+
"admin"
|
|
3210
|
+
],
|
|
2934
3211
|
"summary": "List allowed sources",
|
|
2935
3212
|
"description": "Retrieves all allowed IP addresses with access to your application.",
|
|
2936
3213
|
"responses": {
|
|
@@ -2959,9 +3236,13 @@
|
|
|
2959
3236
|
}
|
|
2960
3237
|
},
|
|
2961
3238
|
"put": {
|
|
2962
|
-
"tags": [
|
|
3239
|
+
"tags": [
|
|
3240
|
+
"Vaults"
|
|
3241
|
+
],
|
|
2963
3242
|
"operationId": "replaceSources",
|
|
2964
|
-
"x-acl": [
|
|
3243
|
+
"x-acl": [
|
|
3244
|
+
"admin"
|
|
3245
|
+
],
|
|
2965
3246
|
"summary": "Replace allowed sources",
|
|
2966
3247
|
"description": "Replaces the list of allowed sources.",
|
|
2967
3248
|
"requestBody": {
|
|
@@ -2984,7 +3265,9 @@
|
|
|
2984
3265
|
"title": "replaceSourceResponse",
|
|
2985
3266
|
"type": "object",
|
|
2986
3267
|
"additionalProperties": false,
|
|
2987
|
-
"required": [
|
|
3268
|
+
"required": [
|
|
3269
|
+
"updatedAt"
|
|
3270
|
+
],
|
|
2988
3271
|
"properties": {
|
|
2989
3272
|
"updatedAt": {
|
|
2990
3273
|
"$ref": "#/components/schemas/updatedAt"
|
|
@@ -3011,9 +3294,13 @@
|
|
|
3011
3294
|
},
|
|
3012
3295
|
"/1/security/sources/append": {
|
|
3013
3296
|
"post": {
|
|
3014
|
-
"tags": [
|
|
3297
|
+
"tags": [
|
|
3298
|
+
"Vaults"
|
|
3299
|
+
],
|
|
3015
3300
|
"operationId": "appendSource",
|
|
3016
|
-
"x-acl": [
|
|
3301
|
+
"x-acl": [
|
|
3302
|
+
"admin"
|
|
3303
|
+
],
|
|
3017
3304
|
"description": "Adds a source to the list of allowed sources.",
|
|
3018
3305
|
"summary": "Add a source",
|
|
3019
3306
|
"requestBody": {
|
|
@@ -3048,9 +3335,13 @@
|
|
|
3048
3335
|
},
|
|
3049
3336
|
"/1/security/sources/{source}": {
|
|
3050
3337
|
"delete": {
|
|
3051
|
-
"tags": [
|
|
3338
|
+
"tags": [
|
|
3339
|
+
"Vaults"
|
|
3340
|
+
],
|
|
3052
3341
|
"operationId": "deleteSource",
|
|
3053
|
-
"x-acl": [
|
|
3342
|
+
"x-acl": [
|
|
3343
|
+
"admin"
|
|
3344
|
+
],
|
|
3054
3345
|
"description": "Deletes a source from the list of allowed sources.",
|
|
3055
3346
|
"summary": "Delete a source",
|
|
3056
3347
|
"parameters": [
|
|
@@ -3074,7 +3365,9 @@
|
|
|
3074
3365
|
"title": "deleteSourceResponse",
|
|
3075
3366
|
"type": "object",
|
|
3076
3367
|
"additionalProperties": false,
|
|
3077
|
-
"required": [
|
|
3368
|
+
"required": [
|
|
3369
|
+
"deletedAt"
|
|
3370
|
+
],
|
|
3078
3371
|
"properties": {
|
|
3079
3372
|
"deletedAt": {
|
|
3080
3373
|
"$ref": "#/components/schemas/deletedAt"
|
|
@@ -3101,9 +3394,13 @@
|
|
|
3101
3394
|
},
|
|
3102
3395
|
"/1/logs": {
|
|
3103
3396
|
"get": {
|
|
3104
|
-
"tags": [
|
|
3397
|
+
"tags": [
|
|
3398
|
+
"Advanced"
|
|
3399
|
+
],
|
|
3105
3400
|
"operationId": "getLogs",
|
|
3106
|
-
"x-acl": [
|
|
3401
|
+
"x-acl": [
|
|
3402
|
+
"logs"
|
|
3403
|
+
],
|
|
3107
3404
|
"description": "The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).\n\n- Logs are held for the last seven days.\n- Up to 1,000 API requests per server are logged.\n- This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.\n",
|
|
3108
3405
|
"summary": "Retrieve log entries",
|
|
3109
3406
|
"parameters": [
|
|
@@ -3160,7 +3457,9 @@
|
|
|
3160
3457
|
"title": "getLogsResponse",
|
|
3161
3458
|
"type": "object",
|
|
3162
3459
|
"additionalProperties": false,
|
|
3163
|
-
"required": [
|
|
3460
|
+
"required": [
|
|
3461
|
+
"logs"
|
|
3462
|
+
],
|
|
3164
3463
|
"properties": {
|
|
3165
3464
|
"logs": {
|
|
3166
3465
|
"type": "array",
|
|
@@ -3304,9 +3603,13 @@
|
|
|
3304
3603
|
},
|
|
3305
3604
|
"/1/task/{taskID}": {
|
|
3306
3605
|
"get": {
|
|
3307
|
-
"tags": [
|
|
3606
|
+
"tags": [
|
|
3607
|
+
"Advanced"
|
|
3608
|
+
],
|
|
3308
3609
|
"operationId": "getAppTask",
|
|
3309
|
-
"x-acl": [
|
|
3610
|
+
"x-acl": [
|
|
3611
|
+
"editSettings"
|
|
3612
|
+
],
|
|
3310
3613
|
"description": "Checks the status of a given application task.\n",
|
|
3311
3614
|
"summary": "Check application task status",
|
|
3312
3615
|
"parameters": [
|
|
@@ -3347,9 +3650,13 @@
|
|
|
3347
3650
|
},
|
|
3348
3651
|
"/1/indexes/{indexName}/task/{taskID}": {
|
|
3349
3652
|
"get": {
|
|
3350
|
-
"tags": [
|
|
3653
|
+
"tags": [
|
|
3654
|
+
"Indices"
|
|
3655
|
+
],
|
|
3351
3656
|
"operationId": "getTask",
|
|
3352
|
-
"x-acl": [
|
|
3657
|
+
"x-acl": [
|
|
3658
|
+
"addObject"
|
|
3659
|
+
],
|
|
3353
3660
|
"description": "Checks the status of a given task.\n\nIndexing tasks are asynchronous.\nWhen you add, update, or delete records or indices,\na task is created on a queue and completed depending on the load on the server.\n\nThe indexing tasks' responses include a task ID that you can use to check the status.\n",
|
|
3354
3661
|
"summary": "Check task status",
|
|
3355
3662
|
"parameters": [
|
|
@@ -3396,9 +3703,13 @@
|
|
|
3396
3703
|
},
|
|
3397
3704
|
"/1/indexes/{indexName}/operation": {
|
|
3398
3705
|
"post": {
|
|
3399
|
-
"tags": [
|
|
3706
|
+
"tags": [
|
|
3707
|
+
"Indices"
|
|
3708
|
+
],
|
|
3400
3709
|
"operationId": "operationIndex",
|
|
3401
|
-
"x-acl": [
|
|
3710
|
+
"x-acl": [
|
|
3711
|
+
"addObject"
|
|
3712
|
+
],
|
|
3402
3713
|
"summary": "Copy or move an index",
|
|
3403
3714
|
"description": "Copies or moves (renames) an index within the same Algolia application.\n\n- Existing destination indices are overwritten, except for their analytics data.\n- If the destination index doesn't exist yet, it'll be created.\n- This operation is resource-intensive.\n\n**Copy**\n\n- Copying a source index that doesn't exist creates a new index with 0 records and default settings.\n- The API keys of the source index are merged with the existing keys in the destination index.\n- You can't copy the `enableReRanking`, `mode`, and `replicas` settings.\n- You can't copy to a destination index that already has replicas.\n- Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits).\n- Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/)\n\n**Move**\n\n- Moving a source index that doesn't exist is ignored without returning an error.\n- When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name.\n To access the original analytics in the dashboard, create an index with the original name.\n- If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices.\n- Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).\n\nThis operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).\n",
|
|
3404
3715
|
"parameters": [
|
|
@@ -3429,7 +3740,10 @@
|
|
|
3429
3740
|
"description": "**Only for copying.**\n\nIf you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged.\nIf you omit the `scope` parameter, everything is copied: records, settings, synonyms, and rules.\n"
|
|
3430
3741
|
}
|
|
3431
3742
|
},
|
|
3432
|
-
"required": [
|
|
3743
|
+
"required": [
|
|
3744
|
+
"operation",
|
|
3745
|
+
"destination"
|
|
3746
|
+
]
|
|
3433
3747
|
}
|
|
3434
3748
|
}
|
|
3435
3749
|
}
|
|
@@ -3455,10 +3769,14 @@
|
|
|
3455
3769
|
},
|
|
3456
3770
|
"/1/indexes": {
|
|
3457
3771
|
"get": {
|
|
3458
|
-
"tags": [
|
|
3772
|
+
"tags": [
|
|
3773
|
+
"Indices"
|
|
3774
|
+
],
|
|
3459
3775
|
"operationId": "listIndices",
|
|
3460
3776
|
"x-mcp-tool": true,
|
|
3461
|
-
"x-acl": [
|
|
3777
|
+
"x-acl": [
|
|
3778
|
+
"listIndexes"
|
|
3779
|
+
],
|
|
3462
3780
|
"summary": "List indices",
|
|
3463
3781
|
"description": "Lists all indices in the current Algolia application.\n\nThe request follows any index restrictions of the API key you use to make the request.\n",
|
|
3464
3782
|
"parameters": [
|
|
@@ -3498,7 +3816,9 @@
|
|
|
3498
3816
|
"/waitForApiKey": {
|
|
3499
3817
|
"get": {
|
|
3500
3818
|
"x-helper": true,
|
|
3501
|
-
"tags": [
|
|
3819
|
+
"tags": [
|
|
3820
|
+
"Api Keys"
|
|
3821
|
+
],
|
|
3502
3822
|
"x-available-languages": [
|
|
3503
3823
|
"csharp",
|
|
3504
3824
|
"go",
|
|
@@ -3563,7 +3883,9 @@
|
|
|
3563
3883
|
"/waitForTask": {
|
|
3564
3884
|
"get": {
|
|
3565
3885
|
"x-helper": true,
|
|
3566
|
-
"tags": [
|
|
3886
|
+
"tags": [
|
|
3887
|
+
"Records"
|
|
3888
|
+
],
|
|
3567
3889
|
"x-available-languages": [
|
|
3568
3890
|
"csharp",
|
|
3569
3891
|
"go",
|
|
@@ -3667,7 +3989,9 @@
|
|
|
3667
3989
|
"/browseObjects": {
|
|
3668
3990
|
"get": {
|
|
3669
3991
|
"x-helper": true,
|
|
3670
|
-
"tags": [
|
|
3992
|
+
"tags": [
|
|
3993
|
+
"Records"
|
|
3994
|
+
],
|
|
3671
3995
|
"operationId": "browseObjects",
|
|
3672
3996
|
"summary": "Get all records from an index",
|
|
3673
3997
|
"description": "You can use the browse method to get records from an index—for example, to export your index as a backup. To export all records, use an empty query.\n\nUse browse instead of search when exporting records from your index, when ranking, or analytics, isn't important. The Analytics API doesn't collect data when using browse.\n\nDon't use this method for building a search UI. Use search instead.\n",
|
|
@@ -3705,7 +4029,9 @@
|
|
|
3705
4029
|
"get": {
|
|
3706
4030
|
"x-helper": true,
|
|
3707
4031
|
"x-asynchronous-helper": false,
|
|
3708
|
-
"tags": [
|
|
4032
|
+
"tags": [
|
|
4033
|
+
"Api Keys"
|
|
4034
|
+
],
|
|
3709
4035
|
"x-available-languages": [
|
|
3710
4036
|
"csharp",
|
|
3711
4037
|
"go",
|
|
@@ -3761,9 +4087,19 @@
|
|
|
3761
4087
|
"/accountCopyIndex": {
|
|
3762
4088
|
"get": {
|
|
3763
4089
|
"x-helper": true,
|
|
3764
|
-
"x-available-languages": [
|
|
3765
|
-
|
|
3766
|
-
|
|
4090
|
+
"x-available-languages": [
|
|
4091
|
+
"javascript"
|
|
4092
|
+
],
|
|
4093
|
+
"tags": [
|
|
4094
|
+
"Account"
|
|
4095
|
+
],
|
|
4096
|
+
"x-acl": [
|
|
4097
|
+
"browse",
|
|
4098
|
+
"editSettings",
|
|
4099
|
+
"addObject",
|
|
4100
|
+
"settings",
|
|
4101
|
+
"search"
|
|
4102
|
+
],
|
|
3767
4103
|
"operationId": "accountCopyIndex",
|
|
3768
4104
|
"summary": "Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`",
|
|
3769
4105
|
"description": "Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.\n",
|
|
@@ -3831,7 +4167,9 @@
|
|
|
3831
4167
|
"/replaceAllObjects": {
|
|
3832
4168
|
"get": {
|
|
3833
4169
|
"x-helper": true,
|
|
3834
|
-
"tags": [
|
|
4170
|
+
"tags": [
|
|
4171
|
+
"Records"
|
|
4172
|
+
],
|
|
3835
4173
|
"x-available-languages": [
|
|
3836
4174
|
"csharp",
|
|
3837
4175
|
"go",
|
|
@@ -3912,8 +4250,16 @@
|
|
|
3912
4250
|
"/replaceAllObjectsWithTransformation": {
|
|
3913
4251
|
"get": {
|
|
3914
4252
|
"x-helper": true,
|
|
3915
|
-
"tags": [
|
|
3916
|
-
|
|
4253
|
+
"tags": [
|
|
4254
|
+
"Records"
|
|
4255
|
+
],
|
|
4256
|
+
"x-available-languages": [
|
|
4257
|
+
"javascript",
|
|
4258
|
+
"go",
|
|
4259
|
+
"java",
|
|
4260
|
+
"php",
|
|
4261
|
+
"python"
|
|
4262
|
+
],
|
|
3917
4263
|
"operationId": "replaceAllObjectsWithTransformation",
|
|
3918
4264
|
"summary": "Replace all records in an index",
|
|
3919
4265
|
"description": "Replace all records from your index with a new set of records by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).\n\nThis method lets you replace all records in your index without downtime. It performs these operations:\n 1. Copy settings, synonyms, and rules from your original index to a temporary index.\n 2. Add your new records to the temporary index.\n 3. Replace your original index with the temporary index.\n\nUse the safe parameter to ensure that these (asynchronous) operations are performed in sequence.\nIf there's an error duing one of these steps, the temporary index won't be deleted.\nThis operation is rate-limited.\nThis method creates a temporary index: your record count is temporarily doubled. Algolia doesn't count the three days with the highest number of records towards your monthly usage.\nIf you're on a legacy plan (before July 2020), this method counts two operations towards your usage (in addition to the number of records): copySettings and moveIndex.\nThe API key you use for this operation must have access to the index YourIndex and the temporary index YourIndex_tmp.\n",
|
|
@@ -3982,7 +4328,9 @@
|
|
|
3982
4328
|
"/chunkedBatch": {
|
|
3983
4329
|
"get": {
|
|
3984
4330
|
"x-helper": true,
|
|
3985
|
-
"tags": [
|
|
4331
|
+
"tags": [
|
|
4332
|
+
"Records"
|
|
4333
|
+
],
|
|
3986
4334
|
"operationId": "chunkedBatch",
|
|
3987
4335
|
"summary": "Replace all records in an index",
|
|
3988
4336
|
"description": "Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.\n",
|
|
@@ -4059,7 +4407,9 @@
|
|
|
4059
4407
|
"/saveObjects": {
|
|
4060
4408
|
"get": {
|
|
4061
4409
|
"x-helper": true,
|
|
4062
|
-
"tags": [
|
|
4410
|
+
"tags": [
|
|
4411
|
+
"Records"
|
|
4412
|
+
],
|
|
4063
4413
|
"x-available-languages": [
|
|
4064
4414
|
"csharp",
|
|
4065
4415
|
"go",
|
|
@@ -4150,8 +4500,16 @@
|
|
|
4150
4500
|
"/saveObjectsWithTransformation": {
|
|
4151
4501
|
"get": {
|
|
4152
4502
|
"x-helper": true,
|
|
4153
|
-
"x-available-languages": [
|
|
4154
|
-
|
|
4503
|
+
"x-available-languages": [
|
|
4504
|
+
"go",
|
|
4505
|
+
"java",
|
|
4506
|
+
"javascript",
|
|
4507
|
+
"php",
|
|
4508
|
+
"python"
|
|
4509
|
+
],
|
|
4510
|
+
"tags": [
|
|
4511
|
+
"Records"
|
|
4512
|
+
],
|
|
4155
4513
|
"operationId": "saveObjectsWithTransformation",
|
|
4156
4514
|
"summary": "Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)",
|
|
4157
4515
|
"description": "Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.\n",
|
|
@@ -4230,7 +4588,9 @@
|
|
|
4230
4588
|
"/deleteObjects": {
|
|
4231
4589
|
"post": {
|
|
4232
4590
|
"x-helper": true,
|
|
4233
|
-
"tags": [
|
|
4591
|
+
"tags": [
|
|
4592
|
+
"Records"
|
|
4593
|
+
],
|
|
4234
4594
|
"x-available-languages": [
|
|
4235
4595
|
"csharp",
|
|
4236
4596
|
"go",
|
|
@@ -4319,7 +4679,9 @@
|
|
|
4319
4679
|
"/partialUpdateObjects": {
|
|
4320
4680
|
"post": {
|
|
4321
4681
|
"x-helper": true,
|
|
4322
|
-
"tags": [
|
|
4682
|
+
"tags": [
|
|
4683
|
+
"Records"
|
|
4684
|
+
],
|
|
4323
4685
|
"x-available-languages": [
|
|
4324
4686
|
"csharp",
|
|
4325
4687
|
"go",
|
|
@@ -4420,8 +4782,16 @@
|
|
|
4420
4782
|
"/partialUpdateObjectsWithTransformation": {
|
|
4421
4783
|
"post": {
|
|
4422
4784
|
"x-helper": true,
|
|
4423
|
-
"x-available-languages": [
|
|
4424
|
-
|
|
4785
|
+
"x-available-languages": [
|
|
4786
|
+
"go",
|
|
4787
|
+
"java",
|
|
4788
|
+
"javascript",
|
|
4789
|
+
"php",
|
|
4790
|
+
"python"
|
|
4791
|
+
],
|
|
4792
|
+
"tags": [
|
|
4793
|
+
"Records"
|
|
4794
|
+
],
|
|
4425
4795
|
"operationId": "partialUpdateObjectsWithTransformation",
|
|
4426
4796
|
"summary": "Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)",
|
|
4427
4797
|
"description": "Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.\n",
|
|
@@ -4510,7 +4880,9 @@
|
|
|
4510
4880
|
"/indexExists": {
|
|
4511
4881
|
"get": {
|
|
4512
4882
|
"x-helper": true,
|
|
4513
|
-
"tags": [
|
|
4883
|
+
"tags": [
|
|
4884
|
+
"Index"
|
|
4885
|
+
],
|
|
4514
4886
|
"x-available-languages": [
|
|
4515
4887
|
"csharp",
|
|
4516
4888
|
"go",
|
|
@@ -4555,7 +4927,9 @@
|
|
|
4555
4927
|
"get": {
|
|
4556
4928
|
"x-helper": true,
|
|
4557
4929
|
"x-asynchronous-helper": false,
|
|
4558
|
-
"tags": [
|
|
4930
|
+
"tags": [
|
|
4931
|
+
"Api Key"
|
|
4932
|
+
],
|
|
4559
4933
|
"operationId": "setClientApiKey",
|
|
4560
4934
|
"summary": "Switch the API key used to authenticate requests",
|
|
4561
4935
|
"description": "Switch the API key used to authenticate requests.\n",
|
|
@@ -4580,7 +4954,7 @@
|
|
|
4580
4954
|
},
|
|
4581
4955
|
"components": {
|
|
4582
4956
|
"securitySchemes": {
|
|
4583
|
-
"
|
|
4957
|
+
"applicationId": {
|
|
4584
4958
|
"type": "apiKey",
|
|
4585
4959
|
"in": "header",
|
|
4586
4960
|
"name": "x-algolia-application-id",
|
|
@@ -4629,7 +5003,9 @@
|
|
|
4629
5003
|
"title": "Search parameters as query string.",
|
|
4630
5004
|
"description": "Search parameters as query string.",
|
|
4631
5005
|
"additionalProperties": false,
|
|
4632
|
-
"x-discriminator-fields": [
|
|
5006
|
+
"x-discriminator-fields": [
|
|
5007
|
+
"params"
|
|
5008
|
+
],
|
|
4633
5009
|
"properties": {
|
|
4634
5010
|
"params": {
|
|
4635
5011
|
"$ref": "#/components/schemas/paramsAsString"
|
|
@@ -4640,7 +5016,9 @@
|
|
|
4640
5016
|
"type": "string",
|
|
4641
5017
|
"description": "Search query.",
|
|
4642
5018
|
"default": "",
|
|
4643
|
-
"x-categories": [
|
|
5019
|
+
"x-categories": [
|
|
5020
|
+
"Search"
|
|
5021
|
+
]
|
|
4644
5022
|
},
|
|
4645
5023
|
"searchParamsQuery": {
|
|
4646
5024
|
"type": "object",
|
|
@@ -4656,17 +5034,27 @@
|
|
|
4656
5034
|
"description": "Keywords to be used instead of the search query to conduct a more broader search\nUsing the `similarQuery` parameter changes other settings\n- `queryType` is set to `prefixNone`.\n- `removeStopWords` is set to true.\n- `words` is set as the first ranking criterion.\n- All remaining words are treated as `optionalWords`\nSince the `similarQuery` is supposed to do a broad search, they usually return many results.\nCombine it with `filters` to narrow down the list of results.\n",
|
|
4657
5035
|
"default": "",
|
|
4658
5036
|
"example": "comedy drama crime Macy Buscemi",
|
|
4659
|
-
"x-categories": [
|
|
5037
|
+
"x-categories": [
|
|
5038
|
+
"Search"
|
|
5039
|
+
]
|
|
4660
5040
|
},
|
|
4661
5041
|
"filters": {
|
|
4662
5042
|
"type": "string",
|
|
4663
5043
|
"description": "Filter expression to only include items that match the filter criteria in the response.\n\nYou can use these filter expressions:\n\n- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.\n- **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).\n- **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.\n- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).\n- **Boolean filters.** `<facet>: true | false`.\n\nYou can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:\n\n- You can only combine filters of the same type with `OR`.\n **Not supported:** `facet:value OR num > 3`.\n- You can't use `NOT` with combinations of filters.\n **Not supported:** `NOT(facet:value OR facet:value)`\n- You can't combine conjunctions (`AND`) with `OR`.\n **Not supported:** `facet:value OR (facet:value AND facet:value)`\n\nUse quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes.\nIf a facet attribute is an array, the filter matches if it matches at least one element of the array.\n\nFor more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).\n",
|
|
4664
5044
|
"example": "(category:Book OR category:Ebook) AND _tags:published",
|
|
4665
|
-
"x-categories": [
|
|
5045
|
+
"x-categories": [
|
|
5046
|
+
"Filtering"
|
|
5047
|
+
]
|
|
4666
5048
|
},
|
|
4667
5049
|
"facetFilters": {
|
|
4668
5050
|
"description": "Filter the search by facet values, so that only records with the same facet values are retrieved.\n\n**Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**\n\n- `[filter1, filter2]` is interpreted as `filter1 AND filter2`.\n- `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`.\n- `facet:-value` is interpreted as `NOT facet:value`.\n\nWhile it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash:\n`facet:\\-value`.\n",
|
|
4669
|
-
"example": [
|
|
5051
|
+
"example": [
|
|
5052
|
+
[
|
|
5053
|
+
"category:Book",
|
|
5054
|
+
"category:-Movie"
|
|
5055
|
+
],
|
|
5056
|
+
"author:John Doe"
|
|
5057
|
+
],
|
|
4670
5058
|
"oneOf": [
|
|
4671
5059
|
{
|
|
4672
5060
|
"type": "array",
|
|
@@ -4678,11 +5066,16 @@
|
|
|
4678
5066
|
"type": "string"
|
|
4679
5067
|
}
|
|
4680
5068
|
],
|
|
4681
|
-
"x-categories": [
|
|
5069
|
+
"x-categories": [
|
|
5070
|
+
"Filtering"
|
|
5071
|
+
]
|
|
4682
5072
|
},
|
|
4683
5073
|
"optionalFilters": {
|
|
4684
5074
|
"description": "Filters to promote or demote records in the search results.\n\nOptional filters work like facet filters, but they don't exclude records from the search results.\nRecords that match the optional filter rank before records that don't match.\nIf you're using a negative filter `facet:-value`, matching records rank after records that don't match.\n\n- Optional filters don't work on virtual replicas.\n- Optional filters are applied _after_ sort-by attributes.\n- Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)).\n- Optional filters don't work with numeric attributes.\n",
|
|
4685
|
-
"example": [
|
|
5075
|
+
"example": [
|
|
5076
|
+
"category:Book",
|
|
5077
|
+
"author:John Doe"
|
|
5078
|
+
],
|
|
4686
5079
|
"oneOf": [
|
|
4687
5080
|
{
|
|
4688
5081
|
"type": "array",
|
|
@@ -4694,11 +5087,19 @@
|
|
|
4694
5087
|
"type": "string"
|
|
4695
5088
|
}
|
|
4696
5089
|
],
|
|
4697
|
-
"x-categories": [
|
|
5090
|
+
"x-categories": [
|
|
5091
|
+
"Filtering"
|
|
5092
|
+
]
|
|
4698
5093
|
},
|
|
4699
5094
|
"numericFilters": {
|
|
4700
5095
|
"description": "Filter by numeric facets.\n\n**Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**\n\nYou can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`.\nComparisons are precise up to 3 decimals.\nYou can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries.\nThe same combination rules apply as for `facetFilters`.\n",
|
|
4701
|
-
"example": [
|
|
5096
|
+
"example": [
|
|
5097
|
+
[
|
|
5098
|
+
"inStock = 1",
|
|
5099
|
+
"deliveryDate < 1441755506"
|
|
5100
|
+
],
|
|
5101
|
+
"price < 1000"
|
|
5102
|
+
],
|
|
4702
5103
|
"oneOf": [
|
|
4703
5104
|
{
|
|
4704
5105
|
"type": "array",
|
|
@@ -4710,11 +5111,19 @@
|
|
|
4710
5111
|
"type": "string"
|
|
4711
5112
|
}
|
|
4712
5113
|
],
|
|
4713
|
-
"x-categories": [
|
|
5114
|
+
"x-categories": [
|
|
5115
|
+
"Filtering"
|
|
5116
|
+
]
|
|
4714
5117
|
},
|
|
4715
5118
|
"tagFilters": {
|
|
4716
5119
|
"description": "Filter the search by values of the special `_tags` attribute.\n\n**Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**\n\nDifferent from regular facets, `_tags` can only be used for filtering (including or excluding records).\nYou won't get a facet count.\nThe same combination and escaping rules apply as for `facetFilters`.\n",
|
|
4717
|
-
"example": [
|
|
5120
|
+
"example": [
|
|
5121
|
+
[
|
|
5122
|
+
"Book",
|
|
5123
|
+
"Movie"
|
|
5124
|
+
],
|
|
5125
|
+
"SciFi"
|
|
5126
|
+
],
|
|
4718
5127
|
"oneOf": [
|
|
4719
5128
|
{
|
|
4720
5129
|
"type": "array",
|
|
@@ -4726,62 +5135,83 @@
|
|
|
4726
5135
|
"type": "string"
|
|
4727
5136
|
}
|
|
4728
5137
|
],
|
|
4729
|
-
"x-categories": [
|
|
5138
|
+
"x-categories": [
|
|
5139
|
+
"Filtering"
|
|
5140
|
+
]
|
|
4730
5141
|
},
|
|
4731
5142
|
"sumOrFiltersScores": {
|
|
4732
5143
|
"type": "boolean",
|
|
4733
5144
|
"description": "Whether to sum all filter scores\nIf true, all filter scores are summed.\nOtherwise, the maximum filter score is kept.\nFor more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).\n",
|
|
4734
5145
|
"default": false,
|
|
4735
|
-
"x-categories": [
|
|
5146
|
+
"x-categories": [
|
|
5147
|
+
"Filtering"
|
|
5148
|
+
]
|
|
4736
5149
|
},
|
|
4737
5150
|
"restrictSearchableAttributes": {
|
|
4738
5151
|
"type": "array",
|
|
4739
5152
|
"items": {
|
|
4740
5153
|
"type": "string"
|
|
4741
5154
|
},
|
|
4742
|
-
"example": [
|
|
5155
|
+
"example": [
|
|
5156
|
+
"title",
|
|
5157
|
+
"author"
|
|
5158
|
+
],
|
|
4743
5159
|
"description": "Restricts a search to a subset of your searchable attributes.\nAttribute names are case-sensitive.\n",
|
|
4744
5160
|
"default": [],
|
|
4745
|
-
"x-categories": [
|
|
5161
|
+
"x-categories": [
|
|
5162
|
+
"Filtering"
|
|
5163
|
+
]
|
|
4746
5164
|
},
|
|
4747
5165
|
"facetingAfterDistinct": {
|
|
4748
5166
|
"type": "boolean",
|
|
4749
5167
|
"description": "Whether faceting should be applied after deduplication with `distinct`\nThis leads to accurate facet counts when using faceting in combination with `distinct`.\nIt's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting,\nas `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.\n",
|
|
4750
5168
|
"default": false,
|
|
4751
|
-
"x-categories": [
|
|
5169
|
+
"x-categories": [
|
|
5170
|
+
"Faceting"
|
|
5171
|
+
]
|
|
4752
5172
|
},
|
|
4753
5173
|
"page": {
|
|
4754
5174
|
"type": "integer",
|
|
4755
5175
|
"description": "Page of search results to retrieve.",
|
|
4756
5176
|
"default": 0,
|
|
4757
5177
|
"minimum": 0,
|
|
4758
|
-
"x-categories": [
|
|
5178
|
+
"x-categories": [
|
|
5179
|
+
"Pagination"
|
|
5180
|
+
]
|
|
4759
5181
|
},
|
|
4760
5182
|
"length": {
|
|
4761
5183
|
"type": "integer",
|
|
4762
5184
|
"description": "Number of hits to retrieve (used in combination with `offset`).",
|
|
4763
5185
|
"minimum": 0,
|
|
4764
5186
|
"maximum": 1000,
|
|
4765
|
-
"x-categories": [
|
|
5187
|
+
"x-categories": [
|
|
5188
|
+
"Pagination"
|
|
5189
|
+
]
|
|
4766
5190
|
},
|
|
4767
5191
|
"aroundLatLng": {
|
|
4768
5192
|
"type": "string",
|
|
4769
5193
|
"description": "Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.\n\nOnly records included within a circle around this central location are included in the results.\nThe radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings.\nThis parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.\n",
|
|
4770
5194
|
"example": "40.71,-74.01",
|
|
4771
5195
|
"default": "",
|
|
4772
|
-
"x-categories": [
|
|
5196
|
+
"x-categories": [
|
|
5197
|
+
"Geo-Search"
|
|
5198
|
+
]
|
|
4773
5199
|
},
|
|
4774
5200
|
"aroundLatLngViaIP": {
|
|
4775
5201
|
"type": "boolean",
|
|
4776
5202
|
"description": "Whether to obtain the coordinates from the request's IP address.",
|
|
4777
5203
|
"default": false,
|
|
4778
|
-
"x-categories": [
|
|
5204
|
+
"x-categories": [
|
|
5205
|
+
"Geo-Search"
|
|
5206
|
+
]
|
|
4779
5207
|
},
|
|
4780
5208
|
"aroundRadiusAll": {
|
|
4781
5209
|
"title": "all",
|
|
4782
5210
|
"type": "string",
|
|
4783
5211
|
"description": "Return all records with a valid `_geoloc` attribute. Don't filter by distance.",
|
|
4784
|
-
"enum": [
|
|
5212
|
+
"enum": [
|
|
5213
|
+
"all"
|
|
5214
|
+
]
|
|
4785
5215
|
},
|
|
4786
5216
|
"aroundRadius": {
|
|
4787
5217
|
"description": "Maximum radius for a search around a central location.\n\nThis parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters.\nBy default, the search radius is determined automatically from the density of hits around the central location.\nThe search radius is small if there are many hits close to the central coordinates.\n",
|
|
@@ -4795,7 +5225,9 @@
|
|
|
4795
5225
|
"$ref": "#/components/schemas/aroundRadiusAll"
|
|
4796
5226
|
}
|
|
4797
5227
|
],
|
|
4798
|
-
"x-categories": [
|
|
5228
|
+
"x-categories": [
|
|
5229
|
+
"Geo-Search"
|
|
5230
|
+
]
|
|
4799
5231
|
},
|
|
4800
5232
|
"aroundPrecisionFromValue": {
|
|
4801
5233
|
"title": "range objects",
|
|
@@ -4829,13 +5261,17 @@
|
|
|
4829
5261
|
"$ref": "#/components/schemas/aroundPrecisionFromValue"
|
|
4830
5262
|
}
|
|
4831
5263
|
],
|
|
4832
|
-
"x-categories": [
|
|
5264
|
+
"x-categories": [
|
|
5265
|
+
"Geo-Search"
|
|
5266
|
+
]
|
|
4833
5267
|
},
|
|
4834
5268
|
"minimumAroundRadius": {
|
|
4835
5269
|
"type": "integer",
|
|
4836
5270
|
"description": "Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.",
|
|
4837
5271
|
"minimum": 1,
|
|
4838
|
-
"x-categories": [
|
|
5272
|
+
"x-categories": [
|
|
5273
|
+
"Geo-Search"
|
|
5274
|
+
]
|
|
4839
5275
|
},
|
|
4840
5276
|
"insideBoundingBoxArray": {
|
|
4841
5277
|
"type": "array",
|
|
@@ -4850,10 +5286,22 @@
|
|
|
4850
5286
|
},
|
|
4851
5287
|
"description": "Coordinates for a rectangular area in which to search.\n\nEach bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair:\n`[p1 lat, p1 long, p2 lat, p2 long]`.\nProvide multiple bounding boxes as nested arrays.\nFor more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).\n",
|
|
4852
5288
|
"example": [
|
|
4853
|
-
[
|
|
4854
|
-
|
|
5289
|
+
[
|
|
5290
|
+
47.3165,
|
|
5291
|
+
4.9665,
|
|
5292
|
+
47.3424,
|
|
5293
|
+
5.0201
|
|
5294
|
+
],
|
|
5295
|
+
[
|
|
5296
|
+
40.9234,
|
|
5297
|
+
2.1185,
|
|
5298
|
+
38.643,
|
|
5299
|
+
1.9916
|
|
5300
|
+
]
|
|
4855
5301
|
],
|
|
4856
|
-
"x-categories": [
|
|
5302
|
+
"x-categories": [
|
|
5303
|
+
"Geo-Search"
|
|
5304
|
+
]
|
|
4857
5305
|
},
|
|
4858
5306
|
"insideBoundingBox": {
|
|
4859
5307
|
"oneOf": [
|
|
@@ -4881,10 +5329,26 @@
|
|
|
4881
5329
|
},
|
|
4882
5330
|
"description": "Coordinates of a polygon in which to search.\n\nPolygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude.\nProvide multiple polygons as nested arrays.\nFor more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).\nThis parameter is ignored if you also specify `insideBoundingBox`.\n",
|
|
4883
5331
|
"example": [
|
|
4884
|
-
[
|
|
4885
|
-
|
|
5332
|
+
[
|
|
5333
|
+
47.3165,
|
|
5334
|
+
4.9665,
|
|
5335
|
+
47.3424,
|
|
5336
|
+
5.0201,
|
|
5337
|
+
47.32,
|
|
5338
|
+
4.9
|
|
5339
|
+
],
|
|
5340
|
+
[
|
|
5341
|
+
40.9234,
|
|
5342
|
+
2.1185,
|
|
5343
|
+
38.643,
|
|
5344
|
+
1.9916,
|
|
5345
|
+
39.2587,
|
|
5346
|
+
2.0104
|
|
5347
|
+
]
|
|
4886
5348
|
],
|
|
4887
|
-
"x-categories": [
|
|
5349
|
+
"x-categories": [
|
|
5350
|
+
"Geo-Search"
|
|
5351
|
+
]
|
|
4888
5352
|
},
|
|
4889
5353
|
"supportedLanguage": {
|
|
4890
5354
|
"type": "string",
|
|
@@ -4967,7 +5431,9 @@
|
|
|
4967
5431
|
},
|
|
4968
5432
|
"description": "ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)\n- Sets `removeStopWords` and `ignorePlurals` to the list of provided languages.\n- Sets `removeWordsIfNoResults` to `allOptional`.\n- Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.\n",
|
|
4969
5433
|
"default": [],
|
|
4970
|
-
"x-categories": [
|
|
5434
|
+
"x-categories": [
|
|
5435
|
+
"Languages"
|
|
5436
|
+
]
|
|
4971
5437
|
},
|
|
4972
5438
|
"ruleContexts": {
|
|
4973
5439
|
"type": "array",
|
|
@@ -4976,8 +5442,12 @@
|
|
|
4976
5442
|
},
|
|
4977
5443
|
"description": "Assigns a rule context to the search query\n[Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.\n",
|
|
4978
5444
|
"default": [],
|
|
4979
|
-
"example": [
|
|
4980
|
-
|
|
5445
|
+
"example": [
|
|
5446
|
+
"mobile"
|
|
5447
|
+
],
|
|
5448
|
+
"x-categories": [
|
|
5449
|
+
"Rules"
|
|
5450
|
+
]
|
|
4981
5451
|
},
|
|
4982
5452
|
"personalizationImpact": {
|
|
4983
5453
|
"type": "integer",
|
|
@@ -4985,37 +5455,49 @@
|
|
|
4985
5455
|
"default": 100,
|
|
4986
5456
|
"minimum": 0,
|
|
4987
5457
|
"maximum": 100,
|
|
4988
|
-
"x-categories": [
|
|
5458
|
+
"x-categories": [
|
|
5459
|
+
"Personalization"
|
|
5460
|
+
]
|
|
4989
5461
|
},
|
|
4990
5462
|
"userToken": {
|
|
4991
5463
|
"type": "string",
|
|
4992
5464
|
"description": "Unique pseudonymous or anonymous user identifier.\n\nThis helps with analytics and click and conversion events.\nFor more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).\n",
|
|
4993
5465
|
"example": "test-user-123",
|
|
4994
|
-
"x-categories": [
|
|
5466
|
+
"x-categories": [
|
|
5467
|
+
"Personalization"
|
|
5468
|
+
]
|
|
4995
5469
|
},
|
|
4996
5470
|
"getRankingInfo": {
|
|
4997
5471
|
"type": "boolean",
|
|
4998
5472
|
"description": "Whether the search response should include detailed ranking information.",
|
|
4999
5473
|
"default": false,
|
|
5000
|
-
"x-categories": [
|
|
5474
|
+
"x-categories": [
|
|
5475
|
+
"Advanced"
|
|
5476
|
+
]
|
|
5001
5477
|
},
|
|
5002
5478
|
"synonyms": {
|
|
5003
5479
|
"type": "boolean",
|
|
5004
5480
|
"description": "Whether to take into account an index's synonyms for this search.",
|
|
5005
5481
|
"default": true,
|
|
5006
|
-
"x-categories": [
|
|
5482
|
+
"x-categories": [
|
|
5483
|
+
"Advanced"
|
|
5484
|
+
]
|
|
5007
5485
|
},
|
|
5008
5486
|
"clickAnalytics": {
|
|
5009
5487
|
"type": "boolean",
|
|
5010
5488
|
"description": "Whether to include a `queryID` attribute in the response\nThe query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).\n",
|
|
5011
5489
|
"default": false,
|
|
5012
|
-
"x-categories": [
|
|
5490
|
+
"x-categories": [
|
|
5491
|
+
"Analytics"
|
|
5492
|
+
]
|
|
5013
5493
|
},
|
|
5014
5494
|
"analytics": {
|
|
5015
5495
|
"type": "boolean",
|
|
5016
5496
|
"description": "Whether this search will be included in Analytics.",
|
|
5017
5497
|
"default": true,
|
|
5018
|
-
"x-categories": [
|
|
5498
|
+
"x-categories": [
|
|
5499
|
+
"Analytics"
|
|
5500
|
+
]
|
|
5019
5501
|
},
|
|
5020
5502
|
"analyticsTags": {
|
|
5021
5503
|
"type": "array",
|
|
@@ -5029,13 +5511,17 @@
|
|
|
5029
5511
|
"type": "boolean",
|
|
5030
5512
|
"description": "Whether to include this search when calculating processing-time percentiles.",
|
|
5031
5513
|
"default": true,
|
|
5032
|
-
"x-categories": [
|
|
5514
|
+
"x-categories": [
|
|
5515
|
+
"Advanced"
|
|
5516
|
+
]
|
|
5033
5517
|
},
|
|
5034
5518
|
"enableABTest": {
|
|
5035
5519
|
"type": "boolean",
|
|
5036
5520
|
"description": "Whether to enable A/B testing for this search.",
|
|
5037
5521
|
"default": true,
|
|
5038
|
-
"x-categories": [
|
|
5522
|
+
"x-categories": [
|
|
5523
|
+
"Advanced"
|
|
5524
|
+
]
|
|
5039
5525
|
},
|
|
5040
5526
|
"baseSearchParamsWithoutQuery": {
|
|
5041
5527
|
"type": "object",
|
|
@@ -5072,8 +5558,12 @@
|
|
|
5072
5558
|
},
|
|
5073
5559
|
"description": "Facets for which to retrieve facet values that match the search criteria and the number of matching facet values\nTo retrieve all facets, use the wildcard character `*`.\nFor more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).\n",
|
|
5074
5560
|
"default": [],
|
|
5075
|
-
"example": [
|
|
5076
|
-
|
|
5561
|
+
"example": [
|
|
5562
|
+
"*"
|
|
5563
|
+
],
|
|
5564
|
+
"x-categories": [
|
|
5565
|
+
"Faceting"
|
|
5566
|
+
]
|
|
5077
5567
|
},
|
|
5078
5568
|
"facetingAfterDistinct": {
|
|
5079
5569
|
"$ref": "#/components/schemas/facetingAfterDistinct"
|
|
@@ -5084,7 +5574,9 @@
|
|
|
5084
5574
|
"offset": {
|
|
5085
5575
|
"type": "integer",
|
|
5086
5576
|
"description": "Position of the first hit to retrieve.",
|
|
5087
|
-
"x-categories": [
|
|
5577
|
+
"x-categories": [
|
|
5578
|
+
"Pagination"
|
|
5579
|
+
]
|
|
5088
5580
|
},
|
|
5089
5581
|
"length": {
|
|
5090
5582
|
"$ref": "#/components/schemas/length"
|
|
@@ -5136,7 +5628,9 @@
|
|
|
5136
5628
|
},
|
|
5137
5629
|
"analyticsTags": {
|
|
5138
5630
|
"$ref": "#/components/schemas/analyticsTags",
|
|
5139
|
-
"x-categories": [
|
|
5631
|
+
"x-categories": [
|
|
5632
|
+
"Analytics"
|
|
5633
|
+
]
|
|
5140
5634
|
},
|
|
5141
5635
|
"percentileComputation": {
|
|
5142
5636
|
"$ref": "#/components/schemas/percentileComputation"
|
|
@@ -5161,60 +5655,90 @@
|
|
|
5161
5655
|
"items": {
|
|
5162
5656
|
"type": "string"
|
|
5163
5657
|
},
|
|
5164
|
-
"example": [
|
|
5658
|
+
"example": [
|
|
5659
|
+
"author",
|
|
5660
|
+
"title",
|
|
5661
|
+
"content"
|
|
5662
|
+
],
|
|
5165
5663
|
"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",
|
|
5166
|
-
"default": [
|
|
5167
|
-
|
|
5664
|
+
"default": [
|
|
5665
|
+
"*"
|
|
5666
|
+
],
|
|
5667
|
+
"x-categories": [
|
|
5668
|
+
"Attributes"
|
|
5669
|
+
]
|
|
5168
5670
|
},
|
|
5169
5671
|
"relevancyStrictness": {
|
|
5170
5672
|
"type": "integer",
|
|
5171
5673
|
"example": 90,
|
|
5172
5674
|
"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",
|
|
5173
5675
|
"default": 100,
|
|
5174
|
-
"x-categories": [
|
|
5676
|
+
"x-categories": [
|
|
5677
|
+
"Ranking"
|
|
5678
|
+
]
|
|
5175
5679
|
},
|
|
5176
5680
|
"attributesToHighlight": {
|
|
5177
5681
|
"type": "array",
|
|
5178
5682
|
"items": {
|
|
5179
5683
|
"type": "string"
|
|
5180
5684
|
},
|
|
5181
|
-
"example": [
|
|
5685
|
+
"example": [
|
|
5686
|
+
"author",
|
|
5687
|
+
"title",
|
|
5688
|
+
"conten",
|
|
5689
|
+
"content"
|
|
5690
|
+
],
|
|
5182
5691
|
"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",
|
|
5183
|
-
"x-categories": [
|
|
5692
|
+
"x-categories": [
|
|
5693
|
+
"Highlighting and Snippeting"
|
|
5694
|
+
]
|
|
5184
5695
|
},
|
|
5185
5696
|
"attributesToSnippet": {
|
|
5186
5697
|
"type": "array",
|
|
5187
5698
|
"items": {
|
|
5188
5699
|
"type": "string"
|
|
5189
5700
|
},
|
|
5190
|
-
"example": [
|
|
5701
|
+
"example": [
|
|
5702
|
+
"content:80",
|
|
5703
|
+
"description"
|
|
5704
|
+
],
|
|
5191
5705
|
"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",
|
|
5192
5706
|
"default": [],
|
|
5193
|
-
"x-categories": [
|
|
5707
|
+
"x-categories": [
|
|
5708
|
+
"Highlighting and Snippeting"
|
|
5709
|
+
]
|
|
5194
5710
|
},
|
|
5195
5711
|
"highlightPreTag": {
|
|
5196
5712
|
"type": "string",
|
|
5197
5713
|
"description": "HTML tag to insert before the highlighted parts in all highlighted results and snippets.",
|
|
5198
5714
|
"default": "<em>",
|
|
5199
|
-
"x-categories": [
|
|
5715
|
+
"x-categories": [
|
|
5716
|
+
"Highlighting and Snippeting"
|
|
5717
|
+
]
|
|
5200
5718
|
},
|
|
5201
5719
|
"highlightPostTag": {
|
|
5202
5720
|
"type": "string",
|
|
5203
5721
|
"description": "HTML tag to insert after the highlighted parts in all highlighted results and snippets.",
|
|
5204
5722
|
"default": "</em>",
|
|
5205
|
-
"x-categories": [
|
|
5723
|
+
"x-categories": [
|
|
5724
|
+
"Highlighting and Snippeting"
|
|
5725
|
+
]
|
|
5206
5726
|
},
|
|
5207
5727
|
"snippetEllipsisText": {
|
|
5208
5728
|
"type": "string",
|
|
5209
5729
|
"description": "String used as an ellipsis indicator when a snippet is truncated.",
|
|
5210
5730
|
"default": "…",
|
|
5211
|
-
"x-categories": [
|
|
5731
|
+
"x-categories": [
|
|
5732
|
+
"Highlighting and Snippeting"
|
|
5733
|
+
]
|
|
5212
5734
|
},
|
|
5213
5735
|
"restrictHighlightAndSnippetArrays": {
|
|
5214
5736
|
"type": "boolean",
|
|
5215
5737
|
"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",
|
|
5216
5738
|
"default": false,
|
|
5217
|
-
"x-categories": [
|
|
5739
|
+
"x-categories": [
|
|
5740
|
+
"Highlighting and Snippeting"
|
|
5741
|
+
]
|
|
5218
5742
|
},
|
|
5219
5743
|
"hitsPerPage": {
|
|
5220
5744
|
"type": "integer",
|
|
@@ -5222,25 +5746,36 @@
|
|
|
5222
5746
|
"default": 20,
|
|
5223
5747
|
"minimum": 1,
|
|
5224
5748
|
"maximum": 1000,
|
|
5225
|
-
"x-categories": [
|
|
5749
|
+
"x-categories": [
|
|
5750
|
+
"Pagination"
|
|
5751
|
+
]
|
|
5226
5752
|
},
|
|
5227
5753
|
"minWordSizefor1Typo": {
|
|
5228
5754
|
"type": "integer",
|
|
5229
5755
|
"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).",
|
|
5230
5756
|
"default": 4,
|
|
5231
|
-
"x-categories": [
|
|
5757
|
+
"x-categories": [
|
|
5758
|
+
"Typos"
|
|
5759
|
+
]
|
|
5232
5760
|
},
|
|
5233
5761
|
"minWordSizefor2Typos": {
|
|
5234
5762
|
"type": "integer",
|
|
5235
5763
|
"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).",
|
|
5236
5764
|
"default": 8,
|
|
5237
|
-
"x-categories": [
|
|
5765
|
+
"x-categories": [
|
|
5766
|
+
"Typos"
|
|
5767
|
+
]
|
|
5238
5768
|
},
|
|
5239
5769
|
"typoToleranceEnum": {
|
|
5240
5770
|
"type": "string",
|
|
5241
5771
|
"title": "typo tolerance",
|
|
5242
5772
|
"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",
|
|
5243
|
-
"enum": [
|
|
5773
|
+
"enum": [
|
|
5774
|
+
"min",
|
|
5775
|
+
"strict",
|
|
5776
|
+
"true",
|
|
5777
|
+
"false"
|
|
5778
|
+
]
|
|
5244
5779
|
},
|
|
5245
5780
|
"typoTolerance": {
|
|
5246
5781
|
"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",
|
|
@@ -5254,31 +5789,45 @@
|
|
|
5254
5789
|
"$ref": "#/components/schemas/typoToleranceEnum"
|
|
5255
5790
|
}
|
|
5256
5791
|
],
|
|
5257
|
-
"x-categories": [
|
|
5792
|
+
"x-categories": [
|
|
5793
|
+
"Typos"
|
|
5794
|
+
]
|
|
5258
5795
|
},
|
|
5259
5796
|
"allowTyposOnNumericTokens": {
|
|
5260
5797
|
"type": "boolean",
|
|
5261
5798
|
"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",
|
|
5262
5799
|
"default": true,
|
|
5263
|
-
"x-categories": [
|
|
5800
|
+
"x-categories": [
|
|
5801
|
+
"Typos"
|
|
5802
|
+
]
|
|
5264
5803
|
},
|
|
5265
5804
|
"disableTypoToleranceOnAttributes": {
|
|
5266
5805
|
"type": "array",
|
|
5267
5806
|
"items": {
|
|
5268
5807
|
"type": "string"
|
|
5269
5808
|
},
|
|
5270
|
-
"example": [
|
|
5809
|
+
"example": [
|
|
5810
|
+
"sku"
|
|
5811
|
+
],
|
|
5271
5812
|
"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",
|
|
5272
5813
|
"default": [],
|
|
5273
|
-
"x-categories": [
|
|
5814
|
+
"x-categories": [
|
|
5815
|
+
"Typos"
|
|
5816
|
+
]
|
|
5274
5817
|
},
|
|
5275
5818
|
"booleanString": {
|
|
5276
5819
|
"type": "string",
|
|
5277
|
-
"enum": [
|
|
5820
|
+
"enum": [
|
|
5821
|
+
"true",
|
|
5822
|
+
"false"
|
|
5823
|
+
]
|
|
5278
5824
|
},
|
|
5279
5825
|
"ignorePlurals": {
|
|
5280
5826
|
"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",
|
|
5281
|
-
"example": [
|
|
5827
|
+
"example": [
|
|
5828
|
+
"ca",
|
|
5829
|
+
"es"
|
|
5830
|
+
],
|
|
5282
5831
|
"oneOf": [
|
|
5283
5832
|
{
|
|
5284
5833
|
"type": "array",
|
|
@@ -5296,11 +5845,16 @@
|
|
|
5296
5845
|
"default": false
|
|
5297
5846
|
}
|
|
5298
5847
|
],
|
|
5299
|
-
"x-categories": [
|
|
5848
|
+
"x-categories": [
|
|
5849
|
+
"Languages"
|
|
5850
|
+
]
|
|
5300
5851
|
},
|
|
5301
5852
|
"removeStopWords": {
|
|
5302
5853
|
"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",
|
|
5303
|
-
"example": [
|
|
5854
|
+
"example": [
|
|
5855
|
+
"ca",
|
|
5856
|
+
"es"
|
|
5857
|
+
],
|
|
5304
5858
|
"oneOf": [
|
|
5305
5859
|
{
|
|
5306
5860
|
"type": "array",
|
|
@@ -5315,57 +5869,87 @@
|
|
|
5315
5869
|
"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"
|
|
5316
5870
|
}
|
|
5317
5871
|
],
|
|
5318
|
-
"x-categories": [
|
|
5872
|
+
"x-categories": [
|
|
5873
|
+
"Languages"
|
|
5874
|
+
]
|
|
5319
5875
|
},
|
|
5320
5876
|
"queryLanguages": {
|
|
5321
5877
|
"type": "array",
|
|
5322
5878
|
"items": {
|
|
5323
5879
|
"$ref": "#/components/schemas/supportedLanguage"
|
|
5324
5880
|
},
|
|
5325
|
-
"example": [
|
|
5881
|
+
"example": [
|
|
5882
|
+
"es"
|
|
5883
|
+
],
|
|
5326
5884
|
"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",
|
|
5327
5885
|
"default": [],
|
|
5328
|
-
"x-categories": [
|
|
5886
|
+
"x-categories": [
|
|
5887
|
+
"Languages"
|
|
5888
|
+
]
|
|
5329
5889
|
},
|
|
5330
5890
|
"decompoundQuery": {
|
|
5331
5891
|
"type": "boolean",
|
|
5332
5892
|
"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",
|
|
5333
5893
|
"default": true,
|
|
5334
|
-
"x-categories": [
|
|
5894
|
+
"x-categories": [
|
|
5895
|
+
"Languages"
|
|
5896
|
+
]
|
|
5335
5897
|
},
|
|
5336
5898
|
"enableRules": {
|
|
5337
5899
|
"type": "boolean",
|
|
5338
5900
|
"description": "Whether to enable rules.",
|
|
5339
5901
|
"default": true,
|
|
5340
|
-
"x-categories": [
|
|
5902
|
+
"x-categories": [
|
|
5903
|
+
"Rules"
|
|
5904
|
+
]
|
|
5341
5905
|
},
|
|
5342
5906
|
"enablePersonalization": {
|
|
5343
5907
|
"type": "boolean",
|
|
5344
5908
|
"description": "Whether to enable Personalization.",
|
|
5345
5909
|
"default": false,
|
|
5346
|
-
"x-categories": [
|
|
5910
|
+
"x-categories": [
|
|
5911
|
+
"Personalization"
|
|
5912
|
+
]
|
|
5347
5913
|
},
|
|
5348
5914
|
"queryType": {
|
|
5349
5915
|
"type": "string",
|
|
5350
|
-
"enum": [
|
|
5916
|
+
"enum": [
|
|
5917
|
+
"prefixLast",
|
|
5918
|
+
"prefixAll",
|
|
5919
|
+
"prefixNone"
|
|
5920
|
+
],
|
|
5351
5921
|
"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",
|
|
5352
5922
|
"default": "prefixLast",
|
|
5353
|
-
"x-categories": [
|
|
5923
|
+
"x-categories": [
|
|
5924
|
+
"Query strategy"
|
|
5925
|
+
]
|
|
5354
5926
|
},
|
|
5355
5927
|
"removeWordsIfNoResults": {
|
|
5356
5928
|
"type": "string",
|
|
5357
|
-
"enum": [
|
|
5929
|
+
"enum": [
|
|
5930
|
+
"none",
|
|
5931
|
+
"lastWords",
|
|
5932
|
+
"firstWords",
|
|
5933
|
+
"allOptional"
|
|
5934
|
+
],
|
|
5358
5935
|
"example": "firstWords",
|
|
5359
5936
|
"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",
|
|
5360
5937
|
"default": "none",
|
|
5361
|
-
"x-categories": [
|
|
5938
|
+
"x-categories": [
|
|
5939
|
+
"Query strategy"
|
|
5940
|
+
]
|
|
5362
5941
|
},
|
|
5363
5942
|
"mode": {
|
|
5364
5943
|
"type": "string",
|
|
5365
|
-
"enum": [
|
|
5944
|
+
"enum": [
|
|
5945
|
+
"neuralSearch",
|
|
5946
|
+
"keywordSearch"
|
|
5947
|
+
],
|
|
5366
5948
|
"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",
|
|
5367
5949
|
"default": "keywordSearch",
|
|
5368
|
-
"x-categories": [
|
|
5950
|
+
"x-categories": [
|
|
5951
|
+
"Query strategy"
|
|
5952
|
+
]
|
|
5369
5953
|
},
|
|
5370
5954
|
"semanticSearch": {
|
|
5371
5955
|
"type": "object",
|
|
@@ -5391,17 +5975,24 @@
|
|
|
5391
5975
|
"type": "boolean",
|
|
5392
5976
|
"description": "Whether to support phrase matching and excluding words from search queries\nUse the `advancedSyntaxFeatures` parameter to control which feature is supported.\n",
|
|
5393
5977
|
"default": false,
|
|
5394
|
-
"x-categories": [
|
|
5978
|
+
"x-categories": [
|
|
5979
|
+
"Query strategy"
|
|
5980
|
+
]
|
|
5395
5981
|
},
|
|
5396
5982
|
"optionalWordsArray": {
|
|
5397
5983
|
"type": "array",
|
|
5398
5984
|
"items": {
|
|
5399
5985
|
"type": "string"
|
|
5400
5986
|
},
|
|
5401
|
-
"example": [
|
|
5987
|
+
"example": [
|
|
5988
|
+
"blue",
|
|
5989
|
+
"iphone case"
|
|
5990
|
+
],
|
|
5402
5991
|
"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).",
|
|
5403
5992
|
"default": [],
|
|
5404
|
-
"x-categories": [
|
|
5993
|
+
"x-categories": [
|
|
5994
|
+
"Query strategy"
|
|
5995
|
+
]
|
|
5405
5996
|
},
|
|
5406
5997
|
"optionalWords": {
|
|
5407
5998
|
"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",
|
|
@@ -5422,22 +6013,39 @@
|
|
|
5422
6013
|
"items": {
|
|
5423
6014
|
"type": "string"
|
|
5424
6015
|
},
|
|
5425
|
-
"example": [
|
|
6016
|
+
"example": [
|
|
6017
|
+
"description"
|
|
6018
|
+
],
|
|
5426
6019
|
"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",
|
|
5427
6020
|
"default": [],
|
|
5428
|
-
"x-categories": [
|
|
6021
|
+
"x-categories": [
|
|
6022
|
+
"Query strategy"
|
|
6023
|
+
]
|
|
5429
6024
|
},
|
|
5430
6025
|
"exactOnSingleWordQuery": {
|
|
5431
6026
|
"type": "string",
|
|
5432
|
-
"enum": [
|
|
6027
|
+
"enum": [
|
|
6028
|
+
"attribute",
|
|
6029
|
+
"none",
|
|
6030
|
+
"word"
|
|
6031
|
+
],
|
|
5433
6032
|
"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",
|
|
5434
6033
|
"default": "attribute",
|
|
5435
|
-
"x-categories": [
|
|
6034
|
+
"x-categories": [
|
|
6035
|
+
"Query strategy"
|
|
6036
|
+
]
|
|
5436
6037
|
},
|
|
5437
6038
|
"alternativesAsExact": {
|
|
5438
6039
|
"type": "string",
|
|
5439
|
-
"enum": [
|
|
5440
|
-
|
|
6040
|
+
"enum": [
|
|
6041
|
+
"ignorePlurals",
|
|
6042
|
+
"singleWordSynonym",
|
|
6043
|
+
"multiWordsSynonym",
|
|
6044
|
+
"ignoreConjugations"
|
|
6045
|
+
],
|
|
6046
|
+
"x-categories": [
|
|
6047
|
+
"Query strategy"
|
|
6048
|
+
]
|
|
5441
6049
|
},
|
|
5442
6050
|
"IndexSettings_alternativesAsExact": {
|
|
5443
6051
|
"type": "array",
|
|
@@ -5445,13 +6053,23 @@
|
|
|
5445
6053
|
"$ref": "#/components/schemas/alternativesAsExact"
|
|
5446
6054
|
},
|
|
5447
6055
|
"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",
|
|
5448
|
-
"default": [
|
|
5449
|
-
|
|
6056
|
+
"default": [
|
|
6057
|
+
"ignorePlurals",
|
|
6058
|
+
"singleWordSynonym"
|
|
6059
|
+
],
|
|
6060
|
+
"x-categories": [
|
|
6061
|
+
"Query strategy"
|
|
6062
|
+
]
|
|
5450
6063
|
},
|
|
5451
6064
|
"advancedSyntaxFeatures": {
|
|
5452
6065
|
"type": "string",
|
|
5453
|
-
"enum": [
|
|
5454
|
-
|
|
6066
|
+
"enum": [
|
|
6067
|
+
"exactPhrase",
|
|
6068
|
+
"excludeWords"
|
|
6069
|
+
],
|
|
6070
|
+
"x-categories": [
|
|
6071
|
+
"Query strategy"
|
|
6072
|
+
]
|
|
5455
6073
|
},
|
|
5456
6074
|
"IndexSettings_advancedSyntaxFeatures": {
|
|
5457
6075
|
"type": "array",
|
|
@@ -5459,8 +6077,13 @@
|
|
|
5459
6077
|
"$ref": "#/components/schemas/advancedSyntaxFeatures"
|
|
5460
6078
|
},
|
|
5461
6079
|
"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",
|
|
5462
|
-
"default": [
|
|
5463
|
-
|
|
6080
|
+
"default": [
|
|
6081
|
+
"exactPhrase",
|
|
6082
|
+
"excludeWords"
|
|
6083
|
+
],
|
|
6084
|
+
"x-categories": [
|
|
6085
|
+
"Query strategy"
|
|
6086
|
+
]
|
|
5464
6087
|
},
|
|
5465
6088
|
"distinct": {
|
|
5466
6089
|
"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",
|
|
@@ -5478,13 +6101,17 @@
|
|
|
5478
6101
|
"default": 0
|
|
5479
6102
|
}
|
|
5480
6103
|
],
|
|
5481
|
-
"x-categories": [
|
|
6104
|
+
"x-categories": [
|
|
6105
|
+
"Advanced"
|
|
6106
|
+
]
|
|
5482
6107
|
},
|
|
5483
6108
|
"replaceSynonymsInHighlight": {
|
|
5484
6109
|
"type": "boolean",
|
|
5485
6110
|
"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",
|
|
5486
6111
|
"default": false,
|
|
5487
|
-
"x-categories": [
|
|
6112
|
+
"x-categories": [
|
|
6113
|
+
"Highlighting and Snippeting"
|
|
6114
|
+
]
|
|
5488
6115
|
},
|
|
5489
6116
|
"minProximity": {
|
|
5490
6117
|
"type": "integer",
|
|
@@ -5492,7 +6119,9 @@
|
|
|
5492
6119
|
"maximum": 7,
|
|
5493
6120
|
"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",
|
|
5494
6121
|
"default": 1,
|
|
5495
|
-
"x-categories": [
|
|
6122
|
+
"x-categories": [
|
|
6123
|
+
"Advanced"
|
|
6124
|
+
]
|
|
5496
6125
|
},
|
|
5497
6126
|
"responseFields": {
|
|
5498
6127
|
"type": "array",
|
|
@@ -5500,27 +6129,37 @@
|
|
|
5500
6129
|
"type": "string"
|
|
5501
6130
|
},
|
|
5502
6131
|
"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",
|
|
5503
|
-
"default": [
|
|
5504
|
-
|
|
6132
|
+
"default": [
|
|
6133
|
+
"*"
|
|
6134
|
+
],
|
|
6135
|
+
"x-categories": [
|
|
6136
|
+
"Advanced"
|
|
6137
|
+
]
|
|
5505
6138
|
},
|
|
5506
6139
|
"maxValuesPerFacet": {
|
|
5507
6140
|
"type": "integer",
|
|
5508
6141
|
"description": "Maximum number of facet values to return for each facet.",
|
|
5509
6142
|
"default": 100,
|
|
5510
6143
|
"maximum": 1000,
|
|
5511
|
-
"x-categories": [
|
|
6144
|
+
"x-categories": [
|
|
6145
|
+
"Faceting"
|
|
6146
|
+
]
|
|
5512
6147
|
},
|
|
5513
6148
|
"sortFacetValuesBy": {
|
|
5514
6149
|
"type": "string",
|
|
5515
6150
|
"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",
|
|
5516
6151
|
"default": "count",
|
|
5517
|
-
"x-categories": [
|
|
6152
|
+
"x-categories": [
|
|
6153
|
+
"Faceting"
|
|
6154
|
+
]
|
|
5518
6155
|
},
|
|
5519
6156
|
"attributeCriteriaComputedByMinProximity": {
|
|
5520
6157
|
"type": "boolean",
|
|
5521
6158
|
"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",
|
|
5522
6159
|
"default": false,
|
|
5523
|
-
"x-categories": [
|
|
6160
|
+
"x-categories": [
|
|
6161
|
+
"Advanced"
|
|
6162
|
+
]
|
|
5524
6163
|
},
|
|
5525
6164
|
"order": {
|
|
5526
6165
|
"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",
|
|
@@ -5542,7 +6181,11 @@
|
|
|
5542
6181
|
"sortRemainingBy": {
|
|
5543
6182
|
"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",
|
|
5544
6183
|
"type": "string",
|
|
5545
|
-
"enum": [
|
|
6184
|
+
"enum": [
|
|
6185
|
+
"count",
|
|
6186
|
+
"alpha",
|
|
6187
|
+
"hidden"
|
|
6188
|
+
]
|
|
5546
6189
|
},
|
|
5547
6190
|
"hide": {
|
|
5548
6191
|
"description": "Hide facet values.",
|
|
@@ -5678,13 +6321,17 @@
|
|
|
5678
6321
|
"$ref": "#/components/schemas/widgets"
|
|
5679
6322
|
}
|
|
5680
6323
|
},
|
|
5681
|
-
"x-categories": [
|
|
6324
|
+
"x-categories": [
|
|
6325
|
+
"Advanced"
|
|
6326
|
+
]
|
|
5682
6327
|
},
|
|
5683
6328
|
"enableReRanking": {
|
|
5684
6329
|
"type": "boolean",
|
|
5685
6330
|
"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",
|
|
5686
6331
|
"default": true,
|
|
5687
|
-
"x-categories": [
|
|
6332
|
+
"x-categories": [
|
|
6333
|
+
"Filtering"
|
|
6334
|
+
]
|
|
5688
6335
|
},
|
|
5689
6336
|
"reRankingApplyFilter": {
|
|
5690
6337
|
"description": "Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.\n",
|
|
@@ -5697,7 +6344,9 @@
|
|
|
5697
6344
|
},
|
|
5698
6345
|
{
|
|
5699
6346
|
"type": "string",
|
|
5700
|
-
"x-categories": [
|
|
6347
|
+
"x-categories": [
|
|
6348
|
+
"Filtering"
|
|
6349
|
+
]
|
|
5701
6350
|
}
|
|
5702
6351
|
]
|
|
5703
6352
|
},
|
|
@@ -5724,7 +6373,9 @@
|
|
|
5724
6373
|
"exact",
|
|
5725
6374
|
"custom"
|
|
5726
6375
|
],
|
|
5727
|
-
"x-categories": [
|
|
6376
|
+
"x-categories": [
|
|
6377
|
+
"Ranking"
|
|
6378
|
+
]
|
|
5728
6379
|
},
|
|
5729
6380
|
"relevancyStrictness": {
|
|
5730
6381
|
"$ref": "#/components/schemas/relevancyStrictness"
|
|
@@ -5902,7 +6553,9 @@
|
|
|
5902
6553
|
"title": "redirectRuleIndexData",
|
|
5903
6554
|
"type": "object",
|
|
5904
6555
|
"description": "Redirect rule data.",
|
|
5905
|
-
"required": [
|
|
6556
|
+
"required": [
|
|
6557
|
+
"ruleObjectID"
|
|
6558
|
+
],
|
|
5906
6559
|
"properties": {
|
|
5907
6560
|
"ruleObjectID": {
|
|
5908
6561
|
"type": "string"
|
|
@@ -5910,7 +6563,13 @@
|
|
|
5910
6563
|
}
|
|
5911
6564
|
}
|
|
5912
6565
|
},
|
|
5913
|
-
"required": [
|
|
6566
|
+
"required": [
|
|
6567
|
+
"data",
|
|
6568
|
+
"succeed",
|
|
6569
|
+
"reason",
|
|
6570
|
+
"dest",
|
|
6571
|
+
"source"
|
|
6572
|
+
]
|
|
5914
6573
|
},
|
|
5915
6574
|
"userData": {
|
|
5916
6575
|
"example": {
|
|
@@ -5919,7 +6578,9 @@
|
|
|
5919
6578
|
},
|
|
5920
6579
|
"description": "An object with custom data.\n\nYou can store up to 32kB as custom data.\n",
|
|
5921
6580
|
"default": {},
|
|
5922
|
-
"x-categories": [
|
|
6581
|
+
"x-categories": [
|
|
6582
|
+
"Advanced"
|
|
6583
|
+
]
|
|
5923
6584
|
},
|
|
5924
6585
|
"baseSearchResponse": {
|
|
5925
6586
|
"type": "object",
|
|
@@ -6164,7 +6825,11 @@
|
|
|
6164
6825
|
"matchLevel": {
|
|
6165
6826
|
"type": "string",
|
|
6166
6827
|
"description": "Whether the whole query string matches or only a part.",
|
|
6167
|
-
"enum": [
|
|
6828
|
+
"enum": [
|
|
6829
|
+
"none",
|
|
6830
|
+
"partial",
|
|
6831
|
+
"full"
|
|
6832
|
+
]
|
|
6168
6833
|
},
|
|
6169
6834
|
"highlightResultOption": {
|
|
6170
6835
|
"title": "highlightResultOption",
|
|
@@ -6181,7 +6846,9 @@
|
|
|
6181
6846
|
"matchedWords": {
|
|
6182
6847
|
"type": "array",
|
|
6183
6848
|
"description": "List of matched words from the search query.",
|
|
6184
|
-
"example": [
|
|
6849
|
+
"example": [
|
|
6850
|
+
"action"
|
|
6851
|
+
],
|
|
6185
6852
|
"items": {
|
|
6186
6853
|
"type": "string"
|
|
6187
6854
|
}
|
|
@@ -6191,8 +6858,15 @@
|
|
|
6191
6858
|
"description": "Whether the entire attribute value is highlighted."
|
|
6192
6859
|
}
|
|
6193
6860
|
},
|
|
6194
|
-
"required": [
|
|
6195
|
-
|
|
6861
|
+
"required": [
|
|
6862
|
+
"value",
|
|
6863
|
+
"matchLevel",
|
|
6864
|
+
"matchedWords"
|
|
6865
|
+
],
|
|
6866
|
+
"x-discriminator-fields": [
|
|
6867
|
+
"matchLevel",
|
|
6868
|
+
"matchedWords"
|
|
6869
|
+
]
|
|
6196
6870
|
},
|
|
6197
6871
|
"highlightResultMap": {
|
|
6198
6872
|
"title": "highlightResultMap",
|
|
@@ -6238,8 +6912,13 @@
|
|
|
6238
6912
|
"$ref": "#/components/schemas/matchLevel"
|
|
6239
6913
|
}
|
|
6240
6914
|
},
|
|
6241
|
-
"required": [
|
|
6242
|
-
|
|
6915
|
+
"required": [
|
|
6916
|
+
"value",
|
|
6917
|
+
"matchLevel"
|
|
6918
|
+
],
|
|
6919
|
+
"x-discriminator-fields": [
|
|
6920
|
+
"matchLevel"
|
|
6921
|
+
]
|
|
6243
6922
|
},
|
|
6244
6923
|
"snippetResultMap": {
|
|
6245
6924
|
"title": "snippetResultMap",
|
|
@@ -6372,7 +7051,13 @@
|
|
|
6372
7051
|
"description": "Whether the record is re-ranked."
|
|
6373
7052
|
}
|
|
6374
7053
|
},
|
|
6375
|
-
"required": [
|
|
7054
|
+
"required": [
|
|
7055
|
+
"nbTypos",
|
|
7056
|
+
"firstMatchedWord",
|
|
7057
|
+
"geoDistance",
|
|
7058
|
+
"nbExactWords",
|
|
7059
|
+
"userScore"
|
|
7060
|
+
]
|
|
6376
7061
|
},
|
|
6377
7062
|
"distinctSeqID": {
|
|
6378
7063
|
"type": "integer"
|
|
@@ -6383,7 +7068,9 @@
|
|
|
6383
7068
|
"x-is-generic": true,
|
|
6384
7069
|
"x-is-hit-object": true,
|
|
6385
7070
|
"additionalProperties": true,
|
|
6386
|
-
"required": [
|
|
7071
|
+
"required": [
|
|
7072
|
+
"objectID"
|
|
7073
|
+
],
|
|
6387
7074
|
"properties": {
|
|
6388
7075
|
"objectID": {
|
|
6389
7076
|
"$ref": "#/components/schemas/objectID"
|
|
@@ -6422,7 +7109,11 @@
|
|
|
6422
7109
|
"example": "query=a&hitsPerPage=20"
|
|
6423
7110
|
}
|
|
6424
7111
|
},
|
|
6425
|
-
"required": [
|
|
7112
|
+
"required": [
|
|
7113
|
+
"hits",
|
|
7114
|
+
"query",
|
|
7115
|
+
"params"
|
|
7116
|
+
]
|
|
6426
7117
|
},
|
|
6427
7118
|
"searchResponse": {
|
|
6428
7119
|
"additionalProperties": true,
|
|
@@ -6445,7 +7136,9 @@
|
|
|
6445
7136
|
},
|
|
6446
7137
|
"searchTypeDefault": {
|
|
6447
7138
|
"type": "string",
|
|
6448
|
-
"enum": [
|
|
7139
|
+
"enum": [
|
|
7140
|
+
"default"
|
|
7141
|
+
],
|
|
6449
7142
|
"default": "default",
|
|
6450
7143
|
"description": "- `default`: perform a search query\n- `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).\n"
|
|
6451
7144
|
},
|
|
@@ -6460,7 +7153,9 @@
|
|
|
6460
7153
|
"$ref": "#/components/schemas/searchTypeDefault"
|
|
6461
7154
|
}
|
|
6462
7155
|
},
|
|
6463
|
-
"required": [
|
|
7156
|
+
"required": [
|
|
7157
|
+
"indexName"
|
|
7158
|
+
]
|
|
6464
7159
|
},
|
|
6465
7160
|
"SearchForHits": {
|
|
6466
7161
|
"allOf": [
|
|
@@ -6483,11 +7178,15 @@
|
|
|
6483
7178
|
"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).",
|
|
6484
7179
|
"maximum": 100,
|
|
6485
7180
|
"default": 10,
|
|
6486
|
-
"x-categories": [
|
|
7181
|
+
"x-categories": [
|
|
7182
|
+
"Advanced"
|
|
7183
|
+
]
|
|
6487
7184
|
},
|
|
6488
7185
|
"searchTypeFacet": {
|
|
6489
7186
|
"type": "string",
|
|
6490
|
-
"enum": [
|
|
7187
|
+
"enum": [
|
|
7188
|
+
"facet"
|
|
7189
|
+
],
|
|
6491
7190
|
"default": "facet",
|
|
6492
7191
|
"description": "- `default`: perform a search query\n- `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).\n"
|
|
6493
7192
|
},
|
|
@@ -6511,7 +7210,11 @@
|
|
|
6511
7210
|
"$ref": "#/components/schemas/searchTypeFacet"
|
|
6512
7211
|
}
|
|
6513
7212
|
},
|
|
6514
|
-
"required": [
|
|
7213
|
+
"required": [
|
|
7214
|
+
"indexName",
|
|
7215
|
+
"type",
|
|
7216
|
+
"facet"
|
|
7217
|
+
]
|
|
6515
7218
|
},
|
|
6516
7219
|
"SearchForFacets": {
|
|
6517
7220
|
"allOf": [
|
|
@@ -6522,7 +7225,10 @@
|
|
|
6522
7225
|
"$ref": "#/components/schemas/searchForFacetsOptions"
|
|
6523
7226
|
}
|
|
6524
7227
|
],
|
|
6525
|
-
"x-discriminator-fields": [
|
|
7228
|
+
"x-discriminator-fields": [
|
|
7229
|
+
"facet",
|
|
7230
|
+
"type"
|
|
7231
|
+
]
|
|
6526
7232
|
},
|
|
6527
7233
|
"SearchQuery": {
|
|
6528
7234
|
"oneOf": [
|
|
@@ -6536,14 +7242,22 @@
|
|
|
6536
7242
|
},
|
|
6537
7243
|
"searchStrategy": {
|
|
6538
7244
|
"type": "string",
|
|
6539
|
-
"enum": [
|
|
7245
|
+
"enum": [
|
|
7246
|
+
"none",
|
|
7247
|
+
"stopIfEnoughMatches"
|
|
7248
|
+
],
|
|
6540
7249
|
"description": "Strategy for multiple search queries:\n\n- `none`. Run all queries.\n- `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.\n"
|
|
6541
7250
|
},
|
|
6542
7251
|
"searchForFacetValuesResponse": {
|
|
6543
7252
|
"type": "object",
|
|
6544
7253
|
"additionalProperties": false,
|
|
6545
|
-
"required": [
|
|
6546
|
-
|
|
7254
|
+
"required": [
|
|
7255
|
+
"facetHits",
|
|
7256
|
+
"exhaustiveFacetsCount"
|
|
7257
|
+
],
|
|
7258
|
+
"x-discriminator-fields": [
|
|
7259
|
+
"facetHits"
|
|
7260
|
+
],
|
|
6547
7261
|
"properties": {
|
|
6548
7262
|
"facetHits": {
|
|
6549
7263
|
"type": "array",
|
|
@@ -6552,7 +7266,11 @@
|
|
|
6552
7266
|
"title": "facetHits",
|
|
6553
7267
|
"type": "object",
|
|
6554
7268
|
"additionalProperties": false,
|
|
6555
|
-
"required": [
|
|
7269
|
+
"required": [
|
|
7270
|
+
"value",
|
|
7271
|
+
"highlighted",
|
|
7272
|
+
"count"
|
|
7273
|
+
],
|
|
6556
7274
|
"properties": {
|
|
6557
7275
|
"value": {
|
|
6558
7276
|
"description": "Facet value.",
|
|
@@ -6708,7 +7426,10 @@
|
|
|
6708
7426
|
"type": "object",
|
|
6709
7427
|
"description": "Response, taskID, and update timestamp.",
|
|
6710
7428
|
"additionalProperties": false,
|
|
6711
|
-
"required": [
|
|
7429
|
+
"required": [
|
|
7430
|
+
"taskID",
|
|
7431
|
+
"updatedAt"
|
|
7432
|
+
],
|
|
6712
7433
|
"properties": {
|
|
6713
7434
|
"taskID": {
|
|
6714
7435
|
"$ref": "#/components/schemas/taskID"
|
|
@@ -6757,11 +7478,16 @@
|
|
|
6757
7478
|
}
|
|
6758
7479
|
}
|
|
6759
7480
|
},
|
|
6760
|
-
"required": [
|
|
7481
|
+
"required": [
|
|
7482
|
+
"action",
|
|
7483
|
+
"body"
|
|
7484
|
+
]
|
|
6761
7485
|
}
|
|
6762
7486
|
}
|
|
6763
7487
|
},
|
|
6764
|
-
"required": [
|
|
7488
|
+
"required": [
|
|
7489
|
+
"requests"
|
|
7490
|
+
],
|
|
6765
7491
|
"example": {
|
|
6766
7492
|
"requests": [
|
|
6767
7493
|
{
|
|
@@ -6788,7 +7514,10 @@
|
|
|
6788
7514
|
"items": {
|
|
6789
7515
|
"type": "string"
|
|
6790
7516
|
},
|
|
6791
|
-
"example": [
|
|
7517
|
+
"example": [
|
|
7518
|
+
"record-1",
|
|
7519
|
+
"record-2"
|
|
7520
|
+
],
|
|
6792
7521
|
"description": "Unique record identifiers."
|
|
6793
7522
|
},
|
|
6794
7523
|
"batchResponse": {
|
|
@@ -6802,7 +7531,10 @@
|
|
|
6802
7531
|
"$ref": "#/components/schemas/objectIDs"
|
|
6803
7532
|
}
|
|
6804
7533
|
},
|
|
6805
|
-
"required": [
|
|
7534
|
+
"required": [
|
|
7535
|
+
"taskID",
|
|
7536
|
+
"objectIDs"
|
|
7537
|
+
]
|
|
6806
7538
|
},
|
|
6807
7539
|
"baseIndexSettings": {
|
|
6808
7540
|
"type": "object",
|
|
@@ -6822,17 +7554,24 @@
|
|
|
6822
7554
|
],
|
|
6823
7555
|
"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",
|
|
6824
7556
|
"default": [],
|
|
6825
|
-
"x-categories": [
|
|
7557
|
+
"x-categories": [
|
|
7558
|
+
"Faceting"
|
|
7559
|
+
]
|
|
6826
7560
|
},
|
|
6827
7561
|
"replicas": {
|
|
6828
7562
|
"type": "array",
|
|
6829
7563
|
"items": {
|
|
6830
7564
|
"type": "string"
|
|
6831
7565
|
},
|
|
6832
|
-
"example": [
|
|
7566
|
+
"example": [
|
|
7567
|
+
"virtual(prod_products_price_asc)",
|
|
7568
|
+
"dev_products_replica"
|
|
7569
|
+
],
|
|
6833
7570
|
"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",
|
|
6834
7571
|
"default": [],
|
|
6835
|
-
"x-categories": [
|
|
7572
|
+
"x-categories": [
|
|
7573
|
+
"Ranking"
|
|
7574
|
+
]
|
|
6836
7575
|
},
|
|
6837
7576
|
"paginationLimitedTo": {
|
|
6838
7577
|
"type": "integer",
|
|
@@ -6846,20 +7585,29 @@
|
|
|
6846
7585
|
"items": {
|
|
6847
7586
|
"type": "string"
|
|
6848
7587
|
},
|
|
6849
|
-
"example": [
|
|
7588
|
+
"example": [
|
|
7589
|
+
"total_sales"
|
|
7590
|
+
],
|
|
6850
7591
|
"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",
|
|
6851
7592
|
"default": [],
|
|
6852
|
-
"x-categories": [
|
|
7593
|
+
"x-categories": [
|
|
7594
|
+
"Attributes"
|
|
7595
|
+
]
|
|
6853
7596
|
},
|
|
6854
7597
|
"disableTypoToleranceOnWords": {
|
|
6855
7598
|
"type": "array",
|
|
6856
7599
|
"items": {
|
|
6857
7600
|
"type": "string"
|
|
6858
7601
|
},
|
|
6859
|
-
"example": [
|
|
7602
|
+
"example": [
|
|
7603
|
+
"wheel",
|
|
7604
|
+
"1X2BCD"
|
|
7605
|
+
],
|
|
6860
7606
|
"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",
|
|
6861
7607
|
"default": [],
|
|
6862
|
-
"x-categories": [
|
|
7608
|
+
"x-categories": [
|
|
7609
|
+
"Typos"
|
|
7610
|
+
]
|
|
6863
7611
|
},
|
|
6864
7612
|
"attributesToTransliterate": {
|
|
6865
7613
|
"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",
|
|
@@ -6867,53 +7615,76 @@
|
|
|
6867
7615
|
"items": {
|
|
6868
7616
|
"type": "string"
|
|
6869
7617
|
},
|
|
6870
|
-
"example": [
|
|
6871
|
-
|
|
7618
|
+
"example": [
|
|
7619
|
+
"name",
|
|
7620
|
+
"description"
|
|
7621
|
+
],
|
|
7622
|
+
"x-categories": [
|
|
7623
|
+
"Languages"
|
|
7624
|
+
]
|
|
6872
7625
|
},
|
|
6873
7626
|
"camelCaseAttributes": {
|
|
6874
7627
|
"type": "array",
|
|
6875
7628
|
"items": {
|
|
6876
7629
|
"type": "string"
|
|
6877
7630
|
},
|
|
6878
|
-
"example": [
|
|
7631
|
+
"example": [
|
|
7632
|
+
"description"
|
|
7633
|
+
],
|
|
6879
7634
|
"description": "Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.\nAttribute names are case-sensitive.\n",
|
|
6880
7635
|
"default": [],
|
|
6881
|
-
"x-categories": [
|
|
7636
|
+
"x-categories": [
|
|
7637
|
+
"Languages"
|
|
7638
|
+
]
|
|
6882
7639
|
},
|
|
6883
7640
|
"decompoundedAttributes": {
|
|
6884
7641
|
"type": "object",
|
|
6885
7642
|
"example": {
|
|
6886
|
-
"de": [
|
|
7643
|
+
"de": [
|
|
7644
|
+
"name"
|
|
7645
|
+
]
|
|
6887
7646
|
},
|
|
6888
7647
|
"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",
|
|
6889
7648
|
"default": {},
|
|
6890
|
-
"x-categories": [
|
|
7649
|
+
"x-categories": [
|
|
7650
|
+
"Languages"
|
|
7651
|
+
]
|
|
6891
7652
|
},
|
|
6892
7653
|
"indexLanguages": {
|
|
6893
7654
|
"type": "array",
|
|
6894
7655
|
"items": {
|
|
6895
7656
|
"$ref": "#/components/schemas/supportedLanguage"
|
|
6896
7657
|
},
|
|
6897
|
-
"example": [
|
|
7658
|
+
"example": [
|
|
7659
|
+
"ja"
|
|
7660
|
+
],
|
|
6898
7661
|
"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",
|
|
6899
7662
|
"default": [],
|
|
6900
|
-
"x-categories": [
|
|
7663
|
+
"x-categories": [
|
|
7664
|
+
"Languages"
|
|
7665
|
+
]
|
|
6901
7666
|
},
|
|
6902
7667
|
"disablePrefixOnAttributes": {
|
|
6903
7668
|
"type": "array",
|
|
6904
7669
|
"items": {
|
|
6905
7670
|
"type": "string"
|
|
6906
7671
|
},
|
|
6907
|
-
"example": [
|
|
7672
|
+
"example": [
|
|
7673
|
+
"sku"
|
|
7674
|
+
],
|
|
6908
7675
|
"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",
|
|
6909
7676
|
"default": [],
|
|
6910
|
-
"x-categories": [
|
|
7677
|
+
"x-categories": [
|
|
7678
|
+
"Query strategy"
|
|
7679
|
+
]
|
|
6911
7680
|
},
|
|
6912
7681
|
"allowCompressionOfIntegerArray": {
|
|
6913
7682
|
"type": "boolean",
|
|
6914
7683
|
"description": "Whether arrays with exclusively non-negative integers should be compressed for better performance.\nIf true, the compressed arrays may be reordered.\n",
|
|
6915
7684
|
"default": false,
|
|
6916
|
-
"x-categories": [
|
|
7685
|
+
"x-categories": [
|
|
7686
|
+
"Performance"
|
|
7687
|
+
]
|
|
6917
7688
|
},
|
|
6918
7689
|
"numericAttributesForFiltering": {
|
|
6919
7690
|
"type": "array",
|
|
@@ -6921,26 +7692,40 @@
|
|
|
6921
7692
|
"type": "string"
|
|
6922
7693
|
},
|
|
6923
7694
|
"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",
|
|
6924
|
-
"example": [
|
|
7695
|
+
"example": [
|
|
7696
|
+
"equalOnly(quantity)",
|
|
7697
|
+
"popularity"
|
|
7698
|
+
],
|
|
6925
7699
|
"default": [],
|
|
6926
|
-
"x-categories": [
|
|
7700
|
+
"x-categories": [
|
|
7701
|
+
"Performance"
|
|
7702
|
+
]
|
|
6927
7703
|
},
|
|
6928
7704
|
"separatorsToIndex": {
|
|
6929
7705
|
"type": "string",
|
|
6930
7706
|
"example": "+#",
|
|
6931
7707
|
"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",
|
|
6932
7708
|
"default": "",
|
|
6933
|
-
"x-categories": [
|
|
7709
|
+
"x-categories": [
|
|
7710
|
+
"Typos"
|
|
7711
|
+
]
|
|
6934
7712
|
},
|
|
6935
7713
|
"searchableAttributes": {
|
|
6936
7714
|
"type": "array",
|
|
6937
7715
|
"items": {
|
|
6938
7716
|
"type": "string"
|
|
6939
7717
|
},
|
|
6940
|
-
"example": [
|
|
7718
|
+
"example": [
|
|
7719
|
+
"title,alternative_title",
|
|
7720
|
+
"author",
|
|
7721
|
+
"unordered(text)",
|
|
7722
|
+
"emails.personal"
|
|
7723
|
+
],
|
|
6941
7724
|
"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",
|
|
6942
7725
|
"default": [],
|
|
6943
|
-
"x-categories": [
|
|
7726
|
+
"x-categories": [
|
|
7727
|
+
"Attributes"
|
|
7728
|
+
]
|
|
6944
7729
|
},
|
|
6945
7730
|
"userData": {
|
|
6946
7731
|
"$ref": "#/components/schemas/userData"
|
|
@@ -6960,7 +7745,9 @@
|
|
|
6960
7745
|
"type": "string"
|
|
6961
7746
|
}
|
|
6962
7747
|
},
|
|
6963
|
-
"x-categories": [
|
|
7748
|
+
"x-categories": [
|
|
7749
|
+
"Languages"
|
|
7750
|
+
]
|
|
6964
7751
|
},
|
|
6965
7752
|
"attributeForDistinct": {
|
|
6966
7753
|
"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",
|
|
@@ -6975,17 +7762,24 @@
|
|
|
6975
7762
|
"example": "øé",
|
|
6976
7763
|
"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",
|
|
6977
7764
|
"default": "",
|
|
6978
|
-
"x-categories": [
|
|
7765
|
+
"x-categories": [
|
|
7766
|
+
"Languages"
|
|
7767
|
+
]
|
|
6979
7768
|
},
|
|
6980
7769
|
"customRanking": {
|
|
6981
7770
|
"type": "array",
|
|
6982
7771
|
"items": {
|
|
6983
7772
|
"type": "string"
|
|
6984
7773
|
},
|
|
6985
|
-
"example": [
|
|
7774
|
+
"example": [
|
|
7775
|
+
"desc(popularity)",
|
|
7776
|
+
"asc(price)"
|
|
7777
|
+
],
|
|
6986
7778
|
"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",
|
|
6987
7779
|
"default": [],
|
|
6988
|
-
"x-categories": [
|
|
7780
|
+
"x-categories": [
|
|
7781
|
+
"Ranking"
|
|
7782
|
+
]
|
|
6989
7783
|
}
|
|
6990
7784
|
}
|
|
6991
7785
|
},
|
|
@@ -7054,7 +7848,10 @@
|
|
|
7054
7848
|
"type": "string"
|
|
7055
7849
|
},
|
|
7056
7850
|
"description": "Words or phrases considered equivalent.",
|
|
7057
|
-
"example": [
|
|
7851
|
+
"example": [
|
|
7852
|
+
"vehicle",
|
|
7853
|
+
"auto"
|
|
7854
|
+
]
|
|
7058
7855
|
},
|
|
7059
7856
|
"input": {
|
|
7060
7857
|
"type": "string",
|
|
@@ -7072,7 +7869,10 @@
|
|
|
7072
7869
|
"type": "string"
|
|
7073
7870
|
},
|
|
7074
7871
|
"description": "Words to be matched in records.",
|
|
7075
|
-
"example": [
|
|
7872
|
+
"example": [
|
|
7873
|
+
"vehicle",
|
|
7874
|
+
"auto"
|
|
7875
|
+
]
|
|
7076
7876
|
},
|
|
7077
7877
|
"placeholder": {
|
|
7078
7878
|
"type": "string",
|
|
@@ -7085,10 +7885,16 @@
|
|
|
7085
7885
|
"type": "string"
|
|
7086
7886
|
},
|
|
7087
7887
|
"description": "Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).",
|
|
7088
|
-
"example": [
|
|
7888
|
+
"example": [
|
|
7889
|
+
"street",
|
|
7890
|
+
"st"
|
|
7891
|
+
]
|
|
7089
7892
|
}
|
|
7090
7893
|
},
|
|
7091
|
-
"required": [
|
|
7894
|
+
"required": [
|
|
7895
|
+
"objectID",
|
|
7896
|
+
"type"
|
|
7897
|
+
]
|
|
7092
7898
|
},
|
|
7093
7899
|
"id": {
|
|
7094
7900
|
"type": "string",
|
|
@@ -7113,7 +7919,10 @@
|
|
|
7113
7919
|
"$ref": "#/components/schemas/nbHits"
|
|
7114
7920
|
}
|
|
7115
7921
|
},
|
|
7116
|
-
"required": [
|
|
7922
|
+
"required": [
|
|
7923
|
+
"hits",
|
|
7924
|
+
"nbHits"
|
|
7925
|
+
]
|
|
7117
7926
|
},
|
|
7118
7927
|
"keyString": {
|
|
7119
7928
|
"type": "string",
|
|
@@ -7137,7 +7946,10 @@
|
|
|
7137
7946
|
"$ref": "#/components/schemas/createdAtTimestamp"
|
|
7138
7947
|
}
|
|
7139
7948
|
},
|
|
7140
|
-
"required": [
|
|
7949
|
+
"required": [
|
|
7950
|
+
"value",
|
|
7951
|
+
"createdAt"
|
|
7952
|
+
]
|
|
7141
7953
|
},
|
|
7142
7954
|
"acl": {
|
|
7143
7955
|
"description": "Access control list permissions.",
|
|
@@ -7168,7 +7980,10 @@
|
|
|
7168
7980
|
"acl": {
|
|
7169
7981
|
"type": "array",
|
|
7170
7982
|
"description": "Permissions that determine the type of API requests this key can make.\nThe required ACL is listed in each endpoint's reference.\nFor more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).\n",
|
|
7171
|
-
"example": [
|
|
7983
|
+
"example": [
|
|
7984
|
+
"search",
|
|
7985
|
+
"addObject"
|
|
7986
|
+
],
|
|
7172
7987
|
"default": [],
|
|
7173
7988
|
"items": {
|
|
7174
7989
|
"$ref": "#/components/schemas/acl"
|
|
@@ -7183,7 +7998,10 @@
|
|
|
7183
7998
|
"indexes": {
|
|
7184
7999
|
"type": "array",
|
|
7185
8000
|
"description": "Index names or patterns that this API key can access.\nBy default, an API key can access all indices in the same application.\n\nYou can use leading and trailing wildcard characters (`*`):\n\n- `dev_*` matches all indices starting with \"dev_\".\n- `*_dev` matches all indices ending with \"_dev\".\n- `*_products_*` matches all indices containing \"_products_\".\n",
|
|
7186
|
-
"example": [
|
|
8001
|
+
"example": [
|
|
8002
|
+
"dev_*",
|
|
8003
|
+
"prod_en_products"
|
|
8004
|
+
],
|
|
7187
8005
|
"default": [],
|
|
7188
8006
|
"items": {
|
|
7189
8007
|
"type": "string"
|
|
@@ -7208,7 +8026,9 @@
|
|
|
7208
8026
|
"referers": {
|
|
7209
8027
|
"type": "array",
|
|
7210
8028
|
"description": "Allowed HTTP referrers for this API key.\n\nBy default, all referrers are allowed.\nYou can use leading and trailing wildcard characters (`*`):\n\n- `https://algolia.com/*` allows all referrers starting with \"https://algolia.com/\"\n- `*.algolia.com` allows all referrers ending with \".algolia.com\"\n- `*algolia.com*` allows all referrers in the domain \"algolia.com\".\n\nLike all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data.\nFor more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).\n",
|
|
7211
|
-
"example": [
|
|
8029
|
+
"example": [
|
|
8030
|
+
"*algolia.com*"
|
|
8031
|
+
],
|
|
7212
8032
|
"default": [],
|
|
7213
8033
|
"items": {
|
|
7214
8034
|
"type": "string"
|
|
@@ -7221,7 +8041,9 @@
|
|
|
7221
8041
|
"default": 0
|
|
7222
8042
|
}
|
|
7223
8043
|
},
|
|
7224
|
-
"required": [
|
|
8044
|
+
"required": [
|
|
8045
|
+
"acl"
|
|
8046
|
+
]
|
|
7225
8047
|
},
|
|
7226
8048
|
"getApiKeyResponse": {
|
|
7227
8049
|
"allOf": [
|
|
@@ -7244,7 +8066,10 @@
|
|
|
7244
8066
|
"$ref": "#/components/schemas/createdAt"
|
|
7245
8067
|
}
|
|
7246
8068
|
},
|
|
7247
|
-
"required": [
|
|
8069
|
+
"required": [
|
|
8070
|
+
"key",
|
|
8071
|
+
"createdAt"
|
|
8072
|
+
]
|
|
7248
8073
|
},
|
|
7249
8074
|
"ruleID": {
|
|
7250
8075
|
"title": "objectID",
|
|
@@ -7254,7 +8079,12 @@
|
|
|
7254
8079
|
"anchoring": {
|
|
7255
8080
|
"type": "string",
|
|
7256
8081
|
"description": "Which part of the search query the pattern should match:\n\n- `startsWith`. The pattern must match the beginning of the query.\n- `endsWith`. The pattern must match the end of the query.\n- `is`. The pattern must match the query exactly.\n- `contains`. The pattern must match anywhere in the query.\n\nEmpty queries are only allowed as patterns with `anchoring: is`.\n",
|
|
7257
|
-
"enum": [
|
|
8082
|
+
"enum": [
|
|
8083
|
+
"is",
|
|
8084
|
+
"startsWith",
|
|
8085
|
+
"endsWith",
|
|
8086
|
+
"contains"
|
|
8087
|
+
]
|
|
7258
8088
|
},
|
|
7259
8089
|
"context": {
|
|
7260
8090
|
"type": "string",
|
|
@@ -7292,7 +8122,10 @@
|
|
|
7292
8122
|
"editType": {
|
|
7293
8123
|
"description": "Type of edit.",
|
|
7294
8124
|
"type": "string",
|
|
7295
|
-
"enum": [
|
|
8125
|
+
"enum": [
|
|
8126
|
+
"remove",
|
|
8127
|
+
"replace"
|
|
8128
|
+
]
|
|
7296
8129
|
},
|
|
7297
8130
|
"edit": {
|
|
7298
8131
|
"type": "object",
|
|
@@ -7362,7 +8195,9 @@
|
|
|
7362
8195
|
"description": "Whether the filter is disjunctive or conjunctive.\n\nIf true the filter has multiple matches, multiple occurences are combined with the logical `OR` operation.\nIf false, multiple occurences are combined with the logical `AND` operation.\n"
|
|
7363
8196
|
}
|
|
7364
8197
|
},
|
|
7365
|
-
"required": [
|
|
8198
|
+
"required": [
|
|
8199
|
+
"facet"
|
|
8200
|
+
]
|
|
7366
8201
|
},
|
|
7367
8202
|
"automaticFacetFilters": {
|
|
7368
8203
|
"description": "Filter to be applied to the search.\n\nYou can use this to respond to search queries that match a facet value.\nFor example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet,\nyou can filter the results to show the top-ranked comedy movies.\n",
|
|
@@ -7436,8 +8271,13 @@
|
|
|
7436
8271
|
"$ref": "#/components/schemas/promotePosition"
|
|
7437
8272
|
}
|
|
7438
8273
|
},
|
|
7439
|
-
"required": [
|
|
7440
|
-
|
|
8274
|
+
"required": [
|
|
8275
|
+
"position",
|
|
8276
|
+
"objectIDs"
|
|
8277
|
+
],
|
|
8278
|
+
"x-discriminator-fields": [
|
|
8279
|
+
"objectIDs"
|
|
8280
|
+
]
|
|
7441
8281
|
},
|
|
7442
8282
|
"promoteObjectID": {
|
|
7443
8283
|
"title": "objectID",
|
|
@@ -7452,8 +8292,13 @@
|
|
|
7452
8292
|
"$ref": "#/components/schemas/promotePosition"
|
|
7453
8293
|
}
|
|
7454
8294
|
},
|
|
7455
|
-
"required": [
|
|
7456
|
-
|
|
8295
|
+
"required": [
|
|
8296
|
+
"position",
|
|
8297
|
+
"objectID"
|
|
8298
|
+
],
|
|
8299
|
+
"x-discriminator-fields": [
|
|
8300
|
+
"objectID"
|
|
8301
|
+
]
|
|
7457
8302
|
},
|
|
7458
8303
|
"promote": {
|
|
7459
8304
|
"oneOf": [
|
|
@@ -7500,7 +8345,9 @@
|
|
|
7500
8345
|
"$ref": "#/components/schemas/objectID"
|
|
7501
8346
|
}
|
|
7502
8347
|
},
|
|
7503
|
-
"required": [
|
|
8348
|
+
"required": [
|
|
8349
|
+
"objectID"
|
|
8350
|
+
]
|
|
7504
8351
|
}
|
|
7505
8352
|
},
|
|
7506
8353
|
"userData": {
|
|
@@ -7567,7 +8414,10 @@
|
|
|
7567
8414
|
}
|
|
7568
8415
|
}
|
|
7569
8416
|
},
|
|
7570
|
-
"required": [
|
|
8417
|
+
"required": [
|
|
8418
|
+
"objectID",
|
|
8419
|
+
"consequence"
|
|
8420
|
+
]
|
|
7571
8421
|
},
|
|
7572
8422
|
"parameters_query": {
|
|
7573
8423
|
"type": "string",
|
|
@@ -7588,29 +8438,44 @@
|
|
|
7588
8438
|
},
|
|
7589
8439
|
"dictionaryType": {
|
|
7590
8440
|
"type": "string",
|
|
7591
|
-
"enum": [
|
|
8441
|
+
"enum": [
|
|
8442
|
+
"plurals",
|
|
8443
|
+
"stopwords",
|
|
8444
|
+
"compounds"
|
|
8445
|
+
]
|
|
7592
8446
|
},
|
|
7593
8447
|
"dictionaryAction": {
|
|
7594
8448
|
"type": "string",
|
|
7595
|
-
"enum": [
|
|
8449
|
+
"enum": [
|
|
8450
|
+
"addEntry",
|
|
8451
|
+
"deleteEntry"
|
|
8452
|
+
],
|
|
7596
8453
|
"description": "Actions to perform."
|
|
7597
8454
|
},
|
|
7598
8455
|
"dictionaryEntryState": {
|
|
7599
8456
|
"type": "string",
|
|
7600
|
-
"enum": [
|
|
8457
|
+
"enum": [
|
|
8458
|
+
"enabled",
|
|
8459
|
+
"disabled"
|
|
8460
|
+
],
|
|
7601
8461
|
"default": "enabled",
|
|
7602
8462
|
"description": "Whether a dictionary entry is active."
|
|
7603
8463
|
},
|
|
7604
8464
|
"dictionaryEntryType": {
|
|
7605
8465
|
"type": "string",
|
|
7606
|
-
"enum": [
|
|
8466
|
+
"enum": [
|
|
8467
|
+
"custom",
|
|
8468
|
+
"standard"
|
|
8469
|
+
],
|
|
7607
8470
|
"description": "Whether a dictionary entry is provided by Algolia (standard), or has been added by you (custom)."
|
|
7608
8471
|
},
|
|
7609
8472
|
"dictionaryEntry": {
|
|
7610
8473
|
"type": "object",
|
|
7611
8474
|
"description": "Dictionary entry.",
|
|
7612
8475
|
"additionalProperties": true,
|
|
7613
|
-
"required": [
|
|
8476
|
+
"required": [
|
|
8477
|
+
"objectID"
|
|
8478
|
+
],
|
|
7614
8479
|
"properties": {
|
|
7615
8480
|
"objectID": {
|
|
7616
8481
|
"type": "string",
|
|
@@ -7628,7 +8493,10 @@
|
|
|
7628
8493
|
"words": {
|
|
7629
8494
|
"type": "array",
|
|
7630
8495
|
"description": "Matching words in the `plurals` dictionary including declensions.",
|
|
7631
|
-
"example": [
|
|
8496
|
+
"example": [
|
|
8497
|
+
"cheval",
|
|
8498
|
+
"cheveaux"
|
|
8499
|
+
],
|
|
7632
8500
|
"items": {
|
|
7633
8501
|
"type": "string"
|
|
7634
8502
|
}
|
|
@@ -7636,7 +8504,11 @@
|
|
|
7636
8504
|
"decomposition": {
|
|
7637
8505
|
"type": "array",
|
|
7638
8506
|
"description": "Invividual components of a compound word in the `compounds` dictionary.",
|
|
7639
|
-
"example": [
|
|
8507
|
+
"example": [
|
|
8508
|
+
"kopf",
|
|
8509
|
+
"schmerz",
|
|
8510
|
+
"tablette"
|
|
8511
|
+
],
|
|
7640
8512
|
"items": {
|
|
7641
8513
|
"type": "string"
|
|
7642
8514
|
}
|
|
@@ -7670,7 +8542,12 @@
|
|
|
7670
8542
|
"$ref": "#/components/schemas/nbPages"
|
|
7671
8543
|
}
|
|
7672
8544
|
},
|
|
7673
|
-
"required": [
|
|
8545
|
+
"required": [
|
|
8546
|
+
"hits",
|
|
8547
|
+
"page",
|
|
8548
|
+
"nbHits",
|
|
8549
|
+
"nbPages"
|
|
8550
|
+
]
|
|
7674
8551
|
},
|
|
7675
8552
|
"standardEntry": {
|
|
7676
8553
|
"oneOf": [
|
|
@@ -7728,7 +8605,11 @@
|
|
|
7728
8605
|
"type": "object",
|
|
7729
8606
|
"description": "Dictionary language.",
|
|
7730
8607
|
"additionalProperties": false,
|
|
7731
|
-
"required": [
|
|
8608
|
+
"required": [
|
|
8609
|
+
"plurals",
|
|
8610
|
+
"stopwords",
|
|
8611
|
+
"compounds"
|
|
8612
|
+
],
|
|
7732
8613
|
"properties": {
|
|
7733
8614
|
"plurals": {
|
|
7734
8615
|
"$ref": "#/components/schemas/dictionaryLanguage"
|
|
@@ -7771,7 +8652,12 @@
|
|
|
7771
8652
|
"example": 0
|
|
7772
8653
|
}
|
|
7773
8654
|
},
|
|
7774
|
-
"required": [
|
|
8655
|
+
"required": [
|
|
8656
|
+
"userID",
|
|
8657
|
+
"clusterName",
|
|
8658
|
+
"nbRecords",
|
|
8659
|
+
"dataSize"
|
|
8660
|
+
]
|
|
7775
8661
|
},
|
|
7776
8662
|
"clusterName": {
|
|
7777
8663
|
"type": "string",
|
|
@@ -7791,7 +8677,9 @@
|
|
|
7791
8677
|
"source": {
|
|
7792
8678
|
"type": "object",
|
|
7793
8679
|
"description": "Source.",
|
|
7794
|
-
"required": [
|
|
8680
|
+
"required": [
|
|
8681
|
+
"source"
|
|
8682
|
+
],
|
|
7795
8683
|
"properties": {
|
|
7796
8684
|
"source": {
|
|
7797
8685
|
"description": "IP address range of the source.",
|
|
@@ -7814,12 +8702,20 @@
|
|
|
7814
8702
|
},
|
|
7815
8703
|
"logType": {
|
|
7816
8704
|
"type": "string",
|
|
7817
|
-
"enum": [
|
|
8705
|
+
"enum": [
|
|
8706
|
+
"all",
|
|
8707
|
+
"query",
|
|
8708
|
+
"build",
|
|
8709
|
+
"error"
|
|
8710
|
+
],
|
|
7818
8711
|
"default": "all"
|
|
7819
8712
|
},
|
|
7820
8713
|
"taskStatus": {
|
|
7821
8714
|
"type": "string",
|
|
7822
|
-
"enum": [
|
|
8715
|
+
"enum": [
|
|
8716
|
+
"published",
|
|
8717
|
+
"notPublished"
|
|
8718
|
+
],
|
|
7823
8719
|
"description": "Task status, `published` if the task is completed, `notPublished` otherwise."
|
|
7824
8720
|
},
|
|
7825
8721
|
"GetTaskResponse": {
|
|
@@ -7831,17 +8727,26 @@
|
|
|
7831
8727
|
"$ref": "#/components/schemas/taskStatus"
|
|
7832
8728
|
}
|
|
7833
8729
|
},
|
|
7834
|
-
"required": [
|
|
8730
|
+
"required": [
|
|
8731
|
+
"status"
|
|
8732
|
+
]
|
|
7835
8733
|
},
|
|
7836
8734
|
"operationType": {
|
|
7837
8735
|
"type": "string",
|
|
7838
|
-
"enum": [
|
|
8736
|
+
"enum": [
|
|
8737
|
+
"move",
|
|
8738
|
+
"copy"
|
|
8739
|
+
],
|
|
7839
8740
|
"example": "copy",
|
|
7840
8741
|
"description": "Operation to perform on the index."
|
|
7841
8742
|
},
|
|
7842
8743
|
"scopeType": {
|
|
7843
8744
|
"type": "string",
|
|
7844
|
-
"enum": [
|
|
8745
|
+
"enum": [
|
|
8746
|
+
"settings",
|
|
8747
|
+
"synonyms",
|
|
8748
|
+
"rules"
|
|
8749
|
+
]
|
|
7845
8750
|
},
|
|
7846
8751
|
"fetchedIndex": {
|
|
7847
8752
|
"type": "object",
|
|
@@ -7903,12 +8808,17 @@
|
|
|
7903
8808
|
"type": "string"
|
|
7904
8809
|
},
|
|
7905
8810
|
"description": "Only present if the index is a primary index with replicas. Contains the names of all linked replicas.",
|
|
7906
|
-
"example": [
|
|
8811
|
+
"example": [
|
|
8812
|
+
"T02_push",
|
|
8813
|
+
"T2replica"
|
|
8814
|
+
]
|
|
7907
8815
|
},
|
|
7908
8816
|
"virtual": {
|
|
7909
8817
|
"type": "boolean",
|
|
7910
8818
|
"description": "Only present if the index is a [virtual replica](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-an-index-alphabetically/#virtual-replicas).",
|
|
7911
|
-
"x-categories": [
|
|
8819
|
+
"x-categories": [
|
|
8820
|
+
"Ranking"
|
|
8821
|
+
]
|
|
7912
8822
|
}
|
|
7913
8823
|
},
|
|
7914
8824
|
"required": [
|
|
@@ -7940,11 +8850,17 @@
|
|
|
7940
8850
|
"example": 100
|
|
7941
8851
|
}
|
|
7942
8852
|
},
|
|
7943
|
-
"required": [
|
|
8853
|
+
"required": [
|
|
8854
|
+
"items"
|
|
8855
|
+
]
|
|
7944
8856
|
},
|
|
7945
8857
|
"apiKeyOperation": {
|
|
7946
8858
|
"type": "string",
|
|
7947
|
-
"enum": [
|
|
8859
|
+
"enum": [
|
|
8860
|
+
"add",
|
|
8861
|
+
"delete",
|
|
8862
|
+
"update"
|
|
8863
|
+
]
|
|
7948
8864
|
},
|
|
7949
8865
|
"securedApiKeyRestrictions": {
|
|
7950
8866
|
"type": "object",
|
|
@@ -8000,7 +8916,11 @@
|
|
|
8000
8916
|
"$ref": "#/components/schemas/updatedAtResponse"
|
|
8001
8917
|
}
|
|
8002
8918
|
},
|
|
8003
|
-
"required": [
|
|
8919
|
+
"required": [
|
|
8920
|
+
"copyOperationResponse",
|
|
8921
|
+
"batchResponses",
|
|
8922
|
+
"moveOperationResponse"
|
|
8923
|
+
]
|
|
8004
8924
|
},
|
|
8005
8925
|
"RunID": {
|
|
8006
8926
|
"type": "string",
|
|
@@ -8016,7 +8936,14 @@
|
|
|
8016
8936
|
"oneOf": [
|
|
8017
8937
|
{
|
|
8018
8938
|
"type": "string",
|
|
8019
|
-
"enum": [
|
|
8939
|
+
"enum": [
|
|
8940
|
+
"created",
|
|
8941
|
+
"started",
|
|
8942
|
+
"retried",
|
|
8943
|
+
"failed",
|
|
8944
|
+
"succeeded",
|
|
8945
|
+
"critical"
|
|
8946
|
+
]
|
|
8020
8947
|
},
|
|
8021
8948
|
{
|
|
8022
8949
|
"type": "null"
|
|
@@ -8025,7 +8952,12 @@
|
|
|
8025
8952
|
},
|
|
8026
8953
|
"EventType": {
|
|
8027
8954
|
"type": "string",
|
|
8028
|
-
"enum": [
|
|
8955
|
+
"enum": [
|
|
8956
|
+
"fetch",
|
|
8957
|
+
"record",
|
|
8958
|
+
"log",
|
|
8959
|
+
"transform"
|
|
8960
|
+
]
|
|
8029
8961
|
},
|
|
8030
8962
|
"PublishedAt": {
|
|
8031
8963
|
"type": "string",
|
|
@@ -8070,7 +9002,14 @@
|
|
|
8070
9002
|
"$ref": "#/components/schemas/PublishedAt"
|
|
8071
9003
|
}
|
|
8072
9004
|
},
|
|
8073
|
-
"required": [
|
|
9005
|
+
"required": [
|
|
9006
|
+
"eventID",
|
|
9007
|
+
"runID",
|
|
9008
|
+
"status",
|
|
9009
|
+
"type",
|
|
9010
|
+
"batchSize",
|
|
9011
|
+
"publishedAt"
|
|
9012
|
+
]
|
|
8074
9013
|
},
|
|
8075
9014
|
"CreatedAt": {
|
|
8076
9015
|
"type": "string",
|
|
@@ -8108,7 +9047,9 @@
|
|
|
8108
9047
|
"$ref": "#/components/schemas/CreatedAt"
|
|
8109
9048
|
}
|
|
8110
9049
|
},
|
|
8111
|
-
"required": [
|
|
9050
|
+
"required": [
|
|
9051
|
+
"runID"
|
|
9052
|
+
]
|
|
8112
9053
|
},
|
|
8113
9054
|
"replaceAllObjectsWithTransformationResponse": {
|
|
8114
9055
|
"type": "object",
|
|
@@ -8130,7 +9071,11 @@
|
|
|
8130
9071
|
"$ref": "#/components/schemas/updatedAtResponse"
|
|
8131
9072
|
}
|
|
8132
9073
|
},
|
|
8133
|
-
"required": [
|
|
9074
|
+
"required": [
|
|
9075
|
+
"copyOperationResponse",
|
|
9076
|
+
"watchResponses",
|
|
9077
|
+
"moveOperationResponse"
|
|
9078
|
+
]
|
|
8134
9079
|
},
|
|
8135
9080
|
"builtInOperationType": {
|
|
8136
9081
|
"type": "string",
|
|
@@ -8169,7 +9114,10 @@
|
|
|
8169
9114
|
"$ref": "#/components/schemas/builtInOperationValue"
|
|
8170
9115
|
}
|
|
8171
9116
|
},
|
|
8172
|
-
"required": [
|
|
9117
|
+
"required": [
|
|
9118
|
+
"_operation",
|
|
9119
|
+
"value"
|
|
9120
|
+
]
|
|
8173
9121
|
}
|
|
8174
9122
|
},
|
|
8175
9123
|
"parameters": {
|
|
@@ -8381,7 +9329,10 @@
|
|
|
8381
9329
|
"description": "Response, taskID, and deletion timestamp.",
|
|
8382
9330
|
"additionalProperties": false,
|
|
8383
9331
|
"type": "object",
|
|
8384
|
-
"required": [
|
|
9332
|
+
"required": [
|
|
9333
|
+
"taskID",
|
|
9334
|
+
"deletedAt"
|
|
9335
|
+
],
|
|
8385
9336
|
"properties": {
|
|
8386
9337
|
"taskID": {
|
|
8387
9338
|
"$ref": "#/components/schemas/taskID"
|
|
@@ -8437,7 +9388,9 @@
|
|
|
8437
9388
|
"description": "Response and creation timestamp.",
|
|
8438
9389
|
"additionalProperties": false,
|
|
8439
9390
|
"type": "object",
|
|
8440
|
-
"required": [
|
|
9391
|
+
"required": [
|
|
9392
|
+
"createdAt"
|
|
9393
|
+
],
|
|
8441
9394
|
"properties": {
|
|
8442
9395
|
"createdAt": {
|
|
8443
9396
|
"$ref": "#/components/schemas/createdAt"
|
|
@@ -8472,19 +9425,34 @@
|
|
|
8472
9425
|
"x-tagGroups": [
|
|
8473
9426
|
{
|
|
8474
9427
|
"name": "Search and indexing",
|
|
8475
|
-
"tags": [
|
|
9428
|
+
"tags": [
|
|
9429
|
+
"Indices",
|
|
9430
|
+
"Records",
|
|
9431
|
+
"Search"
|
|
9432
|
+
]
|
|
8476
9433
|
},
|
|
8477
9434
|
{
|
|
8478
9435
|
"name": "Relevance",
|
|
8479
|
-
"tags": [
|
|
9436
|
+
"tags": [
|
|
9437
|
+
"Rules",
|
|
9438
|
+
"Synonyms",
|
|
9439
|
+
"Dictionaries"
|
|
9440
|
+
]
|
|
8480
9441
|
},
|
|
8481
9442
|
{
|
|
8482
9443
|
"name": "Others",
|
|
8483
|
-
"tags": [
|
|
9444
|
+
"tags": [
|
|
9445
|
+
"Api Keys",
|
|
9446
|
+
"Clusters",
|
|
9447
|
+
"Vaults",
|
|
9448
|
+
"Advanced"
|
|
9449
|
+
]
|
|
8484
9450
|
},
|
|
8485
9451
|
{
|
|
8486
9452
|
"name": "Models",
|
|
8487
|
-
"tags": [
|
|
9453
|
+
"tags": [
|
|
9454
|
+
"_model_index_settings"
|
|
9455
|
+
]
|
|
8488
9456
|
}
|
|
8489
9457
|
]
|
|
8490
|
-
}
|
|
9458
|
+
}
|