@nvisy/sdk 0.31.0 → 0.33.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/CHANGELOG.md +55 -1
- package/dist/auth/index.d.ts +1 -1
- package/dist/{client-DWiS0wu7.d.ts → client-CULULKFQ.d.ts} +123 -16
- package/dist/client-CULULKFQ.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{errors-C9iizEYH.d.ts → errors-BZvRatQn.d.ts} +2 -2
- package/dist/{errors-C9iizEYH.d.ts.map → errors-BZvRatQn.d.ts.map} +1 -1
- package/dist/{index-DnLNkzKf.d.ts → index-0_K3HaXB.d.ts} +2057 -725
- package/dist/index-0_K3HaXB.d.ts.map +1 -0
- package/dist/index.d.ts +3 -3
- package/dist/index.js +13 -1
- package/dist/index.js.map +1 -1
- package/dist/services/index.d.ts +2 -2
- package/dist/services/index.js +2 -2
- package/dist/{services-CcdXk5hx.js → services-CTpA4P73.js} +237 -82
- package/dist/services-CTpA4P73.js.map +1 -0
- package/dist/webhooks/index.d.ts +2 -2
- package/package.json +5 -5
- package/dist/client-DWiS0wu7.d.ts.map +0 -1
- package/dist/index-DnLNkzKf.d.ts.map +0 -1
- package/dist/services-CcdXk5hx.js.map +0 -1
|
@@ -487,6 +487,12 @@ interface paths {
|
|
|
487
487
|
* Obtain this from the `nextCursor` field in the response.
|
|
488
488
|
*/
|
|
489
489
|
after?: string;
|
|
490
|
+
/**
|
|
491
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
492
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
493
|
+
* only when the count is actually needed.
|
|
494
|
+
*/
|
|
495
|
+
includeCount?: boolean;
|
|
490
496
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
491
497
|
limit?: number;
|
|
492
498
|
};
|
|
@@ -1221,18 +1227,39 @@ interface paths {
|
|
|
1221
1227
|
};
|
|
1222
1228
|
/**
|
|
1223
1229
|
* List workspace activities
|
|
1224
|
-
* @description Returns
|
|
1230
|
+
* @description Returns the workspace's activity log, most recent first, cursor-paginated. Optional filters: `type` (repeatable, e.g. `file.created`), `actor` (an account id), and a `from`/`to` day range (each bound narrows only when given; the feed is otherwise all-time).
|
|
1225
1231
|
*/
|
|
1226
1232
|
get: {
|
|
1227
1233
|
parameters: {
|
|
1228
1234
|
query?: {
|
|
1235
|
+
/** @description Keep only activities performed by this account. Omit for any actor. */
|
|
1236
|
+
actor?: string;
|
|
1229
1237
|
/**
|
|
1230
1238
|
* @description Cursor pointing to the last item of the previous page.
|
|
1231
1239
|
* Obtain this from the `nextCursor` field in the response.
|
|
1232
1240
|
*/
|
|
1233
1241
|
after?: string;
|
|
1242
|
+
/**
|
|
1243
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1244
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1245
|
+
*/
|
|
1246
|
+
from?: string;
|
|
1247
|
+
/**
|
|
1248
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
1249
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
1250
|
+
* only when the count is actually needed.
|
|
1251
|
+
*/
|
|
1252
|
+
includeCount?: boolean;
|
|
1234
1253
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
1235
1254
|
limit?: number;
|
|
1255
|
+
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1256
|
+
to?: string;
|
|
1257
|
+
/**
|
|
1258
|
+
* @description Keep only these activity types (e.g. `file.created`). Repeat the `type`
|
|
1259
|
+
* parameter for several; omit for no type constraint. The field is `types`
|
|
1260
|
+
* since `type` is a reserved word.
|
|
1261
|
+
*/
|
|
1262
|
+
type?: components["schemas"]["ActivityType"][];
|
|
1236
1263
|
};
|
|
1237
1264
|
header?: never;
|
|
1238
1265
|
path: {
|
|
@@ -1298,7 +1325,7 @@ interface paths {
|
|
|
1298
1325
|
patch?: never;
|
|
1299
1326
|
trace?: never;
|
|
1300
1327
|
};
|
|
1301
|
-
"/workspaces/{workspaceSlug}/
|
|
1328
|
+
"/workspaces/{workspaceSlug}/activities/export": {
|
|
1302
1329
|
parameters: {
|
|
1303
1330
|
query?: never;
|
|
1304
1331
|
header?: never;
|
|
@@ -1306,27 +1333,29 @@ interface paths {
|
|
|
1306
1333
|
cookie?: never;
|
|
1307
1334
|
};
|
|
1308
1335
|
/**
|
|
1309
|
-
*
|
|
1310
|
-
* @description
|
|
1336
|
+
* Export workspace activities
|
|
1337
|
+
* @description Exports a workspace's activity log over a date window as a downloadable file. The window is `from`/`to` (inclusive, YYYY-MM-DD); it defaults to the last 30 days and is capped at 366 days. The same `type` (repeatable) and `actor` filters as the feed apply. `format` is `csv` (default) or `json`. Each activity is a flat row: timestamp, the type split into object/action, the actor, and the acted-on object's id and label, oldest first. At most 100,000 rows are returned (the oldest in the window); a truncated export sets the `X-Export-Truncated` response header.
|
|
1311
1338
|
*/
|
|
1312
1339
|
get: {
|
|
1313
1340
|
parameters: {
|
|
1314
1341
|
query?: {
|
|
1315
|
-
/** @description
|
|
1316
|
-
|
|
1317
|
-
/** @description
|
|
1318
|
-
|
|
1319
|
-
/** @description Filter by workspace role. */
|
|
1320
|
-
role?: components["schemas"]["WorkspaceRole"];
|
|
1321
|
-
/** @description Sort by field. */
|
|
1322
|
-
sortBy?: components["schemas"]["MemberSortField"];
|
|
1342
|
+
/** @description Keep only activities performed by this account. Omit for any actor. */
|
|
1343
|
+
actor?: string;
|
|
1344
|
+
/** @description Output format; defaults to `csv`. */
|
|
1345
|
+
format?: components["schemas"]["ExportFormat"];
|
|
1323
1346
|
/**
|
|
1324
|
-
* @description
|
|
1325
|
-
*
|
|
1347
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1348
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1326
1349
|
*/
|
|
1327
|
-
|
|
1328
|
-
/** @description
|
|
1329
|
-
|
|
1350
|
+
from?: string;
|
|
1351
|
+
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1352
|
+
to?: string;
|
|
1353
|
+
/**
|
|
1354
|
+
* @description Keep only these activity types (e.g. `file.created`). Repeat the `type`
|
|
1355
|
+
* parameter for several; omit for no type constraint. The field is `types`
|
|
1356
|
+
* since `type` is a reserved word.
|
|
1357
|
+
*/
|
|
1358
|
+
type?: components["schemas"]["ActivityType"][];
|
|
1330
1359
|
};
|
|
1331
1360
|
header?: never;
|
|
1332
1361
|
path: {
|
|
@@ -1337,19 +1366,29 @@ interface paths {
|
|
|
1337
1366
|
};
|
|
1338
1367
|
requestBody?: never;
|
|
1339
1368
|
responses: {
|
|
1369
|
+
/** @description The exported activity log. */
|
|
1370
|
+
200: {
|
|
1371
|
+
headers: {
|
|
1372
|
+
[name: string]: unknown;
|
|
1373
|
+
};
|
|
1374
|
+
content: {
|
|
1375
|
+
"text/csv": unknown;
|
|
1376
|
+
"application/json": unknown;
|
|
1377
|
+
};
|
|
1378
|
+
};
|
|
1340
1379
|
/**
|
|
1341
|
-
* @description
|
|
1380
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1342
1381
|
*
|
|
1343
|
-
*
|
|
1344
|
-
*
|
|
1345
|
-
*
|
|
1382
|
+
* This struct contains all the information needed to serialize an error
|
|
1383
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1384
|
+
* information, and user-friendly messages.
|
|
1346
1385
|
*/
|
|
1347
|
-
|
|
1386
|
+
400: {
|
|
1348
1387
|
headers: {
|
|
1349
1388
|
[name: string]: unknown;
|
|
1350
1389
|
};
|
|
1351
1390
|
content: {
|
|
1352
|
-
"application/json": components["schemas"]["
|
|
1391
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1353
1392
|
};
|
|
1354
1393
|
};
|
|
1355
1394
|
/**
|
|
@@ -1407,20 +1446,18 @@ interface paths {
|
|
|
1407
1446
|
patch?: never;
|
|
1408
1447
|
trace?: never;
|
|
1409
1448
|
};
|
|
1410
|
-
"/workspaces/{workspaceSlug}/
|
|
1449
|
+
"/workspaces/{workspaceSlug}/analytics/": {
|
|
1411
1450
|
parameters: {
|
|
1412
1451
|
query?: never;
|
|
1413
1452
|
header?: never;
|
|
1414
1453
|
path?: never;
|
|
1415
1454
|
cookie?: never;
|
|
1416
1455
|
};
|
|
1417
|
-
get?: never;
|
|
1418
|
-
put?: never;
|
|
1419
1456
|
/**
|
|
1420
|
-
*
|
|
1421
|
-
* @description
|
|
1457
|
+
* Workspace analytics
|
|
1458
|
+
* @description Returns aggregate analytics for a workspace: stored-file totals with a per-kind breakdown, pipeline-run health (status mix, error rate, and durations), and inference token usage (workspace totals plus a per-model breakdown). Breakdowns list every kind/status, zero-filled, in a stable order.
|
|
1422
1459
|
*/
|
|
1423
|
-
|
|
1460
|
+
get: {
|
|
1424
1461
|
parameters: {
|
|
1425
1462
|
query?: never;
|
|
1426
1463
|
header?: never;
|
|
@@ -1432,12 +1469,17 @@ interface paths {
|
|
|
1432
1469
|
};
|
|
1433
1470
|
requestBody?: never;
|
|
1434
1471
|
responses: {
|
|
1435
|
-
/**
|
|
1472
|
+
/**
|
|
1473
|
+
* @description Aggregate analytics for a workspace: what it stores, how its runs fare, and
|
|
1474
|
+
* the inference tokens they spent.
|
|
1475
|
+
*/
|
|
1436
1476
|
200: {
|
|
1437
1477
|
headers: {
|
|
1438
1478
|
[name: string]: unknown;
|
|
1439
1479
|
};
|
|
1440
|
-
content
|
|
1480
|
+
content: {
|
|
1481
|
+
"application/json": components["schemas"]["WorkspaceAnalytics"];
|
|
1482
|
+
};
|
|
1441
1483
|
};
|
|
1442
1484
|
/**
|
|
1443
1485
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -1446,7 +1488,7 @@ interface paths {
|
|
|
1446
1488
|
* response, including the error name, message, HTTP status code, resource
|
|
1447
1489
|
* information, and user-friendly messages.
|
|
1448
1490
|
*/
|
|
1449
|
-
|
|
1491
|
+
401: {
|
|
1450
1492
|
headers: {
|
|
1451
1493
|
[name: string]: unknown;
|
|
1452
1494
|
};
|
|
@@ -1461,7 +1503,7 @@ interface paths {
|
|
|
1461
1503
|
* response, including the error name, message, HTTP status code, resource
|
|
1462
1504
|
* information, and user-friendly messages.
|
|
1463
1505
|
*/
|
|
1464
|
-
|
|
1506
|
+
403: {
|
|
1465
1507
|
headers: {
|
|
1466
1508
|
[name: string]: unknown;
|
|
1467
1509
|
};
|
|
@@ -1486,13 +1528,15 @@ interface paths {
|
|
|
1486
1528
|
};
|
|
1487
1529
|
};
|
|
1488
1530
|
};
|
|
1531
|
+
put?: never;
|
|
1532
|
+
post?: never;
|
|
1489
1533
|
delete?: never;
|
|
1490
1534
|
options?: never;
|
|
1491
1535
|
head?: never;
|
|
1492
1536
|
patch?: never;
|
|
1493
1537
|
trace?: never;
|
|
1494
1538
|
};
|
|
1495
|
-
"/workspaces/{workspaceSlug}/
|
|
1539
|
+
"/workspaces/{workspaceSlug}/analytics/runs/timeseries/": {
|
|
1496
1540
|
parameters: {
|
|
1497
1541
|
query?: never;
|
|
1498
1542
|
header?: never;
|
|
@@ -1500,30 +1544,54 @@ interface paths {
|
|
|
1500
1544
|
cookie?: never;
|
|
1501
1545
|
};
|
|
1502
1546
|
/**
|
|
1503
|
-
*
|
|
1504
|
-
* @description Returns
|
|
1547
|
+
* Workspace run time series
|
|
1548
|
+
* @description Returns a workspace's daily pipeline-run activity over a date window: runs per day, plus each day's error rate and durations. Every day in the window is present (quiet days report runs: 0), so the series plots as a continuous line or a contribution-style calendar. The window is `from`/`to` (inclusive, YYYY-MM-DD); it defaults to the last 30 days and is capped at 366 days.
|
|
1505
1549
|
*/
|
|
1506
1550
|
get: {
|
|
1507
1551
|
parameters: {
|
|
1508
|
-
query?:
|
|
1552
|
+
query?: {
|
|
1553
|
+
/**
|
|
1554
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1555
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1556
|
+
*/
|
|
1557
|
+
from?: string;
|
|
1558
|
+
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1559
|
+
to?: string;
|
|
1560
|
+
};
|
|
1509
1561
|
header?: never;
|
|
1510
1562
|
path: {
|
|
1511
1563
|
/** @description URL-safe workspace identifier. */
|
|
1512
1564
|
workspaceSlug: string;
|
|
1513
|
-
/** @description Public handle of the member's account. */
|
|
1514
|
-
username: components["schemas"]["Handle"];
|
|
1515
1565
|
};
|
|
1516
1566
|
cookie?: never;
|
|
1517
1567
|
};
|
|
1518
1568
|
requestBody?: never;
|
|
1519
1569
|
responses: {
|
|
1520
|
-
/**
|
|
1570
|
+
/**
|
|
1571
|
+
* @description A workspace's daily run activity over a window: one point per day, dense
|
|
1572
|
+
* (quiet days included with `runs: 0`), ready to plot as a continuous series.
|
|
1573
|
+
*/
|
|
1521
1574
|
200: {
|
|
1522
1575
|
headers: {
|
|
1523
1576
|
[name: string]: unknown;
|
|
1524
1577
|
};
|
|
1525
1578
|
content: {
|
|
1526
|
-
"application/json": components["schemas"]["
|
|
1579
|
+
"application/json": components["schemas"]["RunTimeSeries"];
|
|
1580
|
+
};
|
|
1581
|
+
};
|
|
1582
|
+
/**
|
|
1583
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1584
|
+
*
|
|
1585
|
+
* This struct contains all the information needed to serialize an error
|
|
1586
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1587
|
+
* information, and user-friendly messages.
|
|
1588
|
+
*/
|
|
1589
|
+
400: {
|
|
1590
|
+
headers: {
|
|
1591
|
+
[name: string]: unknown;
|
|
1592
|
+
};
|
|
1593
|
+
content: {
|
|
1594
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1527
1595
|
};
|
|
1528
1596
|
};
|
|
1529
1597
|
/**
|
|
@@ -1575,44 +1643,70 @@ interface paths {
|
|
|
1575
1643
|
};
|
|
1576
1644
|
put?: never;
|
|
1577
1645
|
post?: never;
|
|
1646
|
+
delete?: never;
|
|
1647
|
+
options?: never;
|
|
1648
|
+
head?: never;
|
|
1649
|
+
patch?: never;
|
|
1650
|
+
trace?: never;
|
|
1651
|
+
};
|
|
1652
|
+
"/workspaces/{workspaceSlug}/members/": {
|
|
1653
|
+
parameters: {
|
|
1654
|
+
query?: never;
|
|
1655
|
+
header?: never;
|
|
1656
|
+
path?: never;
|
|
1657
|
+
cookie?: never;
|
|
1658
|
+
};
|
|
1578
1659
|
/**
|
|
1579
|
-
*
|
|
1580
|
-
* @description
|
|
1660
|
+
* List members
|
|
1661
|
+
* @description Returns a paginated list of workspace members with their roles and status.
|
|
1581
1662
|
*/
|
|
1582
|
-
|
|
1663
|
+
get: {
|
|
1583
1664
|
parameters: {
|
|
1584
|
-
query?:
|
|
1665
|
+
query?: {
|
|
1666
|
+
/** @description Filter by 2FA status. */
|
|
1667
|
+
has2fa?: boolean;
|
|
1668
|
+
/** @description Sort order (asc or desc). */
|
|
1669
|
+
order?: components["schemas"]["SortOrder"];
|
|
1670
|
+
/** @description Filter by workspace role. */
|
|
1671
|
+
role?: components["schemas"]["WorkspaceRole"];
|
|
1672
|
+
/** @description Sort by field. */
|
|
1673
|
+
sortBy?: components["schemas"]["MemberSortField"];
|
|
1674
|
+
/**
|
|
1675
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
1676
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
1677
|
+
*/
|
|
1678
|
+
after?: string;
|
|
1679
|
+
/**
|
|
1680
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
1681
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
1682
|
+
* only when the count is actually needed.
|
|
1683
|
+
*/
|
|
1684
|
+
includeCount?: boolean;
|
|
1685
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
1686
|
+
limit?: number;
|
|
1687
|
+
};
|
|
1585
1688
|
header?: never;
|
|
1586
1689
|
path: {
|
|
1587
1690
|
/** @description URL-safe workspace identifier. */
|
|
1588
1691
|
workspaceSlug: string;
|
|
1589
|
-
/** @description Public handle of the member's account. */
|
|
1590
|
-
username: components["schemas"]["Handle"];
|
|
1591
1692
|
};
|
|
1592
1693
|
cookie?: never;
|
|
1593
1694
|
};
|
|
1594
1695
|
requestBody?: never;
|
|
1595
1696
|
responses: {
|
|
1596
|
-
/** @description no content */
|
|
1597
|
-
200: {
|
|
1598
|
-
headers: {
|
|
1599
|
-
[name: string]: unknown;
|
|
1600
|
-
};
|
|
1601
|
-
content?: never;
|
|
1602
|
-
};
|
|
1603
1697
|
/**
|
|
1604
|
-
* @description
|
|
1698
|
+
* @description Generic paginated response wrapper.
|
|
1605
1699
|
*
|
|
1606
|
-
*
|
|
1607
|
-
*
|
|
1608
|
-
*
|
|
1700
|
+
* Provides a consistent structure for all paginated API responses with
|
|
1701
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
1702
|
+
* are more items to fetch.
|
|
1609
1703
|
*/
|
|
1610
|
-
|
|
1704
|
+
200: {
|
|
1611
1705
|
headers: {
|
|
1612
1706
|
[name: string]: unknown;
|
|
1613
1707
|
};
|
|
1614
1708
|
content: {
|
|
1615
|
-
"application/json": components["schemas"]["
|
|
1709
|
+
"application/json": components["schemas"]["MemberPage"];
|
|
1616
1710
|
};
|
|
1617
1711
|
};
|
|
1618
1712
|
/**
|
|
@@ -1662,39 +1756,45 @@ interface paths {
|
|
|
1662
1756
|
};
|
|
1663
1757
|
};
|
|
1664
1758
|
};
|
|
1759
|
+
put?: never;
|
|
1760
|
+
post?: never;
|
|
1761
|
+
delete?: never;
|
|
1665
1762
|
options?: never;
|
|
1666
1763
|
head?: never;
|
|
1764
|
+
patch?: never;
|
|
1765
|
+
trace?: never;
|
|
1766
|
+
};
|
|
1767
|
+
"/workspaces/{workspaceSlug}/members/leave/": {
|
|
1768
|
+
parameters: {
|
|
1769
|
+
query?: never;
|
|
1770
|
+
header?: never;
|
|
1771
|
+
path?: never;
|
|
1772
|
+
cookie?: never;
|
|
1773
|
+
};
|
|
1774
|
+
get?: never;
|
|
1775
|
+
put?: never;
|
|
1667
1776
|
/**
|
|
1668
|
-
*
|
|
1669
|
-
* @description
|
|
1777
|
+
* Leave workspace
|
|
1778
|
+
* @description Allows a member to voluntarily leave a workspace.
|
|
1670
1779
|
*/
|
|
1671
|
-
|
|
1780
|
+
post: {
|
|
1672
1781
|
parameters: {
|
|
1673
1782
|
query?: never;
|
|
1674
1783
|
header?: never;
|
|
1675
1784
|
path: {
|
|
1676
1785
|
/** @description URL-safe workspace identifier. */
|
|
1677
1786
|
workspaceSlug: string;
|
|
1678
|
-
/** @description Public handle of the member's account. */
|
|
1679
|
-
username: components["schemas"]["Handle"];
|
|
1680
1787
|
};
|
|
1681
1788
|
cookie?: never;
|
|
1682
1789
|
};
|
|
1683
|
-
|
|
1684
|
-
requestBody: {
|
|
1685
|
-
content: {
|
|
1686
|
-
"application/json": components["schemas"]["UpdateMember"];
|
|
1687
|
-
};
|
|
1688
|
-
};
|
|
1790
|
+
requestBody?: never;
|
|
1689
1791
|
responses: {
|
|
1690
|
-
/** @description
|
|
1792
|
+
/** @description no content */
|
|
1691
1793
|
200: {
|
|
1692
1794
|
headers: {
|
|
1693
1795
|
[name: string]: unknown;
|
|
1694
1796
|
};
|
|
1695
|
-
content
|
|
1696
|
-
"application/json": components["schemas"]["Member"];
|
|
1697
|
-
};
|
|
1797
|
+
content?: never;
|
|
1698
1798
|
};
|
|
1699
1799
|
/**
|
|
1700
1800
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -1726,21 +1826,6 @@ interface paths {
|
|
|
1726
1826
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1727
1827
|
};
|
|
1728
1828
|
};
|
|
1729
|
-
/**
|
|
1730
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1731
|
-
*
|
|
1732
|
-
* This struct contains all the information needed to serialize an error
|
|
1733
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1734
|
-
* information, and user-friendly messages.
|
|
1735
|
-
*/
|
|
1736
|
-
403: {
|
|
1737
|
-
headers: {
|
|
1738
|
-
[name: string]: unknown;
|
|
1739
|
-
};
|
|
1740
|
-
content: {
|
|
1741
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1742
|
-
};
|
|
1743
|
-
};
|
|
1744
1829
|
/**
|
|
1745
1830
|
* @description HTTP error response representation with security-conscious design.
|
|
1746
1831
|
*
|
|
@@ -1756,29 +1841,15 @@ interface paths {
|
|
|
1756
1841
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1757
1842
|
};
|
|
1758
1843
|
};
|
|
1759
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
1760
|
-
415: {
|
|
1761
|
-
headers: {
|
|
1762
|
-
[name: string]: unknown;
|
|
1763
|
-
};
|
|
1764
|
-
content: {
|
|
1765
|
-
"text/plain": string;
|
|
1766
|
-
};
|
|
1767
|
-
};
|
|
1768
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
1769
|
-
422: {
|
|
1770
|
-
headers: {
|
|
1771
|
-
[name: string]: unknown;
|
|
1772
|
-
};
|
|
1773
|
-
content: {
|
|
1774
|
-
"text/plain": string;
|
|
1775
|
-
};
|
|
1776
|
-
};
|
|
1777
1844
|
};
|
|
1778
1845
|
};
|
|
1846
|
+
delete?: never;
|
|
1847
|
+
options?: never;
|
|
1848
|
+
head?: never;
|
|
1849
|
+
patch?: never;
|
|
1779
1850
|
trace?: never;
|
|
1780
1851
|
};
|
|
1781
|
-
"/workspaces/{workspaceSlug}/
|
|
1852
|
+
"/workspaces/{workspaceSlug}/members/{username}/": {
|
|
1782
1853
|
parameters: {
|
|
1783
1854
|
query?: never;
|
|
1784
1855
|
header?: never;
|
|
@@ -1786,47 +1857,30 @@ interface paths {
|
|
|
1786
1857
|
cookie?: never;
|
|
1787
1858
|
};
|
|
1788
1859
|
/**
|
|
1789
|
-
*
|
|
1790
|
-
* @description Returns
|
|
1860
|
+
* Get member
|
|
1861
|
+
* @description Returns detailed information about a specific workspace member.
|
|
1791
1862
|
*/
|
|
1792
1863
|
get: {
|
|
1793
1864
|
parameters: {
|
|
1794
|
-
query?:
|
|
1795
|
-
/**
|
|
1796
|
-
* @description Cursor pointing to the last item of the previous page.
|
|
1797
|
-
* Obtain this from the `nextCursor` field in the response.
|
|
1798
|
-
*/
|
|
1799
|
-
after?: string;
|
|
1800
|
-
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
1801
|
-
limit?: number;
|
|
1802
|
-
/**
|
|
1803
|
-
* @description Filter by provider (`s3`, `azure`, `gcs`). Repeatable; a connection
|
|
1804
|
-
* matches if it uses any of the given providers. Empty means no filter.
|
|
1805
|
-
*/
|
|
1806
|
-
provider?: string[];
|
|
1807
|
-
};
|
|
1865
|
+
query?: never;
|
|
1808
1866
|
header?: never;
|
|
1809
1867
|
path: {
|
|
1810
1868
|
/** @description URL-safe workspace identifier. */
|
|
1811
1869
|
workspaceSlug: string;
|
|
1870
|
+
/** @description Public handle of the member's account. */
|
|
1871
|
+
username: components["schemas"]["Handle"];
|
|
1812
1872
|
};
|
|
1813
1873
|
cookie?: never;
|
|
1814
1874
|
};
|
|
1815
1875
|
requestBody?: never;
|
|
1816
1876
|
responses: {
|
|
1817
|
-
/**
|
|
1818
|
-
* @description Generic paginated response wrapper.
|
|
1819
|
-
*
|
|
1820
|
-
* Provides a consistent structure for all paginated API responses with
|
|
1821
|
-
* cursor-based pagination support. When `next_cursor` is present, there
|
|
1822
|
-
* are more items to fetch.
|
|
1823
|
-
*/
|
|
1877
|
+
/** @description Represents a workspace member. */
|
|
1824
1878
|
200: {
|
|
1825
1879
|
headers: {
|
|
1826
1880
|
[name: string]: unknown;
|
|
1827
1881
|
};
|
|
1828
1882
|
content: {
|
|
1829
|
-
"application/json": components["schemas"]["
|
|
1883
|
+
"application/json": components["schemas"]["Member"];
|
|
1830
1884
|
};
|
|
1831
1885
|
};
|
|
1832
1886
|
/**
|
|
@@ -1859,43 +1913,49 @@ interface paths {
|
|
|
1859
1913
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1860
1914
|
};
|
|
1861
1915
|
};
|
|
1916
|
+
/**
|
|
1917
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1918
|
+
*
|
|
1919
|
+
* This struct contains all the information needed to serialize an error
|
|
1920
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1921
|
+
* information, and user-friendly messages.
|
|
1922
|
+
*/
|
|
1923
|
+
404: {
|
|
1924
|
+
headers: {
|
|
1925
|
+
[name: string]: unknown;
|
|
1926
|
+
};
|
|
1927
|
+
content: {
|
|
1928
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1929
|
+
};
|
|
1930
|
+
};
|
|
1862
1931
|
};
|
|
1863
1932
|
};
|
|
1864
1933
|
put?: never;
|
|
1934
|
+
post?: never;
|
|
1865
1935
|
/**
|
|
1866
|
-
*
|
|
1867
|
-
* @description
|
|
1936
|
+
* Remove member
|
|
1937
|
+
* @description Permanently removes a member from the workspace. Cannot remove owners or yourself.
|
|
1868
1938
|
*/
|
|
1869
|
-
|
|
1939
|
+
delete: {
|
|
1870
1940
|
parameters: {
|
|
1871
1941
|
query?: never;
|
|
1872
1942
|
header?: never;
|
|
1873
1943
|
path: {
|
|
1874
1944
|
/** @description URL-safe workspace identifier. */
|
|
1875
1945
|
workspaceSlug: string;
|
|
1946
|
+
/** @description Public handle of the member's account. */
|
|
1947
|
+
username: components["schemas"]["Handle"];
|
|
1876
1948
|
};
|
|
1877
1949
|
cookie?: never;
|
|
1878
1950
|
};
|
|
1879
|
-
|
|
1880
|
-
requestBody: {
|
|
1881
|
-
content: {
|
|
1882
|
-
"application/json": components["schemas"]["CreateConnection"];
|
|
1883
|
-
};
|
|
1884
|
-
};
|
|
1951
|
+
requestBody?: never;
|
|
1885
1952
|
responses: {
|
|
1886
|
-
/**
|
|
1887
|
-
|
|
1888
|
-
*
|
|
1889
|
-
* Note: The encrypted connection data is never exposed in API responses.
|
|
1890
|
-
* Only metadata about the connection is returned.
|
|
1891
|
-
*/
|
|
1892
|
-
201: {
|
|
1953
|
+
/** @description no content */
|
|
1954
|
+
200: {
|
|
1893
1955
|
headers: {
|
|
1894
1956
|
[name: string]: unknown;
|
|
1895
1957
|
};
|
|
1896
|
-
content
|
|
1897
|
-
"application/json": components["schemas"]["Connection"];
|
|
1898
|
-
};
|
|
1958
|
+
content?: never;
|
|
1899
1959
|
};
|
|
1900
1960
|
/**
|
|
1901
1961
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -1942,69 +2002,70 @@ interface paths {
|
|
|
1942
2002
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1943
2003
|
};
|
|
1944
2004
|
};
|
|
1945
|
-
/**
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
|
|
1949
|
-
|
|
1950
|
-
|
|
1951
|
-
|
|
1952
|
-
|
|
1953
|
-
};
|
|
1954
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
1955
|
-
422: {
|
|
2005
|
+
/**
|
|
2006
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2007
|
+
*
|
|
2008
|
+
* This struct contains all the information needed to serialize an error
|
|
2009
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2010
|
+
* information, and user-friendly messages.
|
|
2011
|
+
*/
|
|
2012
|
+
404: {
|
|
1956
2013
|
headers: {
|
|
1957
2014
|
[name: string]: unknown;
|
|
1958
2015
|
};
|
|
1959
2016
|
content: {
|
|
1960
|
-
"
|
|
2017
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1961
2018
|
};
|
|
1962
2019
|
};
|
|
1963
2020
|
};
|
|
1964
2021
|
};
|
|
1965
|
-
delete?: never;
|
|
1966
2022
|
options?: never;
|
|
1967
2023
|
head?: never;
|
|
1968
|
-
patch?: never;
|
|
1969
|
-
trace?: never;
|
|
1970
|
-
};
|
|
1971
|
-
"/workspaces/{workspaceSlug}/connections/{connectionId}/": {
|
|
1972
|
-
parameters: {
|
|
1973
|
-
query?: never;
|
|
1974
|
-
header?: never;
|
|
1975
|
-
path?: never;
|
|
1976
|
-
cookie?: never;
|
|
1977
|
-
};
|
|
1978
2024
|
/**
|
|
1979
|
-
*
|
|
1980
|
-
* @description
|
|
2025
|
+
* Update member role
|
|
2026
|
+
* @description Updates a workspace member's role. Cannot update your own role or demote owners.
|
|
1981
2027
|
*/
|
|
1982
|
-
|
|
2028
|
+
patch: {
|
|
1983
2029
|
parameters: {
|
|
1984
2030
|
query?: never;
|
|
1985
2031
|
header?: never;
|
|
1986
2032
|
path: {
|
|
1987
2033
|
/** @description URL-safe workspace identifier. */
|
|
1988
2034
|
workspaceSlug: string;
|
|
1989
|
-
/** @description
|
|
1990
|
-
|
|
2035
|
+
/** @description Public handle of the member's account. */
|
|
2036
|
+
username: components["schemas"]["Handle"];
|
|
1991
2037
|
};
|
|
1992
2038
|
cookie?: never;
|
|
1993
2039
|
};
|
|
1994
|
-
|
|
2040
|
+
/** @description Request to update a member's role. */
|
|
2041
|
+
requestBody: {
|
|
2042
|
+
content: {
|
|
2043
|
+
"application/json": components["schemas"]["UpdateMember"];
|
|
2044
|
+
};
|
|
2045
|
+
};
|
|
1995
2046
|
responses: {
|
|
2047
|
+
/** @description Represents a workspace member. */
|
|
2048
|
+
200: {
|
|
2049
|
+
headers: {
|
|
2050
|
+
[name: string]: unknown;
|
|
2051
|
+
};
|
|
2052
|
+
content: {
|
|
2053
|
+
"application/json": components["schemas"]["Member"];
|
|
2054
|
+
};
|
|
2055
|
+
};
|
|
1996
2056
|
/**
|
|
1997
|
-
* @description
|
|
2057
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1998
2058
|
*
|
|
1999
|
-
*
|
|
2000
|
-
*
|
|
2059
|
+
* This struct contains all the information needed to serialize an error
|
|
2060
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2061
|
+
* information, and user-friendly messages.
|
|
2001
2062
|
*/
|
|
2002
|
-
|
|
2063
|
+
400: {
|
|
2003
2064
|
headers: {
|
|
2004
2065
|
[name: string]: unknown;
|
|
2005
2066
|
};
|
|
2006
2067
|
content: {
|
|
2007
|
-
"application/json": components["schemas"]["
|
|
2068
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2008
2069
|
};
|
|
2009
2070
|
};
|
|
2010
2071
|
/**
|
|
@@ -2052,48 +2113,83 @@ interface paths {
|
|
|
2052
2113
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2053
2114
|
};
|
|
2054
2115
|
};
|
|
2116
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2117
|
+
415: {
|
|
2118
|
+
headers: {
|
|
2119
|
+
[name: string]: unknown;
|
|
2120
|
+
};
|
|
2121
|
+
content: {
|
|
2122
|
+
"text/plain": string;
|
|
2123
|
+
};
|
|
2124
|
+
};
|
|
2125
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2126
|
+
422: {
|
|
2127
|
+
headers: {
|
|
2128
|
+
[name: string]: unknown;
|
|
2129
|
+
};
|
|
2130
|
+
content: {
|
|
2131
|
+
"text/plain": string;
|
|
2132
|
+
};
|
|
2133
|
+
};
|
|
2055
2134
|
};
|
|
2056
2135
|
};
|
|
2057
|
-
|
|
2058
|
-
|
|
2136
|
+
trace?: never;
|
|
2137
|
+
};
|
|
2138
|
+
"/workspaces/{workspaceSlug}/connections/": {
|
|
2139
|
+
parameters: {
|
|
2140
|
+
query?: never;
|
|
2141
|
+
header?: never;
|
|
2142
|
+
path?: never;
|
|
2143
|
+
cookie?: never;
|
|
2144
|
+
};
|
|
2059
2145
|
/**
|
|
2060
|
-
*
|
|
2061
|
-
* @description
|
|
2146
|
+
* List connections
|
|
2147
|
+
* @description Returns all configured connections for the workspace. Only metadata is returned; encrypted credentials are never exposed.
|
|
2062
2148
|
*/
|
|
2063
|
-
|
|
2149
|
+
get: {
|
|
2064
2150
|
parameters: {
|
|
2065
|
-
query?:
|
|
2151
|
+
query?: {
|
|
2152
|
+
/**
|
|
2153
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
2154
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
2155
|
+
*/
|
|
2156
|
+
after?: string;
|
|
2157
|
+
/**
|
|
2158
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
2159
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
2160
|
+
* only when the count is actually needed.
|
|
2161
|
+
*/
|
|
2162
|
+
includeCount?: boolean;
|
|
2163
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2164
|
+
limit?: number;
|
|
2165
|
+
/**
|
|
2166
|
+
* @description Filter by provider (`s3`, `azure`, `gcs`). Repeatable; a connection
|
|
2167
|
+
* matches if it uses any of the given providers. Empty means no filter.
|
|
2168
|
+
*/
|
|
2169
|
+
provider?: string[];
|
|
2170
|
+
};
|
|
2066
2171
|
header?: never;
|
|
2067
2172
|
path: {
|
|
2068
2173
|
/** @description URL-safe workspace identifier. */
|
|
2069
2174
|
workspaceSlug: string;
|
|
2070
|
-
/** @description Opaque identifier of the connection. */
|
|
2071
|
-
connectionId: components["schemas"]["ConnectionId"];
|
|
2072
2175
|
};
|
|
2073
2176
|
cookie?: never;
|
|
2074
2177
|
};
|
|
2075
2178
|
requestBody?: never;
|
|
2076
2179
|
responses: {
|
|
2077
|
-
/** @description no content */
|
|
2078
|
-
204: {
|
|
2079
|
-
headers: {
|
|
2080
|
-
[name: string]: unknown;
|
|
2081
|
-
};
|
|
2082
|
-
content?: never;
|
|
2083
|
-
};
|
|
2084
2180
|
/**
|
|
2085
|
-
* @description
|
|
2181
|
+
* @description Generic paginated response wrapper.
|
|
2086
2182
|
*
|
|
2087
|
-
*
|
|
2088
|
-
*
|
|
2089
|
-
*
|
|
2183
|
+
* Provides a consistent structure for all paginated API responses with
|
|
2184
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
2185
|
+
* are more items to fetch.
|
|
2090
2186
|
*/
|
|
2091
|
-
|
|
2187
|
+
200: {
|
|
2092
2188
|
headers: {
|
|
2093
2189
|
[name: string]: unknown;
|
|
2094
2190
|
};
|
|
2095
2191
|
content: {
|
|
2096
|
-
"application/json": components["schemas"]["
|
|
2192
|
+
"application/json": components["schemas"]["ConnectionPage"];
|
|
2097
2193
|
};
|
|
2098
2194
|
};
|
|
2099
2195
|
/**
|
|
@@ -2103,7 +2199,7 @@ interface paths {
|
|
|
2103
2199
|
* response, including the error name, message, HTTP status code, resource
|
|
2104
2200
|
* information, and user-friendly messages.
|
|
2105
2201
|
*/
|
|
2106
|
-
|
|
2202
|
+
401: {
|
|
2107
2203
|
headers: {
|
|
2108
2204
|
[name: string]: unknown;
|
|
2109
2205
|
};
|
|
@@ -2118,7 +2214,7 @@ interface paths {
|
|
|
2118
2214
|
* response, including the error name, message, HTTP status code, resource
|
|
2119
2215
|
* information, and user-friendly messages.
|
|
2120
2216
|
*/
|
|
2121
|
-
|
|
2217
|
+
403: {
|
|
2122
2218
|
headers: {
|
|
2123
2219
|
[name: string]: unknown;
|
|
2124
2220
|
};
|
|
@@ -2128,28 +2224,25 @@ interface paths {
|
|
|
2128
2224
|
};
|
|
2129
2225
|
};
|
|
2130
2226
|
};
|
|
2131
|
-
|
|
2132
|
-
head?: never;
|
|
2227
|
+
put?: never;
|
|
2133
2228
|
/**
|
|
2134
|
-
*
|
|
2135
|
-
* @description
|
|
2229
|
+
* Create connection
|
|
2230
|
+
* @description Creates a new provider connection for the workspace. Connection data is encrypted and stored securely. The response includes connection metadata but never exposes the encrypted credentials.
|
|
2136
2231
|
*/
|
|
2137
|
-
|
|
2232
|
+
post: {
|
|
2138
2233
|
parameters: {
|
|
2139
2234
|
query?: never;
|
|
2140
2235
|
header?: never;
|
|
2141
2236
|
path: {
|
|
2142
2237
|
/** @description URL-safe workspace identifier. */
|
|
2143
2238
|
workspaceSlug: string;
|
|
2144
|
-
/** @description Opaque identifier of the connection. */
|
|
2145
|
-
connectionId: components["schemas"]["ConnectionId"];
|
|
2146
2239
|
};
|
|
2147
2240
|
cookie?: never;
|
|
2148
2241
|
};
|
|
2149
|
-
/** @description Request payload for
|
|
2242
|
+
/** @description Request payload for creating a new workspace connection. */
|
|
2150
2243
|
requestBody: {
|
|
2151
2244
|
content: {
|
|
2152
|
-
"application/json": components["schemas"]["
|
|
2245
|
+
"application/json": components["schemas"]["CreateConnection"];
|
|
2153
2246
|
};
|
|
2154
2247
|
};
|
|
2155
2248
|
responses: {
|
|
@@ -2159,7 +2252,7 @@ interface paths {
|
|
|
2159
2252
|
* Note: The encrypted connection data is never exposed in API responses.
|
|
2160
2253
|
* Only metadata about the connection is returned.
|
|
2161
2254
|
*/
|
|
2162
|
-
|
|
2255
|
+
201: {
|
|
2163
2256
|
headers: {
|
|
2164
2257
|
[name: string]: unknown;
|
|
2165
2258
|
};
|
|
@@ -2212,21 +2305,6 @@ interface paths {
|
|
|
2212
2305
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2213
2306
|
};
|
|
2214
2307
|
};
|
|
2215
|
-
/**
|
|
2216
|
-
* @description HTTP error response representation with security-conscious design.
|
|
2217
|
-
*
|
|
2218
|
-
* This struct contains all the information needed to serialize an error
|
|
2219
|
-
* response, including the error name, message, HTTP status code, resource
|
|
2220
|
-
* information, and user-friendly messages.
|
|
2221
|
-
*/
|
|
2222
|
-
404: {
|
|
2223
|
-
headers: {
|
|
2224
|
-
[name: string]: unknown;
|
|
2225
|
-
};
|
|
2226
|
-
content: {
|
|
2227
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
2228
|
-
};
|
|
2229
|
-
};
|
|
2230
2308
|
/** @description Expected request with `Content-Type: application/json` */
|
|
2231
2309
|
415: {
|
|
2232
2310
|
headers: {
|
|
@@ -2247,22 +2325,24 @@ interface paths {
|
|
|
2247
2325
|
};
|
|
2248
2326
|
};
|
|
2249
2327
|
};
|
|
2328
|
+
delete?: never;
|
|
2329
|
+
options?: never;
|
|
2330
|
+
head?: never;
|
|
2331
|
+
patch?: never;
|
|
2250
2332
|
trace?: never;
|
|
2251
2333
|
};
|
|
2252
|
-
"/workspaces/{workspaceSlug}/connections/{connectionId}/
|
|
2334
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/": {
|
|
2253
2335
|
parameters: {
|
|
2254
2336
|
query?: never;
|
|
2255
2337
|
header?: never;
|
|
2256
2338
|
path?: never;
|
|
2257
2339
|
cookie?: never;
|
|
2258
2340
|
};
|
|
2259
|
-
get?: never;
|
|
2260
|
-
put?: never;
|
|
2261
2341
|
/**
|
|
2262
|
-
*
|
|
2263
|
-
* @description
|
|
2342
|
+
* Get connection
|
|
2343
|
+
* @description Returns connection metadata without encrypted credentials.
|
|
2264
2344
|
*/
|
|
2265
|
-
|
|
2345
|
+
get: {
|
|
2266
2346
|
parameters: {
|
|
2267
2347
|
query?: never;
|
|
2268
2348
|
header?: never;
|
|
@@ -2276,13 +2356,18 @@ interface paths {
|
|
|
2276
2356
|
};
|
|
2277
2357
|
requestBody?: never;
|
|
2278
2358
|
responses: {
|
|
2279
|
-
/**
|
|
2359
|
+
/**
|
|
2360
|
+
* @description Response type for a workspace connection.
|
|
2361
|
+
*
|
|
2362
|
+
* Note: The encrypted connection data is never exposed in API responses.
|
|
2363
|
+
* Only metadata about the connection is returned.
|
|
2364
|
+
*/
|
|
2280
2365
|
200: {
|
|
2281
2366
|
headers: {
|
|
2282
2367
|
[name: string]: unknown;
|
|
2283
2368
|
};
|
|
2284
2369
|
content: {
|
|
2285
|
-
"application/json": components["schemas"]["
|
|
2370
|
+
"application/json": components["schemas"]["Connection"];
|
|
2286
2371
|
};
|
|
2287
2372
|
};
|
|
2288
2373
|
/**
|
|
@@ -2327,7 +2412,760 @@ interface paths {
|
|
|
2327
2412
|
[name: string]: unknown;
|
|
2328
2413
|
};
|
|
2329
2414
|
content: {
|
|
2330
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
2415
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2416
|
+
};
|
|
2417
|
+
};
|
|
2418
|
+
};
|
|
2419
|
+
};
|
|
2420
|
+
put?: never;
|
|
2421
|
+
post?: never;
|
|
2422
|
+
/**
|
|
2423
|
+
* Delete connection
|
|
2424
|
+
* @description Soft-deletes the connection from the workspace.
|
|
2425
|
+
*/
|
|
2426
|
+
delete: {
|
|
2427
|
+
parameters: {
|
|
2428
|
+
query?: never;
|
|
2429
|
+
header?: never;
|
|
2430
|
+
path: {
|
|
2431
|
+
/** @description URL-safe workspace identifier. */
|
|
2432
|
+
workspaceSlug: string;
|
|
2433
|
+
/** @description Opaque identifier of the connection. */
|
|
2434
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2435
|
+
};
|
|
2436
|
+
cookie?: never;
|
|
2437
|
+
};
|
|
2438
|
+
requestBody?: never;
|
|
2439
|
+
responses: {
|
|
2440
|
+
/** @description no content */
|
|
2441
|
+
204: {
|
|
2442
|
+
headers: {
|
|
2443
|
+
[name: string]: unknown;
|
|
2444
|
+
};
|
|
2445
|
+
content?: never;
|
|
2446
|
+
};
|
|
2447
|
+
/**
|
|
2448
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2449
|
+
*
|
|
2450
|
+
* This struct contains all the information needed to serialize an error
|
|
2451
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2452
|
+
* information, and user-friendly messages.
|
|
2453
|
+
*/
|
|
2454
|
+
401: {
|
|
2455
|
+
headers: {
|
|
2456
|
+
[name: string]: unknown;
|
|
2457
|
+
};
|
|
2458
|
+
content: {
|
|
2459
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2460
|
+
};
|
|
2461
|
+
};
|
|
2462
|
+
/**
|
|
2463
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2464
|
+
*
|
|
2465
|
+
* This struct contains all the information needed to serialize an error
|
|
2466
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2467
|
+
* information, and user-friendly messages.
|
|
2468
|
+
*/
|
|
2469
|
+
403: {
|
|
2470
|
+
headers: {
|
|
2471
|
+
[name: string]: unknown;
|
|
2472
|
+
};
|
|
2473
|
+
content: {
|
|
2474
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2475
|
+
};
|
|
2476
|
+
};
|
|
2477
|
+
/**
|
|
2478
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2479
|
+
*
|
|
2480
|
+
* This struct contains all the information needed to serialize an error
|
|
2481
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2482
|
+
* information, and user-friendly messages.
|
|
2483
|
+
*/
|
|
2484
|
+
404: {
|
|
2485
|
+
headers: {
|
|
2486
|
+
[name: string]: unknown;
|
|
2487
|
+
};
|
|
2488
|
+
content: {
|
|
2489
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2490
|
+
};
|
|
2491
|
+
};
|
|
2492
|
+
};
|
|
2493
|
+
};
|
|
2494
|
+
options?: never;
|
|
2495
|
+
head?: never;
|
|
2496
|
+
/**
|
|
2497
|
+
* Update connection
|
|
2498
|
+
* @description Updates connection name or encrypted data.
|
|
2499
|
+
*/
|
|
2500
|
+
patch: {
|
|
2501
|
+
parameters: {
|
|
2502
|
+
query?: never;
|
|
2503
|
+
header?: never;
|
|
2504
|
+
path: {
|
|
2505
|
+
/** @description URL-safe workspace identifier. */
|
|
2506
|
+
workspaceSlug: string;
|
|
2507
|
+
/** @description Opaque identifier of the connection. */
|
|
2508
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2509
|
+
};
|
|
2510
|
+
cookie?: never;
|
|
2511
|
+
};
|
|
2512
|
+
/** @description Request payload for updating an existing workspace connection. */
|
|
2513
|
+
requestBody: {
|
|
2514
|
+
content: {
|
|
2515
|
+
"application/json": components["schemas"]["UpdateConnection"];
|
|
2516
|
+
};
|
|
2517
|
+
};
|
|
2518
|
+
responses: {
|
|
2519
|
+
/**
|
|
2520
|
+
* @description Response type for a workspace connection.
|
|
2521
|
+
*
|
|
2522
|
+
* Note: The encrypted connection data is never exposed in API responses.
|
|
2523
|
+
* Only metadata about the connection is returned.
|
|
2524
|
+
*/
|
|
2525
|
+
200: {
|
|
2526
|
+
headers: {
|
|
2527
|
+
[name: string]: unknown;
|
|
2528
|
+
};
|
|
2529
|
+
content: {
|
|
2530
|
+
"application/json": components["schemas"]["Connection"];
|
|
2531
|
+
};
|
|
2532
|
+
};
|
|
2533
|
+
/**
|
|
2534
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2535
|
+
*
|
|
2536
|
+
* This struct contains all the information needed to serialize an error
|
|
2537
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2538
|
+
* information, and user-friendly messages.
|
|
2539
|
+
*/
|
|
2540
|
+
400: {
|
|
2541
|
+
headers: {
|
|
2542
|
+
[name: string]: unknown;
|
|
2543
|
+
};
|
|
2544
|
+
content: {
|
|
2545
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2546
|
+
};
|
|
2547
|
+
};
|
|
2548
|
+
/**
|
|
2549
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2550
|
+
*
|
|
2551
|
+
* This struct contains all the information needed to serialize an error
|
|
2552
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2553
|
+
* information, and user-friendly messages.
|
|
2554
|
+
*/
|
|
2555
|
+
401: {
|
|
2556
|
+
headers: {
|
|
2557
|
+
[name: string]: unknown;
|
|
2558
|
+
};
|
|
2559
|
+
content: {
|
|
2560
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2561
|
+
};
|
|
2562
|
+
};
|
|
2563
|
+
/**
|
|
2564
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2565
|
+
*
|
|
2566
|
+
* This struct contains all the information needed to serialize an error
|
|
2567
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2568
|
+
* information, and user-friendly messages.
|
|
2569
|
+
*/
|
|
2570
|
+
403: {
|
|
2571
|
+
headers: {
|
|
2572
|
+
[name: string]: unknown;
|
|
2573
|
+
};
|
|
2574
|
+
content: {
|
|
2575
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2576
|
+
};
|
|
2577
|
+
};
|
|
2578
|
+
/**
|
|
2579
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2580
|
+
*
|
|
2581
|
+
* This struct contains all the information needed to serialize an error
|
|
2582
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2583
|
+
* information, and user-friendly messages.
|
|
2584
|
+
*/
|
|
2585
|
+
404: {
|
|
2586
|
+
headers: {
|
|
2587
|
+
[name: string]: unknown;
|
|
2588
|
+
};
|
|
2589
|
+
content: {
|
|
2590
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2591
|
+
};
|
|
2592
|
+
};
|
|
2593
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2594
|
+
415: {
|
|
2595
|
+
headers: {
|
|
2596
|
+
[name: string]: unknown;
|
|
2597
|
+
};
|
|
2598
|
+
content: {
|
|
2599
|
+
"text/plain": string;
|
|
2600
|
+
};
|
|
2601
|
+
};
|
|
2602
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2603
|
+
422: {
|
|
2604
|
+
headers: {
|
|
2605
|
+
[name: string]: unknown;
|
|
2606
|
+
};
|
|
2607
|
+
content: {
|
|
2608
|
+
"text/plain": string;
|
|
2609
|
+
};
|
|
2610
|
+
};
|
|
2611
|
+
};
|
|
2612
|
+
};
|
|
2613
|
+
trace?: never;
|
|
2614
|
+
};
|
|
2615
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/verify/": {
|
|
2616
|
+
parameters: {
|
|
2617
|
+
query?: never;
|
|
2618
|
+
header?: never;
|
|
2619
|
+
path?: never;
|
|
2620
|
+
cookie?: never;
|
|
2621
|
+
};
|
|
2622
|
+
get?: never;
|
|
2623
|
+
put?: never;
|
|
2624
|
+
/**
|
|
2625
|
+
* Verify connection
|
|
2626
|
+
* @description Checks whether the connection's backing store is reachable with its stored credentials.
|
|
2627
|
+
*/
|
|
2628
|
+
post: {
|
|
2629
|
+
parameters: {
|
|
2630
|
+
query?: never;
|
|
2631
|
+
header?: never;
|
|
2632
|
+
path: {
|
|
2633
|
+
/** @description URL-safe workspace identifier. */
|
|
2634
|
+
workspaceSlug: string;
|
|
2635
|
+
/** @description Opaque identifier of the connection. */
|
|
2636
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2637
|
+
};
|
|
2638
|
+
cookie?: never;
|
|
2639
|
+
};
|
|
2640
|
+
requestBody?: never;
|
|
2641
|
+
responses: {
|
|
2642
|
+
/** @description Result of a connection reachability check. */
|
|
2643
|
+
200: {
|
|
2644
|
+
headers: {
|
|
2645
|
+
[name: string]: unknown;
|
|
2646
|
+
};
|
|
2647
|
+
content: {
|
|
2648
|
+
"application/json": components["schemas"]["ConnectionVerification"];
|
|
2649
|
+
};
|
|
2650
|
+
};
|
|
2651
|
+
/**
|
|
2652
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2653
|
+
*
|
|
2654
|
+
* This struct contains all the information needed to serialize an error
|
|
2655
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2656
|
+
* information, and user-friendly messages.
|
|
2657
|
+
*/
|
|
2658
|
+
401: {
|
|
2659
|
+
headers: {
|
|
2660
|
+
[name: string]: unknown;
|
|
2661
|
+
};
|
|
2662
|
+
content: {
|
|
2663
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2664
|
+
};
|
|
2665
|
+
};
|
|
2666
|
+
/**
|
|
2667
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2668
|
+
*
|
|
2669
|
+
* This struct contains all the information needed to serialize an error
|
|
2670
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2671
|
+
* information, and user-friendly messages.
|
|
2672
|
+
*/
|
|
2673
|
+
403: {
|
|
2674
|
+
headers: {
|
|
2675
|
+
[name: string]: unknown;
|
|
2676
|
+
};
|
|
2677
|
+
content: {
|
|
2678
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2679
|
+
};
|
|
2680
|
+
};
|
|
2681
|
+
/**
|
|
2682
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2683
|
+
*
|
|
2684
|
+
* This struct contains all the information needed to serialize an error
|
|
2685
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2686
|
+
* information, and user-friendly messages.
|
|
2687
|
+
*/
|
|
2688
|
+
404: {
|
|
2689
|
+
headers: {
|
|
2690
|
+
[name: string]: unknown;
|
|
2691
|
+
};
|
|
2692
|
+
content: {
|
|
2693
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2694
|
+
};
|
|
2695
|
+
};
|
|
2696
|
+
};
|
|
2697
|
+
};
|
|
2698
|
+
delete?: never;
|
|
2699
|
+
options?: never;
|
|
2700
|
+
head?: never;
|
|
2701
|
+
patch?: never;
|
|
2702
|
+
trace?: never;
|
|
2703
|
+
};
|
|
2704
|
+
"/workspaces/{workspaceSlug}/chat/sessions/": {
|
|
2705
|
+
parameters: {
|
|
2706
|
+
query?: never;
|
|
2707
|
+
header?: never;
|
|
2708
|
+
path?: never;
|
|
2709
|
+
cookie?: never;
|
|
2710
|
+
};
|
|
2711
|
+
/**
|
|
2712
|
+
* List chat sessions
|
|
2713
|
+
* @description Returns the workspace's chat sessions, newest first, cursor-paginated.
|
|
2714
|
+
*/
|
|
2715
|
+
get: {
|
|
2716
|
+
parameters: {
|
|
2717
|
+
query?: {
|
|
2718
|
+
/**
|
|
2719
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
2720
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
2721
|
+
*/
|
|
2722
|
+
after?: string;
|
|
2723
|
+
/**
|
|
2724
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
2725
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
2726
|
+
* only when the count is actually needed.
|
|
2727
|
+
*/
|
|
2728
|
+
includeCount?: boolean;
|
|
2729
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2730
|
+
limit?: number;
|
|
2731
|
+
};
|
|
2732
|
+
header?: never;
|
|
2733
|
+
path: {
|
|
2734
|
+
/** @description URL-safe workspace identifier. */
|
|
2735
|
+
workspaceSlug: string;
|
|
2736
|
+
};
|
|
2737
|
+
cookie?: never;
|
|
2738
|
+
};
|
|
2739
|
+
requestBody?: never;
|
|
2740
|
+
responses: {
|
|
2741
|
+
/**
|
|
2742
|
+
* @description Generic paginated response wrapper.
|
|
2743
|
+
*
|
|
2744
|
+
* Provides a consistent structure for all paginated API responses with
|
|
2745
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
2746
|
+
* are more items to fetch.
|
|
2747
|
+
*/
|
|
2748
|
+
200: {
|
|
2749
|
+
headers: {
|
|
2750
|
+
[name: string]: unknown;
|
|
2751
|
+
};
|
|
2752
|
+
content: {
|
|
2753
|
+
"application/json": components["schemas"]["ChatSessionPage"];
|
|
2754
|
+
};
|
|
2755
|
+
};
|
|
2756
|
+
/**
|
|
2757
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2758
|
+
*
|
|
2759
|
+
* This struct contains all the information needed to serialize an error
|
|
2760
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2761
|
+
* information, and user-friendly messages.
|
|
2762
|
+
*/
|
|
2763
|
+
401: {
|
|
2764
|
+
headers: {
|
|
2765
|
+
[name: string]: unknown;
|
|
2766
|
+
};
|
|
2767
|
+
content: {
|
|
2768
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2769
|
+
};
|
|
2770
|
+
};
|
|
2771
|
+
/**
|
|
2772
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2773
|
+
*
|
|
2774
|
+
* This struct contains all the information needed to serialize an error
|
|
2775
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2776
|
+
* information, and user-friendly messages.
|
|
2777
|
+
*/
|
|
2778
|
+
403: {
|
|
2779
|
+
headers: {
|
|
2780
|
+
[name: string]: unknown;
|
|
2781
|
+
};
|
|
2782
|
+
content: {
|
|
2783
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2784
|
+
};
|
|
2785
|
+
};
|
|
2786
|
+
};
|
|
2787
|
+
};
|
|
2788
|
+
put?: never;
|
|
2789
|
+
/**
|
|
2790
|
+
* Create chat session
|
|
2791
|
+
* @description Opens a new assistant chat session in the workspace.
|
|
2792
|
+
*/
|
|
2793
|
+
post: {
|
|
2794
|
+
parameters: {
|
|
2795
|
+
query?: never;
|
|
2796
|
+
header?: never;
|
|
2797
|
+
path: {
|
|
2798
|
+
/** @description URL-safe workspace identifier. */
|
|
2799
|
+
workspaceSlug: string;
|
|
2800
|
+
};
|
|
2801
|
+
cookie?: never;
|
|
2802
|
+
};
|
|
2803
|
+
/** @description Request to create a chat session. */
|
|
2804
|
+
requestBody: {
|
|
2805
|
+
content: {
|
|
2806
|
+
"application/json": components["schemas"]["CreateChatSession"];
|
|
2807
|
+
};
|
|
2808
|
+
};
|
|
2809
|
+
responses: {
|
|
2810
|
+
/** @description A chat session. */
|
|
2811
|
+
201: {
|
|
2812
|
+
headers: {
|
|
2813
|
+
[name: string]: unknown;
|
|
2814
|
+
};
|
|
2815
|
+
content: {
|
|
2816
|
+
"application/json": components["schemas"]["ChatSession"];
|
|
2817
|
+
};
|
|
2818
|
+
};
|
|
2819
|
+
/** @description Failed to parse the request body as JSON */
|
|
2820
|
+
400: {
|
|
2821
|
+
headers: {
|
|
2822
|
+
[name: string]: unknown;
|
|
2823
|
+
};
|
|
2824
|
+
content: {
|
|
2825
|
+
"text/plain": string;
|
|
2826
|
+
};
|
|
2827
|
+
};
|
|
2828
|
+
/**
|
|
2829
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2830
|
+
*
|
|
2831
|
+
* This struct contains all the information needed to serialize an error
|
|
2832
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2833
|
+
* information, and user-friendly messages.
|
|
2834
|
+
*/
|
|
2835
|
+
401: {
|
|
2836
|
+
headers: {
|
|
2837
|
+
[name: string]: unknown;
|
|
2838
|
+
};
|
|
2839
|
+
content: {
|
|
2840
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2841
|
+
};
|
|
2842
|
+
};
|
|
2843
|
+
/**
|
|
2844
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2845
|
+
*
|
|
2846
|
+
* This struct contains all the information needed to serialize an error
|
|
2847
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2848
|
+
* information, and user-friendly messages.
|
|
2849
|
+
*/
|
|
2850
|
+
403: {
|
|
2851
|
+
headers: {
|
|
2852
|
+
[name: string]: unknown;
|
|
2853
|
+
};
|
|
2854
|
+
content: {
|
|
2855
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2856
|
+
};
|
|
2857
|
+
};
|
|
2858
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2859
|
+
415: {
|
|
2860
|
+
headers: {
|
|
2861
|
+
[name: string]: unknown;
|
|
2862
|
+
};
|
|
2863
|
+
content: {
|
|
2864
|
+
"text/plain": string;
|
|
2865
|
+
};
|
|
2866
|
+
};
|
|
2867
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2868
|
+
422: {
|
|
2869
|
+
headers: {
|
|
2870
|
+
[name: string]: unknown;
|
|
2871
|
+
};
|
|
2872
|
+
content: {
|
|
2873
|
+
"text/plain": string;
|
|
2874
|
+
};
|
|
2875
|
+
};
|
|
2876
|
+
};
|
|
2877
|
+
};
|
|
2878
|
+
delete?: never;
|
|
2879
|
+
options?: never;
|
|
2880
|
+
head?: never;
|
|
2881
|
+
patch?: never;
|
|
2882
|
+
trace?: never;
|
|
2883
|
+
};
|
|
2884
|
+
"/workspaces/{workspaceSlug}/chat/sessions/{sessionId}/": {
|
|
2885
|
+
parameters: {
|
|
2886
|
+
query?: never;
|
|
2887
|
+
header?: never;
|
|
2888
|
+
path?: never;
|
|
2889
|
+
cookie?: never;
|
|
2890
|
+
};
|
|
2891
|
+
get?: never;
|
|
2892
|
+
put?: never;
|
|
2893
|
+
post?: never;
|
|
2894
|
+
/**
|
|
2895
|
+
* Delete chat session
|
|
2896
|
+
* @description Soft-deletes a chat session.
|
|
2897
|
+
*/
|
|
2898
|
+
delete: {
|
|
2899
|
+
parameters: {
|
|
2900
|
+
query?: never;
|
|
2901
|
+
header?: never;
|
|
2902
|
+
path: {
|
|
2903
|
+
/** @description URL-safe workspace identifier. */
|
|
2904
|
+
workspaceSlug: string;
|
|
2905
|
+
/** @description The session id. */
|
|
2906
|
+
sessionId: string;
|
|
2907
|
+
};
|
|
2908
|
+
cookie?: never;
|
|
2909
|
+
};
|
|
2910
|
+
requestBody?: never;
|
|
2911
|
+
responses: {
|
|
2912
|
+
/** @description no content */
|
|
2913
|
+
204: {
|
|
2914
|
+
headers: {
|
|
2915
|
+
[name: string]: unknown;
|
|
2916
|
+
};
|
|
2917
|
+
content?: never;
|
|
2918
|
+
};
|
|
2919
|
+
/**
|
|
2920
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2921
|
+
*
|
|
2922
|
+
* This struct contains all the information needed to serialize an error
|
|
2923
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2924
|
+
* information, and user-friendly messages.
|
|
2925
|
+
*/
|
|
2926
|
+
401: {
|
|
2927
|
+
headers: {
|
|
2928
|
+
[name: string]: unknown;
|
|
2929
|
+
};
|
|
2930
|
+
content: {
|
|
2931
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2932
|
+
};
|
|
2933
|
+
};
|
|
2934
|
+
/**
|
|
2935
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2936
|
+
*
|
|
2937
|
+
* This struct contains all the information needed to serialize an error
|
|
2938
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2939
|
+
* information, and user-friendly messages.
|
|
2940
|
+
*/
|
|
2941
|
+
403: {
|
|
2942
|
+
headers: {
|
|
2943
|
+
[name: string]: unknown;
|
|
2944
|
+
};
|
|
2945
|
+
content: {
|
|
2946
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2947
|
+
};
|
|
2948
|
+
};
|
|
2949
|
+
/**
|
|
2950
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2951
|
+
*
|
|
2952
|
+
* This struct contains all the information needed to serialize an error
|
|
2953
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2954
|
+
* information, and user-friendly messages.
|
|
2955
|
+
*/
|
|
2956
|
+
404: {
|
|
2957
|
+
headers: {
|
|
2958
|
+
[name: string]: unknown;
|
|
2959
|
+
};
|
|
2960
|
+
content: {
|
|
2961
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2962
|
+
};
|
|
2963
|
+
};
|
|
2964
|
+
};
|
|
2965
|
+
};
|
|
2966
|
+
options?: never;
|
|
2967
|
+
head?: never;
|
|
2968
|
+
patch?: never;
|
|
2969
|
+
trace?: never;
|
|
2970
|
+
};
|
|
2971
|
+
"/workspaces/{workspaceSlug}/chat/sessions/{sessionId}/messages/": {
|
|
2972
|
+
parameters: {
|
|
2973
|
+
query?: never;
|
|
2974
|
+
header?: never;
|
|
2975
|
+
path?: never;
|
|
2976
|
+
cookie?: never;
|
|
2977
|
+
};
|
|
2978
|
+
/**
|
|
2979
|
+
* List chat messages
|
|
2980
|
+
* @description Returns a session's messages in chronological order.
|
|
2981
|
+
*/
|
|
2982
|
+
get: {
|
|
2983
|
+
parameters: {
|
|
2984
|
+
query?: never;
|
|
2985
|
+
header?: never;
|
|
2986
|
+
path: {
|
|
2987
|
+
/** @description URL-safe workspace identifier. */
|
|
2988
|
+
workspaceSlug: string;
|
|
2989
|
+
/** @description The session id. */
|
|
2990
|
+
sessionId: string;
|
|
2991
|
+
};
|
|
2992
|
+
cookie?: never;
|
|
2993
|
+
};
|
|
2994
|
+
requestBody?: never;
|
|
2995
|
+
responses: {
|
|
2996
|
+
200: {
|
|
2997
|
+
headers: {
|
|
2998
|
+
[name: string]: unknown;
|
|
2999
|
+
};
|
|
3000
|
+
content: {
|
|
3001
|
+
"application/json": components["schemas"]["ChatMessage"][];
|
|
3002
|
+
};
|
|
3003
|
+
};
|
|
3004
|
+
/**
|
|
3005
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3006
|
+
*
|
|
3007
|
+
* This struct contains all the information needed to serialize an error
|
|
3008
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3009
|
+
* information, and user-friendly messages.
|
|
3010
|
+
*/
|
|
3011
|
+
401: {
|
|
3012
|
+
headers: {
|
|
3013
|
+
[name: string]: unknown;
|
|
3014
|
+
};
|
|
3015
|
+
content: {
|
|
3016
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3017
|
+
};
|
|
3018
|
+
};
|
|
3019
|
+
/**
|
|
3020
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3021
|
+
*
|
|
3022
|
+
* This struct contains all the information needed to serialize an error
|
|
3023
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3024
|
+
* information, and user-friendly messages.
|
|
3025
|
+
*/
|
|
3026
|
+
403: {
|
|
3027
|
+
headers: {
|
|
3028
|
+
[name: string]: unknown;
|
|
3029
|
+
};
|
|
3030
|
+
content: {
|
|
3031
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3032
|
+
};
|
|
3033
|
+
};
|
|
3034
|
+
/**
|
|
3035
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3036
|
+
*
|
|
3037
|
+
* This struct contains all the information needed to serialize an error
|
|
3038
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3039
|
+
* information, and user-friendly messages.
|
|
3040
|
+
*/
|
|
3041
|
+
404: {
|
|
3042
|
+
headers: {
|
|
3043
|
+
[name: string]: unknown;
|
|
3044
|
+
};
|
|
3045
|
+
content: {
|
|
3046
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3047
|
+
};
|
|
3048
|
+
};
|
|
3049
|
+
};
|
|
3050
|
+
};
|
|
3051
|
+
put?: never;
|
|
3052
|
+
/**
|
|
3053
|
+
* Send chat message
|
|
3054
|
+
* @description Sends a message and streams the assistant's reply as Server-Sent Events. Each event's `data` is a `ChatToken` delta. Authenticate with a Bearer token via a `fetch`-based client; the native `EventSource` cannot send an `Authorization` header. 409 when the workspace has no language model connection configured.
|
|
3055
|
+
*/
|
|
3056
|
+
post: {
|
|
3057
|
+
parameters: {
|
|
3058
|
+
query?: never;
|
|
3059
|
+
header?: never;
|
|
3060
|
+
path: {
|
|
3061
|
+
/** @description URL-safe workspace identifier. */
|
|
3062
|
+
workspaceSlug: string;
|
|
3063
|
+
/** @description The session id. */
|
|
3064
|
+
sessionId: string;
|
|
3065
|
+
};
|
|
3066
|
+
cookie?: never;
|
|
3067
|
+
};
|
|
3068
|
+
/** @description Request to send a message and stream the assistant's reply. */
|
|
3069
|
+
requestBody: {
|
|
3070
|
+
content: {
|
|
3071
|
+
"application/json": components["schemas"]["SendChatMessage"];
|
|
3072
|
+
};
|
|
3073
|
+
};
|
|
3074
|
+
responses: {
|
|
3075
|
+
/** @description Server-sent event stream; each event's `data` is the payload below. */
|
|
3076
|
+
200: {
|
|
3077
|
+
headers: {
|
|
3078
|
+
[name: string]: unknown;
|
|
3079
|
+
};
|
|
3080
|
+
content: {
|
|
3081
|
+
"text/event-stream": components["schemas"]["ChatToken"];
|
|
3082
|
+
};
|
|
3083
|
+
};
|
|
3084
|
+
/** @description Failed to parse the request body as JSON */
|
|
3085
|
+
400: {
|
|
3086
|
+
headers: {
|
|
3087
|
+
[name: string]: unknown;
|
|
3088
|
+
};
|
|
3089
|
+
content: {
|
|
3090
|
+
"text/plain": string;
|
|
3091
|
+
};
|
|
3092
|
+
};
|
|
3093
|
+
/**
|
|
3094
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3095
|
+
*
|
|
3096
|
+
* This struct contains all the information needed to serialize an error
|
|
3097
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3098
|
+
* information, and user-friendly messages.
|
|
3099
|
+
*/
|
|
3100
|
+
401: {
|
|
3101
|
+
headers: {
|
|
3102
|
+
[name: string]: unknown;
|
|
3103
|
+
};
|
|
3104
|
+
content: {
|
|
3105
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3106
|
+
};
|
|
3107
|
+
};
|
|
3108
|
+
/**
|
|
3109
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3110
|
+
*
|
|
3111
|
+
* This struct contains all the information needed to serialize an error
|
|
3112
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3113
|
+
* information, and user-friendly messages.
|
|
3114
|
+
*/
|
|
3115
|
+
403: {
|
|
3116
|
+
headers: {
|
|
3117
|
+
[name: string]: unknown;
|
|
3118
|
+
};
|
|
3119
|
+
content: {
|
|
3120
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3121
|
+
};
|
|
3122
|
+
};
|
|
3123
|
+
/**
|
|
3124
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3125
|
+
*
|
|
3126
|
+
* This struct contains all the information needed to serialize an error
|
|
3127
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3128
|
+
* information, and user-friendly messages.
|
|
3129
|
+
*/
|
|
3130
|
+
404: {
|
|
3131
|
+
headers: {
|
|
3132
|
+
[name: string]: unknown;
|
|
3133
|
+
};
|
|
3134
|
+
content: {
|
|
3135
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3136
|
+
};
|
|
3137
|
+
};
|
|
3138
|
+
/**
|
|
3139
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3140
|
+
*
|
|
3141
|
+
* This struct contains all the information needed to serialize an error
|
|
3142
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3143
|
+
* information, and user-friendly messages.
|
|
3144
|
+
*/
|
|
3145
|
+
409: {
|
|
3146
|
+
headers: {
|
|
3147
|
+
[name: string]: unknown;
|
|
3148
|
+
};
|
|
3149
|
+
content: {
|
|
3150
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3151
|
+
};
|
|
3152
|
+
};
|
|
3153
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
3154
|
+
415: {
|
|
3155
|
+
headers: {
|
|
3156
|
+
[name: string]: unknown;
|
|
3157
|
+
};
|
|
3158
|
+
content: {
|
|
3159
|
+
"text/plain": string;
|
|
3160
|
+
};
|
|
3161
|
+
};
|
|
3162
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
3163
|
+
422: {
|
|
3164
|
+
headers: {
|
|
3165
|
+
[name: string]: unknown;
|
|
3166
|
+
};
|
|
3167
|
+
content: {
|
|
3168
|
+
"text/plain": string;
|
|
2331
3169
|
};
|
|
2332
3170
|
};
|
|
2333
3171
|
};
|
|
@@ -2357,6 +3195,12 @@ interface paths {
|
|
|
2357
3195
|
* Obtain this from the `nextCursor` field in the response.
|
|
2358
3196
|
*/
|
|
2359
3197
|
after?: string;
|
|
3198
|
+
/**
|
|
3199
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
3200
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
3201
|
+
* only when the count is actually needed.
|
|
3202
|
+
*/
|
|
3203
|
+
includeCount?: boolean;
|
|
2360
3204
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2361
3205
|
limit?: number;
|
|
2362
3206
|
/**
|
|
@@ -2601,6 +3445,12 @@ interface paths {
|
|
|
2601
3445
|
* Obtain this from the `nextCursor` field in the response.
|
|
2602
3446
|
*/
|
|
2603
3447
|
after?: string;
|
|
3448
|
+
/**
|
|
3449
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
3450
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
3451
|
+
* only when the count is actually needed.
|
|
3452
|
+
*/
|
|
3453
|
+
includeCount?: boolean;
|
|
2604
3454
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2605
3455
|
limit?: number;
|
|
2606
3456
|
};
|
|
@@ -2910,6 +3760,12 @@ interface paths {
|
|
|
2910
3760
|
* Obtain this from the `nextCursor` field in the response.
|
|
2911
3761
|
*/
|
|
2912
3762
|
after?: string;
|
|
3763
|
+
/**
|
|
3764
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
3765
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
3766
|
+
* only when the count is actually needed.
|
|
3767
|
+
*/
|
|
3768
|
+
includeCount?: boolean;
|
|
2913
3769
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2914
3770
|
limit?: number;
|
|
2915
3771
|
};
|
|
@@ -3137,7 +3993,7 @@ interface paths {
|
|
|
3137
3993
|
post?: never;
|
|
3138
3994
|
/**
|
|
3139
3995
|
* Delete file
|
|
3140
|
-
* @description
|
|
3996
|
+
* @description Deletes a file: the record is retired and its stored content is removed. This is permanent — the file's content cannot be recovered.
|
|
3141
3997
|
*/
|
|
3142
3998
|
delete: {
|
|
3143
3999
|
parameters: {
|
|
@@ -3348,12 +4204,14 @@ interface paths {
|
|
|
3348
4204
|
};
|
|
3349
4205
|
requestBody?: never;
|
|
3350
4206
|
responses: {
|
|
3351
|
-
/** @description
|
|
4207
|
+
/** @description The file content. */
|
|
3352
4208
|
200: {
|
|
3353
4209
|
headers: {
|
|
3354
4210
|
[name: string]: unknown;
|
|
3355
4211
|
};
|
|
3356
|
-
content
|
|
4212
|
+
content: {
|
|
4213
|
+
"application/octet-stream": unknown;
|
|
4214
|
+
};
|
|
3357
4215
|
};
|
|
3358
4216
|
/**
|
|
3359
4217
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -3429,6 +4287,12 @@ interface paths {
|
|
|
3429
4287
|
* Obtain this from the `nextCursor` field in the response.
|
|
3430
4288
|
*/
|
|
3431
4289
|
after?: string;
|
|
4290
|
+
/**
|
|
4291
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
4292
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
4293
|
+
* only when the count is actually needed.
|
|
4294
|
+
*/
|
|
4295
|
+
includeCount?: boolean;
|
|
3432
4296
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
3433
4297
|
limit?: number;
|
|
3434
4298
|
/** @description Search by pipeline name (trigram similarity). */
|
|
@@ -3894,6 +4758,12 @@ interface paths {
|
|
|
3894
4758
|
* Obtain this from the `nextCursor` field in the response.
|
|
3895
4759
|
*/
|
|
3896
4760
|
after?: string;
|
|
4761
|
+
/**
|
|
4762
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
4763
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
4764
|
+
* only when the count is actually needed.
|
|
4765
|
+
*/
|
|
4766
|
+
includeCount?: boolean;
|
|
3897
4767
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
3898
4768
|
limit?: number;
|
|
3899
4769
|
/** @description Filter by the source file the run analyzes. */
|
|
@@ -4005,6 +4875,12 @@ interface paths {
|
|
|
4005
4875
|
* Obtain this from the `nextCursor` field in the response.
|
|
4006
4876
|
*/
|
|
4007
4877
|
after?: string;
|
|
4878
|
+
/**
|
|
4879
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
4880
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
4881
|
+
* only when the count is actually needed.
|
|
4882
|
+
*/
|
|
4883
|
+
includeCount?: boolean;
|
|
4008
4884
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
4009
4885
|
limit?: number;
|
|
4010
4886
|
/** @description Filter by the source file the run analyzes. */
|
|
@@ -4660,7 +5536,7 @@ interface paths {
|
|
|
4660
5536
|
patch?: never;
|
|
4661
5537
|
trace?: never;
|
|
4662
5538
|
};
|
|
4663
|
-
"/workspaces/{workspaceSlug}/runs/{runId}/audit
|
|
5539
|
+
"/workspaces/{workspaceSlug}/runs/{runId}/audit": {
|
|
4664
5540
|
parameters: {
|
|
4665
5541
|
query?: never;
|
|
4666
5542
|
header?: never;
|
|
@@ -4668,12 +5544,15 @@ interface paths {
|
|
|
4668
5544
|
cookie?: never;
|
|
4669
5545
|
};
|
|
4670
5546
|
/**
|
|
4671
|
-
* Download run audit
|
|
4672
|
-
* @description Downloads the run's audit as a pretty-printed JSON file.
|
|
5547
|
+
* Download run audit
|
|
5548
|
+
* @description Downloads the run's audit as a file. `format` is `csv` (default) — a zip of entities.csv, provenance.csv, and reviews.csv — or `json`, a pretty-printed JSON file.
|
|
4673
5549
|
*/
|
|
4674
5550
|
get: {
|
|
4675
5551
|
parameters: {
|
|
4676
|
-
query?:
|
|
5552
|
+
query?: {
|
|
5553
|
+
/** @description Output format; defaults to `csv`. */
|
|
5554
|
+
format?: components["schemas"]["ExportFormat"];
|
|
5555
|
+
};
|
|
4677
5556
|
header?: never;
|
|
4678
5557
|
path: {
|
|
4679
5558
|
/** @description URL-safe workspace identifier. */
|
|
@@ -4685,114 +5564,15 @@ interface paths {
|
|
|
4685
5564
|
};
|
|
4686
5565
|
requestBody?: never;
|
|
4687
5566
|
responses: {
|
|
4688
|
-
/** @description
|
|
5567
|
+
/** @description The run's exported audit. */
|
|
4689
5568
|
200: {
|
|
4690
|
-
headers: {
|
|
4691
|
-
[name: string]: unknown;
|
|
4692
|
-
};
|
|
4693
|
-
content?: never;
|
|
4694
|
-
};
|
|
4695
|
-
/**
|
|
4696
|
-
* @description HTTP error response representation with security-conscious design.
|
|
4697
|
-
*
|
|
4698
|
-
* This struct contains all the information needed to serialize an error
|
|
4699
|
-
* response, including the error name, message, HTTP status code, resource
|
|
4700
|
-
* information, and user-friendly messages.
|
|
4701
|
-
*/
|
|
4702
|
-
401: {
|
|
4703
|
-
headers: {
|
|
4704
|
-
[name: string]: unknown;
|
|
4705
|
-
};
|
|
4706
|
-
content: {
|
|
4707
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
4708
|
-
};
|
|
4709
|
-
};
|
|
4710
|
-
/**
|
|
4711
|
-
* @description HTTP error response representation with security-conscious design.
|
|
4712
|
-
*
|
|
4713
|
-
* This struct contains all the information needed to serialize an error
|
|
4714
|
-
* response, including the error name, message, HTTP status code, resource
|
|
4715
|
-
* information, and user-friendly messages.
|
|
4716
|
-
*/
|
|
4717
|
-
403: {
|
|
4718
|
-
headers: {
|
|
4719
|
-
[name: string]: unknown;
|
|
4720
|
-
};
|
|
4721
|
-
content: {
|
|
4722
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
4723
|
-
};
|
|
4724
|
-
};
|
|
4725
|
-
/**
|
|
4726
|
-
* @description HTTP error response representation with security-conscious design.
|
|
4727
|
-
*
|
|
4728
|
-
* This struct contains all the information needed to serialize an error
|
|
4729
|
-
* response, including the error name, message, HTTP status code, resource
|
|
4730
|
-
* information, and user-friendly messages.
|
|
4731
|
-
*/
|
|
4732
|
-
404: {
|
|
4733
|
-
headers: {
|
|
4734
|
-
[name: string]: unknown;
|
|
4735
|
-
};
|
|
4736
|
-
content: {
|
|
4737
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
4738
|
-
};
|
|
4739
|
-
};
|
|
4740
|
-
/**
|
|
4741
|
-
* @description HTTP error response representation with security-conscious design.
|
|
4742
|
-
*
|
|
4743
|
-
* This struct contains all the information needed to serialize an error
|
|
4744
|
-
* response, including the error name, message, HTTP status code, resource
|
|
4745
|
-
* information, and user-friendly messages.
|
|
4746
|
-
*/
|
|
4747
|
-
409: {
|
|
4748
5569
|
headers: {
|
|
4749
5570
|
[name: string]: unknown;
|
|
4750
5571
|
};
|
|
4751
5572
|
content: {
|
|
4752
|
-
"application/
|
|
4753
|
-
|
|
4754
|
-
};
|
|
4755
|
-
};
|
|
4756
|
-
};
|
|
4757
|
-
put?: never;
|
|
4758
|
-
post?: never;
|
|
4759
|
-
delete?: never;
|
|
4760
|
-
options?: never;
|
|
4761
|
-
head?: never;
|
|
4762
|
-
patch?: never;
|
|
4763
|
-
trace?: never;
|
|
4764
|
-
};
|
|
4765
|
-
"/workspaces/{workspaceSlug}/runs/{runId}/audit/csv": {
|
|
4766
|
-
parameters: {
|
|
4767
|
-
query?: never;
|
|
4768
|
-
header?: never;
|
|
4769
|
-
path?: never;
|
|
4770
|
-
cookie?: never;
|
|
4771
|
-
};
|
|
4772
|
-
/**
|
|
4773
|
-
* Download run audit (CSV)
|
|
4774
|
-
* @description Downloads the run's audit as a zip of entities.csv, provenance.csv, and reviews.csv.
|
|
4775
|
-
*/
|
|
4776
|
-
get: {
|
|
4777
|
-
parameters: {
|
|
4778
|
-
query?: never;
|
|
4779
|
-
header?: never;
|
|
4780
|
-
path: {
|
|
4781
|
-
/** @description URL-safe workspace identifier. */
|
|
4782
|
-
workspaceSlug: string;
|
|
4783
|
-
/** @description Opaque identifier of the run. */
|
|
4784
|
-
runId: components["schemas"]["RunId"];
|
|
4785
|
-
};
|
|
4786
|
-
cookie?: never;
|
|
4787
|
-
};
|
|
4788
|
-
requestBody?: never;
|
|
4789
|
-
responses: {
|
|
4790
|
-
/** @description no content */
|
|
4791
|
-
200: {
|
|
4792
|
-
headers: {
|
|
4793
|
-
[name: string]: unknown;
|
|
5573
|
+
"application/zip": unknown;
|
|
5574
|
+
"application/json": unknown;
|
|
4794
5575
|
};
|
|
4795
|
-
content?: never;
|
|
4796
5576
|
};
|
|
4797
5577
|
/**
|
|
4798
5578
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -4883,6 +5663,12 @@ interface paths {
|
|
|
4883
5663
|
* Obtain this from the `nextCursor` field in the response.
|
|
4884
5664
|
*/
|
|
4885
5665
|
after?: string;
|
|
5666
|
+
/**
|
|
5667
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
5668
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
5669
|
+
* only when the count is actually needed.
|
|
5670
|
+
*/
|
|
5671
|
+
includeCount?: boolean;
|
|
4886
5672
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
4887
5673
|
limit?: number;
|
|
4888
5674
|
};
|
|
@@ -5463,6 +6249,12 @@ interface paths {
|
|
|
5463
6249
|
* Obtain this from the `nextCursor` field in the response.
|
|
5464
6250
|
*/
|
|
5465
6251
|
after?: string;
|
|
6252
|
+
/**
|
|
6253
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
6254
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
6255
|
+
* only when the count is actually needed.
|
|
6256
|
+
*/
|
|
6257
|
+
includeCount?: boolean;
|
|
5466
6258
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
5467
6259
|
limit?: number;
|
|
5468
6260
|
};
|
|
@@ -5857,6 +6649,12 @@ interface paths {
|
|
|
5857
6649
|
* Obtain this from the `nextCursor` field in the response.
|
|
5858
6650
|
*/
|
|
5859
6651
|
after?: string;
|
|
6652
|
+
/**
|
|
6653
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
6654
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
6655
|
+
* only when the count is actually needed.
|
|
6656
|
+
*/
|
|
6657
|
+
includeCount?: boolean;
|
|
5860
6658
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
5861
6659
|
limit?: number;
|
|
5862
6660
|
};
|
|
@@ -6163,6 +6961,12 @@ interface paths {
|
|
|
6163
6961
|
* Obtain this from the `nextCursor` field in the response.
|
|
6164
6962
|
*/
|
|
6165
6963
|
after?: string;
|
|
6964
|
+
/**
|
|
6965
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
6966
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
6967
|
+
* only when the count is actually needed.
|
|
6968
|
+
*/
|
|
6969
|
+
includeCount?: boolean;
|
|
6166
6970
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
6167
6971
|
limit?: number;
|
|
6168
6972
|
};
|
|
@@ -6873,6 +7677,12 @@ interface paths {
|
|
|
6873
7677
|
* Obtain this from the `nextCursor` field in the response.
|
|
6874
7678
|
*/
|
|
6875
7679
|
after?: string;
|
|
7680
|
+
/**
|
|
7681
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
7682
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
7683
|
+
* only when the count is actually needed.
|
|
7684
|
+
*/
|
|
7685
|
+
includeCount?: boolean;
|
|
6876
7686
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
6877
7687
|
limit?: number;
|
|
6878
7688
|
};
|
|
@@ -7901,6 +8711,83 @@ interface components {
|
|
|
7901
8711
|
/** @description Handle of the workspace this activity belongs to. */
|
|
7902
8712
|
workspaceSlug: components["schemas"]["Handle"];
|
|
7903
8713
|
};
|
|
8714
|
+
/**
|
|
8715
|
+
* @description Query parameters for the activity export: the type/actor filter, a bounded date
|
|
8716
|
+
* window (defaulted and capped, since the export materializes rows), and the
|
|
8717
|
+
* output `format`. See [`DateWindow`] for the range defaults and bounds.
|
|
8718
|
+
*/
|
|
8719
|
+
ActivityExportQuery: {
|
|
8720
|
+
/**
|
|
8721
|
+
* Format: uuid
|
|
8722
|
+
* @description Keep only activities performed by this account. Omit for any actor.
|
|
8723
|
+
*/
|
|
8724
|
+
actor?: string;
|
|
8725
|
+
/** @description Output format; defaults to `csv`. */
|
|
8726
|
+
format?: components["schemas"]["ExportFormat"];
|
|
8727
|
+
/**
|
|
8728
|
+
* Format: date
|
|
8729
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
8730
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
8731
|
+
*/
|
|
8732
|
+
from?: string;
|
|
8733
|
+
/**
|
|
8734
|
+
* Format: date
|
|
8735
|
+
* @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC).
|
|
8736
|
+
*/
|
|
8737
|
+
to?: string;
|
|
8738
|
+
/**
|
|
8739
|
+
* @description Keep only these activity types (e.g. `file.created`). Repeat the `type`
|
|
8740
|
+
* parameter for several; omit for no type constraint. The field is `types`
|
|
8741
|
+
* since `type` is a reserved word.
|
|
8742
|
+
*/
|
|
8743
|
+
type?: components["schemas"]["ActivityType"][];
|
|
8744
|
+
};
|
|
8745
|
+
/**
|
|
8746
|
+
* @description Query parameters for the activity feed: the type/actor filter, an optional date
|
|
8747
|
+
* window (narrows only when given — the feed is otherwise all-time), and cursor
|
|
8748
|
+
* pagination.
|
|
8749
|
+
*/
|
|
8750
|
+
ActivityListQuery: {
|
|
8751
|
+
/**
|
|
8752
|
+
* Format: uuid
|
|
8753
|
+
* @description Keep only activities performed by this account. Omit for any actor.
|
|
8754
|
+
*/
|
|
8755
|
+
actor?: string;
|
|
8756
|
+
/**
|
|
8757
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
8758
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
8759
|
+
*/
|
|
8760
|
+
after?: string;
|
|
8761
|
+
/**
|
|
8762
|
+
* Format: date
|
|
8763
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
8764
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
8765
|
+
*/
|
|
8766
|
+
from?: string;
|
|
8767
|
+
/**
|
|
8768
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
8769
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
8770
|
+
* only when the count is actually needed.
|
|
8771
|
+
* @default false
|
|
8772
|
+
*/
|
|
8773
|
+
includeCount?: boolean;
|
|
8774
|
+
/**
|
|
8775
|
+
* Format: uint32
|
|
8776
|
+
* @description The maximum number of records to return (1-100, default: 20).
|
|
8777
|
+
*/
|
|
8778
|
+
limit?: number;
|
|
8779
|
+
/**
|
|
8780
|
+
* Format: date
|
|
8781
|
+
* @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC).
|
|
8782
|
+
*/
|
|
8783
|
+
to?: string;
|
|
8784
|
+
/**
|
|
8785
|
+
* @description Keep only these activity types (e.g. `file.created`). Repeat the `type`
|
|
8786
|
+
* parameter for several; omit for no type constraint. The field is `types`
|
|
8787
|
+
* since `type` is a reserved word.
|
|
8788
|
+
*/
|
|
8789
|
+
type?: components["schemas"]["ActivityType"][];
|
|
8790
|
+
};
|
|
7904
8791
|
/**
|
|
7905
8792
|
* @description Generic paginated response wrapper.
|
|
7906
8793
|
*
|
|
@@ -7920,112 +8807,151 @@ interface components {
|
|
|
7920
8807
|
total?: number;
|
|
7921
8808
|
};
|
|
7922
8809
|
/**
|
|
7923
|
-
* @description The typed payload of an audit-log activity, tagged by `
|
|
8810
|
+
* @description The typed payload of an audit-log activity, tagged by `type` with its params
|
|
8811
|
+
* under `data` (the same `{type, data}` envelope the notification payload and
|
|
8812
|
+
* outbox event use).
|
|
7924
8813
|
*
|
|
7925
8814
|
* Each variant is one activity type carrying its own params. No rendered text is
|
|
7926
|
-
* included — the client localizes the copy from `
|
|
7927
|
-
*
|
|
8815
|
+
* included — the client localizes the copy from `type` and the params. The `type`
|
|
8816
|
+
* values match the `ACTIVITY_TYPE` enum.
|
|
7928
8817
|
*/
|
|
7929
|
-
ActivityPayload:
|
|
7930
|
-
|
|
7931
|
-
activityType: "workspace.created";
|
|
7932
|
-
} & components["schemas"]["WorkspaceActivityParams"]) | ({
|
|
8818
|
+
ActivityPayload: {
|
|
8819
|
+
data: components["schemas"]["WorkspaceActivityParams"];
|
|
7933
8820
|
/** @constant */
|
|
7934
|
-
|
|
7935
|
-
}
|
|
8821
|
+
type: "workspace.created";
|
|
8822
|
+
} | {
|
|
8823
|
+
data: components["schemas"]["WorkspaceActivityParams"];
|
|
7936
8824
|
/** @constant */
|
|
7937
|
-
|
|
7938
|
-
}
|
|
8825
|
+
type: "workspace.updated";
|
|
8826
|
+
} | {
|
|
8827
|
+
data: components["schemas"]["WorkspaceActivityParams"];
|
|
7939
8828
|
/** @constant */
|
|
7940
|
-
|
|
7941
|
-
}
|
|
8829
|
+
type: "workspace.deleted";
|
|
8830
|
+
} | {
|
|
8831
|
+
data: components["schemas"]["MemberActivityParams"];
|
|
7942
8832
|
/** @constant */
|
|
7943
|
-
|
|
7944
|
-
}
|
|
8833
|
+
type: "member.added";
|
|
8834
|
+
} | {
|
|
8835
|
+
data: components["schemas"]["MemberActivityParams"];
|
|
7945
8836
|
/** @constant */
|
|
7946
|
-
|
|
7947
|
-
}
|
|
8837
|
+
type: "member.updated";
|
|
8838
|
+
} | {
|
|
8839
|
+
data: components["schemas"]["MemberActivityParams"];
|
|
7948
8840
|
/** @constant */
|
|
7949
|
-
|
|
7950
|
-
}
|
|
8841
|
+
type: "member.deleted";
|
|
8842
|
+
} | {
|
|
8843
|
+
data: components["schemas"]["InviteActivityParams"];
|
|
7951
8844
|
/** @constant */
|
|
7952
|
-
|
|
7953
|
-
}
|
|
8845
|
+
type: "invite.created";
|
|
8846
|
+
} | {
|
|
8847
|
+
data: components["schemas"]["InviteActivityParams"];
|
|
7954
8848
|
/** @constant */
|
|
7955
|
-
|
|
7956
|
-
}
|
|
8849
|
+
type: "invite.accepted";
|
|
8850
|
+
} | {
|
|
8851
|
+
data: components["schemas"]["InviteActivityParams"];
|
|
7957
8852
|
/** @constant */
|
|
7958
|
-
|
|
7959
|
-
}
|
|
8853
|
+
type: "invite.declined";
|
|
8854
|
+
} | {
|
|
8855
|
+
data: components["schemas"]["InviteActivityParams"];
|
|
7960
8856
|
/** @constant */
|
|
7961
|
-
|
|
7962
|
-
}
|
|
8857
|
+
type: "invite.canceled";
|
|
8858
|
+
} | {
|
|
8859
|
+
data: components["schemas"]["ConnectionActivityParams"];
|
|
7963
8860
|
/** @constant */
|
|
7964
|
-
|
|
7965
|
-
}
|
|
8861
|
+
type: "connection.created";
|
|
8862
|
+
} | {
|
|
8863
|
+
data: components["schemas"]["ConnectionActivityParams"];
|
|
7966
8864
|
/** @constant */
|
|
7967
|
-
|
|
7968
|
-
}
|
|
8865
|
+
type: "connection.updated";
|
|
8866
|
+
} | {
|
|
8867
|
+
data: components["schemas"]["ConnectionActivityParams"];
|
|
7969
8868
|
/** @constant */
|
|
7970
|
-
|
|
7971
|
-
}
|
|
8869
|
+
type: "connection.deleted";
|
|
8870
|
+
} | {
|
|
8871
|
+
data: components["schemas"]["ConnectionActivityParams"];
|
|
7972
8872
|
/** @constant */
|
|
7973
|
-
|
|
7974
|
-
}
|
|
8873
|
+
type: "connection.sync.started";
|
|
8874
|
+
} | {
|
|
8875
|
+
data: components["schemas"]["ConnectionActivityParams"];
|
|
7975
8876
|
/** @constant */
|
|
7976
|
-
|
|
7977
|
-
}
|
|
8877
|
+
type: "connection.sync.completed";
|
|
8878
|
+
} | {
|
|
8879
|
+
data: components["schemas"]["ConnectionActivityParams"];
|
|
7978
8880
|
/** @constant */
|
|
7979
|
-
|
|
7980
|
-
}
|
|
8881
|
+
type: "connection.sync.failed";
|
|
8882
|
+
} | {
|
|
8883
|
+
data: components["schemas"]["WebhookActivityParams"];
|
|
7981
8884
|
/** @constant */
|
|
7982
|
-
|
|
7983
|
-
}
|
|
8885
|
+
type: "webhook.created";
|
|
8886
|
+
} | {
|
|
8887
|
+
data: components["schemas"]["WebhookActivityParams"];
|
|
7984
8888
|
/** @constant */
|
|
7985
|
-
|
|
7986
|
-
}
|
|
8889
|
+
type: "webhook.updated";
|
|
8890
|
+
} | {
|
|
8891
|
+
data: components["schemas"]["WebhookActivityParams"];
|
|
7987
8892
|
/** @constant */
|
|
7988
|
-
|
|
7989
|
-
}
|
|
8893
|
+
type: "webhook.deleted";
|
|
8894
|
+
} | {
|
|
8895
|
+
data: components["schemas"]["FileActivityParams"];
|
|
7990
8896
|
/** @constant */
|
|
7991
|
-
|
|
7992
|
-
}
|
|
8897
|
+
type: "file.created";
|
|
8898
|
+
} | {
|
|
8899
|
+
data: components["schemas"]["FileActivityParams"];
|
|
7993
8900
|
/** @constant */
|
|
7994
|
-
|
|
7995
|
-
}
|
|
8901
|
+
type: "file.updated";
|
|
8902
|
+
} | {
|
|
8903
|
+
data: components["schemas"]["FileActivityParams"];
|
|
7996
8904
|
/** @constant */
|
|
7997
|
-
|
|
7998
|
-
}
|
|
8905
|
+
type: "file.deleted";
|
|
8906
|
+
} | {
|
|
8907
|
+
data: components["schemas"]["PipelineActivityParams"];
|
|
7999
8908
|
/** @constant */
|
|
8000
|
-
|
|
8001
|
-
}
|
|
8909
|
+
type: "pipeline.created";
|
|
8910
|
+
} | {
|
|
8911
|
+
data: components["schemas"]["PipelineActivityParams"];
|
|
8002
8912
|
/** @constant */
|
|
8003
|
-
|
|
8004
|
-
}
|
|
8913
|
+
type: "pipeline.updated";
|
|
8914
|
+
} | {
|
|
8915
|
+
data: components["schemas"]["PipelineActivityParams"];
|
|
8005
8916
|
/** @constant */
|
|
8006
|
-
|
|
8007
|
-
}
|
|
8917
|
+
type: "pipeline.deleted";
|
|
8918
|
+
} | {
|
|
8919
|
+
data: components["schemas"]["PipelineRunActivityParams"];
|
|
8008
8920
|
/** @constant */
|
|
8009
|
-
|
|
8010
|
-
}
|
|
8921
|
+
type: "pipeline.run.started";
|
|
8922
|
+
} | {
|
|
8923
|
+
data: components["schemas"]["PipelineRunActivityParams"];
|
|
8011
8924
|
/** @constant */
|
|
8012
|
-
|
|
8013
|
-
}
|
|
8925
|
+
type: "pipeline.run.analyzed";
|
|
8926
|
+
} | {
|
|
8927
|
+
data: components["schemas"]["PipelineRunActivityParams"];
|
|
8014
8928
|
/** @constant */
|
|
8015
|
-
|
|
8016
|
-
}
|
|
8929
|
+
type: "pipeline.run.completed";
|
|
8930
|
+
} | {
|
|
8931
|
+
data: components["schemas"]["PipelineRunActivityParams"];
|
|
8017
8932
|
/** @constant */
|
|
8018
|
-
|
|
8019
|
-
}
|
|
8933
|
+
type: "pipeline.run.failed";
|
|
8934
|
+
} | {
|
|
8935
|
+
data: components["schemas"]["PolicyActivityParams"];
|
|
8020
8936
|
/** @constant */
|
|
8021
|
-
|
|
8022
|
-
}
|
|
8937
|
+
type: "policy.created";
|
|
8938
|
+
} | {
|
|
8939
|
+
data: components["schemas"]["PolicyActivityParams"];
|
|
8023
8940
|
/** @constant */
|
|
8024
|
-
|
|
8025
|
-
}
|
|
8941
|
+
type: "policy.updated";
|
|
8942
|
+
} | {
|
|
8943
|
+
data: components["schemas"]["PolicyActivityParams"];
|
|
8026
8944
|
/** @constant */
|
|
8027
|
-
|
|
8028
|
-
}
|
|
8945
|
+
type: "policy.deleted";
|
|
8946
|
+
};
|
|
8947
|
+
/**
|
|
8948
|
+
* @description Defines the type of activity performed in a workspace for audit logging.
|
|
8949
|
+
*
|
|
8950
|
+
* This enumeration corresponds to the `ACTIVITY_TYPE` PostgreSQL enum and is used
|
|
8951
|
+
* to categorize different types of activities that occur within workspaces for comprehensive
|
|
8952
|
+
* audit trail and activity tracking.
|
|
8953
|
+
*/
|
|
8954
|
+
ActivityType: "workspace.created" | "workspace.updated" | "workspace.deleted" | "member.added" | "member.updated" | "member.deleted" | "invite.created" | "invite.accepted" | "invite.declined" | "invite.canceled" | "connection.created" | "connection.updated" | "connection.deleted" | "connection.sync.started" | "connection.sync.completed" | "connection.sync.failed" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "file.created" | "file.updated" | "file.deleted" | "pipeline.created" | "pipeline.updated" | "pipeline.deleted" | "pipeline.run.started" | "pipeline.run.analyzed" | "pipeline.run.completed" | "pipeline.run.failed" | "policy.created" | "policy.updated" | "policy.deleted";
|
|
8029
8955
|
/** @description Anthropic API credentials. */
|
|
8030
8956
|
AnthropicCredentials: {
|
|
8031
8957
|
/** @description Anthropic API key. */
|
|
@@ -8555,21 +9481,21 @@ interface components {
|
|
|
8555
9481
|
* audible but not painful, and never clips.
|
|
8556
9482
|
* @default 0.5
|
|
8557
9483
|
*/
|
|
8558
|
-
amplitude
|
|
9484
|
+
amplitude?: number;
|
|
8559
9485
|
/**
|
|
8560
9486
|
* Format: float
|
|
8561
9487
|
* @description Tone frequency in Hertz. Default 1 kHz, the broadcast
|
|
8562
9488
|
* convention.
|
|
8563
9489
|
* @default 1000
|
|
8564
9490
|
*/
|
|
8565
|
-
hz
|
|
9491
|
+
hz?: number;
|
|
8566
9492
|
/** @constant */
|
|
8567
9493
|
kind: "beep";
|
|
8568
9494
|
/**
|
|
8569
9495
|
* @description Tone shape. Default sine.
|
|
8570
9496
|
* @default sine
|
|
8571
9497
|
*/
|
|
8572
|
-
waveform
|
|
9498
|
+
waveform?: components["schemas"]["Waveform"];
|
|
8573
9499
|
};
|
|
8574
9500
|
/**
|
|
8575
9501
|
* @description What detection found in one document.
|
|
@@ -8624,6 +9550,18 @@ interface components {
|
|
|
8624
9550
|
parts?: {
|
|
8625
9551
|
[key: string]: components["schemas"]["EntityGroup"];
|
|
8626
9552
|
};
|
|
9553
|
+
/**
|
|
9554
|
+
* @description What the analyze pass cost: one entry per recognizer and
|
|
9555
|
+
* enricher that ran, each self-identifying by the name the
|
|
9556
|
+
* deployment configured it under.
|
|
9557
|
+
*
|
|
9558
|
+
* Empty when nothing model-backed ran, which is the common
|
|
9559
|
+
* case for a pattern-only pass. Recorded on analyze and not
|
|
9560
|
+
* re-derived at anonymize time, so a host that bills or rate
|
|
9561
|
+
* limits on model spend reads it straight off the returned
|
|
9562
|
+
* [`Audit`].
|
|
9563
|
+
*/
|
|
9564
|
+
usage?: components["schemas"]["UsageReport"];
|
|
8627
9565
|
};
|
|
8628
9566
|
/**
|
|
8629
9567
|
* @description Recognition-side facts that travel from analyze to anonymize.
|
|
@@ -8675,7 +9613,7 @@ interface components {
|
|
|
8675
9613
|
* time; anonymize re-uses them verbatim.
|
|
8676
9614
|
* @default []
|
|
8677
9615
|
*/
|
|
8678
|
-
languages
|
|
9616
|
+
languages?: components["schemas"]["Languages"];
|
|
8679
9617
|
/**
|
|
8680
9618
|
* @description Free-form request context: document tags, request purpose,
|
|
8681
9619
|
* output audience. See elide's [`ScopeMetadata`].
|
|
@@ -8692,7 +9630,7 @@ interface components {
|
|
|
8692
9630
|
* "kind": "auto"
|
|
8693
9631
|
* }
|
|
8694
9632
|
*/
|
|
8695
|
-
rasterMode
|
|
9633
|
+
rasterMode?: components["schemas"]["RasterMode"];
|
|
8696
9634
|
};
|
|
8697
9635
|
/**
|
|
8698
9636
|
* @description A 32-byte BLAKE3 digest.
|
|
@@ -8750,25 +9688,16 @@ interface components {
|
|
|
8750
9688
|
* responses.
|
|
8751
9689
|
*/
|
|
8752
9690
|
AzureCredentials: {
|
|
8753
|
-
/**
|
|
8754
|
-
|
|
8755
|
-
* @default null
|
|
8756
|
-
*/
|
|
8757
|
-
accessKey: string;
|
|
9691
|
+
/** @description Storage account access key. */
|
|
9692
|
+
accessKey?: string;
|
|
8758
9693
|
/** @description Azure storage account name. */
|
|
8759
9694
|
accountName: string;
|
|
8760
9695
|
/** @description Azure storage container name. */
|
|
8761
9696
|
container: string;
|
|
8762
|
-
/**
|
|
8763
|
-
|
|
8764
|
-
|
|
8765
|
-
|
|
8766
|
-
endpoint: string;
|
|
8767
|
-
/**
|
|
8768
|
-
* @description Shared Access Signature token.
|
|
8769
|
-
* @default null
|
|
8770
|
-
*/
|
|
8771
|
-
sasToken: string;
|
|
9697
|
+
/** @description Custom endpoint URL (for Azure Stack or Azurite). */
|
|
9698
|
+
endpoint?: string;
|
|
9699
|
+
/** @description Shared Access Signature token. */
|
|
9700
|
+
sasToken?: string;
|
|
8772
9701
|
};
|
|
8773
9702
|
/**
|
|
8774
9703
|
* @description Axis-aligned rectangle, given by its minimum and maximum corners.
|
|
@@ -8806,6 +9735,90 @@ interface components {
|
|
|
8806
9735
|
* [`tags`]: super::Label::tags
|
|
8807
9736
|
*/
|
|
8808
9737
|
Category: string;
|
|
9738
|
+
/** @description A single chat message. */
|
|
9739
|
+
ChatMessage: {
|
|
9740
|
+
/** @description Message text. */
|
|
9741
|
+
content: string;
|
|
9742
|
+
/**
|
|
9743
|
+
* Format: date-time
|
|
9744
|
+
* @description When the message was created.
|
|
9745
|
+
*/
|
|
9746
|
+
createdAt: string;
|
|
9747
|
+
/**
|
|
9748
|
+
* Format: uuid
|
|
9749
|
+
* @description Unique message identifier.
|
|
9750
|
+
*/
|
|
9751
|
+
id: string;
|
|
9752
|
+
/**
|
|
9753
|
+
* Format: uuid
|
|
9754
|
+
* @description Parent in the conversation tree; absent for a root.
|
|
9755
|
+
*/
|
|
9756
|
+
parentId?: string;
|
|
9757
|
+
/** @description Author of the message. */
|
|
9758
|
+
role: components["schemas"]["ChatRole"];
|
|
9759
|
+
};
|
|
9760
|
+
/**
|
|
9761
|
+
* @description The author of a chat message.
|
|
9762
|
+
*
|
|
9763
|
+
* Corresponds to the `CHAT_ROLE` PostgreSQL enum.
|
|
9764
|
+
*/
|
|
9765
|
+
ChatRole: "system" | "user" | "assistant";
|
|
9766
|
+
/** @description A chat session. */
|
|
9767
|
+
ChatSession: {
|
|
9768
|
+
/**
|
|
9769
|
+
* Format: date-time
|
|
9770
|
+
* @description When the session was created.
|
|
9771
|
+
*/
|
|
9772
|
+
createdAt: string;
|
|
9773
|
+
/**
|
|
9774
|
+
* Format: uuid
|
|
9775
|
+
* @description Active leaf of the message tree (the conversation's resume point).
|
|
9776
|
+
*/
|
|
9777
|
+
currentMessageId?: string;
|
|
9778
|
+
/**
|
|
9779
|
+
* Format: uuid
|
|
9780
|
+
* @description Unique session identifier.
|
|
9781
|
+
*/
|
|
9782
|
+
id: string;
|
|
9783
|
+
/** @description Human-readable title. */
|
|
9784
|
+
title: string;
|
|
9785
|
+
/**
|
|
9786
|
+
* Format: date-time
|
|
9787
|
+
* @description When the session was last active.
|
|
9788
|
+
*/
|
|
9789
|
+
updatedAt: string;
|
|
9790
|
+
};
|
|
9791
|
+
/**
|
|
9792
|
+
* @description Generic paginated response wrapper.
|
|
9793
|
+
*
|
|
9794
|
+
* Provides a consistent structure for all paginated API responses with
|
|
9795
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
9796
|
+
* are more items to fetch.
|
|
9797
|
+
*/
|
|
9798
|
+
ChatSessionPage: {
|
|
9799
|
+
/** @description Items in this page. */
|
|
9800
|
+
items: components["schemas"]["ChatSession"][];
|
|
9801
|
+
/** @description Cursor to fetch the next page. Present only when more items exist. */
|
|
9802
|
+
nextCursor?: string;
|
|
9803
|
+
/**
|
|
9804
|
+
* Format: int64
|
|
9805
|
+
* @description Total count of items matching the query (if requested).
|
|
9806
|
+
*/
|
|
9807
|
+
total?: number;
|
|
9808
|
+
};
|
|
9809
|
+
/** @description Path parameters for a chat session. */
|
|
9810
|
+
ChatSessionPathParams: {
|
|
9811
|
+
/**
|
|
9812
|
+
* Format: uuid
|
|
9813
|
+
* @description The session id.
|
|
9814
|
+
*/
|
|
9815
|
+
sessionId: string;
|
|
9816
|
+
};
|
|
9817
|
+
/** @description One streamed chunk of the assistant's reply. */
|
|
9818
|
+
ChatToken: {
|
|
9819
|
+
/** @description The text delta. */
|
|
9820
|
+
delta: string;
|
|
9821
|
+
};
|
|
8809
9822
|
/**
|
|
8810
9823
|
* @description Text a [`TextRedaction::Clamp`] emits for out-of-range values.
|
|
8811
9824
|
*
|
|
@@ -8913,6 +9926,8 @@ interface components {
|
|
|
8913
9926
|
isActive: boolean;
|
|
8914
9927
|
/** @description Provider identifier (`s3`, `azure`, `gcs`, `openai`, `ollama`, ...). */
|
|
8915
9928
|
provider: string;
|
|
9929
|
+
/** @description Capability category of the provider (object store, language model, ...). */
|
|
9930
|
+
providerType: components["schemas"]["ProviderType"];
|
|
8916
9931
|
/** @description Sync configuration; present only for sync-capable connections. */
|
|
8917
9932
|
sync?: components["schemas"]["SyncSchedule"];
|
|
8918
9933
|
/**
|
|
@@ -8925,11 +9940,10 @@ interface components {
|
|
|
8925
9940
|
};
|
|
8926
9941
|
/** @description Params of a connection activity (`connection.*`). */
|
|
8927
9942
|
ConnectionActivityParams: {
|
|
8928
|
-
/**
|
|
8929
|
-
|
|
8930
|
-
|
|
8931
|
-
|
|
8932
|
-
connectionId: string;
|
|
9943
|
+
/** @description Id of the connection. */
|
|
9944
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
9945
|
+
/** @description Display name of the connection. */
|
|
9946
|
+
connectionName: string;
|
|
8933
9947
|
};
|
|
8934
9948
|
/**
|
|
8935
9949
|
* @description A fully-typed connection configuration for any capability.
|
|
@@ -9010,11 +10024,10 @@ interface components {
|
|
|
9010
10024
|
};
|
|
9011
10025
|
/** @description Params of a `connection.sync.completed` notification. */
|
|
9012
10026
|
ConnectionSyncCompletedParams: {
|
|
9013
|
-
/**
|
|
9014
|
-
|
|
9015
|
-
|
|
9016
|
-
|
|
9017
|
-
connectionId: string;
|
|
10027
|
+
/** @description Id of the connection that synced. */
|
|
10028
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
10029
|
+
/** @description Display name of the connection that synced. */
|
|
10030
|
+
connectionName: string;
|
|
9018
10031
|
/**
|
|
9019
10032
|
* Format: int64
|
|
9020
10033
|
* @description Number of records synced, if known.
|
|
@@ -9023,11 +10036,10 @@ interface components {
|
|
|
9023
10036
|
};
|
|
9024
10037
|
/** @description Params of a `connection.sync.failed` notification. */
|
|
9025
10038
|
ConnectionSyncFailedParams: {
|
|
9026
|
-
/**
|
|
9027
|
-
|
|
9028
|
-
|
|
9029
|
-
|
|
9030
|
-
connectionId: string;
|
|
10039
|
+
/** @description Id of the connection that failed to sync. */
|
|
10040
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
10041
|
+
/** @description Display name of the connection that failed to sync. */
|
|
10042
|
+
connectionName: string;
|
|
9031
10043
|
/** @description Failure reason, if available. */
|
|
9032
10044
|
error?: string;
|
|
9033
10045
|
};
|
|
@@ -9073,7 +10085,7 @@ interface components {
|
|
|
9073
10085
|
* matches if it uses any of the given providers. Empty means no filter.
|
|
9074
10086
|
* @default []
|
|
9075
10087
|
*/
|
|
9076
|
-
provider
|
|
10088
|
+
provider?: string[];
|
|
9077
10089
|
};
|
|
9078
10090
|
/**
|
|
9079
10091
|
* @description [ISO 3166-1] country, identified by its code.
|
|
@@ -9098,6 +10110,11 @@ interface components {
|
|
|
9098
10110
|
/** @description When the token expires. */
|
|
9099
10111
|
expiresIn: components["schemas"]["TokenExpiration"];
|
|
9100
10112
|
};
|
|
10113
|
+
/** @description Request to create a chat session. */
|
|
10114
|
+
CreateChatSession: {
|
|
10115
|
+
/** @description Optional title. Defaults to a title seeded from the first message. */
|
|
10116
|
+
title?: string;
|
|
10117
|
+
};
|
|
9101
10118
|
/** @description Request payload for creating a new workspace connection. */
|
|
9102
10119
|
CreateConnection: {
|
|
9103
10120
|
/**
|
|
@@ -9263,6 +10280,13 @@ interface components {
|
|
|
9263
10280
|
* Obtain this from the `nextCursor` field in the response.
|
|
9264
10281
|
*/
|
|
9265
10282
|
after?: string;
|
|
10283
|
+
/**
|
|
10284
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
10285
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
10286
|
+
* only when the count is actually needed.
|
|
10287
|
+
* @default false
|
|
10288
|
+
*/
|
|
10289
|
+
includeCount?: boolean;
|
|
9266
10290
|
/**
|
|
9267
10291
|
* Format: uint32
|
|
9268
10292
|
* @description The maximum number of records to return (1-100, default: 20).
|
|
@@ -9287,6 +10311,24 @@ interface components {
|
|
|
9287
10311
|
* author, who knows the corpus's convention, sets it.
|
|
9288
10312
|
*/
|
|
9289
10313
|
DateStyle: "iso" | "us";
|
|
10314
|
+
/**
|
|
10315
|
+
* @description A `from`/`to` day range (inclusive), both optional. Flatten it into an
|
|
10316
|
+
* endpoint's query struct with `#[serde(flatten)]`, or use it directly when the
|
|
10317
|
+
* range is the only parameter.
|
|
10318
|
+
*/
|
|
10319
|
+
DateWindow: {
|
|
10320
|
+
/**
|
|
10321
|
+
* Format: date
|
|
10322
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
10323
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
10324
|
+
*/
|
|
10325
|
+
from?: string;
|
|
10326
|
+
/**
|
|
10327
|
+
* Format: date
|
|
10328
|
+
* @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC).
|
|
10329
|
+
*/
|
|
10330
|
+
to?: string;
|
|
10331
|
+
};
|
|
9290
10332
|
/**
|
|
9291
10333
|
* @description Pixel dimensions of an image or any 2-D canvas.
|
|
9292
10334
|
*
|
|
@@ -9387,6 +10429,17 @@ interface components {
|
|
|
9387
10429
|
/** @description Validation error details for field-specific errors */
|
|
9388
10430
|
validation?: components["schemas"]["ValidationErrorDetail"][];
|
|
9389
10431
|
};
|
|
10432
|
+
/** @description The file format an export is rendered as. */
|
|
10433
|
+
ExportFormat: "csv" | "json";
|
|
10434
|
+
/**
|
|
10435
|
+
* @description Query parameters for an export whose only choice is the output format. Used by
|
|
10436
|
+
* endpoints that already scope their data another way (e.g. by path), so the
|
|
10437
|
+
* format is all the query carries.
|
|
10438
|
+
*/
|
|
10439
|
+
ExportQuery: {
|
|
10440
|
+
/** @description Output format; defaults to `csv`. */
|
|
10441
|
+
format?: components["schemas"]["ExportFormat"];
|
|
10442
|
+
};
|
|
9390
10443
|
/** @description Represents a file in responses. */
|
|
9391
10444
|
File: {
|
|
9392
10445
|
/**
|
|
@@ -9484,21 +10537,12 @@ interface components {
|
|
|
9484
10537
|
GcsCredentials: {
|
|
9485
10538
|
/** @description GCS bucket name. */
|
|
9486
10539
|
bucket: string;
|
|
9487
|
-
/**
|
|
9488
|
-
|
|
9489
|
-
|
|
9490
|
-
|
|
9491
|
-
|
|
9492
|
-
|
|
9493
|
-
* @description Inline service account key JSON (the file contents, not a path).
|
|
9494
|
-
* @default null
|
|
9495
|
-
*/
|
|
9496
|
-
serviceAccountKeyJson: string;
|
|
9497
|
-
/**
|
|
9498
|
-
* @description Path to a service account key JSON file on the local filesystem.
|
|
9499
|
-
* @default null
|
|
9500
|
-
*/
|
|
9501
|
-
serviceAccountPath: string;
|
|
10540
|
+
/** @description Custom endpoint URL (for testing with a fake GCS server). */
|
|
10541
|
+
endpoint?: string;
|
|
10542
|
+
/** @description Inline service account key JSON (the file contents, not a path). */
|
|
10543
|
+
serviceAccountKeyJson?: string;
|
|
10544
|
+
/** @description Path to a service account key JSON file on the local filesystem. */
|
|
10545
|
+
serviceAccountPath?: string;
|
|
9502
10546
|
};
|
|
9503
10547
|
/**
|
|
9504
10548
|
* @description Which operator to apply to Article 9 special-category entities.
|
|
@@ -10009,7 +11053,7 @@ interface components {
|
|
|
10009
11053
|
* Larger is blurrier (and harder to reverse).
|
|
10010
11054
|
* @default 16
|
|
10011
11055
|
*/
|
|
10012
|
-
sigma
|
|
11056
|
+
sigma?: number;
|
|
10013
11057
|
} | {
|
|
10014
11058
|
/**
|
|
10015
11059
|
* Format: uint32
|
|
@@ -10017,7 +11061,7 @@ interface components {
|
|
|
10017
11061
|
* blocks are coarser (and harder to reverse).
|
|
10018
11062
|
* @default 16
|
|
10019
11063
|
*/
|
|
10020
|
-
block_size
|
|
11064
|
+
block_size?: number;
|
|
10021
11065
|
/** @constant */
|
|
10022
11066
|
kind: "pixelate";
|
|
10023
11067
|
} | {
|
|
@@ -10029,7 +11073,7 @@ interface components {
|
|
|
10029
11073
|
* "r": 0
|
|
10030
11074
|
* }
|
|
10031
11075
|
*/
|
|
10032
|
-
color
|
|
11076
|
+
color?: components["schemas"]["Color"];
|
|
10033
11077
|
/** @constant */
|
|
10034
11078
|
kind: "blackbox";
|
|
10035
11079
|
};
|
|
@@ -10074,8 +11118,11 @@ interface components {
|
|
|
10074
11118
|
};
|
|
10075
11119
|
/** @description Params of an invite activity (`invite.*`). */
|
|
10076
11120
|
InviteActivityParams: {
|
|
10077
|
-
/**
|
|
10078
|
-
|
|
11121
|
+
/**
|
|
11122
|
+
* @description Email the invite was addressed to, when it recorded one. `None` keeps an
|
|
11123
|
+
* absent address distinct from a blank one.
|
|
11124
|
+
*/
|
|
11125
|
+
email?: string;
|
|
10079
11126
|
/**
|
|
10080
11127
|
* Format: uuid
|
|
10081
11128
|
* @description Id of the invite.
|
|
@@ -10514,7 +11561,7 @@ interface components {
|
|
|
10514
11561
|
* @description Whether to remember this device for extended session. Defaults to false.
|
|
10515
11562
|
* @default false
|
|
10516
11563
|
*/
|
|
10517
|
-
rememberMe
|
|
11564
|
+
rememberMe?: boolean;
|
|
10518
11565
|
};
|
|
10519
11566
|
/** @description Response type for a mark-all-read action. */
|
|
10520
11567
|
MarkedReadStatus: {
|
|
@@ -10552,16 +11599,16 @@ interface components {
|
|
|
10552
11599
|
/** @description Params of a `member.invited` notification. */
|
|
10553
11600
|
MemberInvitedParams: {
|
|
10554
11601
|
/** @description Username of the account that sent the invite, if known. */
|
|
10555
|
-
invitedBy?:
|
|
11602
|
+
invitedBy?: components["schemas"]["Handle"];
|
|
10556
11603
|
/** @description Slug of the workspace the account was invited to. */
|
|
10557
|
-
workspaceSlug:
|
|
11604
|
+
workspaceSlug: components["schemas"]["Handle"];
|
|
10558
11605
|
};
|
|
10559
11606
|
/** @description Params of a `member.joined` notification. */
|
|
10560
11607
|
MemberJoinedParams: {
|
|
10561
11608
|
/** @description Username of the member that joined. */
|
|
10562
|
-
memberUsername:
|
|
11609
|
+
memberUsername: components["schemas"]["Handle"];
|
|
10563
11610
|
/** @description Slug of the workspace the member joined. */
|
|
10564
|
-
workspaceSlug:
|
|
11611
|
+
workspaceSlug: components["schemas"]["Handle"];
|
|
10565
11612
|
};
|
|
10566
11613
|
/**
|
|
10567
11614
|
* @description Generic paginated response wrapper.
|
|
@@ -10623,6 +11670,39 @@ interface components {
|
|
|
10623
11670
|
/** @description Model version string, when known. */
|
|
10624
11671
|
version?: string;
|
|
10625
11672
|
};
|
|
11673
|
+
/**
|
|
11674
|
+
* @description Model detail for a model-backed recognizer or enricher: which model it
|
|
11675
|
+
* called and the tokens that cost. Absent from a pure-CPU component (a
|
|
11676
|
+
* pattern recognizer, a language enricher).
|
|
11677
|
+
*/
|
|
11678
|
+
ModelUsage: {
|
|
11679
|
+
/** @description Model name the backend called (e.g. `"gpt-4o"`, `"gliner-multi"`). */
|
|
11680
|
+
model: string;
|
|
11681
|
+
/** @description Tokens the call spent, as far as the provider reports them. */
|
|
11682
|
+
tokens?: components["schemas"]["TokenCounts"];
|
|
11683
|
+
/** @description Model version, when the backend reports one. */
|
|
11684
|
+
version?: string;
|
|
11685
|
+
};
|
|
11686
|
+
/** @description One model's token usage across a workspace's runs. */
|
|
11687
|
+
ModelUsageEntry: {
|
|
11688
|
+
/**
|
|
11689
|
+
* Format: int64
|
|
11690
|
+
* @description Input/prompt tokens summed for this model (`0` if never reported).
|
|
11691
|
+
*/
|
|
11692
|
+
inputTokens: number;
|
|
11693
|
+
/** @description The model. */
|
|
11694
|
+
model: string;
|
|
11695
|
+
/**
|
|
11696
|
+
* Format: int64
|
|
11697
|
+
* @description Output/completion tokens summed for this model (`0` if never reported).
|
|
11698
|
+
*/
|
|
11699
|
+
outputTokens: number;
|
|
11700
|
+
/**
|
|
11701
|
+
* Format: int64
|
|
11702
|
+
* @description Reported total tokens summed for this model (`0` if never reported).
|
|
11703
|
+
*/
|
|
11704
|
+
totalTokens: number;
|
|
11705
|
+
};
|
|
10626
11706
|
/**
|
|
10627
11707
|
* @description Response type for an account notification.
|
|
10628
11708
|
*
|
|
@@ -10664,7 +11744,7 @@ interface components {
|
|
|
10664
11744
|
* The values mirror the [`WebhookEvent`](super::WebhookEvent) naming for the
|
|
10665
11745
|
* events the two channels share.
|
|
10666
11746
|
*/
|
|
10667
|
-
NotificationEvent: "member.invited" | "member.joined" | "connection.sync.completed" | "connection.sync.failed" | "pipeline.run.analyzed" | "pipeline.run.completed" | "pipeline.run.failed"
|
|
11747
|
+
NotificationEvent: "member.invited" | "member.joined" | "connection.sync.completed" | "connection.sync.failed" | "pipeline.run.analyzed" | "pipeline.run.completed" | "pipeline.run.failed";
|
|
10668
11748
|
/**
|
|
10669
11749
|
* @description Generic paginated response wrapper.
|
|
10670
11750
|
*
|
|
@@ -10697,40 +11777,42 @@ interface components {
|
|
|
10697
11777
|
notificationId: string;
|
|
10698
11778
|
};
|
|
10699
11779
|
/**
|
|
10700
|
-
* @description The typed payload of a notification, tagged by `
|
|
11780
|
+
* @description The typed payload of a notification, tagged by `type` with its params under
|
|
11781
|
+
* `data` (the same `{type, data}` envelope the activity log and outbox event use).
|
|
10701
11782
|
*
|
|
10702
11783
|
* Each variant is one notification type carrying its own params struct. The
|
|
10703
|
-
* `
|
|
10704
|
-
*
|
|
11784
|
+
* `type` values match `NotificationEvent`, so the same key drives the member's
|
|
11785
|
+
* per-event preferences.
|
|
10705
11786
|
*/
|
|
10706
|
-
NotificationPayload:
|
|
10707
|
-
|
|
10708
|
-
notifyType: "member.invited";
|
|
10709
|
-
} & components["schemas"]["MemberInvitedParams"]) | ({
|
|
10710
|
-
/** @constant */
|
|
10711
|
-
notifyType: "member.joined";
|
|
10712
|
-
} & components["schemas"]["MemberJoinedParams"]) | ({
|
|
11787
|
+
NotificationPayload: {
|
|
11788
|
+
data: components["schemas"]["MemberInvitedParams"];
|
|
10713
11789
|
/** @constant */
|
|
10714
|
-
|
|
10715
|
-
}
|
|
11790
|
+
type: "member.invited";
|
|
11791
|
+
} | {
|
|
11792
|
+
data: components["schemas"]["MemberJoinedParams"];
|
|
10716
11793
|
/** @constant */
|
|
10717
|
-
|
|
10718
|
-
}
|
|
11794
|
+
type: "member.joined";
|
|
11795
|
+
} | {
|
|
11796
|
+
data: components["schemas"]["ConnectionSyncCompletedParams"];
|
|
10719
11797
|
/** @constant */
|
|
10720
|
-
|
|
10721
|
-
}
|
|
11798
|
+
type: "connection.sync.completed";
|
|
11799
|
+
} | {
|
|
11800
|
+
data: components["schemas"]["ConnectionSyncFailedParams"];
|
|
10722
11801
|
/** @constant */
|
|
10723
|
-
|
|
10724
|
-
}
|
|
11802
|
+
type: "connection.sync.failed";
|
|
11803
|
+
} | {
|
|
11804
|
+
data: components["schemas"]["PipelineRunAnalyzedParams"];
|
|
10725
11805
|
/** @constant */
|
|
10726
|
-
|
|
10727
|
-
}
|
|
11806
|
+
type: "pipeline.run.analyzed";
|
|
11807
|
+
} | {
|
|
11808
|
+
data: components["schemas"]["PipelineRunCompletedParams"];
|
|
10728
11809
|
/** @constant */
|
|
10729
|
-
|
|
10730
|
-
}
|
|
11810
|
+
type: "pipeline.run.completed";
|
|
11811
|
+
} | {
|
|
11812
|
+
data: components["schemas"]["PipelineRunFailedParams"];
|
|
10731
11813
|
/** @constant */
|
|
10732
|
-
|
|
10733
|
-
}
|
|
11814
|
+
type: "pipeline.run.failed";
|
|
11815
|
+
};
|
|
10734
11816
|
/** @description Response for notification settings within a workspace. */
|
|
10735
11817
|
NotificationSettings: {
|
|
10736
11818
|
/** @description Notification events to receive in-app. */
|
|
@@ -10986,35 +12068,26 @@ interface components {
|
|
|
10986
12068
|
PipelineRunActivityParams: {
|
|
10987
12069
|
/** @description Slug of the owning pipeline. */
|
|
10988
12070
|
pipelineSlug: components["schemas"]["Handle"];
|
|
10989
|
-
/**
|
|
10990
|
-
|
|
10991
|
-
* @description Id of the run.
|
|
10992
|
-
*/
|
|
10993
|
-
runId: string;
|
|
12071
|
+
/** @description Id of the run. */
|
|
12072
|
+
runId: components["schemas"]["RunId"];
|
|
10994
12073
|
};
|
|
10995
12074
|
/** @description Params of a `pipeline.run.analyzed` notification. */
|
|
10996
12075
|
PipelineRunAnalyzedParams: {
|
|
10997
12076
|
/** @description Display name of the analyzed file, if known. */
|
|
10998
12077
|
inputFileName?: string;
|
|
10999
12078
|
/** @description Slug of the owning pipeline. */
|
|
11000
|
-
pipelineSlug:
|
|
11001
|
-
/**
|
|
11002
|
-
|
|
11003
|
-
* @description Id of the run.
|
|
11004
|
-
*/
|
|
11005
|
-
runId: string;
|
|
12079
|
+
pipelineSlug: components["schemas"]["Handle"];
|
|
12080
|
+
/** @description Id of the run. */
|
|
12081
|
+
runId: components["schemas"]["RunId"];
|
|
11006
12082
|
};
|
|
11007
12083
|
/** @description Params of a `pipeline.run.completed` notification. */
|
|
11008
12084
|
PipelineRunCompletedParams: {
|
|
11009
12085
|
/** @description Display name of the analyzed file, if known. */
|
|
11010
12086
|
inputFileName?: string;
|
|
11011
12087
|
/** @description Slug of the owning pipeline. */
|
|
11012
|
-
pipelineSlug:
|
|
11013
|
-
/**
|
|
11014
|
-
|
|
11015
|
-
* @description Id of the run.
|
|
11016
|
-
*/
|
|
11017
|
-
runId: string;
|
|
12088
|
+
pipelineSlug: components["schemas"]["Handle"];
|
|
12089
|
+
/** @description Id of the run. */
|
|
12090
|
+
runId: components["schemas"]["RunId"];
|
|
11018
12091
|
};
|
|
11019
12092
|
/** @description Params of a `pipeline.run.failed` notification. */
|
|
11020
12093
|
PipelineRunFailedParams: {
|
|
@@ -11023,12 +12096,9 @@ interface components {
|
|
|
11023
12096
|
/** @description Display name of the analyzed file, if known. */
|
|
11024
12097
|
inputFileName?: string;
|
|
11025
12098
|
/** @description Slug of the owning pipeline. */
|
|
11026
|
-
pipelineSlug:
|
|
11027
|
-
/**
|
|
11028
|
-
|
|
11029
|
-
* @description Id of the run.
|
|
11030
|
-
*/
|
|
11031
|
-
runId: string;
|
|
12099
|
+
pipelineSlug: components["schemas"]["Handle"];
|
|
12100
|
+
/** @description Id of the run. */
|
|
12101
|
+
runId: components["schemas"]["RunId"];
|
|
11032
12102
|
};
|
|
11033
12103
|
/**
|
|
11034
12104
|
* @description Generic paginated response wrapper.
|
|
@@ -11196,6 +12266,8 @@ interface components {
|
|
|
11196
12266
|
* @description Id of the policy.
|
|
11197
12267
|
*/
|
|
11198
12268
|
policyId: string;
|
|
12269
|
+
/** @description Slug of the policy. */
|
|
12270
|
+
policySlug: components["schemas"]["Handle"];
|
|
11199
12271
|
};
|
|
11200
12272
|
/**
|
|
11201
12273
|
* @description A named governance policy.
|
|
@@ -11439,7 +12511,7 @@ interface components {
|
|
|
11439
12511
|
* addresses under the §(R) catch-all reading.
|
|
11440
12512
|
* @default standard
|
|
11441
12513
|
*/
|
|
11442
|
-
accounts
|
|
12514
|
+
accounts?: components["schemas"]["HipaaAccountNumbers"];
|
|
11443
12515
|
/** @constant */
|
|
11444
12516
|
kind: "hipaa_deidentification";
|
|
11445
12517
|
/**
|
|
@@ -11460,7 +12532,7 @@ interface components {
|
|
|
11460
12532
|
* Article 10 criminal-justice data.
|
|
11461
12533
|
* @default article9
|
|
11462
12534
|
*/
|
|
11463
|
-
scope
|
|
12535
|
+
scope?: components["schemas"]["GdprSensitiveScope"];
|
|
11464
12536
|
/**
|
|
11465
12537
|
* @description Which operator to apply to matches. See
|
|
11466
12538
|
* [`GdprArticle9Treatment`] for the tradeoff.
|
|
@@ -11539,6 +12611,16 @@ interface components {
|
|
|
11539
12611
|
/** @description Negated predicate. */
|
|
11540
12612
|
not: components["schemas"]["Predicate"];
|
|
11541
12613
|
};
|
|
12614
|
+
/**
|
|
12615
|
+
* @description The capability category of a connection's provider.
|
|
12616
|
+
*
|
|
12617
|
+
* Corresponds to the `PROVIDER_TYPE` PostgreSQL enum. A stable, closed set:
|
|
12618
|
+
* the concrete provider (the `provider` column, e.g. `s3` or `anthropic`) stays
|
|
12619
|
+
* open and extensible, while its capability is one of these types. Lets a
|
|
12620
|
+
* connection be found by what it can do — e.g. a workspace's language model —
|
|
12621
|
+
* without decrypting its config.
|
|
12622
|
+
*/
|
|
12623
|
+
ProviderType: "object_store" | "language_model";
|
|
11542
12624
|
/**
|
|
11543
12625
|
* @description Public view of an account, returned when looking up someone other than the
|
|
11544
12626
|
* authenticated caller. Carries only the fields safe to share with a
|
|
@@ -11598,6 +12680,22 @@ interface components {
|
|
|
11598
12680
|
/** @description NER (named-entity recognition) recognizers. */
|
|
11599
12681
|
ner: components["schemas"]["RegisteredRecognizer"][];
|
|
11600
12682
|
};
|
|
12683
|
+
/**
|
|
12684
|
+
* @description Identifies a recognizer (name + version).
|
|
12685
|
+
*
|
|
12686
|
+
* Pairs a stable name with a free-form version string so the audit
|
|
12687
|
+
* trail records not just *which* recognizer fired but *which build* of
|
|
12688
|
+
* it: a rerun against an updated ruleset or model is then
|
|
12689
|
+
* distinguishable from the original. The version is opaque text (a
|
|
12690
|
+
* semver, a checkpoint hash, a ruleset date); the core attaches no
|
|
12691
|
+
* ordering or comparison semantics to it.
|
|
12692
|
+
*/
|
|
12693
|
+
RecognizerId: {
|
|
12694
|
+
/** @description Stable, human-readable recognizer name (e.g. `"us-ssn-pattern"`). */
|
|
12695
|
+
name: string;
|
|
12696
|
+
/** @description Recognizer's version at the time it ran. */
|
|
12697
|
+
version: string;
|
|
12698
|
+
};
|
|
11601
12699
|
/**
|
|
11602
12700
|
* @description Public view of one recognizer in the engine's NER or LLM
|
|
11603
12701
|
* lineup.
|
|
@@ -11669,16 +12767,10 @@ interface components {
|
|
|
11669
12767
|
* override and always follow the workspace baseline.
|
|
11670
12768
|
*/
|
|
11671
12769
|
RetentionOverride: {
|
|
11672
|
-
/**
|
|
11673
|
-
|
|
11674
|
-
|
|
11675
|
-
|
|
11676
|
-
auditLogs: components["schemas"]["Retention"];
|
|
11677
|
-
/**
|
|
11678
|
-
* @description Overrides redacted-document retention when set.
|
|
11679
|
-
* @default null
|
|
11680
|
-
*/
|
|
11681
|
-
redactedDocuments: components["schemas"]["Retention"];
|
|
12770
|
+
/** @description Overrides audit-blob retention when set. */
|
|
12771
|
+
auditLogs?: components["schemas"]["Retention"];
|
|
12772
|
+
/** @description Overrides redacted-document retention when set. */
|
|
12773
|
+
redactedDocuments?: components["schemas"]["Retention"];
|
|
11682
12774
|
};
|
|
11683
12775
|
/**
|
|
11684
12776
|
* @description Retention for every scope. Missing fields default to [`Retention::Forever`],
|
|
@@ -11691,21 +12783,21 @@ interface components {
|
|
|
11691
12783
|
* "mode": "forever"
|
|
11692
12784
|
* }
|
|
11693
12785
|
*/
|
|
11694
|
-
auditLogs
|
|
12786
|
+
auditLogs?: components["schemas"]["Retention"];
|
|
11695
12787
|
/**
|
|
11696
12788
|
* @description Retention for uploaded/imported source documents.
|
|
11697
12789
|
* @default {
|
|
11698
12790
|
* "mode": "forever"
|
|
11699
12791
|
* }
|
|
11700
12792
|
*/
|
|
11701
|
-
originalDocuments
|
|
12793
|
+
originalDocuments?: components["schemas"]["Retention"];
|
|
11702
12794
|
/**
|
|
11703
12795
|
* @description Retention for generated redacted documents.
|
|
11704
12796
|
* @default {
|
|
11705
12797
|
* "mode": "forever"
|
|
11706
12798
|
* }
|
|
11707
12799
|
*/
|
|
11708
|
-
redactedDocuments
|
|
12800
|
+
redactedDocuments?: components["schemas"]["Retention"];
|
|
11709
12801
|
};
|
|
11710
12802
|
/**
|
|
11711
12803
|
* @description A reviewer-supplied redaction override with the policy
|
|
@@ -11760,6 +12852,80 @@ interface components {
|
|
|
11760
12852
|
} | {
|
|
11761
12853
|
tag: string;
|
|
11762
12854
|
} | "predicate" | "fallback";
|
|
12855
|
+
/** @description Pipeline-run health for a workspace. */
|
|
12856
|
+
RunAnalytics: {
|
|
12857
|
+
/**
|
|
12858
|
+
* Format: int64
|
|
12859
|
+
* @description Mean completed-run duration in milliseconds; omitted until a run completes.
|
|
12860
|
+
*/
|
|
12861
|
+
avgDurationMs?: number;
|
|
12862
|
+
/**
|
|
12863
|
+
* @description Per-status breakdown, one entry per run status (zero-filled), in a stable
|
|
12864
|
+
* order.
|
|
12865
|
+
*/
|
|
12866
|
+
byStatus: components["schemas"]["RunStatusEntry"][];
|
|
12867
|
+
/**
|
|
12868
|
+
* Format: double
|
|
12869
|
+
* @description Failed / (completed + failed). Omitted when no run has reached a terminal
|
|
12870
|
+
* state (genuinely no signal, not zero).
|
|
12871
|
+
*/
|
|
12872
|
+
errorRate?: number;
|
|
12873
|
+
/**
|
|
12874
|
+
* Format: int64
|
|
12875
|
+
* @description 95th-percentile completed-run duration in milliseconds; omitted until a run
|
|
12876
|
+
* completes.
|
|
12877
|
+
*/
|
|
12878
|
+
p95DurationMs?: number;
|
|
12879
|
+
/**
|
|
12880
|
+
* Format: int64
|
|
12881
|
+
* @description Total number of runs.
|
|
12882
|
+
*/
|
|
12883
|
+
total: number;
|
|
12884
|
+
};
|
|
12885
|
+
/** @description A single day of run activity. */
|
|
12886
|
+
RunDayEntry: {
|
|
12887
|
+
/**
|
|
12888
|
+
* Format: int64
|
|
12889
|
+
* @description Mean completed-run duration (milliseconds) this day; omitted if none completed.
|
|
12890
|
+
*/
|
|
12891
|
+
avgDurationMs?: number;
|
|
12892
|
+
/**
|
|
12893
|
+
* Format: date
|
|
12894
|
+
* @description The day (`YYYY-MM-DD`, UTC).
|
|
12895
|
+
*/
|
|
12896
|
+
date: string;
|
|
12897
|
+
/**
|
|
12898
|
+
* Format: double
|
|
12899
|
+
* @description Failed / (completed + failed) for this day; omitted when no run reached a
|
|
12900
|
+
* terminal state that day.
|
|
12901
|
+
*/
|
|
12902
|
+
errorRate?: number;
|
|
12903
|
+
/**
|
|
12904
|
+
* Format: int64
|
|
12905
|
+
* @description Input/prompt tokens spent by this day's runs; omitted when none used a model.
|
|
12906
|
+
*/
|
|
12907
|
+
inputTokens?: number;
|
|
12908
|
+
/**
|
|
12909
|
+
* Format: int64
|
|
12910
|
+
* @description Output/completion tokens spent this day; omitted when none used a model.
|
|
12911
|
+
*/
|
|
12912
|
+
outputTokens?: number;
|
|
12913
|
+
/**
|
|
12914
|
+
* Format: int64
|
|
12915
|
+
* @description 95th-percentile completed-run duration (milliseconds) this day; omitted if none.
|
|
12916
|
+
*/
|
|
12917
|
+
p95DurationMs?: number;
|
|
12918
|
+
/**
|
|
12919
|
+
* Format: int64
|
|
12920
|
+
* @description Runs started this day (`0` on a quiet day).
|
|
12921
|
+
*/
|
|
12922
|
+
runs: number;
|
|
12923
|
+
/**
|
|
12924
|
+
* Format: int64
|
|
12925
|
+
* @description Reported total tokens this day; omitted when none used a model.
|
|
12926
|
+
*/
|
|
12927
|
+
totalTokens?: number;
|
|
12928
|
+
};
|
|
11763
12929
|
/** @description Opaque run identifier (run_<uuid>). */
|
|
11764
12930
|
RunId: string;
|
|
11765
12931
|
/** @description Structured metadata for a pipeline run. */
|
|
@@ -11768,6 +12934,23 @@ interface components {
|
|
|
11768
12934
|
error?: string;
|
|
11769
12935
|
/** @description Free-form labels attached to the run. */
|
|
11770
12936
|
tags?: string[];
|
|
12937
|
+
/**
|
|
12938
|
+
* @description The engine's full per-recognizer usage report (durations, per-model token
|
|
12939
|
+
* counts), stored opaquely for drill-down. Per-model token totals for
|
|
12940
|
+
* aggregation live in the `workspace_pipeline_run_usage` table; this keeps
|
|
12941
|
+
* the detail. Absent when the run produced no usage.
|
|
12942
|
+
*/
|
|
12943
|
+
usage?: unknown;
|
|
12944
|
+
};
|
|
12945
|
+
/** @description One status's share of a workspace's runs. */
|
|
12946
|
+
RunStatusEntry: {
|
|
12947
|
+
/**
|
|
12948
|
+
* Format: int64
|
|
12949
|
+
* @description Number of runs in this status.
|
|
12950
|
+
*/
|
|
12951
|
+
count: number;
|
|
12952
|
+
/** @description The run status. */
|
|
12953
|
+
status: components["schemas"]["PipelineRunStatus"];
|
|
11771
12954
|
};
|
|
11772
12955
|
/**
|
|
11773
12956
|
* @description A run's status change, broadcast on the core-NATS subject [`run_subject`].
|
|
@@ -11784,6 +12967,14 @@ interface components {
|
|
|
11784
12967
|
/** @description The run's new status. */
|
|
11785
12968
|
status: components["schemas"]["PipelineRunStatus"];
|
|
11786
12969
|
};
|
|
12970
|
+
/**
|
|
12971
|
+
* @description A workspace's daily run activity over a window: one point per day, dense
|
|
12972
|
+
* (quiet days included with `runs: 0`), ready to plot as a continuous series.
|
|
12973
|
+
*/
|
|
12974
|
+
RunTimeSeries: {
|
|
12975
|
+
/** @description One entry per day in the requested window, oldest first. */
|
|
12976
|
+
points: components["schemas"]["RunDayEntry"][];
|
|
12977
|
+
};
|
|
11787
12978
|
/**
|
|
11788
12979
|
* @description Typed credentials for S3-compatible provider.
|
|
11789
12980
|
*
|
|
@@ -11792,34 +12983,24 @@ interface components {
|
|
|
11792
12983
|
* responses.
|
|
11793
12984
|
*/
|
|
11794
12985
|
S3Credentials: {
|
|
11795
|
-
/**
|
|
11796
|
-
|
|
11797
|
-
* @default null
|
|
11798
|
-
*/
|
|
11799
|
-
accessKeyId: string;
|
|
12986
|
+
/** @description Access key ID for static credentials. */
|
|
12987
|
+
accessKeyId?: string;
|
|
11800
12988
|
/** @description S3 bucket name. */
|
|
11801
12989
|
bucket: string;
|
|
11802
12990
|
/**
|
|
11803
12991
|
* @description Endpoint URL (e.g. `http://localhost:9000` for MinIO).
|
|
11804
12992
|
* Required for non-AWS S3-compatible services.
|
|
11805
|
-
* @default null
|
|
11806
12993
|
*/
|
|
11807
|
-
endpoint
|
|
12994
|
+
endpoint?: string;
|
|
11808
12995
|
/**
|
|
11809
12996
|
* @description AWS region (defaults to `us-east-1`).
|
|
11810
12997
|
* @default us-east-1
|
|
11811
12998
|
*/
|
|
11812
|
-
region
|
|
11813
|
-
/**
|
|
11814
|
-
|
|
11815
|
-
|
|
11816
|
-
|
|
11817
|
-
secretAccessKey: string;
|
|
11818
|
-
/**
|
|
11819
|
-
* @description Session token for temporary credentials.
|
|
11820
|
-
* @default null
|
|
11821
|
-
*/
|
|
11822
|
-
sessionToken: string;
|
|
12999
|
+
region?: string;
|
|
13000
|
+
/** @description Secret access key for static credentials. */
|
|
13001
|
+
secretAccessKey?: string;
|
|
13002
|
+
/** @description Session token for temporary credentials. */
|
|
13003
|
+
sessionToken?: string;
|
|
11823
13004
|
};
|
|
11824
13005
|
/**
|
|
11825
13006
|
* @description Caller-asserted scope shared across every payload of one analysis.
|
|
@@ -11865,15 +13046,14 @@ interface components {
|
|
|
11865
13046
|
* selected differently per audience. May hold several.
|
|
11866
13047
|
* @default []
|
|
11867
13048
|
*/
|
|
11868
|
-
audience
|
|
13049
|
+
audience?: string[];
|
|
11869
13050
|
/**
|
|
11870
13051
|
* @description The caller-asserted business purpose driving this request (e.g.
|
|
11871
13052
|
* `"fraud_detection"`, `"gdpr_erasure_request"`). A scope-aware operator
|
|
11872
13053
|
* predicate may skip or swap a rule based on it; a recognizer may bias
|
|
11873
13054
|
* detection on it. `None` when the caller asserts no purpose.
|
|
11874
|
-
* @default null
|
|
11875
13055
|
*/
|
|
11876
|
-
purpose
|
|
13056
|
+
purpose?: string;
|
|
11877
13057
|
/**
|
|
11878
13058
|
* @description Document-level classification tags (e.g. `"medical"`,
|
|
11879
13059
|
* `"gdpr-request"`). Recognizers may use these to bias their behavior
|
|
@@ -11888,7 +13068,7 @@ interface components {
|
|
|
11888
13068
|
* [`LabelCatalog`]: crate::entity::LabelCatalog
|
|
11889
13069
|
* @default []
|
|
11890
13070
|
*/
|
|
11891
|
-
tags
|
|
13071
|
+
tags?: string[];
|
|
11892
13072
|
};
|
|
11893
13073
|
/**
|
|
11894
13074
|
* @description Caller-asserted scope for one request.
|
|
@@ -11918,13 +13098,25 @@ interface components {
|
|
|
11918
13098
|
* (if a language enricher runs) to fill in.
|
|
11919
13099
|
* @default []
|
|
11920
13100
|
*/
|
|
11921
|
-
languages
|
|
13101
|
+
languages?: components["schemas"]["Languages"];
|
|
11922
13102
|
/**
|
|
11923
13103
|
* @description Free-form request context: document tags, request purpose,
|
|
11924
13104
|
* output audience. See elide's [`ScopeMetadata`].
|
|
11925
13105
|
*/
|
|
11926
13106
|
metadata?: components["schemas"]["ScopeMetadata"];
|
|
11927
13107
|
};
|
|
13108
|
+
/** @description Request to send a message and stream the assistant's reply. */
|
|
13109
|
+
SendChatMessage: {
|
|
13110
|
+
/** @description The user's message. */
|
|
13111
|
+
content: string;
|
|
13112
|
+
/**
|
|
13113
|
+
* Format: uuid
|
|
13114
|
+
* @description The message this turn replies to (the branch being extended). Omit to
|
|
13115
|
+
* continue from the session's current leaf; use an earlier message's id to
|
|
13116
|
+
* branch (e.g. edit-and-resend).
|
|
13117
|
+
*/
|
|
13118
|
+
parentId?: string;
|
|
13119
|
+
};
|
|
11928
13120
|
/**
|
|
11929
13121
|
* @description Which SHA-2 variant a hashing operator uses.
|
|
11930
13122
|
*
|
|
@@ -11951,7 +13143,7 @@ interface components {
|
|
|
11951
13143
|
* @description Whether to remember the device for extended session. Defaults to false.
|
|
11952
13144
|
* @default false
|
|
11953
13145
|
*/
|
|
11954
|
-
rememberMe
|
|
13146
|
+
rememberMe?: boolean;
|
|
11955
13147
|
/** @description Public account handle, unique across all accounts. */
|
|
11956
13148
|
username: components["schemas"]["Handle"];
|
|
11957
13149
|
};
|
|
@@ -11988,6 +13180,24 @@ interface components {
|
|
|
11988
13180
|
/** @description The raw source byte range. */
|
|
11989
13181
|
range: components["schemas"]["Range_of_uint"];
|
|
11990
13182
|
};
|
|
13183
|
+
/** @description Storage totals across a workspace's live files. */
|
|
13184
|
+
StorageAnalytics: {
|
|
13185
|
+
/**
|
|
13186
|
+
* @description Per-kind breakdown, one entry per `file_kind` (zero-filled), in a stable
|
|
13187
|
+
* order.
|
|
13188
|
+
*/
|
|
13189
|
+
byKind: components["schemas"]["StorageKindEntry"][];
|
|
13190
|
+
/**
|
|
13191
|
+
* Format: int64
|
|
13192
|
+
* @description Number of live files.
|
|
13193
|
+
*/
|
|
13194
|
+
fileCount: number;
|
|
13195
|
+
/**
|
|
13196
|
+
* Format: int64
|
|
13197
|
+
* @description Total bytes of all live files.
|
|
13198
|
+
*/
|
|
13199
|
+
totalBytes: number;
|
|
13200
|
+
};
|
|
11991
13201
|
/**
|
|
11992
13202
|
* @description A fully-typed object-store connection configuration.
|
|
11993
13203
|
*
|
|
@@ -12022,6 +13232,21 @@ interface components {
|
|
|
12022
13232
|
/** @description Optional root prefix within the bucket; keys resolve relative to it. */
|
|
12023
13233
|
rootPath?: string;
|
|
12024
13234
|
};
|
|
13235
|
+
/** @description One `file_kind`'s share of a workspace's storage. */
|
|
13236
|
+
StorageKindEntry: {
|
|
13237
|
+
/**
|
|
13238
|
+
* Format: int64
|
|
13239
|
+
* @description Number of live files of this kind.
|
|
13240
|
+
*/
|
|
13241
|
+
fileCount: number;
|
|
13242
|
+
/** @description The file kind. */
|
|
13243
|
+
kind: components["schemas"]["FileKind"];
|
|
13244
|
+
/**
|
|
13245
|
+
* Format: int64
|
|
13246
|
+
* @description Total bytes of live files of this kind.
|
|
13247
|
+
*/
|
|
13248
|
+
totalBytes: number;
|
|
13249
|
+
};
|
|
12025
13250
|
/**
|
|
12026
13251
|
* @description Request payload to trigger a connection sync.
|
|
12027
13252
|
*
|
|
@@ -12080,14 +13305,14 @@ interface components {
|
|
|
12080
13305
|
* @description How an import reconciles files whose source object was deleted.
|
|
12081
13306
|
* @default ignore
|
|
12082
13307
|
*/
|
|
12083
|
-
deletionPolicy
|
|
13308
|
+
deletionPolicy?: components["schemas"]["SyncDeletionPolicy"];
|
|
12084
13309
|
/** @description Cron expression for scheduled imports; omit for manual-only. */
|
|
12085
13310
|
scheduleCron?: string;
|
|
12086
13311
|
/**
|
|
12087
13312
|
* @description Whether the connection imports data in or exports data out.
|
|
12088
13313
|
* @default import
|
|
12089
13314
|
*/
|
|
12090
|
-
syncMode
|
|
13315
|
+
syncMode?: components["schemas"]["SyncMode"];
|
|
12091
13316
|
};
|
|
12092
13317
|
/**
|
|
12093
13318
|
* @description Defines the execution status of a connection sync run.
|
|
@@ -12103,19 +13328,6 @@ interface components {
|
|
|
12103
13328
|
* to track whether a run was manually triggered, scheduled, or triggered by a webhook.
|
|
12104
13329
|
*/
|
|
12105
13330
|
SyncTriggerType: "manual" | "scheduled" | "webhook";
|
|
12106
|
-
/** @description Params of a `system.announcement` notification. */
|
|
12107
|
-
SystemAnnouncementParams: {
|
|
12108
|
-
/** @description Announcement message key or body. */
|
|
12109
|
-
message: string;
|
|
12110
|
-
};
|
|
12111
|
-
/** @description Params of a `system.report` notification. */
|
|
12112
|
-
SystemReportParams: {
|
|
12113
|
-
/**
|
|
12114
|
-
* Format: uuid
|
|
12115
|
-
* @description Id of the generated report, if any.
|
|
12116
|
-
*/
|
|
12117
|
-
reportId?: string;
|
|
12118
|
-
};
|
|
12119
13331
|
/**
|
|
12120
13332
|
* @description One node in an entity's audit DAG: a thing that happened, with its
|
|
12121
13333
|
* effect on confidence and its tamper-evident links.
|
|
@@ -12586,7 +13798,7 @@ interface components {
|
|
|
12586
13798
|
* @description Template string. Default `[{label}]`.
|
|
12587
13799
|
* @default [{label}]
|
|
12588
13800
|
*/
|
|
12589
|
-
template
|
|
13801
|
+
template?: string;
|
|
12590
13802
|
} | {
|
|
12591
13803
|
/**
|
|
12592
13804
|
* Format: uint
|
|
@@ -12604,7 +13816,7 @@ interface components {
|
|
|
12604
13816
|
* @description The character that replaces masked positions.
|
|
12605
13817
|
* @default *
|
|
12606
13818
|
*/
|
|
12607
|
-
mask_char
|
|
13819
|
+
mask_char?: string;
|
|
12608
13820
|
};
|
|
12609
13821
|
/** @description Request payload for testing a webhook. */
|
|
12610
13822
|
TestWebhook: {
|
|
@@ -13019,7 +14231,7 @@ interface components {
|
|
|
13019
14231
|
* @description The character that replaces masked positions.
|
|
13020
14232
|
* @default *
|
|
13021
14233
|
*/
|
|
13022
|
-
mask_char
|
|
14234
|
+
mask_char?: string;
|
|
13023
14235
|
} | {
|
|
13024
14236
|
/** @constant */
|
|
13025
14237
|
kind: "replace";
|
|
@@ -13027,13 +14239,13 @@ interface components {
|
|
|
13027
14239
|
* @description Template string. Default `[{label}]`.
|
|
13028
14240
|
* @default [{label}]
|
|
13029
14241
|
*/
|
|
13030
|
-
template
|
|
14242
|
+
template?: string;
|
|
13031
14243
|
} | {
|
|
13032
14244
|
/**
|
|
13033
14245
|
* @description SHA-256 (default) or SHA-512.
|
|
13034
14246
|
* @default sha256
|
|
13035
14247
|
*/
|
|
13036
|
-
algorithm
|
|
14248
|
+
algorithm?: components["schemas"]["Sha2Algorithm"];
|
|
13037
14249
|
/** @constant */
|
|
13038
14250
|
kind: "hash";
|
|
13039
14251
|
/** @description Salt prepended to the value before hashing. */
|
|
@@ -13053,7 +14265,7 @@ interface components {
|
|
|
13053
14265
|
* [`Replace`]: TextRedaction::Replace
|
|
13054
14266
|
* @default [{label}]
|
|
13055
14267
|
*/
|
|
13056
|
-
fallback_template
|
|
14268
|
+
fallback_template?: string;
|
|
13057
14269
|
/** @constant */
|
|
13058
14270
|
kind: "fake";
|
|
13059
14271
|
/**
|
|
@@ -13074,7 +14286,7 @@ interface components {
|
|
|
13074
14286
|
* @description HMAC-SHA-256 (default) or HMAC-SHA-512.
|
|
13075
14287
|
* @default sha256
|
|
13076
14288
|
*/
|
|
13077
|
-
algorithm
|
|
14289
|
+
algorithm?: components["schemas"]["Sha2Algorithm"];
|
|
13078
14290
|
/** @constant */
|
|
13079
14291
|
kind: "hmac_hash";
|
|
13080
14292
|
} | {
|
|
@@ -13130,14 +14342,14 @@ interface components {
|
|
|
13130
14342
|
* @description Coarseness of the output. Default `Year`.
|
|
13131
14343
|
* @default year
|
|
13132
14344
|
*/
|
|
13133
|
-
granularity
|
|
14345
|
+
granularity?: components["schemas"]["DateGranularity"];
|
|
13134
14346
|
/** @constant */
|
|
13135
14347
|
kind: "generalize_date";
|
|
13136
14348
|
/**
|
|
13137
14349
|
* @description Which input convention to accept. Default `Iso`.
|
|
13138
14350
|
* @default iso
|
|
13139
14351
|
*/
|
|
13140
|
-
style
|
|
14352
|
+
style?: components["schemas"]["DateStyle"];
|
|
13141
14353
|
};
|
|
13142
14354
|
/**
|
|
13143
14355
|
* @description Half-open `[start, end)` stream interval, measured in microseconds.
|
|
@@ -13171,6 +14383,27 @@ interface components {
|
|
|
13171
14383
|
*/
|
|
13172
14384
|
start_us: number;
|
|
13173
14385
|
};
|
|
14386
|
+
/**
|
|
14387
|
+
* @description Token counts a model reported, each optional because providers differ in
|
|
14388
|
+
* what they return — some give only a total, some none at all.
|
|
14389
|
+
*/
|
|
14390
|
+
TokenCounts: {
|
|
14391
|
+
/**
|
|
14392
|
+
* Format: uint64
|
|
14393
|
+
* @description Prompt / input tokens.
|
|
14394
|
+
*/
|
|
14395
|
+
input?: number;
|
|
14396
|
+
/**
|
|
14397
|
+
* Format: uint64
|
|
14398
|
+
* @description Completion / output tokens.
|
|
14399
|
+
*/
|
|
14400
|
+
output?: number;
|
|
14401
|
+
/**
|
|
14402
|
+
* Format: uint64
|
|
14403
|
+
* @description Total tokens — may be reported even when the input/output split is not.
|
|
14404
|
+
*/
|
|
14405
|
+
total?: number;
|
|
14406
|
+
};
|
|
13174
14407
|
/** @description Expiration options for API tokens. */
|
|
13175
14408
|
TokenExpiration: "never" | "in7Days" | "in30Days" | "in90Days" | "in1Year";
|
|
13176
14409
|
/**
|
|
@@ -13345,6 +14578,59 @@ interface components {
|
|
|
13345
14578
|
*/
|
|
13346
14579
|
settings?: components["schemas"]["WorkspaceSettings"];
|
|
13347
14580
|
};
|
|
14581
|
+
/**
|
|
14582
|
+
* @description One recognizer's or enricher's resource usage for one payload.
|
|
14583
|
+
*
|
|
14584
|
+
* `id` and `duration` are always present; `count` (entities or spans found,
|
|
14585
|
+
* artifacts produced) and `model` are present only where they mean
|
|
14586
|
+
* something. `duration` serializes as a whole number of milliseconds.
|
|
14587
|
+
*/
|
|
14588
|
+
Usage: {
|
|
14589
|
+
/**
|
|
14590
|
+
* Format: uint64
|
|
14591
|
+
* @description Entities or spans found (recognizer) or artifacts produced (enricher);
|
|
14592
|
+
* `None` when a count is not meaningful for the component.
|
|
14593
|
+
*/
|
|
14594
|
+
count?: number;
|
|
14595
|
+
/**
|
|
14596
|
+
* Format: uint64
|
|
14597
|
+
* @description Wall-clock execution time. Serialized as integer milliseconds.
|
|
14598
|
+
*/
|
|
14599
|
+
duration: number;
|
|
14600
|
+
/** @description Which recognizer / enricher this describes. */
|
|
14601
|
+
id: components["schemas"]["RecognizerId"];
|
|
14602
|
+
/** @description Model / token detail; `None` for a pure-CPU component. */
|
|
14603
|
+
model?: components["schemas"]["ModelUsage"];
|
|
14604
|
+
};
|
|
14605
|
+
/** @description Inference token usage across a workspace's runs. */
|
|
14606
|
+
UsageAnalytics: {
|
|
14607
|
+
/** @description Per-model breakdown, one entry per model used, in a stable order. */
|
|
14608
|
+
byModel: components["schemas"]["ModelUsageEntry"][];
|
|
14609
|
+
/**
|
|
14610
|
+
* Format: int64
|
|
14611
|
+
* @description Total input/prompt tokens across all models.
|
|
14612
|
+
*/
|
|
14613
|
+
inputTokens: number;
|
|
14614
|
+
/**
|
|
14615
|
+
* Format: int64
|
|
14616
|
+
* @description Total output/completion tokens across all models.
|
|
14617
|
+
*/
|
|
14618
|
+
outputTokens: number;
|
|
14619
|
+
/**
|
|
14620
|
+
* Format: int64
|
|
14621
|
+
* @description Total tokens as reported across all models (not necessarily input +
|
|
14622
|
+
* output).
|
|
14623
|
+
*/
|
|
14624
|
+
totalTokens: number;
|
|
14625
|
+
};
|
|
14626
|
+
/**
|
|
14627
|
+
* @description Every recognizer/enricher's [`Usage`] across a whole document analysis, in
|
|
14628
|
+
* the order the components ran (the body first, then each part).
|
|
14629
|
+
*/
|
|
14630
|
+
UsageReport: {
|
|
14631
|
+
/** @description The per-component usage entries, each self-identifying via its `id`. */
|
|
14632
|
+
entries: components["schemas"]["Usage"][];
|
|
14633
|
+
};
|
|
13348
14634
|
/** @description Validation error details for field-specific errors. */
|
|
13349
14635
|
ValidationErrorDetail: {
|
|
13350
14636
|
/** @description Error code for the validation failure */
|
|
@@ -13415,11 +14701,10 @@ interface components {
|
|
|
13415
14701
|
};
|
|
13416
14702
|
/** @description Params of a webhook activity (`webhook.*`). */
|
|
13417
14703
|
WebhookActivityParams: {
|
|
13418
|
-
/**
|
|
13419
|
-
|
|
13420
|
-
|
|
13421
|
-
|
|
13422
|
-
webhookId: string;
|
|
14704
|
+
/** @description Id of the webhook. */
|
|
14705
|
+
webhookId: components["schemas"]["WebhookId"];
|
|
14706
|
+
/** @description Display name of the webhook. */
|
|
14707
|
+
webhookName: string;
|
|
13423
14708
|
};
|
|
13424
14709
|
/**
|
|
13425
14710
|
* @description Webhook creation response that includes the secret (visible only once).
|
|
@@ -13567,6 +14852,18 @@ interface components {
|
|
|
13567
14852
|
/** @description Slug of the workspace acted on. */
|
|
13568
14853
|
workspaceSlug: components["schemas"]["Handle"];
|
|
13569
14854
|
};
|
|
14855
|
+
/**
|
|
14856
|
+
* @description Aggregate analytics for a workspace: what it stores, how its runs fare, and
|
|
14857
|
+
* the inference tokens they spent.
|
|
14858
|
+
*/
|
|
14859
|
+
WorkspaceAnalytics: {
|
|
14860
|
+
/** @description Pipeline-run health: volume, status mix, and durations. */
|
|
14861
|
+
runs: components["schemas"]["RunAnalytics"];
|
|
14862
|
+
/** @description Stored-file totals and their per-kind breakdown. */
|
|
14863
|
+
storage: components["schemas"]["StorageAnalytics"];
|
|
14864
|
+
/** @description Inference token usage: workspace totals and a per-model breakdown. */
|
|
14865
|
+
usage: components["schemas"]["UsageAnalytics"];
|
|
14866
|
+
};
|
|
13570
14867
|
/** @description Path parameters for file operations within a workspace context. */
|
|
13571
14868
|
WorkspaceFilePathParams: {
|
|
13572
14869
|
/**
|
|
@@ -13632,12 +14929,12 @@ interface components {
|
|
|
13632
14929
|
* @description How documents are rendered for OCR during detection.
|
|
13633
14930
|
* @default auto
|
|
13634
14931
|
*/
|
|
13635
|
-
ocr
|
|
14932
|
+
ocr?: components["schemas"]["OcrPolicy"];
|
|
13636
14933
|
/**
|
|
13637
14934
|
* @description Whether approval is required before processed files become visible.
|
|
13638
14935
|
* @default true
|
|
13639
14936
|
*/
|
|
13640
|
-
requireApproval
|
|
14937
|
+
requireApproval?: boolean;
|
|
13641
14938
|
/**
|
|
13642
14939
|
* @description Data-retention rules for the workspace.
|
|
13643
14940
|
* @default {
|
|
@@ -13652,7 +14949,7 @@ interface components {
|
|
|
13652
14949
|
* }
|
|
13653
14950
|
* }
|
|
13654
14951
|
*/
|
|
13655
|
-
retention
|
|
14952
|
+
retention?: components["schemas"]["RetentionSettings"];
|
|
13656
14953
|
};
|
|
13657
14954
|
/** @description Query parameters for listing all syncs across a workspace. */
|
|
13658
14955
|
WorkspaceSyncsQuery: {
|
|
@@ -13662,7 +14959,7 @@ interface components {
|
|
|
13662
14959
|
* provider filter.
|
|
13663
14960
|
* @default []
|
|
13664
14961
|
*/
|
|
13665
|
-
provider
|
|
14962
|
+
provider?: string[];
|
|
13666
14963
|
/** @description Filter by sync status. */
|
|
13667
14964
|
status?: components["schemas"]["SyncStatus"];
|
|
13668
14965
|
};
|
|
@@ -13675,141 +14972,178 @@ interface components {
|
|
|
13675
14972
|
}
|
|
13676
14973
|
//#endregion
|
|
13677
14974
|
//#region src/datatypes/account.d.ts
|
|
13678
|
-
type Schemas$
|
|
13679
|
-
type Handle = Schemas$
|
|
13680
|
-
type Account = Schemas$
|
|
13681
|
-
type PublicAccount = Schemas$
|
|
13682
|
-
type UpdateAccount = Schemas$
|
|
13683
|
-
type PasswordChange = Schemas$
|
|
13684
|
-
type AccountRef = Schemas$
|
|
14975
|
+
type Schemas$22 = components["schemas"];
|
|
14976
|
+
type Handle = Schemas$22["Handle"];
|
|
14977
|
+
type Account = Schemas$22["Account"];
|
|
14978
|
+
type PublicAccount = Schemas$22["PublicAccount"];
|
|
14979
|
+
type UpdateAccount = Schemas$22["UpdateAccount"];
|
|
14980
|
+
type PasswordChange = Schemas$22["PasswordChange"];
|
|
14981
|
+
type AccountRef = Schemas$22["AccountRef"];
|
|
13685
14982
|
//#endregion
|
|
13686
14983
|
//#region src/datatypes/activity.d.ts
|
|
13687
|
-
type Schemas$
|
|
13688
|
-
type Activity = Schemas$
|
|
13689
|
-
type ActivityPage = Schemas$
|
|
13690
|
-
type
|
|
13691
|
-
type
|
|
13692
|
-
type
|
|
13693
|
-
type
|
|
13694
|
-
type
|
|
13695
|
-
type
|
|
13696
|
-
type
|
|
13697
|
-
type
|
|
13698
|
-
type
|
|
13699
|
-
type
|
|
14984
|
+
type Schemas$21 = components["schemas"];
|
|
14985
|
+
type Activity = Schemas$21["Activity"];
|
|
14986
|
+
type ActivityPage = Schemas$21["ActivityPage"];
|
|
14987
|
+
type ActivityType = Schemas$21["ActivityType"];
|
|
14988
|
+
type ActivityListQuery = Schemas$21["ActivityListQuery"];
|
|
14989
|
+
type ActivityExportQuery = Schemas$21["ActivityExportQuery"];
|
|
14990
|
+
type ActivityPayload = Schemas$21["ActivityPayload"];
|
|
14991
|
+
type WorkspaceActivityParams = Schemas$21["WorkspaceActivityParams"];
|
|
14992
|
+
type MemberActivityParams = Schemas$21["MemberActivityParams"];
|
|
14993
|
+
type InviteActivityParams = Schemas$21["InviteActivityParams"];
|
|
14994
|
+
type ConnectionActivityParams = Schemas$21["ConnectionActivityParams"];
|
|
14995
|
+
type PipelineActivityParams = Schemas$21["PipelineActivityParams"];
|
|
14996
|
+
type PipelineRunActivityParams = Schemas$21["PipelineRunActivityParams"];
|
|
14997
|
+
type PolicyActivityParams = Schemas$21["PolicyActivityParams"];
|
|
14998
|
+
type FileActivityParams = Schemas$21["FileActivityParams"];
|
|
14999
|
+
type WebhookActivityParams = Schemas$21["WebhookActivityParams"];
|
|
15000
|
+
//#endregion
|
|
15001
|
+
//#region src/datatypes/analytics.d.ts
|
|
15002
|
+
type Schemas$20 = components["schemas"];
|
|
15003
|
+
type WorkspaceAnalytics = Schemas$20["WorkspaceAnalytics"];
|
|
15004
|
+
type StorageAnalytics = Schemas$20["StorageAnalytics"];
|
|
15005
|
+
type StorageKindEntry = Schemas$20["StorageKindEntry"];
|
|
15006
|
+
type RunAnalytics = Schemas$20["RunAnalytics"];
|
|
15007
|
+
type RunStatusEntry = Schemas$20["RunStatusEntry"];
|
|
15008
|
+
type UsageAnalytics = Schemas$20["UsageAnalytics"];
|
|
15009
|
+
type ModelUsage = Schemas$20["ModelUsage"];
|
|
15010
|
+
type ModelUsageEntry = Schemas$20["ModelUsageEntry"];
|
|
15011
|
+
type Usage = Schemas$20["Usage"];
|
|
15012
|
+
type UsageReport = Schemas$20["UsageReport"];
|
|
15013
|
+
type TokenCounts = Schemas$20["TokenCounts"];
|
|
15014
|
+
type ProviderType = Schemas$20["ProviderType"];
|
|
15015
|
+
type RecognizerId = Schemas$20["RecognizerId"];
|
|
15016
|
+
type RunTimeSeries = Schemas$20["RunTimeSeries"];
|
|
15017
|
+
type RunDayEntry = Schemas$20["RunDayEntry"];
|
|
13700
15018
|
//#endregion
|
|
13701
15019
|
//#region src/datatypes/api-token.d.ts
|
|
13702
|
-
type Schemas$
|
|
13703
|
-
type ApiToken = Schemas$
|
|
13704
|
-
type ApiTokenWithJWT = Schemas$
|
|
13705
|
-
type ApiTokenType = Schemas$
|
|
13706
|
-
type CreateApiToken = Schemas$
|
|
13707
|
-
type UpdateApiToken = Schemas$
|
|
13708
|
-
type TokenExpiration = Schemas$
|
|
13709
|
-
type ApiTokenPage = Schemas$
|
|
15020
|
+
type Schemas$19 = components["schemas"];
|
|
15021
|
+
type ApiToken = Schemas$19["ApiToken"];
|
|
15022
|
+
type ApiTokenWithJWT = Schemas$19["ApiTokenWithJWT"];
|
|
15023
|
+
type ApiTokenType = Schemas$19["ApiTokenType"];
|
|
15024
|
+
type CreateApiToken = Schemas$19["CreateApiToken"];
|
|
15025
|
+
type UpdateApiToken = Schemas$19["UpdateApiToken"];
|
|
15026
|
+
type TokenExpiration = Schemas$19["TokenExpiration"];
|
|
15027
|
+
type ApiTokenPage = Schemas$19["ApiTokenPage"];
|
|
13710
15028
|
//#endregion
|
|
13711
15029
|
//#region src/datatypes/audit.d.ts
|
|
13712
|
-
type Schemas$
|
|
13713
|
-
type EntityGroup = Schemas$
|
|
13714
|
-
type AuditContext = Schemas$
|
|
13715
|
-
type EntityCoRef = Schemas$
|
|
13716
|
-
type RasterMode = Schemas$
|
|
13717
|
-
type Dpi = Schemas$
|
|
13718
|
-
type Review = Schemas$
|
|
13719
|
-
type Attribution = Schemas$
|
|
13720
|
-
type AttributionKind = Schemas$
|
|
13721
|
-
type LeakProfile = Schemas$
|
|
13722
|
-
type RuleMatch = Schemas$
|
|
13723
|
-
type ModelEvent = Schemas$
|
|
13724
|
-
type PatternEvent = Schemas$
|
|
13725
|
-
type OperatorId = Schemas$
|
|
13726
|
-
type AuditHash = Schemas$
|
|
13727
|
-
type Category = Schemas$
|
|
15030
|
+
type Schemas$18 = components["schemas"];
|
|
15031
|
+
type EntityGroup = Schemas$18["EntityGroup"];
|
|
15032
|
+
type AuditContext = Schemas$18["AuditContext"];
|
|
15033
|
+
type EntityCoRef = Schemas$18["EntityCoRef"];
|
|
15034
|
+
type RasterMode = Schemas$18["RasterMode"];
|
|
15035
|
+
type Dpi = Schemas$18["Dpi"];
|
|
15036
|
+
type Review = Schemas$18["Review"];
|
|
15037
|
+
type Attribution = Schemas$18["Attribution"];
|
|
15038
|
+
type AttributionKind = Schemas$18["AttributionKind"];
|
|
15039
|
+
type LeakProfile = Schemas$18["LeakProfile"];
|
|
15040
|
+
type RuleMatch = Schemas$18["RuleMatch"];
|
|
15041
|
+
type ModelEvent = Schemas$18["ModelEvent"];
|
|
15042
|
+
type PatternEvent = Schemas$18["PatternEvent"];
|
|
15043
|
+
type OperatorId = Schemas$18["OperatorId"];
|
|
15044
|
+
type AuditHash = Schemas$18["AuditHash"];
|
|
15045
|
+
type Category = Schemas$18["Category"];
|
|
13728
15046
|
/** Half-open `[start, end)` index range. Generated name; a plain uint range. */
|
|
13729
|
-
type RangeOfUint = Schemas$
|
|
13730
|
-
type SourceRef = Schemas$
|
|
13731
|
-
type BoundingBox = Schemas$
|
|
13732
|
-
type Point = Schemas$
|
|
13733
|
-
type Polygon = Schemas$
|
|
13734
|
-
type Dimensions = Schemas$
|
|
13735
|
-
type TimeSpan = Schemas$
|
|
13736
|
-
type TextEntity = Schemas$
|
|
13737
|
-
type TextEntityRecord = Schemas$
|
|
13738
|
-
type TextAuditEvent = Schemas$
|
|
13739
|
-
type TextAuditKind = Schemas$
|
|
13740
|
-
type TextHint = Schemas$
|
|
13741
|
-
type TextLocation = Schemas$
|
|
13742
|
-
type TextAuditLog = Schemas$
|
|
13743
|
-
type TextData = Schemas$
|
|
13744
|
-
type ImageEntity = Schemas$
|
|
13745
|
-
type ImageEntityRecord = Schemas$
|
|
13746
|
-
type ImageAuditEvent = Schemas$
|
|
13747
|
-
type ImageAuditKind = Schemas$
|
|
13748
|
-
type ImageHint = Schemas$
|
|
13749
|
-
type ImageLocation = Schemas$
|
|
13750
|
-
type ImageAuditLog = Schemas$
|
|
13751
|
-
type ImageData = Schemas$
|
|
13752
|
-
type AudioEntity = Schemas$
|
|
13753
|
-
type AudioEntityRecord = Schemas$
|
|
13754
|
-
type AudioAuditEvent = Schemas$
|
|
13755
|
-
type AudioAuditKind = Schemas$
|
|
13756
|
-
type AudioHint = Schemas$
|
|
13757
|
-
type AudioLocation = Schemas$
|
|
13758
|
-
type AudioAuditLog = Schemas$
|
|
13759
|
-
type AudioData = Schemas$
|
|
13760
|
-
type TabularEntity = Schemas$
|
|
13761
|
-
type TabularEntityRecord = Schemas$
|
|
13762
|
-
type TabularAuditEvent = Schemas$
|
|
13763
|
-
type TabularAuditKind = Schemas$
|
|
13764
|
-
type TabularHint = Schemas$
|
|
13765
|
-
type TabularLocation = Schemas$
|
|
13766
|
-
type TabularAuditLog = Schemas$
|
|
15047
|
+
type RangeOfUint = Schemas$18["Range_of_uint"];
|
|
15048
|
+
type SourceRef = Schemas$18["SourceRef"];
|
|
15049
|
+
type BoundingBox = Schemas$18["BoundingBox"];
|
|
15050
|
+
type Point = Schemas$18["Point"];
|
|
15051
|
+
type Polygon = Schemas$18["Polygon"];
|
|
15052
|
+
type Dimensions = Schemas$18["Dimensions"];
|
|
15053
|
+
type TimeSpan = Schemas$18["TimeSpan"];
|
|
15054
|
+
type TextEntity = Schemas$18["TextEntity"];
|
|
15055
|
+
type TextEntityRecord = Schemas$18["TextEntityRecord"];
|
|
15056
|
+
type TextAuditEvent = Schemas$18["TextAuditEvent"];
|
|
15057
|
+
type TextAuditKind = Schemas$18["TextAuditKind"];
|
|
15058
|
+
type TextHint = Schemas$18["TextHint"];
|
|
15059
|
+
type TextLocation = Schemas$18["TextLocation"];
|
|
15060
|
+
type TextAuditLog = Schemas$18["TextAuditLog"];
|
|
15061
|
+
type TextData = Schemas$18["TextData"];
|
|
15062
|
+
type ImageEntity = Schemas$18["ImageEntity"];
|
|
15063
|
+
type ImageEntityRecord = Schemas$18["ImageEntityRecord"];
|
|
15064
|
+
type ImageAuditEvent = Schemas$18["ImageAuditEvent"];
|
|
15065
|
+
type ImageAuditKind = Schemas$18["ImageAuditKind"];
|
|
15066
|
+
type ImageHint = Schemas$18["ImageHint"];
|
|
15067
|
+
type ImageLocation = Schemas$18["ImageLocation"];
|
|
15068
|
+
type ImageAuditLog = Schemas$18["ImageAuditLog"];
|
|
15069
|
+
type ImageData = Schemas$18["ImageData"];
|
|
15070
|
+
type AudioEntity = Schemas$18["AudioEntity"];
|
|
15071
|
+
type AudioEntityRecord = Schemas$18["AudioEntityRecord"];
|
|
15072
|
+
type AudioAuditEvent = Schemas$18["AudioAuditEvent"];
|
|
15073
|
+
type AudioAuditKind = Schemas$18["AudioAuditKind"];
|
|
15074
|
+
type AudioHint = Schemas$18["AudioHint"];
|
|
15075
|
+
type AudioLocation = Schemas$18["AudioLocation"];
|
|
15076
|
+
type AudioAuditLog = Schemas$18["AudioAuditLog"];
|
|
15077
|
+
type AudioData = Schemas$18["AudioData"];
|
|
15078
|
+
type TabularEntity = Schemas$18["TabularEntity"];
|
|
15079
|
+
type TabularEntityRecord = Schemas$18["TabularEntityRecord"];
|
|
15080
|
+
type TabularAuditEvent = Schemas$18["TabularAuditEvent"];
|
|
15081
|
+
type TabularAuditKind = Schemas$18["TabularAuditKind"];
|
|
15082
|
+
type TabularHint = Schemas$18["TabularHint"];
|
|
15083
|
+
type TabularLocation = Schemas$18["TabularLocation"];
|
|
15084
|
+
type TabularAuditLog = Schemas$18["TabularAuditLog"];
|
|
13767
15085
|
//#endregion
|
|
13768
15086
|
//#region src/datatypes/auth.d.ts
|
|
13769
|
-
type Schemas$
|
|
13770
|
-
type Login = Schemas$
|
|
13771
|
-
type Signup = Schemas$
|
|
13772
|
-
type AuthToken = Schemas$
|
|
15087
|
+
type Schemas$17 = components["schemas"];
|
|
15088
|
+
type Login = Schemas$17["Login"];
|
|
15089
|
+
type Signup = Schemas$17["Signup"];
|
|
15090
|
+
type AuthToken = Schemas$17["AuthToken"];
|
|
13773
15091
|
//#endregion
|
|
13774
15092
|
//#region src/datatypes/catalog.d.ts
|
|
13775
|
-
type Schemas$
|
|
15093
|
+
type Schemas$16 = components["schemas"];
|
|
13776
15094
|
/** Registry of the deployment's built-in labels, keyed by id. */
|
|
13777
|
-
type LabelCatalog = Schemas$
|
|
15095
|
+
type LabelCatalog = Schemas$16["LabelCatalog"];
|
|
13778
15096
|
/** The engine's registered recognizers, grouped into NER and LLM. */
|
|
13779
|
-
type RecognizerCatalog = Schemas$
|
|
13780
|
-
type RegisteredRecognizer = Schemas$
|
|
15097
|
+
type RecognizerCatalog = Schemas$16["RecognizerCatalog"];
|
|
15098
|
+
type RegisteredRecognizer = Schemas$16["RegisteredRecognizer"];
|
|
15099
|
+
//#endregion
|
|
15100
|
+
//#region src/datatypes/chat.d.ts
|
|
15101
|
+
type Schemas$15 = components["schemas"];
|
|
15102
|
+
type ChatSession = Schemas$15["ChatSession"];
|
|
15103
|
+
type ChatSessionPage = Schemas$15["ChatSessionPage"];
|
|
15104
|
+
type CreateChatSession = Schemas$15["CreateChatSession"];
|
|
15105
|
+
type ChatMessage = Schemas$15["ChatMessage"];
|
|
15106
|
+
type ChatRole = Schemas$15["ChatRole"];
|
|
15107
|
+
type SendChatMessage = Schemas$15["SendChatMessage"];
|
|
15108
|
+
type ChatToken = Schemas$15["ChatToken"];
|
|
13781
15109
|
//#endregion
|
|
13782
15110
|
//#region src/datatypes/connection.d.ts
|
|
13783
|
-
type Schemas$
|
|
13784
|
-
type ConnectionId = Schemas$
|
|
13785
|
-
type Connection = Schemas$
|
|
13786
|
-
type CreateConnection = Schemas$
|
|
13787
|
-
type UpdateConnection = Schemas$
|
|
13788
|
-
type ConnectionsQuery = Schemas$
|
|
13789
|
-
type ConnectionPage = Schemas$
|
|
13790
|
-
type SyncConnection = Schemas$
|
|
13791
|
-
type ConnectionSync = Schemas$
|
|
13792
|
-
type ConnectionSyncPage = Schemas$
|
|
13793
|
-
type ConnectionVerification = Schemas$
|
|
13794
|
-
type SyncMode = Schemas$
|
|
13795
|
-
type SyncStatus = Schemas$
|
|
13796
|
-
type SyncTriggerType = Schemas$
|
|
13797
|
-
type SyncDeletionPolicy = Schemas$
|
|
13798
|
-
type ConnectionConfig = Schemas$
|
|
13799
|
-
type StorageConfig = Schemas$
|
|
13800
|
-
type S3Credentials = Schemas$
|
|
13801
|
-
type AzureCredentials = Schemas$
|
|
13802
|
-
type GcsCredentials = Schemas$
|
|
13803
|
-
type LlmConfig = Schemas$
|
|
13804
|
-
type AnthropicCredentials = Schemas$
|
|
13805
|
-
type OpenAiCredentials = Schemas$
|
|
13806
|
-
type SyncSchedule = Schemas$
|
|
13807
|
-
type SyncScheduleInput = Schemas$
|
|
15111
|
+
type Schemas$14 = components["schemas"];
|
|
15112
|
+
type ConnectionId = Schemas$14["ConnectionId"];
|
|
15113
|
+
type Connection = Schemas$14["Connection"];
|
|
15114
|
+
type CreateConnection = Schemas$14["CreateConnection"];
|
|
15115
|
+
type UpdateConnection = Schemas$14["UpdateConnection"];
|
|
15116
|
+
type ConnectionsQuery = Schemas$14["ConnectionsQuery"];
|
|
15117
|
+
type ConnectionPage = Schemas$14["ConnectionPage"];
|
|
15118
|
+
type SyncConnection = Schemas$14["SyncConnection"];
|
|
15119
|
+
type ConnectionSync = Schemas$14["ConnectionSync"];
|
|
15120
|
+
type ConnectionSyncPage = Schemas$14["ConnectionSyncPage"];
|
|
15121
|
+
type ConnectionVerification = Schemas$14["ConnectionVerification"];
|
|
15122
|
+
type SyncMode = Schemas$14["SyncMode"];
|
|
15123
|
+
type SyncStatus = Schemas$14["SyncStatus"];
|
|
15124
|
+
type SyncTriggerType = Schemas$14["SyncTriggerType"];
|
|
15125
|
+
type SyncDeletionPolicy = Schemas$14["SyncDeletionPolicy"];
|
|
15126
|
+
type ConnectionConfig = Schemas$14["ConnectionConfig"];
|
|
15127
|
+
type StorageConfig = Schemas$14["StorageConfig"];
|
|
15128
|
+
type S3Credentials = Schemas$14["S3Credentials"];
|
|
15129
|
+
type AzureCredentials = Schemas$14["AzureCredentials"];
|
|
15130
|
+
type GcsCredentials = Schemas$14["GcsCredentials"];
|
|
15131
|
+
type LlmConfig = Schemas$14["LlmConfig"];
|
|
15132
|
+
type AnthropicCredentials = Schemas$14["AnthropicCredentials"];
|
|
15133
|
+
type OpenAiCredentials = Schemas$14["OpenAiCredentials"];
|
|
15134
|
+
type SyncSchedule = Schemas$14["SyncSchedule"];
|
|
15135
|
+
type SyncScheduleInput = Schemas$14["SyncScheduleInput"];
|
|
13808
15136
|
//#endregion
|
|
13809
15137
|
//#region src/datatypes/error.d.ts
|
|
15138
|
+
type Schemas$13 = components["schemas"];
|
|
15139
|
+
type ErrorResponse = Schemas$13["ErrorResponse"];
|
|
15140
|
+
type ValidationErrorDetail = Schemas$13["ValidationErrorDetail"];
|
|
15141
|
+
//#endregion
|
|
15142
|
+
//#region src/datatypes/export.d.ts
|
|
13810
15143
|
type Schemas$12 = components["schemas"];
|
|
13811
|
-
type
|
|
13812
|
-
type
|
|
15144
|
+
type ExportFormat = Schemas$12["ExportFormat"];
|
|
15145
|
+
type ExportQuery = Schemas$12["ExportQuery"];
|
|
15146
|
+
type DateWindow = Schemas$12["DateWindow"];
|
|
13813
15147
|
//#endregion
|
|
13814
15148
|
//#region src/datatypes/file.d.ts
|
|
13815
15149
|
type Schemas$11 = components["schemas"];
|
|
@@ -13869,8 +15203,6 @@ type ConnectionSyncFailedParams = Schemas$7["ConnectionSyncFailedParams"];
|
|
|
13869
15203
|
type PipelineRunAnalyzedParams = Schemas$7["PipelineRunAnalyzedParams"];
|
|
13870
15204
|
type PipelineRunCompletedParams = Schemas$7["PipelineRunCompletedParams"];
|
|
13871
15205
|
type PipelineRunFailedParams = Schemas$7["PipelineRunFailedParams"];
|
|
13872
|
-
type SystemAnnouncementParams = Schemas$7["SystemAnnouncementParams"];
|
|
13873
|
-
type SystemReportParams = Schemas$7["SystemReportParams"];
|
|
13874
15206
|
//#endregion
|
|
13875
15207
|
//#region src/datatypes/pagination.d.ts
|
|
13876
15208
|
type Schemas$6 = components["schemas"];
|
|
@@ -13977,5 +15309,5 @@ type Retention = Schemas["Retention"];
|
|
|
13977
15309
|
type RetentionSettings = Schemas["RetentionSettings"];
|
|
13978
15310
|
type RetentionOverride = Schemas["RetentionOverride"];
|
|
13979
15311
|
//#endregion
|
|
13980
|
-
export { LabelRef as $,
|
|
13981
|
-
//# sourceMappingURL=index-
|
|
15312
|
+
export { LabelRef as $, ChatSessionPage as $n, TextAuditEvent as $r, GenerateInviteCode as $t, CreatePipelineRun as A, Activity as Ai, ConnectionId as An, ImageData as Ar, CursorPagination as At, Color as B, PipelineActivityParams as Bi, S3Credentials as Bn, Polygon as Br, NotificationSettings as Bt, Language as C, StorageAnalytics as Ci, ExportQuery as Cn, Dimensions as Cr, PipelineDefinition as Ct, ScopeMetadata as D, UsageAnalytics as Di, AzureCredentials as Dn, ImageAuditEvent as Dr, PipelineSummaryPage as Dt, Languages as E, Usage as Ei, AnthropicCredentials as En, EntityGroup as Er, PipelineSummary as Et, RunId as F, ActivityType as Fi, ConnectionsQuery as Fn, LeakProfile as Fr, MemberJoinedParams as Ft, GdprArticle9Treatment as G, Account as Gi, SyncSchedule as Gn, SourceRef as Gr, UnreadStatus as Gt, CreatePolicy as H, PolicyActivityParams as Hi, SyncConnection as Hn, RasterMode as Hr, PipelineRunCompletedParams as Ht, RunMetadata as I, ConnectionActivityParams as Ii, CreateConnection as In, ModelEvent as Ir, Notification as It, HipaaDeidMethod as J, PasswordChange as Ji, SyncTriggerType as Jn, TabularAuditLog as Jr, Member as Jt, GdprSensitiveScope as K, AccountRef as Ki, SyncScheduleInput as Kn, TabularAuditEvent as Kr, UpdateNotificationSettings as Kt, RunStatusEvent as L, FileActivityParams as Li, GcsCredentials as Ln, OperatorId as Lr, NotificationEvent as Lt, PipelineRunPage as M, ActivityListQuery as Mi, ConnectionSync as Mn, ImageEntityRecord as Mr, ConnectionSyncFailedParams as Mt, PipelineRunStatus as N, ActivityPage as Ni, ConnectionSyncPage as Nn, ImageHint as Nr, MarkedReadStatus as Nt, ScopeParams as O, UsageReport as Oi, Connection as On, ImageAuditKind as Or, PipelineTriggerType as Ot, PipelineRunsQuery as P, ActivityPayload as Pi, ConnectionVerification as Pn, ImageLocation as Pr, MemberInvitedParams as Pt, LabelLocale as Q, ChatSession as Qn, TabularLocation as Qr, CreateInvite as Qt, AudioRedaction as R, InviteActivityParams as Ri, LlmConfig as Rn, PatternEvent as Rr, NotificationPage as Rt, CountryCode as S, RunTimeSeries as Si, ExportFormat as Sn, Category as Sr, Pipeline as St, LanguageSpan as T, TokenCounts as Ti, ValidationErrorDetail as Tn, EntityCoRef as Tr, PipelineStatus as Tt, DateGranularity as U, WebhookActivityParams as Ui, SyncDeletionPolicy as Un, Review as Ur, PipelineRunFailedParams as Ut, ConfidenceThreshold as V, PipelineRunActivityParams as Vi, StorageConfig as Vn, RangeOfUint as Vr, PipelineRunAnalyzedParams as Vt, DateStyle as W, WorkspaceActivityParams as Wi, SyncMode as Wn, RuleMatch as Wr, UnreadCountEvent as Wt, Label as X, UpdateAccount as Xi, ChatMessage as Xn, TabularEntityRecord as Xr, MemberSortField as Xt, ImageRedaction as Y, PublicAccount as Yi, UpdateConnection as Yn, TabularEntity as Yr, MemberPage as Yt, LabelEntry as Z, paths as Zi, ChatRole as Zn, TabularHint as Zr, UpdateMember as Zt, WebhookId as _, ProviderType as _i, FormatToken as _n, AudioHint as _r, TerminalFallback as _t, RetentionSettings as a, TextHint as ai, InviteSent as an, RegisteredRecognizer as ar, PciPanRender as at, WebhookStatus as b, RunDayEntry as bi, UpdateFile as bn, AuditHash as br, Waveform as bt, WorkspacePage as c, ApiToken as ci, ListInvites as cn, Signup as cr, PolicyDraft as ct, CreateWebhook as d, ApiTokenWithJWT as di, ComponentHealth as dn, AudioAuditEvent as dr, PolicySummaryPage as dt, TextAuditKind as ei, Invite as en, ChatToken as er, LabelScope as et, TestWebhook as f, CreateApiToken as fi, Health as fn, AudioAuditKind as fr, PolicyTemplate as ft, WebhookEvent as g, ModelUsageEntry as gi, FilePage as gn, AudioEntityRecord as gr, TemplateOrigin as gt, WebhookCreated as h, ModelUsage as hi, FileKind as hn, AudioEntity as hr, TabularRedaction as ht, RetentionOverride as i, TextEntityRecord as ii, InvitePreview as in, RecognizerCatalog as ir, PciDssPart as it, PipelineRun as j, ActivityExportQuery as ji, ConnectionPage as jn, ImageEntity as jr, ConnectionSyncCompletedParams as jt, Audit as k, WorkspaceAnalytics as ki, ConnectionConfig as kn, ImageAuditLog as kr, UpdatePipeline as kt, WorkspaceRole as l, ApiTokenPage as li, ReplyInvite as ln, Attribution as lr, PolicyRule as lt, Webhook as m, UpdateApiToken as mi, File as mn, AudioData as mr, Sha2Algorithm as mt, OcrPolicy as n, TextData as ni, InviteExpiration as nn, SendChatMessage as nr, LocalizedText as nt, UpdateWorkspace as o, TextLocation as oi, InviteSortField as on, AuthToken as or, Policy as ot, UpdateWebhook as p, TokenExpiration as pi, HealthStatus as pn, AudioAuditLog as pr, Predicate as pt, HipaaAccountNumbers as q, Handle as qi, SyncStatus as qn, TabularAuditKind as qr, ListMembers as qt, Retention as r, TextEntity as ri, InvitePage as rn, LabelCatalog as rr, ModalityRedactions as rt, Workspace as s, TimeSpan as si, InviteStatus as sn, Login as sr, PolicyDefinition as st, CreateWorkspace as t, TextAuditLog as ti, InviteCode as tn, CreateChatSession as tr, LanguageTag as tt, WorkspaceSettings as u, ApiTokenType as ui, SortOrder as un, AttributionKind as ur, PolicySummary as ut, WebhookPage as v, RecognizerId as vi, ListFiles as vn, AudioLocation as vr, TextRedaction as vt, LanguageProvenance as w, StorageKindEntry as wi, ErrorResponse as wn, Dpi as wr, PipelineFilter as wt, Confidence as x, RunStatusEntry as xi, DateWindow as xn, BoundingBox as xr, CreatePipeline as xt, WebhookResult as y, RunAnalytics as yi, ModalityToken as yn, AuditContext as yr, UpdatePolicy as yt, ClampBucket as z, MemberActivityParams as zi, OpenAiCredentials as zn, Point as zr, NotificationPayload as zt };
|
|
15313
|
+
//# sourceMappingURL=index-0_K3HaXB.d.ts.map
|