@algolia/n8n-nodes-algolia 0.5.2 → 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 +91 -8
- package/dist/nodes/Algolia/Algolia.node.js +1918 -1996
- package/dist/nodes/Algolia/specs/abtesting-v3.json +1589 -0
- package/dist/nodes/Algolia/specs/abtesting.json +1493 -0
- package/dist/nodes/Algolia/specs/advanced-personalization.json +1493 -0
- package/dist/nodes/Algolia/specs/analytics.json +2879 -0
- package/dist/nodes/Algolia/specs/composition.json +3714 -0
- package/dist/nodes/Algolia/specs/crawler.json +2999 -0
- package/dist/nodes/Algolia/specs/ingestion.json +5621 -0
- package/dist/nodes/Algolia/specs/insights.json +1677 -0
- package/dist/nodes/Algolia/specs/monitoring.json +1223 -0
- package/dist/nodes/Algolia/specs/personalization.json +666 -0
- package/dist/nodes/Algolia/specs/query-suggestions.json +1090 -0
- package/dist/nodes/Algolia/specs/recommend.json +3212 -0
- package/dist/nodes/Algolia/specs/search.json +86 -87
- package/package.json +5 -4
|
@@ -2,46 +2,46 @@
|
|
|
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": [
|
|
9
9
|
{
|
|
10
|
-
"url": "https://{
|
|
10
|
+
"url": "https://{applicationId}.algolia.net",
|
|
11
11
|
"variables": {
|
|
12
|
-
"
|
|
12
|
+
"applicationId": {
|
|
13
13
|
"default": "ALGOLIA_APPLICATION_ID"
|
|
14
14
|
}
|
|
15
15
|
}
|
|
16
16
|
},
|
|
17
17
|
{
|
|
18
|
-
"url": "https://{
|
|
18
|
+
"url": "https://{applicationId}-1.algolianet.com",
|
|
19
19
|
"variables": {
|
|
20
|
-
"
|
|
20
|
+
"applicationId": {
|
|
21
21
|
"default": "ALGOLIA_APPLICATION_ID"
|
|
22
22
|
}
|
|
23
23
|
}
|
|
24
24
|
},
|
|
25
25
|
{
|
|
26
|
-
"url": "https://{
|
|
26
|
+
"url": "https://{applicationId}-2.algolianet.com",
|
|
27
27
|
"variables": {
|
|
28
|
-
"
|
|
28
|
+
"applicationId": {
|
|
29
29
|
"default": "ALGOLIA_APPLICATION_ID"
|
|
30
30
|
}
|
|
31
31
|
}
|
|
32
32
|
},
|
|
33
33
|
{
|
|
34
|
-
"url": "https://{
|
|
34
|
+
"url": "https://{applicationId}-3.algolianet.com",
|
|
35
35
|
"variables": {
|
|
36
|
-
"
|
|
36
|
+
"applicationId": {
|
|
37
37
|
"default": "ALGOLIA_APPLICATION_ID"
|
|
38
38
|
}
|
|
39
39
|
}
|
|
40
40
|
},
|
|
41
41
|
{
|
|
42
|
-
"url": "https://{
|
|
42
|
+
"url": "https://{applicationId}-dsn.algolia.net",
|
|
43
43
|
"variables": {
|
|
44
|
-
"
|
|
44
|
+
"applicationId": {
|
|
45
45
|
"default": "ALGOLIA_APPLICATION_ID"
|
|
46
46
|
}
|
|
47
47
|
}
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
],
|
|
50
50
|
"security": [
|
|
51
51
|
{
|
|
52
|
-
"
|
|
52
|
+
"applicationId": [],
|
|
53
53
|
"apiKey": []
|
|
54
54
|
}
|
|
55
55
|
],
|
|
@@ -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
|
{
|
|
@@ -309,7 +309,7 @@
|
|
|
309
309
|
"x-cacheable": true,
|
|
310
310
|
"x-acl": ["search"],
|
|
311
311
|
"summary": "Search an index",
|
|
312
|
-
"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",
|
|
313
313
|
"parameters": [
|
|
314
314
|
{
|
|
315
315
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -547,7 +547,7 @@
|
|
|
547
547
|
"operationId": "saveObject",
|
|
548
548
|
"x-mcp-tool": true,
|
|
549
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](
|
|
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",
|
|
551
551
|
"summary": "Add a new record (with auto-generated object ID)",
|
|
552
552
|
"parameters": [
|
|
553
553
|
{
|
|
@@ -615,10 +615,10 @@
|
|
|
615
615
|
"operationId": "deleteIndex",
|
|
616
616
|
"x-acl": ["deleteIndex"],
|
|
617
617
|
"summary": "Delete an index",
|
|
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
|
|
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",
|
|
619
619
|
"externalDocs": {
|
|
620
|
-
"url": "https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/delete-indices
|
|
621
|
-
"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."
|
|
622
622
|
},
|
|
623
623
|
"parameters": [
|
|
624
624
|
{
|
|
@@ -650,7 +650,7 @@
|
|
|
650
650
|
"operationId": "getObject",
|
|
651
651
|
"x-acl": ["search"],
|
|
652
652
|
"summary": "Retrieve a record",
|
|
653
|
-
"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",
|
|
654
654
|
"parameters": [
|
|
655
655
|
{
|
|
656
656
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -701,7 +701,7 @@
|
|
|
701
701
|
"operationId": "addOrUpdateObject",
|
|
702
702
|
"x-acl": ["addObject"],
|
|
703
703
|
"summary": "Add or replace a record",
|
|
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](
|
|
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",
|
|
705
705
|
"parameters": [
|
|
706
706
|
{
|
|
707
707
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -750,7 +750,7 @@
|
|
|
750
750
|
"operationId": "deleteObject",
|
|
751
751
|
"x-acl": ["deleteObject"],
|
|
752
752
|
"summary": "Delete a record",
|
|
753
|
-
"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",
|
|
754
754
|
"parameters": [
|
|
755
755
|
{
|
|
756
756
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -785,7 +785,7 @@
|
|
|
785
785
|
"x-mcp-tool": true,
|
|
786
786
|
"x-acl": ["deleteIndex"],
|
|
787
787
|
"summary": "Delete records matching a filter",
|
|
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](
|
|
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",
|
|
789
789
|
"externalDocs": {
|
|
790
790
|
"url": "https://support.algolia.com/hc/en-us/articles/16385098766353-Should-I-use-the-deleteby-method-for-deleting-records-matching-a-query-",
|
|
791
791
|
"description": "Should I use the deleteBy method for deleting records."
|
|
@@ -1264,7 +1264,7 @@
|
|
|
1264
1264
|
"operationId": "getSynonym",
|
|
1265
1265
|
"x-acl": ["settings"],
|
|
1266
1266
|
"summary": "Retrieve a synonym",
|
|
1267
|
-
"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",
|
|
1268
1268
|
"parameters": [
|
|
1269
1269
|
{
|
|
1270
1270
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -1303,7 +1303,7 @@
|
|
|
1303
1303
|
"operationId": "saveSynonym",
|
|
1304
1304
|
"x-acl": ["editSettings"],
|
|
1305
1305
|
"summary": "Create or replace a synonym",
|
|
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](
|
|
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",
|
|
1307
1307
|
"parameters": [
|
|
1308
1308
|
{
|
|
1309
1309
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -1369,7 +1369,7 @@
|
|
|
1369
1369
|
"operationId": "deleteSynonym",
|
|
1370
1370
|
"x-acl": ["editSettings"],
|
|
1371
1371
|
"summary": "Delete a synonym",
|
|
1372
|
-
"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",
|
|
1373
1373
|
"parameters": [
|
|
1374
1374
|
{
|
|
1375
1375
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -1816,7 +1816,7 @@
|
|
|
1816
1816
|
"operationId": "getRule",
|
|
1817
1817
|
"x-acl": ["settings"],
|
|
1818
1818
|
"summary": "Retrieve a rule",
|
|
1819
|
-
"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",
|
|
1820
1820
|
"parameters": [
|
|
1821
1821
|
{
|
|
1822
1822
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -1855,7 +1855,7 @@
|
|
|
1855
1855
|
"operationId": "saveRule",
|
|
1856
1856
|
"x-acl": ["editSettings"],
|
|
1857
1857
|
"summary": "Create or replace a rule",
|
|
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](
|
|
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",
|
|
1859
1859
|
"parameters": [
|
|
1860
1860
|
{
|
|
1861
1861
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -1900,7 +1900,7 @@
|
|
|
1900
1900
|
"operationId": "deleteRule",
|
|
1901
1901
|
"x-acl": ["editSettings"],
|
|
1902
1902
|
"summary": "Delete a rule",
|
|
1903
|
-
"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",
|
|
1904
1904
|
"parameters": [
|
|
1905
1905
|
{
|
|
1906
1906
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -2355,7 +2355,7 @@
|
|
|
2355
2355
|
"description": "Lists supported languages with their supported dictionary types and number of custom entries.\n",
|
|
2356
2356
|
"summary": "List available languages",
|
|
2357
2357
|
"externalDocs": {
|
|
2358
|
-
"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",
|
|
2359
2359
|
"description": "Supported languages."
|
|
2360
2360
|
},
|
|
2361
2361
|
"responses": {
|
|
@@ -2755,8 +2755,7 @@
|
|
|
2755
2755
|
"additionalProperties": false,
|
|
2756
2756
|
"properties": {
|
|
2757
2757
|
"query": {
|
|
2758
|
-
"type": "string"
|
|
2759
|
-
"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"
|
|
2760
2759
|
},
|
|
2761
2760
|
"clusterName": {
|
|
2762
2761
|
"$ref": "#/components/schemas/clusterName"
|
|
@@ -3400,7 +3399,7 @@
|
|
|
3400
3399
|
"operationId": "operationIndex",
|
|
3401
3400
|
"x-acl": ["addObject"],
|
|
3402
3401
|
"summary": "Copy or move an index",
|
|
3403
|
-
"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",
|
|
3404
3403
|
"parameters": [
|
|
3405
3404
|
{
|
|
3406
3405
|
"$ref": "#/components/parameters/IndexName"
|
|
@@ -3916,7 +3915,7 @@
|
|
|
3916
3915
|
"x-available-languages": ["javascript", "go", "java", "php", "python"],
|
|
3917
3916
|
"operationId": "replaceAllObjectsWithTransformation",
|
|
3918
3917
|
"summary": "Replace all records in an index",
|
|
3919
|
-
"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",
|
|
3920
3919
|
"parameters": [
|
|
3921
3920
|
{
|
|
3922
3921
|
"in": "query",
|
|
@@ -4153,8 +4152,8 @@
|
|
|
4153
4152
|
"x-available-languages": ["go", "java", "javascript", "php", "python"],
|
|
4154
4153
|
"tags": ["Records"],
|
|
4155
4154
|
"operationId": "saveObjectsWithTransformation",
|
|
4156
|
-
"summary": "Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push
|
|
4157
|
-
"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",
|
|
4158
4157
|
"parameters": [
|
|
4159
4158
|
{
|
|
4160
4159
|
"in": "query",
|
|
@@ -4423,8 +4422,8 @@
|
|
|
4423
4422
|
"x-available-languages": ["go", "java", "javascript", "php", "python"],
|
|
4424
4423
|
"tags": ["Records"],
|
|
4425
4424
|
"operationId": "partialUpdateObjectsWithTransformation",
|
|
4426
|
-
"summary": "Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push
|
|
4427
|
-
"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",
|
|
4428
4427
|
"parameters": [
|
|
4429
4428
|
{
|
|
4430
4429
|
"in": "query",
|
|
@@ -4580,7 +4579,7 @@
|
|
|
4580
4579
|
},
|
|
4581
4580
|
"components": {
|
|
4582
4581
|
"securitySchemes": {
|
|
4583
|
-
"
|
|
4582
|
+
"applicationId": {
|
|
4584
4583
|
"type": "apiKey",
|
|
4585
4584
|
"in": "header",
|
|
4586
4585
|
"name": "x-algolia-application-id",
|
|
@@ -4660,7 +4659,7 @@
|
|
|
4660
4659
|
},
|
|
4661
4660
|
"filters": {
|
|
4662
4661
|
"type": "string",
|
|
4663
|
-
"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",
|
|
4664
4663
|
"example": "(category:Book OR category:Ebook) AND _tags:published",
|
|
4665
4664
|
"x-categories": ["Filtering"]
|
|
4666
4665
|
},
|
|
@@ -4681,7 +4680,7 @@
|
|
|
4681
4680
|
"x-categories": ["Filtering"]
|
|
4682
4681
|
},
|
|
4683
4682
|
"optionalFilters": {
|
|
4684
|
-
"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
|
|
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",
|
|
4685
4684
|
"example": ["category:Book", "author:John Doe"],
|
|
4686
4685
|
"oneOf": [
|
|
4687
4686
|
{
|
|
@@ -4989,7 +4988,7 @@
|
|
|
4989
4988
|
},
|
|
4990
4989
|
"userToken": {
|
|
4991
4990
|
"type": "string",
|
|
4992
|
-
"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",
|
|
4993
4992
|
"example": "test-user-123",
|
|
4994
4993
|
"x-categories": ["Personalization"]
|
|
4995
4994
|
},
|
|
@@ -5007,7 +5006,7 @@
|
|
|
5007
5006
|
},
|
|
5008
5007
|
"clickAnalytics": {
|
|
5009
5008
|
"type": "boolean",
|
|
5010
|
-
"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",
|
|
5011
5010
|
"default": false,
|
|
5012
5011
|
"x-categories": ["Analytics"]
|
|
5013
5012
|
},
|
|
@@ -5022,7 +5021,7 @@
|
|
|
5022
5021
|
"items": {
|
|
5023
5022
|
"type": "string"
|
|
5024
5023
|
},
|
|
5025
|
-
"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).",
|
|
5026
5025
|
"default": []
|
|
5027
5026
|
},
|
|
5028
5027
|
"percentileComputation": {
|
|
@@ -5179,7 +5178,7 @@
|
|
|
5179
5178
|
"type": "string"
|
|
5180
5179
|
},
|
|
5181
5180
|
"example": ["author", "title", "conten", "content"],
|
|
5182
|
-
"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
|
|
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",
|
|
5183
5182
|
"x-categories": ["Highlighting and Snippeting"]
|
|
5184
5183
|
},
|
|
5185
5184
|
"attributesToSnippet": {
|
|
@@ -5243,7 +5242,7 @@
|
|
|
5243
5242
|
"enum": ["min", "strict", "true", "false"]
|
|
5244
5243
|
},
|
|
5245
5244
|
"typoTolerance": {
|
|
5246
|
-
"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",
|
|
5247
5246
|
"oneOf": [
|
|
5248
5247
|
{
|
|
5249
5248
|
"type": "boolean",
|
|
@@ -5268,7 +5267,7 @@
|
|
|
5268
5267
|
"type": "string"
|
|
5269
5268
|
},
|
|
5270
5269
|
"example": ["sku"],
|
|
5271
|
-
"description": "Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance
|
|
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",
|
|
5272
5271
|
"default": [],
|
|
5273
5272
|
"x-categories": ["Typos"]
|
|
5274
5273
|
},
|
|
@@ -5323,7 +5322,7 @@
|
|
|
5323
5322
|
"$ref": "#/components/schemas/supportedLanguage"
|
|
5324
5323
|
},
|
|
5325
5324
|
"example": ["es"],
|
|
5326
|
-
"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
|
|
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",
|
|
5327
5326
|
"default": [],
|
|
5328
5327
|
"x-categories": ["Languages"]
|
|
5329
5328
|
},
|
|
@@ -5348,7 +5347,7 @@
|
|
|
5348
5347
|
"queryType": {
|
|
5349
5348
|
"type": "string",
|
|
5350
5349
|
"enum": ["prefixLast", "prefixAll", "prefixNone"],
|
|
5351
|
-
"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
|
|
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",
|
|
5352
5351
|
"default": "prefixLast",
|
|
5353
5352
|
"x-categories": ["Query strategy"]
|
|
5354
5353
|
},
|
|
@@ -5356,7 +5355,7 @@
|
|
|
5356
5355
|
"type": "string",
|
|
5357
5356
|
"enum": ["none", "lastWords", "firstWords", "allOptional"],
|
|
5358
5357
|
"example": "firstWords",
|
|
5359
|
-
"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",
|
|
5360
5359
|
"default": "none",
|
|
5361
5360
|
"x-categories": ["Query strategy"]
|
|
5362
5361
|
},
|
|
@@ -5472,7 +5471,7 @@
|
|
|
5472
5471
|
},
|
|
5473
5472
|
{
|
|
5474
5473
|
"type": "integer",
|
|
5475
|
-
"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",
|
|
5476
5475
|
"minimum": 0,
|
|
5477
5476
|
"maximum": 4,
|
|
5478
5477
|
"default": 0
|
|
@@ -5512,7 +5511,7 @@
|
|
|
5512
5511
|
},
|
|
5513
5512
|
"sortFacetValuesBy": {
|
|
5514
5513
|
"type": "string",
|
|
5515
|
-
"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",
|
|
5516
5515
|
"default": "count",
|
|
5517
5516
|
"x-categories": ["Faceting"]
|
|
5518
5517
|
},
|
|
@@ -5682,12 +5681,12 @@
|
|
|
5682
5681
|
},
|
|
5683
5682
|
"enableReRanking": {
|
|
5684
5683
|
"type": "boolean",
|
|
5685
|
-
"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",
|
|
5686
5685
|
"default": true,
|
|
5687
5686
|
"x-categories": ["Filtering"]
|
|
5688
5687
|
},
|
|
5689
5688
|
"reRankingApplyFilter": {
|
|
5690
|
-
"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",
|
|
5691
5690
|
"oneOf": [
|
|
5692
5691
|
{
|
|
5693
5692
|
"type": "array",
|
|
@@ -5713,7 +5712,7 @@
|
|
|
5713
5712
|
"items": {
|
|
5714
5713
|
"type": "string"
|
|
5715
5714
|
},
|
|
5716
|
-
"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",
|
|
5717
5716
|
"default": [
|
|
5718
5717
|
"typo",
|
|
5719
5718
|
"geo",
|
|
@@ -6086,7 +6085,7 @@
|
|
|
6086
6085
|
"redirect": {
|
|
6087
6086
|
"title": "redirect",
|
|
6088
6087
|
"type": "object",
|
|
6089
|
-
"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",
|
|
6090
6089
|
"properties": {
|
|
6091
6090
|
"index": {
|
|
6092
6091
|
"type": "array",
|
|
@@ -6114,7 +6113,7 @@
|
|
|
6114
6113
|
},
|
|
6115
6114
|
"queryID": {
|
|
6116
6115
|
"type": "string",
|
|
6117
|
-
"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).",
|
|
6118
6117
|
"example": "a00dbc80a8d13c4565a442e7e2dca80a"
|
|
6119
6118
|
},
|
|
6120
6119
|
"_automaticInsights": {
|
|
@@ -6662,7 +6661,7 @@
|
|
|
6662
6661
|
"type": "integer",
|
|
6663
6662
|
"format": "int64",
|
|
6664
6663
|
"example": 1514562690001,
|
|
6665
|
-
"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"
|
|
6666
6665
|
},
|
|
6667
6666
|
"deletedAt": {
|
|
6668
6667
|
"type": "string",
|
|
@@ -6820,7 +6819,7 @@
|
|
|
6820
6819
|
"afterDistinct(category)",
|
|
6821
6820
|
"afterDistinct(searchable(publisher))"
|
|
6822
6821
|
],
|
|
6823
|
-
"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",
|
|
6824
6823
|
"default": [],
|
|
6825
6824
|
"x-categories": ["Faceting"]
|
|
6826
6825
|
},
|
|
@@ -6830,7 +6829,7 @@
|
|
|
6830
6829
|
"type": "string"
|
|
6831
6830
|
},
|
|
6832
6831
|
"example": ["virtual(prod_products_price_asc)", "dev_products_replica"],
|
|
6833
|
-
"description": "Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas
|
|
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",
|
|
6834
6833
|
"default": [],
|
|
6835
6834
|
"x-categories": ["Ranking"]
|
|
6836
6835
|
},
|
|
@@ -6847,7 +6846,7 @@
|
|
|
6847
6846
|
"type": "string"
|
|
6848
6847
|
},
|
|
6849
6848
|
"example": ["total_sales"],
|
|
6850
|
-
"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
|
|
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",
|
|
6851
6850
|
"default": [],
|
|
6852
6851
|
"x-categories": ["Attributes"]
|
|
6853
6852
|
},
|
|
@@ -6857,7 +6856,7 @@
|
|
|
6857
6856
|
"type": "string"
|
|
6858
6857
|
},
|
|
6859
6858
|
"example": ["wheel", "1X2BCD"],
|
|
6860
|
-
"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
|
|
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",
|
|
6861
6860
|
"default": [],
|
|
6862
6861
|
"x-categories": ["Typos"]
|
|
6863
6862
|
},
|
|
@@ -6885,7 +6884,7 @@
|
|
|
6885
6884
|
"example": {
|
|
6886
6885
|
"de": ["name"]
|
|
6887
6886
|
},
|
|
6888
|
-
"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",
|
|
6889
6888
|
"default": {},
|
|
6890
6889
|
"x-categories": ["Languages"]
|
|
6891
6890
|
},
|
|
@@ -6895,7 +6894,7 @@
|
|
|
6895
6894
|
"$ref": "#/components/schemas/supportedLanguage"
|
|
6896
6895
|
},
|
|
6897
6896
|
"example": ["ja"],
|
|
6898
|
-
"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
|
|
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",
|
|
6899
6898
|
"default": [],
|
|
6900
6899
|
"x-categories": ["Languages"]
|
|
6901
6900
|
},
|
|
@@ -6938,7 +6937,7 @@
|
|
|
6938
6937
|
"type": "string"
|
|
6939
6938
|
},
|
|
6940
6939
|
"example": ["title,alternative_title", "author", "unordered(text)", "emails.personal"],
|
|
6941
|
-
"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
|
|
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",
|
|
6942
6941
|
"default": [],
|
|
6943
6942
|
"x-categories": ["Attributes"]
|
|
6944
6943
|
},
|
|
@@ -6946,7 +6945,7 @@
|
|
|
6946
6945
|
"$ref": "#/components/schemas/userData"
|
|
6947
6946
|
},
|
|
6948
6947
|
"customNormalization": {
|
|
6949
|
-
"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",
|
|
6950
6949
|
"type": "object",
|
|
6951
6950
|
"example": {
|
|
6952
6951
|
"default": {
|
|
@@ -6983,7 +6982,7 @@
|
|
|
6983
6982
|
"type": "string"
|
|
6984
6983
|
},
|
|
6985
6984
|
"example": ["desc(popularity)", "asc(price)"],
|
|
6986
|
-
"description": "Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking
|
|
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",
|
|
6987
6986
|
"default": [],
|
|
6988
6987
|
"x-categories": ["Ranking"]
|
|
6989
6988
|
}
|
|
@@ -7058,12 +7057,12 @@
|
|
|
7058
7057
|
},
|
|
7059
7058
|
"input": {
|
|
7060
7059
|
"type": "string",
|
|
7061
|
-
"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)).",
|
|
7062
7061
|
"example": "car"
|
|
7063
7062
|
},
|
|
7064
7063
|
"word": {
|
|
7065
7064
|
"type": "string",
|
|
7066
|
-
"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)).",
|
|
7067
7066
|
"example": "car"
|
|
7068
7067
|
},
|
|
7069
7068
|
"corrections": {
|
|
@@ -7076,7 +7075,7 @@
|
|
|
7076
7075
|
},
|
|
7077
7076
|
"placeholder": {
|
|
7078
7077
|
"type": "string",
|
|
7079
|
-
"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",
|
|
7080
7079
|
"example": "<Street>"
|
|
7081
7080
|
},
|
|
7082
7081
|
"replacements": {
|
|
@@ -7084,7 +7083,7 @@
|
|
|
7084
7083
|
"items": {
|
|
7085
7084
|
"type": "string"
|
|
7086
7085
|
},
|
|
7087
|
-
"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
|
|
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).",
|
|
7088
7087
|
"example": ["street", "st"]
|
|
7089
7088
|
}
|
|
7090
7089
|
},
|
|
@@ -7196,7 +7195,7 @@
|
|
|
7196
7195
|
},
|
|
7197
7196
|
"maxQueriesPerIPPerHour": {
|
|
7198
7197
|
"type": "integer",
|
|
7199
|
-
"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",
|
|
7200
7199
|
"default": 0
|
|
7201
7200
|
},
|
|
7202
7201
|
"queryParameters": {
|
|
@@ -7577,14 +7576,14 @@
|
|
|
7577
7576
|
"parameters_page": {
|
|
7578
7577
|
"type": "integer",
|
|
7579
7578
|
"minimum": 0,
|
|
7580
|
-
"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"
|
|
7581
7580
|
},
|
|
7582
7581
|
"parameters_hitsPerPage": {
|
|
7583
7582
|
"type": "integer",
|
|
7584
7583
|
"default": 20,
|
|
7585
7584
|
"minimum": 1,
|
|
7586
7585
|
"maximum": 1000,
|
|
7587
|
-
"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"
|
|
7588
7587
|
},
|
|
7589
7588
|
"dictionaryType": {
|
|
7590
7589
|
"type": "string",
|
|
@@ -7692,7 +7691,7 @@
|
|
|
7692
7691
|
},
|
|
7693
7692
|
"standardEntries": {
|
|
7694
7693
|
"type": "object",
|
|
7695
|
-
"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",
|
|
7696
7695
|
"additionalProperties": false,
|
|
7697
7696
|
"properties": {
|
|
7698
7697
|
"plurals": {
|