@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": "Algolia Monitoring API",
|
|
5
|
-
"description": "The Monitoring API lets you check the status of your Algolia infrastructure.\n\n## Base URLs\n\nThe base URL for requests to the Monitoring API is:\n\n- `https://status.algolia.com`\n\n**All requests must use HTTPS.**\n\n## Availability and authentication\n\nAccess to the
|
|
5
|
+
"description": "The Monitoring API lets you check the status of your Algolia infrastructure.\n\n## Base URLs\n\nThe base URL for requests to the Monitoring API is:\n\n- `https://status.algolia.com`\n\n**All requests must use HTTPS.**\n\n## Availability and authentication\n\nAccess to the Infrastructure endpoints\nis available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing).\n\nTo authenticate requests to the Infrastructure endpoints, add these headers:\n\n- `x-algolia-application-id`. Your Algolia application ID.\n- `x-algolia-api-key`. Your Monitoring API key.\n\nYou can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).\n\nOther endpoints don't require authentication.\n\n## Response status and errors\n\nThe Monitoring 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 Monitoring 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": [
|
|
@@ -208,9 +208,7 @@
|
|
|
208
208
|
"operationId": "getStatus",
|
|
209
209
|
"summary": "Retrieve status of all clusters",
|
|
210
210
|
"security": [],
|
|
211
|
-
"tags": [
|
|
212
|
-
"status"
|
|
213
|
-
],
|
|
211
|
+
"tags": ["status"],
|
|
214
212
|
"description": "Retrieves the status of all Algolia clusters and instances.",
|
|
215
213
|
"responses": {
|
|
216
214
|
"200": {
|
|
@@ -228,9 +226,7 @@
|
|
|
228
226
|
"description": "Retrieves the status of selected clusters.",
|
|
229
227
|
"operationId": "getClusterStatus",
|
|
230
228
|
"x-mcp-tool": true,
|
|
231
|
-
"tags": [
|
|
232
|
-
"status"
|
|
233
|
-
],
|
|
229
|
+
"tags": ["status"],
|
|
234
230
|
"security": [],
|
|
235
231
|
"parameters": [
|
|
236
232
|
{
|
|
@@ -257,9 +253,7 @@
|
|
|
257
253
|
"operationId": "getIncidents",
|
|
258
254
|
"x-mcp-tool": true,
|
|
259
255
|
"security": [],
|
|
260
|
-
"tags": [
|
|
261
|
-
"incidents"
|
|
262
|
-
],
|
|
256
|
+
"tags": ["incidents"],
|
|
263
257
|
"responses": {
|
|
264
258
|
"200": {
|
|
265
259
|
"$ref": "#/components/responses/IncidentsResponse"
|
|
@@ -275,9 +269,7 @@
|
|
|
275
269
|
"summary": "Retrieve cluster incidents",
|
|
276
270
|
"description": "Retrieves known incidents for the selected clusters.",
|
|
277
271
|
"operationId": "getClusterIncidents",
|
|
278
|
-
"tags": [
|
|
279
|
-
"incidents"
|
|
280
|
-
],
|
|
272
|
+
"tags": ["incidents"],
|
|
281
273
|
"security": [],
|
|
282
274
|
"parameters": [
|
|
283
275
|
{
|
|
@@ -310,9 +302,7 @@
|
|
|
310
302
|
}
|
|
311
303
|
],
|
|
312
304
|
"description": "Retrieves the servers that belong to clusters.\n\nThe response depends on whether you authenticate your API request:\n\n- With authentication, the response lists the servers assigned to your\nAlgolia application's cluster.\n\n- Without authentication, the response lists the servers for all Algolia\nclusters.\n",
|
|
313
|
-
"tags": [
|
|
314
|
-
"monitoring-tag"
|
|
315
|
-
],
|
|
305
|
+
"tags": ["monitoring-tag"],
|
|
316
306
|
"responses": {
|
|
317
307
|
"200": {
|
|
318
308
|
"$ref": "#/components/responses/InventoryResponse"
|
|
@@ -329,9 +319,7 @@
|
|
|
329
319
|
"description": "Retrieves the average latency for search requests for selected clusters.",
|
|
330
320
|
"operationId": "getLatency",
|
|
331
321
|
"security": [],
|
|
332
|
-
"tags": [
|
|
333
|
-
"monitoring-tag"
|
|
334
|
-
],
|
|
322
|
+
"tags": ["monitoring-tag"],
|
|
335
323
|
"parameters": [
|
|
336
324
|
{
|
|
337
325
|
"$ref": "#/components/parameters/Clusters"
|
|
@@ -353,9 +341,7 @@
|
|
|
353
341
|
"description": "Retrieves average times for indexing operations for selected clusters.",
|
|
354
342
|
"operationId": "getIndexingTime",
|
|
355
343
|
"security": [],
|
|
356
|
-
"tags": [
|
|
357
|
-
"monitoring-tag"
|
|
358
|
-
],
|
|
344
|
+
"tags": ["monitoring-tag"],
|
|
359
345
|
"parameters": [
|
|
360
346
|
{
|
|
361
347
|
"$ref": "#/components/parameters/Clusters"
|
|
@@ -377,9 +363,7 @@
|
|
|
377
363
|
"description": "Test whether clusters are reachable or not.",
|
|
378
364
|
"operationId": "getReachability",
|
|
379
365
|
"security": [],
|
|
380
|
-
"tags": [
|
|
381
|
-
"monitoring-tag"
|
|
382
|
-
],
|
|
366
|
+
"tags": ["monitoring-tag"],
|
|
383
367
|
"parameters": [
|
|
384
368
|
{
|
|
385
369
|
"$ref": "#/components/parameters/Clusters"
|
|
@@ -400,9 +384,7 @@
|
|
|
400
384
|
"summary": "Retrieve metrics",
|
|
401
385
|
"description": "Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.\n\nAccess to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing).\nYou must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).\n",
|
|
402
386
|
"operationId": "getMetrics",
|
|
403
|
-
"tags": [
|
|
404
|
-
"infrastructure"
|
|
405
|
-
],
|
|
387
|
+
"tags": ["infrastructure"],
|
|
406
388
|
"parameters": [
|
|
407
389
|
{
|
|
408
390
|
"$ref": "#/components/parameters/MetricInPath"
|
|
@@ -425,9 +407,7 @@
|
|
|
425
407
|
"get": {
|
|
426
408
|
"x-helper": true,
|
|
427
409
|
"x-asynchronous-helper": false,
|
|
428
|
-
"tags": [
|
|
429
|
-
"Api Key"
|
|
430
|
-
],
|
|
410
|
+
"tags": ["Api Key"],
|
|
431
411
|
"operationId": "setClientApiKey",
|
|
432
412
|
"summary": "Switch the API key used to authenticate requests",
|
|
433
413
|
"description": "Switch the API key used to authenticate requests.\n",
|
|
@@ -531,12 +511,7 @@
|
|
|
531
511
|
"title": "status",
|
|
532
512
|
"type": "string",
|
|
533
513
|
"description": "Status of the cluster.",
|
|
534
|
-
"enum": [
|
|
535
|
-
"operational",
|
|
536
|
-
"degraded_performance",
|
|
537
|
-
"partial_outage",
|
|
538
|
-
"major_outage"
|
|
539
|
-
]
|
|
514
|
+
"enum": ["operational", "degraded_performance", "partial_outage", "major_outage"]
|
|
540
515
|
},
|
|
541
516
|
"Timestamp": {
|
|
542
517
|
"type": "integer",
|
|
@@ -600,16 +575,12 @@
|
|
|
600
575
|
"ServerStatus": {
|
|
601
576
|
"title": "status",
|
|
602
577
|
"type": "string",
|
|
603
|
-
"enum": [
|
|
604
|
-
"PRODUCTION"
|
|
605
|
-
]
|
|
578
|
+
"enum": ["PRODUCTION"]
|
|
606
579
|
},
|
|
607
580
|
"Type": {
|
|
608
581
|
"title": "type",
|
|
609
582
|
"type": "string",
|
|
610
|
-
"enum": [
|
|
611
|
-
"cluster"
|
|
612
|
-
]
|
|
583
|
+
"enum": ["cluster"]
|
|
613
584
|
},
|
|
614
585
|
"Server": {
|
|
615
586
|
"title": "server",
|
|
@@ -693,13 +664,7 @@
|
|
|
693
664
|
},
|
|
694
665
|
"Period": {
|
|
695
666
|
"type": "string",
|
|
696
|
-
"enum": [
|
|
697
|
-
"minute",
|
|
698
|
-
"hour",
|
|
699
|
-
"day",
|
|
700
|
-
"week",
|
|
701
|
-
"month"
|
|
702
|
-
],
|
|
667
|
+
"enum": ["minute", "hour", "day", "week", "month"],
|
|
703
668
|
"example": "week"
|
|
704
669
|
},
|
|
705
670
|
"ProbesMetric": {
|
|
@@ -1252,12 +1217,7 @@
|
|
|
1252
1217
|
"x-tagGroups": [
|
|
1253
1218
|
{
|
|
1254
1219
|
"name": "General",
|
|
1255
|
-
"tags": [
|
|
1256
|
-
"status",
|
|
1257
|
-
"incidents",
|
|
1258
|
-
"infrastructure",
|
|
1259
|
-
"monitoring-tag"
|
|
1260
|
-
]
|
|
1220
|
+
"tags": ["status", "incidents", "infrastructure", "monitoring-tag"]
|
|
1261
1221
|
}
|
|
1262
1222
|
]
|
|
1263
|
-
}
|
|
1223
|
+
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.2",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Personalization API",
|
|
5
|
-
"description": "The Personalization API lets you access user profiles built from the personalization strategy.\n\n## Base URLs\n\nThe base URLs for requests to the Personalization API are:\n\n- `https://personalization.us.algolia.com`\n- `https://personalization.eu.algolia.com`\n\nUse the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).\n\n**All requests must use HTTPS.**\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\nRequest bodies must be JSON objects.\n\n## Response status and errors\n\nThe Personalization 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## Rate limiting\n\nWhen making requests to the Personalization API, you are limited to 40 API calls per second per application.\n\nThe following headers provide information about your current limit:\n\n- `x-ratelimit-limit`: The number of requests allowed every second.\n- `x-ratelimit-remaining`: The number of requests remaining in the current\nsecond period.\n- `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com
|
|
5
|
+
"description": "The Personalization API lets you access user profiles built from the personalization strategy.\n\n## Base URLs\n\nThe base URLs for requests to the Personalization API are:\n\n- `https://personalization.us.algolia.com`\n- `https://personalization.eu.algolia.com`\n\nUse the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).\n\n**All requests must use HTTPS.**\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\nRequest bodies must be JSON objects.\n\n## Response status and errors\n\nThe Personalization 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## Rate limiting\n\nWhen making requests to the Personalization API, you are limited to 40 API calls per second per application.\n\nThe following headers provide information about your current limit:\n\n- `x-ratelimit-limit`: The number of requests allowed every second.\n- `x-ratelimit-remaining`: The number of requests remaining in the current\nsecond period.\n- `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com) of\nthe next time period.\n\n## Version\n\nThe current version of the Personalization 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": [
|
|
@@ -11,10 +11,7 @@
|
|
|
11
11
|
"variables": {
|
|
12
12
|
"region": {
|
|
13
13
|
"description": "The region where your Algolia application is hosted.",
|
|
14
|
-
"enum": [
|
|
15
|
-
"us",
|
|
16
|
-
"eu"
|
|
17
|
-
],
|
|
14
|
+
"enum": ["us", "eu"],
|
|
18
15
|
"default": "us"
|
|
19
16
|
}
|
|
20
17
|
}
|
|
@@ -39,8 +36,8 @@
|
|
|
39
36
|
}
|
|
40
37
|
],
|
|
41
38
|
"externalDocs": {
|
|
42
|
-
"url": "https://www.algolia.com/doc/guides/personalization/what-is-personalization
|
|
43
|
-
"description": "
|
|
39
|
+
"url": "https://www.algolia.com/doc/guides/personalization/what-is-personalization",
|
|
40
|
+
"description": "Algolia Personalization."
|
|
44
41
|
},
|
|
45
42
|
"paths": {
|
|
46
43
|
"/{path}": {
|
|
@@ -215,13 +212,9 @@
|
|
|
215
212
|
},
|
|
216
213
|
"/1/profiles/personalization/{userToken}": {
|
|
217
214
|
"get": {
|
|
218
|
-
"tags": [
|
|
219
|
-
"profiles"
|
|
220
|
-
],
|
|
215
|
+
"tags": ["profiles"],
|
|
221
216
|
"operationId": "getUserTokenProfile",
|
|
222
|
-
"x-acl": [
|
|
223
|
-
"recommendation"
|
|
224
|
-
],
|
|
217
|
+
"x-acl": ["recommendation"],
|
|
225
218
|
"summary": "Retrieve a user profile",
|
|
226
219
|
"description": "Retrieves a user profile and their affinities for different facets.",
|
|
227
220
|
"parameters": [
|
|
@@ -249,11 +242,7 @@
|
|
|
249
242
|
"title": "getUserTokenResponse",
|
|
250
243
|
"type": "object",
|
|
251
244
|
"additionalProperties": false,
|
|
252
|
-
"required": [
|
|
253
|
-
"userToken",
|
|
254
|
-
"scores",
|
|
255
|
-
"lastEventAt"
|
|
256
|
-
],
|
|
245
|
+
"required": ["userToken", "scores", "lastEventAt"],
|
|
257
246
|
"properties": {
|
|
258
247
|
"userToken": {
|
|
259
248
|
"$ref": "#/components/schemas/userToken"
|
|
@@ -288,13 +277,9 @@
|
|
|
288
277
|
},
|
|
289
278
|
"/1/profiles/{userToken}": {
|
|
290
279
|
"delete": {
|
|
291
|
-
"tags": [
|
|
292
|
-
"profiles"
|
|
293
|
-
],
|
|
280
|
+
"tags": ["profiles"],
|
|
294
281
|
"operationId": "deleteUserProfile",
|
|
295
|
-
"x-acl": [
|
|
296
|
-
"recommendation"
|
|
297
|
-
],
|
|
282
|
+
"x-acl": ["recommendation"],
|
|
298
283
|
"summary": "Delete a user profile",
|
|
299
284
|
"description": "Deletes a user profile.\n\nThe response includes a date and time when the user profile can safely be considered deleted.\n",
|
|
300
285
|
"parameters": [
|
|
@@ -322,10 +307,7 @@
|
|
|
322
307
|
"title": "deleteUserProfileResponse",
|
|
323
308
|
"type": "object",
|
|
324
309
|
"additionalProperties": false,
|
|
325
|
-
"required": [
|
|
326
|
-
"userToken",
|
|
327
|
-
"deletedUntil"
|
|
328
|
-
],
|
|
310
|
+
"required": ["userToken", "deletedUntil"],
|
|
329
311
|
"properties": {
|
|
330
312
|
"userToken": {
|
|
331
313
|
"$ref": "#/components/schemas/userToken"
|
|
@@ -356,13 +338,9 @@
|
|
|
356
338
|
},
|
|
357
339
|
"/1/strategies/personalization": {
|
|
358
340
|
"get": {
|
|
359
|
-
"tags": [
|
|
360
|
-
"strategies"
|
|
361
|
-
],
|
|
341
|
+
"tags": ["strategies"],
|
|
362
342
|
"operationId": "getPersonalizationStrategy",
|
|
363
|
-
"x-acl": [
|
|
364
|
-
"recommendation"
|
|
365
|
-
],
|
|
343
|
+
"x-acl": ["recommendation"],
|
|
366
344
|
"summary": "Retrieve the personalization strategy",
|
|
367
345
|
"description": "Retrieves the current personalization strategy.",
|
|
368
346
|
"responses": {
|
|
@@ -402,13 +380,9 @@
|
|
|
402
380
|
}
|
|
403
381
|
},
|
|
404
382
|
"post": {
|
|
405
|
-
"tags": [
|
|
406
|
-
"strategies"
|
|
407
|
-
],
|
|
383
|
+
"tags": ["strategies"],
|
|
408
384
|
"operationId": "setPersonalizationStrategy",
|
|
409
|
-
"x-acl": [
|
|
410
|
-
"recommendation"
|
|
411
|
-
],
|
|
385
|
+
"x-acl": ["recommendation"],
|
|
412
386
|
"summary": "Define the personalization strategy",
|
|
413
387
|
"description": "Creates a new personalization strategy.",
|
|
414
388
|
"requestBody": {
|
|
@@ -430,9 +404,7 @@
|
|
|
430
404
|
"title": "setPersonalizationStrategyResponse",
|
|
431
405
|
"type": "object",
|
|
432
406
|
"additionalProperties": false,
|
|
433
|
-
"required": [
|
|
434
|
-
"message"
|
|
435
|
-
],
|
|
407
|
+
"required": ["message"],
|
|
436
408
|
"properties": {
|
|
437
409
|
"message": {
|
|
438
410
|
"type": "string",
|
|
@@ -463,9 +435,7 @@
|
|
|
463
435
|
"get": {
|
|
464
436
|
"x-helper": true,
|
|
465
437
|
"x-asynchronous-helper": false,
|
|
466
|
-
"tags": [
|
|
467
|
-
"Api Key"
|
|
468
|
-
],
|
|
438
|
+
"tags": ["Api Key"],
|
|
469
439
|
"operationId": "setClientApiKey",
|
|
470
440
|
"summary": "Switch the API key used to authenticate requests",
|
|
471
441
|
"description": "Switch the API key used to authenticate requests.\n",
|
|
@@ -548,11 +518,9 @@
|
|
|
548
518
|
},
|
|
549
519
|
"userToken": {
|
|
550
520
|
"type": "string",
|
|
551
|
-
"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
|
|
521
|
+
"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",
|
|
552
522
|
"example": "test-user-123",
|
|
553
|
-
"x-categories": [
|
|
554
|
-
"Personalization"
|
|
555
|
-
]
|
|
523
|
+
"x-categories": ["Personalization"]
|
|
556
524
|
},
|
|
557
525
|
"score": {
|
|
558
526
|
"type": "integer",
|
|
@@ -562,20 +530,12 @@
|
|
|
562
530
|
"title": "eventType",
|
|
563
531
|
"type": "string",
|
|
564
532
|
"description": "Event type.",
|
|
565
|
-
"enum": [
|
|
566
|
-
"click",
|
|
567
|
-
"conversion",
|
|
568
|
-
"view"
|
|
569
|
-
]
|
|
533
|
+
"enum": ["click", "conversion", "view"]
|
|
570
534
|
},
|
|
571
535
|
"eventsScoring": {
|
|
572
536
|
"type": "object",
|
|
573
537
|
"additionalProperties": false,
|
|
574
|
-
"required": [
|
|
575
|
-
"score",
|
|
576
|
-
"eventName",
|
|
577
|
-
"eventType"
|
|
578
|
-
],
|
|
538
|
+
"required": ["score", "eventName", "eventType"],
|
|
579
539
|
"properties": {
|
|
580
540
|
"score": {
|
|
581
541
|
"$ref": "#/components/schemas/score"
|
|
@@ -592,10 +552,7 @@
|
|
|
592
552
|
"facetsScoring": {
|
|
593
553
|
"type": "object",
|
|
594
554
|
"additionalProperties": false,
|
|
595
|
-
"required": [
|
|
596
|
-
"score",
|
|
597
|
-
"facetName"
|
|
598
|
-
],
|
|
555
|
+
"required": ["score", "facetName"],
|
|
599
556
|
"properties": {
|
|
600
557
|
"score": {
|
|
601
558
|
"$ref": "#/components/schemas/score"
|
|
@@ -609,11 +566,7 @@
|
|
|
609
566
|
"personalizationStrategyParams": {
|
|
610
567
|
"type": "object",
|
|
611
568
|
"additionalProperties": false,
|
|
612
|
-
"required": [
|
|
613
|
-
"eventsScoring",
|
|
614
|
-
"facetsScoring",
|
|
615
|
-
"personalizationImpact"
|
|
616
|
-
],
|
|
569
|
+
"required": ["eventsScoring", "facetsScoring", "personalizationImpact"],
|
|
617
570
|
"properties": {
|
|
618
571
|
"eventsScoring": {
|
|
619
572
|
"type": "array",
|
|
@@ -707,10 +660,7 @@
|
|
|
707
660
|
"x-tagGroups": [
|
|
708
661
|
{
|
|
709
662
|
"name": "General",
|
|
710
|
-
"tags": [
|
|
711
|
-
"profiles",
|
|
712
|
-
"strategies"
|
|
713
|
-
]
|
|
663
|
+
"tags": ["profiles", "strategies"]
|
|
714
664
|
}
|
|
715
665
|
]
|
|
716
|
-
}
|
|
666
|
+
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.2",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Query Suggestions API",
|
|
5
|
-
"description": "The Query Suggestions API lets you manage your Query Suggestions configurations.\nQuery Suggestions add new indices to your Algolia application with popular search queries, external suggestions, or facet values.\nIn your user interface, you can query the Query Suggestions indices like regular indices and add [suggested searches](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/query-suggestions/js
|
|
5
|
+
"description": "The Query Suggestions API lets you manage your Query Suggestions configurations.\nQuery Suggestions add new indices to your Algolia application with popular search queries, external suggestions, or facet values.\nIn your user interface, you can query the Query Suggestions indices like regular indices and add [suggested searches](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/query-suggestions/js) to guide users and speed up their search.\n\n## Base URLs\n\nThe base URLs for requests to the Query Suggestions API are:\n\n- `https://query-suggestions.us.algolia.com`\n- `https://query-suggestions.eu.algolia.com`\n\nUse the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).\n\n**All requests must use HTTPS.**\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\nRequest bodies must be JSON objects.\n\n## Response status and errors\n\nResponse bodies are JSON objects.\nDeleting a user token returns an empty response body with rate-limiting information as headers.\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 Query Suggestions 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": [
|
|
@@ -12,10 +12,7 @@
|
|
|
12
12
|
"variables": {
|
|
13
13
|
"region": {
|
|
14
14
|
"description": "The region where your Algolia application is hosted.",
|
|
15
|
-
"enum": [
|
|
16
|
-
"us",
|
|
17
|
-
"eu"
|
|
18
|
-
],
|
|
15
|
+
"enum": ["us", "eu"],
|
|
19
16
|
"default": "us"
|
|
20
17
|
}
|
|
21
18
|
}
|
|
@@ -212,14 +209,10 @@
|
|
|
212
209
|
},
|
|
213
210
|
"/1/configs": {
|
|
214
211
|
"get": {
|
|
215
|
-
"tags": [
|
|
216
|
-
"configurations"
|
|
217
|
-
],
|
|
212
|
+
"tags": ["configurations"],
|
|
218
213
|
"operationId": "getAllConfigs",
|
|
219
214
|
"x-mcp-tool": true,
|
|
220
|
-
"x-acl": [
|
|
221
|
-
"settings"
|
|
222
|
-
],
|
|
215
|
+
"x-acl": ["settings"],
|
|
223
216
|
"summary": "List configurations",
|
|
224
217
|
"description": "Retrieves all Query Suggestions configurations of your Algolia application.",
|
|
225
218
|
"responses": {
|
|
@@ -242,14 +235,10 @@
|
|
|
242
235
|
}
|
|
243
236
|
},
|
|
244
237
|
"post": {
|
|
245
|
-
"tags": [
|
|
246
|
-
"configurations"
|
|
247
|
-
],
|
|
238
|
+
"tags": ["configurations"],
|
|
248
239
|
"operationId": "createConfig",
|
|
249
240
|
"x-mcp-tool": true,
|
|
250
|
-
"x-acl": [
|
|
251
|
-
"editSettings"
|
|
252
|
-
],
|
|
241
|
+
"x-acl": ["editSettings"],
|
|
253
242
|
"summary": "Create a configuration",
|
|
254
243
|
"description": "Creates a new Query Suggestions configuration.\n\nYou can have up to 100 configurations per Algolia application.\n",
|
|
255
244
|
"requestBody": {
|
|
@@ -299,14 +288,10 @@
|
|
|
299
288
|
},
|
|
300
289
|
"/1/configs/{indexName}": {
|
|
301
290
|
"get": {
|
|
302
|
-
"tags": [
|
|
303
|
-
"configurations"
|
|
304
|
-
],
|
|
291
|
+
"tags": ["configurations"],
|
|
305
292
|
"operationId": "getConfig",
|
|
306
293
|
"x-mcp-tool": true,
|
|
307
|
-
"x-acl": [
|
|
308
|
-
"settings"
|
|
309
|
-
],
|
|
294
|
+
"x-acl": ["settings"],
|
|
310
295
|
"summary": "Retrieve a configuration",
|
|
311
296
|
"description": "Retrieves a single Query Suggestions configuration by its index name.",
|
|
312
297
|
"parameters": [
|
|
@@ -337,14 +322,10 @@
|
|
|
337
322
|
}
|
|
338
323
|
},
|
|
339
324
|
"put": {
|
|
340
|
-
"tags": [
|
|
341
|
-
"configurations"
|
|
342
|
-
],
|
|
325
|
+
"tags": ["configurations"],
|
|
343
326
|
"operationId": "updateConfig",
|
|
344
327
|
"x-mcp-tool": true,
|
|
345
|
-
"x-acl": [
|
|
346
|
-
"editSettings"
|
|
347
|
-
],
|
|
328
|
+
"x-acl": ["editSettings"],
|
|
348
329
|
"summary": "Update a configuration",
|
|
349
330
|
"description": "Updates a QuerySuggestions configuration.",
|
|
350
331
|
"parameters": [
|
|
@@ -391,13 +372,9 @@
|
|
|
391
372
|
}
|
|
392
373
|
},
|
|
393
374
|
"delete": {
|
|
394
|
-
"tags": [
|
|
395
|
-
"configurations"
|
|
396
|
-
],
|
|
375
|
+
"tags": ["configurations"],
|
|
397
376
|
"operationId": "deleteConfig",
|
|
398
|
-
"x-acl": [
|
|
399
|
-
"editSettings"
|
|
400
|
-
],
|
|
377
|
+
"x-acl": ["editSettings"],
|
|
401
378
|
"summary": "Delete a configuration",
|
|
402
379
|
"description": "Deletes a Query Suggestions configuration.\n\nDeleting only removes the configuration and stops updates to the Query Suggestions index.\nTo delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.\n",
|
|
403
380
|
"parameters": [
|
|
@@ -436,14 +413,10 @@
|
|
|
436
413
|
},
|
|
437
414
|
"/1/configs/{indexName}/status": {
|
|
438
415
|
"get": {
|
|
439
|
-
"tags": [
|
|
440
|
-
"configurations"
|
|
441
|
-
],
|
|
416
|
+
"tags": ["configurations"],
|
|
442
417
|
"operationId": "getConfigStatus",
|
|
443
418
|
"x-mcp-tool": true,
|
|
444
|
-
"x-acl": [
|
|
445
|
-
"settings"
|
|
446
|
-
],
|
|
419
|
+
"x-acl": ["settings"],
|
|
447
420
|
"summary": "Retrieve configuration status",
|
|
448
421
|
"description": "Reports the status of a Query Suggestions index.",
|
|
449
422
|
"parameters": [
|
|
@@ -500,14 +473,10 @@
|
|
|
500
473
|
},
|
|
501
474
|
"/1/logs/{indexName}": {
|
|
502
475
|
"get": {
|
|
503
|
-
"tags": [
|
|
504
|
-
"logs"
|
|
505
|
-
],
|
|
476
|
+
"tags": ["logs"],
|
|
506
477
|
"operationId": "getLogFile",
|
|
507
478
|
"x-mcp-tool": true,
|
|
508
|
-
"x-acl": [
|
|
509
|
-
"settings"
|
|
510
|
-
],
|
|
479
|
+
"x-acl": ["settings"],
|
|
511
480
|
"summary": "Retrieve logs",
|
|
512
481
|
"description": "Retrieves the logs for a single Query Suggestions index.",
|
|
513
482
|
"parameters": [
|
|
@@ -561,9 +530,7 @@
|
|
|
561
530
|
"get": {
|
|
562
531
|
"x-helper": true,
|
|
563
532
|
"x-asynchronous-helper": false,
|
|
564
|
-
"tags": [
|
|
565
|
-
"Api Key"
|
|
566
|
-
],
|
|
533
|
+
"tags": ["Api Key"],
|
|
567
534
|
"operationId": "setClientApiKey",
|
|
568
535
|
"summary": "Switch the API key used to authenticate requests",
|
|
569
536
|
"description": "Switch the API key used to authenticate requests.\n",
|
|
@@ -661,7 +628,7 @@
|
|
|
661
628
|
},
|
|
662
629
|
"AnalyticsTags": {
|
|
663
630
|
"title": "analyticsTags",
|
|
664
|
-
"description": "Analytics tags for filtering the popular searches.\nFor more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments
|
|
631
|
+
"description": "Analytics tags for filtering the popular searches.\nFor more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).\n",
|
|
665
632
|
"default": null,
|
|
666
633
|
"oneOf": [
|
|
667
634
|
{
|
|
@@ -733,12 +700,7 @@
|
|
|
733
700
|
"type": "null"
|
|
734
701
|
}
|
|
735
702
|
],
|
|
736
|
-
"example": [
|
|
737
|
-
[
|
|
738
|
-
"color",
|
|
739
|
-
"brand"
|
|
740
|
-
]
|
|
741
|
-
]
|
|
703
|
+
"example": [["color", "brand"]]
|
|
742
704
|
},
|
|
743
705
|
"External": {
|
|
744
706
|
"description": "Algolia indices with popular searches to use as query suggestions.\n\nRecords of these indices must have these attributes:\n\n- `query`: search query which will be added as a suggestion\n- `count`: measure of popularity of that search query\n\nFor example, you can export popular searches from an external analytics provider, such as Google Analytics or Adobe Analytics,\nand feed this data into an Algolia index.\nYou can use this index to generate query suggestions until your Algolia Analytics has collected enough data.\n",
|
|
@@ -758,9 +720,7 @@
|
|
|
758
720
|
"SourceIndex": {
|
|
759
721
|
"type": "object",
|
|
760
722
|
"description": "Configuration of an Algolia index for Query Suggestions.",
|
|
761
|
-
"required": [
|
|
762
|
-
"indexName"
|
|
763
|
-
],
|
|
723
|
+
"required": ["indexName"],
|
|
764
724
|
"properties": {
|
|
765
725
|
"indexName": {
|
|
766
726
|
"type": "string",
|
|
@@ -837,9 +797,7 @@
|
|
|
837
797
|
"Configuration": {
|
|
838
798
|
"type": "object",
|
|
839
799
|
"description": "Query Suggestions configuration.",
|
|
840
|
-
"required": [
|
|
841
|
-
"sourceIndices"
|
|
842
|
-
],
|
|
800
|
+
"required": ["sourceIndices"],
|
|
843
801
|
"properties": {
|
|
844
802
|
"sourceIndices": {
|
|
845
803
|
"type": "array",
|
|
@@ -870,10 +828,7 @@
|
|
|
870
828
|
"ConfigurationWithIndex": {
|
|
871
829
|
"type": "object",
|
|
872
830
|
"description": "Query Suggestions configuration.",
|
|
873
|
-
"required": [
|
|
874
|
-
"indexName",
|
|
875
|
-
"sourceIndices"
|
|
876
|
-
],
|
|
831
|
+
"required": ["indexName", "sourceIndices"],
|
|
877
832
|
"allOf": [
|
|
878
833
|
{
|
|
879
834
|
"type": "object",
|
|
@@ -926,11 +881,7 @@
|
|
|
926
881
|
"title": "level",
|
|
927
882
|
"type": "string",
|
|
928
883
|
"description": "Type of log entry.\n\n- `SKIP`. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enough search results.\n- `INFO`. An informative log entry.\n- `ERROR`. The Query Suggestions process encountered an error.\n",
|
|
929
|
-
"enum": [
|
|
930
|
-
"SKIP",
|
|
931
|
-
"INFO",
|
|
932
|
-
"ERROR"
|
|
933
|
-
]
|
|
884
|
+
"enum": ["SKIP", "INFO", "ERROR"]
|
|
934
885
|
}
|
|
935
886
|
},
|
|
936
887
|
"responses": {
|
|
@@ -1129,15 +1080,11 @@
|
|
|
1129
1080
|
"x-tagGroups": [
|
|
1130
1081
|
{
|
|
1131
1082
|
"name": "Configurations",
|
|
1132
|
-
"tags": [
|
|
1133
|
-
"configurations"
|
|
1134
|
-
]
|
|
1083
|
+
"tags": ["configurations"]
|
|
1135
1084
|
},
|
|
1136
1085
|
{
|
|
1137
1086
|
"name": "Logs",
|
|
1138
|
-
"tags": [
|
|
1139
|
-
"logs"
|
|
1140
|
-
]
|
|
1087
|
+
"tags": ["logs"]
|
|
1141
1088
|
}
|
|
1142
1089
|
]
|
|
1143
|
-
}
|
|
1090
|
+
}
|