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