@nvisy/sdk 0.31.0 → 0.32.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 +33 -1
- package/dist/auth/index.d.ts +1 -1
- package/dist/{client-DWiS0wu7.d.ts → client-CfC5wM9f.d.ts} +121 -15
- package/dist/client-CfC5wM9f.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{errors-C9iizEYH.d.ts → errors-CrAVfGv9.d.ts} +2 -2
- package/dist/{errors-C9iizEYH.d.ts.map → errors-CrAVfGv9.d.ts.map} +1 -1
- package/dist/{index-DnLNkzKf.d.ts → index-CiQYVPsR.d.ts} +1781 -547
- package/dist/index-CiQYVPsR.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-CA6ZPOfu.js} +236 -82
- package/dist/services-CA6ZPOfu.js.map +1 -0
- package/dist/webhooks/index.d.ts +2 -2
- package/package.json +3 -3
- 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,7 +1227,7 @@ 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.
|
|
1225
1231
|
*/
|
|
1226
1232
|
get: {
|
|
1227
1233
|
parameters: {
|
|
@@ -1231,6 +1237,12 @@ interface paths {
|
|
|
1231
1237
|
* Obtain this from the `nextCursor` field in the response.
|
|
1232
1238
|
*/
|
|
1233
1239
|
after?: string;
|
|
1240
|
+
/**
|
|
1241
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
1242
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
1243
|
+
* only when the count is actually needed.
|
|
1244
|
+
*/
|
|
1245
|
+
includeCount?: boolean;
|
|
1234
1246
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
1235
1247
|
limit?: number;
|
|
1236
1248
|
};
|
|
@@ -1298,7 +1310,7 @@ interface paths {
|
|
|
1298
1310
|
patch?: never;
|
|
1299
1311
|
trace?: never;
|
|
1300
1312
|
};
|
|
1301
|
-
"/workspaces/{workspaceSlug}/
|
|
1313
|
+
"/workspaces/{workspaceSlug}/activities/export": {
|
|
1302
1314
|
parameters: {
|
|
1303
1315
|
query?: never;
|
|
1304
1316
|
header?: never;
|
|
@@ -1306,27 +1318,21 @@ interface paths {
|
|
|
1306
1318
|
cookie?: never;
|
|
1307
1319
|
};
|
|
1308
1320
|
/**
|
|
1309
|
-
*
|
|
1310
|
-
* @description
|
|
1321
|
+
* Export workspace activities
|
|
1322
|
+
* @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. `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
1323
|
*/
|
|
1312
1324
|
get: {
|
|
1313
1325
|
parameters: {
|
|
1314
1326
|
query?: {
|
|
1315
|
-
/** @description
|
|
1316
|
-
|
|
1317
|
-
/** @description Sort order (asc or desc). */
|
|
1318
|
-
order?: components["schemas"]["SortOrder"];
|
|
1319
|
-
/** @description Filter by workspace role. */
|
|
1320
|
-
role?: components["schemas"]["WorkspaceRole"];
|
|
1321
|
-
/** @description Sort by field. */
|
|
1322
|
-
sortBy?: components["schemas"]["MemberSortField"];
|
|
1327
|
+
/** @description Output format; defaults to `csv`. */
|
|
1328
|
+
format?: components["schemas"]["ExportFormat"];
|
|
1323
1329
|
/**
|
|
1324
|
-
* @description
|
|
1325
|
-
*
|
|
1330
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1331
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1326
1332
|
*/
|
|
1327
|
-
|
|
1328
|
-
/** @description
|
|
1329
|
-
|
|
1333
|
+
from?: string;
|
|
1334
|
+
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1335
|
+
to?: string;
|
|
1330
1336
|
};
|
|
1331
1337
|
header?: never;
|
|
1332
1338
|
path: {
|
|
@@ -1337,19 +1343,29 @@ interface paths {
|
|
|
1337
1343
|
};
|
|
1338
1344
|
requestBody?: never;
|
|
1339
1345
|
responses: {
|
|
1346
|
+
/** @description The exported activity log. */
|
|
1347
|
+
200: {
|
|
1348
|
+
headers: {
|
|
1349
|
+
[name: string]: unknown;
|
|
1350
|
+
};
|
|
1351
|
+
content: {
|
|
1352
|
+
"text/csv": unknown;
|
|
1353
|
+
"application/json": unknown;
|
|
1354
|
+
};
|
|
1355
|
+
};
|
|
1340
1356
|
/**
|
|
1341
|
-
* @description
|
|
1357
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1342
1358
|
*
|
|
1343
|
-
*
|
|
1344
|
-
*
|
|
1345
|
-
*
|
|
1359
|
+
* This struct contains all the information needed to serialize an error
|
|
1360
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1361
|
+
* information, and user-friendly messages.
|
|
1346
1362
|
*/
|
|
1347
|
-
|
|
1363
|
+
400: {
|
|
1348
1364
|
headers: {
|
|
1349
1365
|
[name: string]: unknown;
|
|
1350
1366
|
};
|
|
1351
1367
|
content: {
|
|
1352
|
-
"application/json": components["schemas"]["
|
|
1368
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1353
1369
|
};
|
|
1354
1370
|
};
|
|
1355
1371
|
/**
|
|
@@ -1407,20 +1423,18 @@ interface paths {
|
|
|
1407
1423
|
patch?: never;
|
|
1408
1424
|
trace?: never;
|
|
1409
1425
|
};
|
|
1410
|
-
"/workspaces/{workspaceSlug}/
|
|
1426
|
+
"/workspaces/{workspaceSlug}/analytics/": {
|
|
1411
1427
|
parameters: {
|
|
1412
1428
|
query?: never;
|
|
1413
1429
|
header?: never;
|
|
1414
1430
|
path?: never;
|
|
1415
1431
|
cookie?: never;
|
|
1416
1432
|
};
|
|
1417
|
-
get?: never;
|
|
1418
|
-
put?: never;
|
|
1419
1433
|
/**
|
|
1420
|
-
*
|
|
1421
|
-
* @description
|
|
1434
|
+
* Workspace analytics
|
|
1435
|
+
* @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
1436
|
*/
|
|
1423
|
-
|
|
1437
|
+
get: {
|
|
1424
1438
|
parameters: {
|
|
1425
1439
|
query?: never;
|
|
1426
1440
|
header?: never;
|
|
@@ -1432,12 +1446,17 @@ interface paths {
|
|
|
1432
1446
|
};
|
|
1433
1447
|
requestBody?: never;
|
|
1434
1448
|
responses: {
|
|
1435
|
-
/**
|
|
1449
|
+
/**
|
|
1450
|
+
* @description Aggregate analytics for a workspace: what it stores, how its runs fare, and
|
|
1451
|
+
* the inference tokens they spent.
|
|
1452
|
+
*/
|
|
1436
1453
|
200: {
|
|
1437
1454
|
headers: {
|
|
1438
1455
|
[name: string]: unknown;
|
|
1439
1456
|
};
|
|
1440
|
-
content
|
|
1457
|
+
content: {
|
|
1458
|
+
"application/json": components["schemas"]["WorkspaceAnalytics"];
|
|
1459
|
+
};
|
|
1441
1460
|
};
|
|
1442
1461
|
/**
|
|
1443
1462
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -1446,7 +1465,7 @@ interface paths {
|
|
|
1446
1465
|
* response, including the error name, message, HTTP status code, resource
|
|
1447
1466
|
* information, and user-friendly messages.
|
|
1448
1467
|
*/
|
|
1449
|
-
|
|
1468
|
+
401: {
|
|
1450
1469
|
headers: {
|
|
1451
1470
|
[name: string]: unknown;
|
|
1452
1471
|
};
|
|
@@ -1461,7 +1480,7 @@ interface paths {
|
|
|
1461
1480
|
* response, including the error name, message, HTTP status code, resource
|
|
1462
1481
|
* information, and user-friendly messages.
|
|
1463
1482
|
*/
|
|
1464
|
-
|
|
1483
|
+
403: {
|
|
1465
1484
|
headers: {
|
|
1466
1485
|
[name: string]: unknown;
|
|
1467
1486
|
};
|
|
@@ -1486,13 +1505,15 @@ interface paths {
|
|
|
1486
1505
|
};
|
|
1487
1506
|
};
|
|
1488
1507
|
};
|
|
1508
|
+
put?: never;
|
|
1509
|
+
post?: never;
|
|
1489
1510
|
delete?: never;
|
|
1490
1511
|
options?: never;
|
|
1491
1512
|
head?: never;
|
|
1492
1513
|
patch?: never;
|
|
1493
1514
|
trace?: never;
|
|
1494
1515
|
};
|
|
1495
|
-
"/workspaces/{workspaceSlug}/
|
|
1516
|
+
"/workspaces/{workspaceSlug}/analytics/runs/timeseries/": {
|
|
1496
1517
|
parameters: {
|
|
1497
1518
|
query?: never;
|
|
1498
1519
|
header?: never;
|
|
@@ -1500,30 +1521,54 @@ interface paths {
|
|
|
1500
1521
|
cookie?: never;
|
|
1501
1522
|
};
|
|
1502
1523
|
/**
|
|
1503
|
-
*
|
|
1504
|
-
* @description Returns
|
|
1524
|
+
* Workspace run time series
|
|
1525
|
+
* @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
1526
|
*/
|
|
1506
1527
|
get: {
|
|
1507
1528
|
parameters: {
|
|
1508
|
-
query?:
|
|
1529
|
+
query?: {
|
|
1530
|
+
/**
|
|
1531
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1532
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1533
|
+
*/
|
|
1534
|
+
from?: string;
|
|
1535
|
+
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1536
|
+
to?: string;
|
|
1537
|
+
};
|
|
1509
1538
|
header?: never;
|
|
1510
1539
|
path: {
|
|
1511
1540
|
/** @description URL-safe workspace identifier. */
|
|
1512
1541
|
workspaceSlug: string;
|
|
1513
|
-
/** @description Public handle of the member's account. */
|
|
1514
|
-
username: components["schemas"]["Handle"];
|
|
1515
1542
|
};
|
|
1516
1543
|
cookie?: never;
|
|
1517
1544
|
};
|
|
1518
1545
|
requestBody?: never;
|
|
1519
1546
|
responses: {
|
|
1520
|
-
/**
|
|
1547
|
+
/**
|
|
1548
|
+
* @description A workspace's daily run activity over a window: one point per day, dense
|
|
1549
|
+
* (quiet days included with `runs: 0`), ready to plot as a continuous series.
|
|
1550
|
+
*/
|
|
1521
1551
|
200: {
|
|
1522
1552
|
headers: {
|
|
1523
1553
|
[name: string]: unknown;
|
|
1524
1554
|
};
|
|
1525
1555
|
content: {
|
|
1526
|
-
"application/json": components["schemas"]["
|
|
1556
|
+
"application/json": components["schemas"]["RunTimeSeries"];
|
|
1557
|
+
};
|
|
1558
|
+
};
|
|
1559
|
+
/**
|
|
1560
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1561
|
+
*
|
|
1562
|
+
* This struct contains all the information needed to serialize an error
|
|
1563
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1564
|
+
* information, and user-friendly messages.
|
|
1565
|
+
*/
|
|
1566
|
+
400: {
|
|
1567
|
+
headers: {
|
|
1568
|
+
[name: string]: unknown;
|
|
1569
|
+
};
|
|
1570
|
+
content: {
|
|
1571
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1527
1572
|
};
|
|
1528
1573
|
};
|
|
1529
1574
|
/**
|
|
@@ -1575,44 +1620,70 @@ interface paths {
|
|
|
1575
1620
|
};
|
|
1576
1621
|
put?: never;
|
|
1577
1622
|
post?: never;
|
|
1623
|
+
delete?: never;
|
|
1624
|
+
options?: never;
|
|
1625
|
+
head?: never;
|
|
1626
|
+
patch?: never;
|
|
1627
|
+
trace?: never;
|
|
1628
|
+
};
|
|
1629
|
+
"/workspaces/{workspaceSlug}/members/": {
|
|
1630
|
+
parameters: {
|
|
1631
|
+
query?: never;
|
|
1632
|
+
header?: never;
|
|
1633
|
+
path?: never;
|
|
1634
|
+
cookie?: never;
|
|
1635
|
+
};
|
|
1578
1636
|
/**
|
|
1579
|
-
*
|
|
1580
|
-
* @description
|
|
1637
|
+
* List members
|
|
1638
|
+
* @description Returns a paginated list of workspace members with their roles and status.
|
|
1581
1639
|
*/
|
|
1582
|
-
|
|
1640
|
+
get: {
|
|
1583
1641
|
parameters: {
|
|
1584
|
-
query?:
|
|
1642
|
+
query?: {
|
|
1643
|
+
/** @description Filter by 2FA status. */
|
|
1644
|
+
has2fa?: boolean;
|
|
1645
|
+
/** @description Sort order (asc or desc). */
|
|
1646
|
+
order?: components["schemas"]["SortOrder"];
|
|
1647
|
+
/** @description Filter by workspace role. */
|
|
1648
|
+
role?: components["schemas"]["WorkspaceRole"];
|
|
1649
|
+
/** @description Sort by field. */
|
|
1650
|
+
sortBy?: components["schemas"]["MemberSortField"];
|
|
1651
|
+
/**
|
|
1652
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
1653
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
1654
|
+
*/
|
|
1655
|
+
after?: string;
|
|
1656
|
+
/**
|
|
1657
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
1658
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
1659
|
+
* only when the count is actually needed.
|
|
1660
|
+
*/
|
|
1661
|
+
includeCount?: boolean;
|
|
1662
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
1663
|
+
limit?: number;
|
|
1664
|
+
};
|
|
1585
1665
|
header?: never;
|
|
1586
1666
|
path: {
|
|
1587
1667
|
/** @description URL-safe workspace identifier. */
|
|
1588
1668
|
workspaceSlug: string;
|
|
1589
|
-
/** @description Public handle of the member's account. */
|
|
1590
|
-
username: components["schemas"]["Handle"];
|
|
1591
1669
|
};
|
|
1592
1670
|
cookie?: never;
|
|
1593
1671
|
};
|
|
1594
1672
|
requestBody?: never;
|
|
1595
1673
|
responses: {
|
|
1596
|
-
/** @description no content */
|
|
1597
|
-
200: {
|
|
1598
|
-
headers: {
|
|
1599
|
-
[name: string]: unknown;
|
|
1600
|
-
};
|
|
1601
|
-
content?: never;
|
|
1602
|
-
};
|
|
1603
1674
|
/**
|
|
1604
|
-
* @description
|
|
1675
|
+
* @description Generic paginated response wrapper.
|
|
1605
1676
|
*
|
|
1606
|
-
*
|
|
1607
|
-
*
|
|
1608
|
-
*
|
|
1677
|
+
* Provides a consistent structure for all paginated API responses with
|
|
1678
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
1679
|
+
* are more items to fetch.
|
|
1609
1680
|
*/
|
|
1610
|
-
|
|
1681
|
+
200: {
|
|
1611
1682
|
headers: {
|
|
1612
1683
|
[name: string]: unknown;
|
|
1613
1684
|
};
|
|
1614
1685
|
content: {
|
|
1615
|
-
"application/json": components["schemas"]["
|
|
1686
|
+
"application/json": components["schemas"]["MemberPage"];
|
|
1616
1687
|
};
|
|
1617
1688
|
};
|
|
1618
1689
|
/**
|
|
@@ -1662,39 +1733,45 @@ interface paths {
|
|
|
1662
1733
|
};
|
|
1663
1734
|
};
|
|
1664
1735
|
};
|
|
1736
|
+
put?: never;
|
|
1737
|
+
post?: never;
|
|
1738
|
+
delete?: never;
|
|
1665
1739
|
options?: never;
|
|
1666
1740
|
head?: never;
|
|
1741
|
+
patch?: never;
|
|
1742
|
+
trace?: never;
|
|
1743
|
+
};
|
|
1744
|
+
"/workspaces/{workspaceSlug}/members/leave/": {
|
|
1745
|
+
parameters: {
|
|
1746
|
+
query?: never;
|
|
1747
|
+
header?: never;
|
|
1748
|
+
path?: never;
|
|
1749
|
+
cookie?: never;
|
|
1750
|
+
};
|
|
1751
|
+
get?: never;
|
|
1752
|
+
put?: never;
|
|
1667
1753
|
/**
|
|
1668
|
-
*
|
|
1669
|
-
* @description
|
|
1754
|
+
* Leave workspace
|
|
1755
|
+
* @description Allows a member to voluntarily leave a workspace.
|
|
1670
1756
|
*/
|
|
1671
|
-
|
|
1757
|
+
post: {
|
|
1672
1758
|
parameters: {
|
|
1673
1759
|
query?: never;
|
|
1674
1760
|
header?: never;
|
|
1675
1761
|
path: {
|
|
1676
1762
|
/** @description URL-safe workspace identifier. */
|
|
1677
1763
|
workspaceSlug: string;
|
|
1678
|
-
/** @description Public handle of the member's account. */
|
|
1679
|
-
username: components["schemas"]["Handle"];
|
|
1680
1764
|
};
|
|
1681
1765
|
cookie?: never;
|
|
1682
1766
|
};
|
|
1683
|
-
|
|
1684
|
-
requestBody: {
|
|
1685
|
-
content: {
|
|
1686
|
-
"application/json": components["schemas"]["UpdateMember"];
|
|
1687
|
-
};
|
|
1688
|
-
};
|
|
1767
|
+
requestBody?: never;
|
|
1689
1768
|
responses: {
|
|
1690
|
-
/** @description
|
|
1769
|
+
/** @description no content */
|
|
1691
1770
|
200: {
|
|
1692
1771
|
headers: {
|
|
1693
1772
|
[name: string]: unknown;
|
|
1694
1773
|
};
|
|
1695
|
-
content
|
|
1696
|
-
"application/json": components["schemas"]["Member"];
|
|
1697
|
-
};
|
|
1774
|
+
content?: never;
|
|
1698
1775
|
};
|
|
1699
1776
|
/**
|
|
1700
1777
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -1726,21 +1803,6 @@ interface paths {
|
|
|
1726
1803
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1727
1804
|
};
|
|
1728
1805
|
};
|
|
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
1806
|
/**
|
|
1745
1807
|
* @description HTTP error response representation with security-conscious design.
|
|
1746
1808
|
*
|
|
@@ -1756,29 +1818,15 @@ interface paths {
|
|
|
1756
1818
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1757
1819
|
};
|
|
1758
1820
|
};
|
|
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
1821
|
};
|
|
1778
1822
|
};
|
|
1823
|
+
delete?: never;
|
|
1824
|
+
options?: never;
|
|
1825
|
+
head?: never;
|
|
1826
|
+
patch?: never;
|
|
1779
1827
|
trace?: never;
|
|
1780
1828
|
};
|
|
1781
|
-
"/workspaces/{workspaceSlug}/
|
|
1829
|
+
"/workspaces/{workspaceSlug}/members/{username}/": {
|
|
1782
1830
|
parameters: {
|
|
1783
1831
|
query?: never;
|
|
1784
1832
|
header?: never;
|
|
@@ -1786,47 +1834,30 @@ interface paths {
|
|
|
1786
1834
|
cookie?: never;
|
|
1787
1835
|
};
|
|
1788
1836
|
/**
|
|
1789
|
-
*
|
|
1790
|
-
* @description Returns
|
|
1837
|
+
* Get member
|
|
1838
|
+
* @description Returns detailed information about a specific workspace member.
|
|
1791
1839
|
*/
|
|
1792
1840
|
get: {
|
|
1793
1841
|
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
|
-
};
|
|
1842
|
+
query?: never;
|
|
1808
1843
|
header?: never;
|
|
1809
1844
|
path: {
|
|
1810
1845
|
/** @description URL-safe workspace identifier. */
|
|
1811
1846
|
workspaceSlug: string;
|
|
1847
|
+
/** @description Public handle of the member's account. */
|
|
1848
|
+
username: components["schemas"]["Handle"];
|
|
1812
1849
|
};
|
|
1813
1850
|
cookie?: never;
|
|
1814
1851
|
};
|
|
1815
1852
|
requestBody?: never;
|
|
1816
1853
|
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
|
-
*/
|
|
1854
|
+
/** @description Represents a workspace member. */
|
|
1824
1855
|
200: {
|
|
1825
1856
|
headers: {
|
|
1826
1857
|
[name: string]: unknown;
|
|
1827
1858
|
};
|
|
1828
1859
|
content: {
|
|
1829
|
-
"application/json": components["schemas"]["
|
|
1860
|
+
"application/json": components["schemas"]["Member"];
|
|
1830
1861
|
};
|
|
1831
1862
|
};
|
|
1832
1863
|
/**
|
|
@@ -1859,27 +1890,606 @@ interface paths {
|
|
|
1859
1890
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1860
1891
|
};
|
|
1861
1892
|
};
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1893
|
+
/**
|
|
1894
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1895
|
+
*
|
|
1896
|
+
* This struct contains all the information needed to serialize an error
|
|
1897
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1898
|
+
* information, and user-friendly messages.
|
|
1899
|
+
*/
|
|
1900
|
+
404: {
|
|
1901
|
+
headers: {
|
|
1902
|
+
[name: string]: unknown;
|
|
1903
|
+
};
|
|
1904
|
+
content: {
|
|
1905
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1906
|
+
};
|
|
1907
|
+
};
|
|
1908
|
+
};
|
|
1909
|
+
};
|
|
1910
|
+
put?: never;
|
|
1911
|
+
post?: never;
|
|
1912
|
+
/**
|
|
1913
|
+
* Remove member
|
|
1914
|
+
* @description Permanently removes a member from the workspace. Cannot remove owners or yourself.
|
|
1915
|
+
*/
|
|
1916
|
+
delete: {
|
|
1917
|
+
parameters: {
|
|
1918
|
+
query?: never;
|
|
1919
|
+
header?: never;
|
|
1920
|
+
path: {
|
|
1921
|
+
/** @description URL-safe workspace identifier. */
|
|
1922
|
+
workspaceSlug: string;
|
|
1923
|
+
/** @description Public handle of the member's account. */
|
|
1924
|
+
username: components["schemas"]["Handle"];
|
|
1925
|
+
};
|
|
1926
|
+
cookie?: never;
|
|
1927
|
+
};
|
|
1928
|
+
requestBody?: never;
|
|
1929
|
+
responses: {
|
|
1930
|
+
/** @description no content */
|
|
1931
|
+
200: {
|
|
1932
|
+
headers: {
|
|
1933
|
+
[name: string]: unknown;
|
|
1934
|
+
};
|
|
1935
|
+
content?: never;
|
|
1936
|
+
};
|
|
1937
|
+
/**
|
|
1938
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1939
|
+
*
|
|
1940
|
+
* This struct contains all the information needed to serialize an error
|
|
1941
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1942
|
+
* information, and user-friendly messages.
|
|
1943
|
+
*/
|
|
1944
|
+
400: {
|
|
1945
|
+
headers: {
|
|
1946
|
+
[name: string]: unknown;
|
|
1947
|
+
};
|
|
1948
|
+
content: {
|
|
1949
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1950
|
+
};
|
|
1951
|
+
};
|
|
1952
|
+
/**
|
|
1953
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1954
|
+
*
|
|
1955
|
+
* This struct contains all the information needed to serialize an error
|
|
1956
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1957
|
+
* information, and user-friendly messages.
|
|
1958
|
+
*/
|
|
1959
|
+
401: {
|
|
1960
|
+
headers: {
|
|
1961
|
+
[name: string]: unknown;
|
|
1962
|
+
};
|
|
1963
|
+
content: {
|
|
1964
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1965
|
+
};
|
|
1966
|
+
};
|
|
1967
|
+
/**
|
|
1968
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1969
|
+
*
|
|
1970
|
+
* This struct contains all the information needed to serialize an error
|
|
1971
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1972
|
+
* information, and user-friendly messages.
|
|
1973
|
+
*/
|
|
1974
|
+
403: {
|
|
1975
|
+
headers: {
|
|
1976
|
+
[name: string]: unknown;
|
|
1977
|
+
};
|
|
1978
|
+
content: {
|
|
1979
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1980
|
+
};
|
|
1981
|
+
};
|
|
1982
|
+
/**
|
|
1983
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1984
|
+
*
|
|
1985
|
+
* This struct contains all the information needed to serialize an error
|
|
1986
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1987
|
+
* information, and user-friendly messages.
|
|
1988
|
+
*/
|
|
1989
|
+
404: {
|
|
1990
|
+
headers: {
|
|
1991
|
+
[name: string]: unknown;
|
|
1992
|
+
};
|
|
1993
|
+
content: {
|
|
1994
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1995
|
+
};
|
|
1996
|
+
};
|
|
1997
|
+
};
|
|
1998
|
+
};
|
|
1999
|
+
options?: never;
|
|
2000
|
+
head?: never;
|
|
2001
|
+
/**
|
|
2002
|
+
* Update member role
|
|
2003
|
+
* @description Updates a workspace member's role. Cannot update your own role or demote owners.
|
|
2004
|
+
*/
|
|
2005
|
+
patch: {
|
|
2006
|
+
parameters: {
|
|
2007
|
+
query?: never;
|
|
2008
|
+
header?: never;
|
|
2009
|
+
path: {
|
|
2010
|
+
/** @description URL-safe workspace identifier. */
|
|
2011
|
+
workspaceSlug: string;
|
|
2012
|
+
/** @description Public handle of the member's account. */
|
|
2013
|
+
username: components["schemas"]["Handle"];
|
|
2014
|
+
};
|
|
2015
|
+
cookie?: never;
|
|
2016
|
+
};
|
|
2017
|
+
/** @description Request to update a member's role. */
|
|
2018
|
+
requestBody: {
|
|
2019
|
+
content: {
|
|
2020
|
+
"application/json": components["schemas"]["UpdateMember"];
|
|
2021
|
+
};
|
|
2022
|
+
};
|
|
2023
|
+
responses: {
|
|
2024
|
+
/** @description Represents a workspace member. */
|
|
2025
|
+
200: {
|
|
2026
|
+
headers: {
|
|
2027
|
+
[name: string]: unknown;
|
|
2028
|
+
};
|
|
2029
|
+
content: {
|
|
2030
|
+
"application/json": components["schemas"]["Member"];
|
|
2031
|
+
};
|
|
2032
|
+
};
|
|
2033
|
+
/**
|
|
2034
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2035
|
+
*
|
|
2036
|
+
* This struct contains all the information needed to serialize an error
|
|
2037
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2038
|
+
* information, and user-friendly messages.
|
|
2039
|
+
*/
|
|
2040
|
+
400: {
|
|
2041
|
+
headers: {
|
|
2042
|
+
[name: string]: unknown;
|
|
2043
|
+
};
|
|
2044
|
+
content: {
|
|
2045
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2046
|
+
};
|
|
2047
|
+
};
|
|
2048
|
+
/**
|
|
2049
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2050
|
+
*
|
|
2051
|
+
* This struct contains all the information needed to serialize an error
|
|
2052
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2053
|
+
* information, and user-friendly messages.
|
|
2054
|
+
*/
|
|
2055
|
+
401: {
|
|
2056
|
+
headers: {
|
|
2057
|
+
[name: string]: unknown;
|
|
2058
|
+
};
|
|
2059
|
+
content: {
|
|
2060
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2061
|
+
};
|
|
2062
|
+
};
|
|
2063
|
+
/**
|
|
2064
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2065
|
+
*
|
|
2066
|
+
* This struct contains all the information needed to serialize an error
|
|
2067
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2068
|
+
* information, and user-friendly messages.
|
|
2069
|
+
*/
|
|
2070
|
+
403: {
|
|
2071
|
+
headers: {
|
|
2072
|
+
[name: string]: unknown;
|
|
2073
|
+
};
|
|
2074
|
+
content: {
|
|
2075
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2076
|
+
};
|
|
2077
|
+
};
|
|
2078
|
+
/**
|
|
2079
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2080
|
+
*
|
|
2081
|
+
* This struct contains all the information needed to serialize an error
|
|
2082
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2083
|
+
* information, and user-friendly messages.
|
|
2084
|
+
*/
|
|
2085
|
+
404: {
|
|
2086
|
+
headers: {
|
|
2087
|
+
[name: string]: unknown;
|
|
2088
|
+
};
|
|
2089
|
+
content: {
|
|
2090
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2091
|
+
};
|
|
2092
|
+
};
|
|
2093
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2094
|
+
415: {
|
|
2095
|
+
headers: {
|
|
2096
|
+
[name: string]: unknown;
|
|
2097
|
+
};
|
|
2098
|
+
content: {
|
|
2099
|
+
"text/plain": string;
|
|
2100
|
+
};
|
|
2101
|
+
};
|
|
2102
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2103
|
+
422: {
|
|
2104
|
+
headers: {
|
|
2105
|
+
[name: string]: unknown;
|
|
2106
|
+
};
|
|
2107
|
+
content: {
|
|
2108
|
+
"text/plain": string;
|
|
2109
|
+
};
|
|
2110
|
+
};
|
|
2111
|
+
};
|
|
2112
|
+
};
|
|
2113
|
+
trace?: never;
|
|
2114
|
+
};
|
|
2115
|
+
"/workspaces/{workspaceSlug}/connections/": {
|
|
2116
|
+
parameters: {
|
|
2117
|
+
query?: never;
|
|
2118
|
+
header?: never;
|
|
2119
|
+
path?: never;
|
|
2120
|
+
cookie?: never;
|
|
2121
|
+
};
|
|
2122
|
+
/**
|
|
2123
|
+
* List connections
|
|
2124
|
+
* @description Returns all configured connections for the workspace. Only metadata is returned; encrypted credentials are never exposed.
|
|
2125
|
+
*/
|
|
2126
|
+
get: {
|
|
2127
|
+
parameters: {
|
|
2128
|
+
query?: {
|
|
2129
|
+
/**
|
|
2130
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
2131
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
2132
|
+
*/
|
|
2133
|
+
after?: string;
|
|
2134
|
+
/**
|
|
2135
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
2136
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
2137
|
+
* only when the count is actually needed.
|
|
2138
|
+
*/
|
|
2139
|
+
includeCount?: boolean;
|
|
2140
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2141
|
+
limit?: number;
|
|
2142
|
+
/**
|
|
2143
|
+
* @description Filter by provider (`s3`, `azure`, `gcs`). Repeatable; a connection
|
|
2144
|
+
* matches if it uses any of the given providers. Empty means no filter.
|
|
2145
|
+
*/
|
|
2146
|
+
provider?: string[];
|
|
2147
|
+
};
|
|
2148
|
+
header?: never;
|
|
2149
|
+
path: {
|
|
2150
|
+
/** @description URL-safe workspace identifier. */
|
|
2151
|
+
workspaceSlug: string;
|
|
2152
|
+
};
|
|
2153
|
+
cookie?: never;
|
|
2154
|
+
};
|
|
2155
|
+
requestBody?: never;
|
|
2156
|
+
responses: {
|
|
2157
|
+
/**
|
|
2158
|
+
* @description Generic paginated response wrapper.
|
|
2159
|
+
*
|
|
2160
|
+
* Provides a consistent structure for all paginated API responses with
|
|
2161
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
2162
|
+
* are more items to fetch.
|
|
2163
|
+
*/
|
|
2164
|
+
200: {
|
|
2165
|
+
headers: {
|
|
2166
|
+
[name: string]: unknown;
|
|
2167
|
+
};
|
|
2168
|
+
content: {
|
|
2169
|
+
"application/json": components["schemas"]["ConnectionPage"];
|
|
2170
|
+
};
|
|
2171
|
+
};
|
|
2172
|
+
/**
|
|
2173
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2174
|
+
*
|
|
2175
|
+
* This struct contains all the information needed to serialize an error
|
|
2176
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2177
|
+
* information, and user-friendly messages.
|
|
2178
|
+
*/
|
|
2179
|
+
401: {
|
|
2180
|
+
headers: {
|
|
2181
|
+
[name: string]: unknown;
|
|
2182
|
+
};
|
|
2183
|
+
content: {
|
|
2184
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2185
|
+
};
|
|
2186
|
+
};
|
|
2187
|
+
/**
|
|
2188
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2189
|
+
*
|
|
2190
|
+
* This struct contains all the information needed to serialize an error
|
|
2191
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2192
|
+
* information, and user-friendly messages.
|
|
2193
|
+
*/
|
|
2194
|
+
403: {
|
|
2195
|
+
headers: {
|
|
2196
|
+
[name: string]: unknown;
|
|
2197
|
+
};
|
|
2198
|
+
content: {
|
|
2199
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2200
|
+
};
|
|
2201
|
+
};
|
|
2202
|
+
};
|
|
2203
|
+
};
|
|
2204
|
+
put?: never;
|
|
2205
|
+
/**
|
|
2206
|
+
* Create connection
|
|
2207
|
+
* @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.
|
|
2208
|
+
*/
|
|
2209
|
+
post: {
|
|
2210
|
+
parameters: {
|
|
2211
|
+
query?: never;
|
|
2212
|
+
header?: never;
|
|
2213
|
+
path: {
|
|
2214
|
+
/** @description URL-safe workspace identifier. */
|
|
2215
|
+
workspaceSlug: string;
|
|
2216
|
+
};
|
|
2217
|
+
cookie?: never;
|
|
2218
|
+
};
|
|
2219
|
+
/** @description Request payload for creating a new workspace connection. */
|
|
2220
|
+
requestBody: {
|
|
2221
|
+
content: {
|
|
2222
|
+
"application/json": components["schemas"]["CreateConnection"];
|
|
2223
|
+
};
|
|
2224
|
+
};
|
|
2225
|
+
responses: {
|
|
2226
|
+
/**
|
|
2227
|
+
* @description Response type for a workspace connection.
|
|
2228
|
+
*
|
|
2229
|
+
* Note: The encrypted connection data is never exposed in API responses.
|
|
2230
|
+
* Only metadata about the connection is returned.
|
|
2231
|
+
*/
|
|
2232
|
+
201: {
|
|
2233
|
+
headers: {
|
|
2234
|
+
[name: string]: unknown;
|
|
2235
|
+
};
|
|
2236
|
+
content: {
|
|
2237
|
+
"application/json": components["schemas"]["Connection"];
|
|
2238
|
+
};
|
|
2239
|
+
};
|
|
2240
|
+
/**
|
|
2241
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2242
|
+
*
|
|
2243
|
+
* This struct contains all the information needed to serialize an error
|
|
2244
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2245
|
+
* information, and user-friendly messages.
|
|
2246
|
+
*/
|
|
2247
|
+
400: {
|
|
2248
|
+
headers: {
|
|
2249
|
+
[name: string]: unknown;
|
|
2250
|
+
};
|
|
2251
|
+
content: {
|
|
2252
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2253
|
+
};
|
|
2254
|
+
};
|
|
2255
|
+
/**
|
|
2256
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2257
|
+
*
|
|
2258
|
+
* This struct contains all the information needed to serialize an error
|
|
2259
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2260
|
+
* information, and user-friendly messages.
|
|
2261
|
+
*/
|
|
2262
|
+
401: {
|
|
2263
|
+
headers: {
|
|
2264
|
+
[name: string]: unknown;
|
|
2265
|
+
};
|
|
2266
|
+
content: {
|
|
2267
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2268
|
+
};
|
|
2269
|
+
};
|
|
2270
|
+
/**
|
|
2271
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2272
|
+
*
|
|
2273
|
+
* This struct contains all the information needed to serialize an error
|
|
2274
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2275
|
+
* information, and user-friendly messages.
|
|
2276
|
+
*/
|
|
2277
|
+
403: {
|
|
2278
|
+
headers: {
|
|
2279
|
+
[name: string]: unknown;
|
|
2280
|
+
};
|
|
2281
|
+
content: {
|
|
2282
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2283
|
+
};
|
|
2284
|
+
};
|
|
2285
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2286
|
+
415: {
|
|
2287
|
+
headers: {
|
|
2288
|
+
[name: string]: unknown;
|
|
2289
|
+
};
|
|
2290
|
+
content: {
|
|
2291
|
+
"text/plain": string;
|
|
2292
|
+
};
|
|
2293
|
+
};
|
|
2294
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2295
|
+
422: {
|
|
2296
|
+
headers: {
|
|
2297
|
+
[name: string]: unknown;
|
|
2298
|
+
};
|
|
2299
|
+
content: {
|
|
2300
|
+
"text/plain": string;
|
|
2301
|
+
};
|
|
2302
|
+
};
|
|
2303
|
+
};
|
|
2304
|
+
};
|
|
2305
|
+
delete?: never;
|
|
2306
|
+
options?: never;
|
|
2307
|
+
head?: never;
|
|
2308
|
+
patch?: never;
|
|
2309
|
+
trace?: never;
|
|
2310
|
+
};
|
|
2311
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/": {
|
|
2312
|
+
parameters: {
|
|
2313
|
+
query?: never;
|
|
2314
|
+
header?: never;
|
|
2315
|
+
path?: never;
|
|
2316
|
+
cookie?: never;
|
|
2317
|
+
};
|
|
2318
|
+
/**
|
|
2319
|
+
* Get connection
|
|
2320
|
+
* @description Returns connection metadata without encrypted credentials.
|
|
2321
|
+
*/
|
|
2322
|
+
get: {
|
|
2323
|
+
parameters: {
|
|
2324
|
+
query?: never;
|
|
2325
|
+
header?: never;
|
|
2326
|
+
path: {
|
|
2327
|
+
/** @description URL-safe workspace identifier. */
|
|
2328
|
+
workspaceSlug: string;
|
|
2329
|
+
/** @description Opaque identifier of the connection. */
|
|
2330
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2331
|
+
};
|
|
2332
|
+
cookie?: never;
|
|
2333
|
+
};
|
|
2334
|
+
requestBody?: never;
|
|
2335
|
+
responses: {
|
|
2336
|
+
/**
|
|
2337
|
+
* @description Response type for a workspace connection.
|
|
2338
|
+
*
|
|
2339
|
+
* Note: The encrypted connection data is never exposed in API responses.
|
|
2340
|
+
* Only metadata about the connection is returned.
|
|
2341
|
+
*/
|
|
2342
|
+
200: {
|
|
2343
|
+
headers: {
|
|
2344
|
+
[name: string]: unknown;
|
|
2345
|
+
};
|
|
2346
|
+
content: {
|
|
2347
|
+
"application/json": components["schemas"]["Connection"];
|
|
2348
|
+
};
|
|
2349
|
+
};
|
|
2350
|
+
/**
|
|
2351
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2352
|
+
*
|
|
2353
|
+
* This struct contains all the information needed to serialize an error
|
|
2354
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2355
|
+
* information, and user-friendly messages.
|
|
2356
|
+
*/
|
|
2357
|
+
401: {
|
|
2358
|
+
headers: {
|
|
2359
|
+
[name: string]: unknown;
|
|
2360
|
+
};
|
|
2361
|
+
content: {
|
|
2362
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2363
|
+
};
|
|
2364
|
+
};
|
|
2365
|
+
/**
|
|
2366
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2367
|
+
*
|
|
2368
|
+
* This struct contains all the information needed to serialize an error
|
|
2369
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2370
|
+
* information, and user-friendly messages.
|
|
2371
|
+
*/
|
|
2372
|
+
403: {
|
|
2373
|
+
headers: {
|
|
2374
|
+
[name: string]: unknown;
|
|
2375
|
+
};
|
|
2376
|
+
content: {
|
|
2377
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2378
|
+
};
|
|
2379
|
+
};
|
|
2380
|
+
/**
|
|
2381
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2382
|
+
*
|
|
2383
|
+
* This struct contains all the information needed to serialize an error
|
|
2384
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2385
|
+
* information, and user-friendly messages.
|
|
2386
|
+
*/
|
|
2387
|
+
404: {
|
|
2388
|
+
headers: {
|
|
2389
|
+
[name: string]: unknown;
|
|
2390
|
+
};
|
|
2391
|
+
content: {
|
|
2392
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2393
|
+
};
|
|
2394
|
+
};
|
|
2395
|
+
};
|
|
2396
|
+
};
|
|
2397
|
+
put?: never;
|
|
2398
|
+
post?: never;
|
|
2399
|
+
/**
|
|
2400
|
+
* Delete connection
|
|
2401
|
+
* @description Soft-deletes the connection from the workspace.
|
|
2402
|
+
*/
|
|
2403
|
+
delete: {
|
|
2404
|
+
parameters: {
|
|
2405
|
+
query?: never;
|
|
2406
|
+
header?: never;
|
|
2407
|
+
path: {
|
|
2408
|
+
/** @description URL-safe workspace identifier. */
|
|
2409
|
+
workspaceSlug: string;
|
|
2410
|
+
/** @description Opaque identifier of the connection. */
|
|
2411
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2412
|
+
};
|
|
2413
|
+
cookie?: never;
|
|
2414
|
+
};
|
|
2415
|
+
requestBody?: never;
|
|
2416
|
+
responses: {
|
|
2417
|
+
/** @description no content */
|
|
2418
|
+
204: {
|
|
2419
|
+
headers: {
|
|
2420
|
+
[name: string]: unknown;
|
|
2421
|
+
};
|
|
2422
|
+
content?: never;
|
|
2423
|
+
};
|
|
2424
|
+
/**
|
|
2425
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2426
|
+
*
|
|
2427
|
+
* This struct contains all the information needed to serialize an error
|
|
2428
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2429
|
+
* information, and user-friendly messages.
|
|
2430
|
+
*/
|
|
2431
|
+
401: {
|
|
2432
|
+
headers: {
|
|
2433
|
+
[name: string]: unknown;
|
|
2434
|
+
};
|
|
2435
|
+
content: {
|
|
2436
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2437
|
+
};
|
|
2438
|
+
};
|
|
2439
|
+
/**
|
|
2440
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2441
|
+
*
|
|
2442
|
+
* This struct contains all the information needed to serialize an error
|
|
2443
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2444
|
+
* information, and user-friendly messages.
|
|
2445
|
+
*/
|
|
2446
|
+
403: {
|
|
2447
|
+
headers: {
|
|
2448
|
+
[name: string]: unknown;
|
|
2449
|
+
};
|
|
2450
|
+
content: {
|
|
2451
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2452
|
+
};
|
|
2453
|
+
};
|
|
2454
|
+
/**
|
|
2455
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2456
|
+
*
|
|
2457
|
+
* This struct contains all the information needed to serialize an error
|
|
2458
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2459
|
+
* information, and user-friendly messages.
|
|
2460
|
+
*/
|
|
2461
|
+
404: {
|
|
2462
|
+
headers: {
|
|
2463
|
+
[name: string]: unknown;
|
|
2464
|
+
};
|
|
2465
|
+
content: {
|
|
2466
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2467
|
+
};
|
|
2468
|
+
};
|
|
2469
|
+
};
|
|
2470
|
+
};
|
|
2471
|
+
options?: never;
|
|
2472
|
+
head?: never;
|
|
1865
2473
|
/**
|
|
1866
|
-
*
|
|
1867
|
-
* @description
|
|
2474
|
+
* Update connection
|
|
2475
|
+
* @description Updates connection name or encrypted data.
|
|
1868
2476
|
*/
|
|
1869
|
-
|
|
2477
|
+
patch: {
|
|
1870
2478
|
parameters: {
|
|
1871
2479
|
query?: never;
|
|
1872
2480
|
header?: never;
|
|
1873
2481
|
path: {
|
|
1874
2482
|
/** @description URL-safe workspace identifier. */
|
|
1875
2483
|
workspaceSlug: string;
|
|
2484
|
+
/** @description Opaque identifier of the connection. */
|
|
2485
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
1876
2486
|
};
|
|
1877
2487
|
cookie?: never;
|
|
1878
2488
|
};
|
|
1879
|
-
/** @description Request payload for
|
|
2489
|
+
/** @description Request payload for updating an existing workspace connection. */
|
|
1880
2490
|
requestBody: {
|
|
1881
2491
|
content: {
|
|
1882
|
-
"application/json": components["schemas"]["
|
|
2492
|
+
"application/json": components["schemas"]["UpdateConnection"];
|
|
1883
2493
|
};
|
|
1884
2494
|
};
|
|
1885
2495
|
responses: {
|
|
@@ -1889,7 +2499,7 @@ interface paths {
|
|
|
1889
2499
|
* Note: The encrypted connection data is never exposed in API responses.
|
|
1890
2500
|
* Only metadata about the connection is returned.
|
|
1891
2501
|
*/
|
|
1892
|
-
|
|
2502
|
+
200: {
|
|
1893
2503
|
headers: {
|
|
1894
2504
|
[name: string]: unknown;
|
|
1895
2505
|
};
|
|
@@ -1942,6 +2552,21 @@ interface paths {
|
|
|
1942
2552
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1943
2553
|
};
|
|
1944
2554
|
};
|
|
2555
|
+
/**
|
|
2556
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2557
|
+
*
|
|
2558
|
+
* This struct contains all the information needed to serialize an error
|
|
2559
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2560
|
+
* information, and user-friendly messages.
|
|
2561
|
+
*/
|
|
2562
|
+
404: {
|
|
2563
|
+
headers: {
|
|
2564
|
+
[name: string]: unknown;
|
|
2565
|
+
};
|
|
2566
|
+
content: {
|
|
2567
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2568
|
+
};
|
|
2569
|
+
};
|
|
1945
2570
|
/** @description Expected request with `Content-Type: application/json` */
|
|
1946
2571
|
415: {
|
|
1947
2572
|
headers: {
|
|
@@ -1962,13 +2587,98 @@ interface paths {
|
|
|
1962
2587
|
};
|
|
1963
2588
|
};
|
|
1964
2589
|
};
|
|
2590
|
+
trace?: never;
|
|
2591
|
+
};
|
|
2592
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/verify/": {
|
|
2593
|
+
parameters: {
|
|
2594
|
+
query?: never;
|
|
2595
|
+
header?: never;
|
|
2596
|
+
path?: never;
|
|
2597
|
+
cookie?: never;
|
|
2598
|
+
};
|
|
2599
|
+
get?: never;
|
|
2600
|
+
put?: never;
|
|
2601
|
+
/**
|
|
2602
|
+
* Verify connection
|
|
2603
|
+
* @description Checks whether the connection's backing store is reachable with its stored credentials.
|
|
2604
|
+
*/
|
|
2605
|
+
post: {
|
|
2606
|
+
parameters: {
|
|
2607
|
+
query?: never;
|
|
2608
|
+
header?: never;
|
|
2609
|
+
path: {
|
|
2610
|
+
/** @description URL-safe workspace identifier. */
|
|
2611
|
+
workspaceSlug: string;
|
|
2612
|
+
/** @description Opaque identifier of the connection. */
|
|
2613
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2614
|
+
};
|
|
2615
|
+
cookie?: never;
|
|
2616
|
+
};
|
|
2617
|
+
requestBody?: never;
|
|
2618
|
+
responses: {
|
|
2619
|
+
/** @description Result of a connection reachability check. */
|
|
2620
|
+
200: {
|
|
2621
|
+
headers: {
|
|
2622
|
+
[name: string]: unknown;
|
|
2623
|
+
};
|
|
2624
|
+
content: {
|
|
2625
|
+
"application/json": components["schemas"]["ConnectionVerification"];
|
|
2626
|
+
};
|
|
2627
|
+
};
|
|
2628
|
+
/**
|
|
2629
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2630
|
+
*
|
|
2631
|
+
* This struct contains all the information needed to serialize an error
|
|
2632
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2633
|
+
* information, and user-friendly messages.
|
|
2634
|
+
*/
|
|
2635
|
+
401: {
|
|
2636
|
+
headers: {
|
|
2637
|
+
[name: string]: unknown;
|
|
2638
|
+
};
|
|
2639
|
+
content: {
|
|
2640
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2641
|
+
};
|
|
2642
|
+
};
|
|
2643
|
+
/**
|
|
2644
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2645
|
+
*
|
|
2646
|
+
* This struct contains all the information needed to serialize an error
|
|
2647
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2648
|
+
* information, and user-friendly messages.
|
|
2649
|
+
*/
|
|
2650
|
+
403: {
|
|
2651
|
+
headers: {
|
|
2652
|
+
[name: string]: unknown;
|
|
2653
|
+
};
|
|
2654
|
+
content: {
|
|
2655
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2656
|
+
};
|
|
2657
|
+
};
|
|
2658
|
+
/**
|
|
2659
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2660
|
+
*
|
|
2661
|
+
* This struct contains all the information needed to serialize an error
|
|
2662
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2663
|
+
* information, and user-friendly messages.
|
|
2664
|
+
*/
|
|
2665
|
+
404: {
|
|
2666
|
+
headers: {
|
|
2667
|
+
[name: string]: unknown;
|
|
2668
|
+
};
|
|
2669
|
+
content: {
|
|
2670
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2671
|
+
};
|
|
2672
|
+
};
|
|
2673
|
+
};
|
|
2674
|
+
};
|
|
1965
2675
|
delete?: never;
|
|
1966
2676
|
options?: never;
|
|
1967
2677
|
head?: never;
|
|
1968
2678
|
patch?: never;
|
|
1969
2679
|
trace?: never;
|
|
1970
2680
|
};
|
|
1971
|
-
"/workspaces/{workspaceSlug}/
|
|
2681
|
+
"/workspaces/{workspaceSlug}/chat/sessions/": {
|
|
1972
2682
|
parameters: {
|
|
1973
2683
|
query?: never;
|
|
1974
2684
|
header?: never;
|
|
@@ -1976,35 +2686,48 @@ interface paths {
|
|
|
1976
2686
|
cookie?: never;
|
|
1977
2687
|
};
|
|
1978
2688
|
/**
|
|
1979
|
-
*
|
|
1980
|
-
* @description Returns
|
|
2689
|
+
* List chat sessions
|
|
2690
|
+
* @description Returns the workspace's chat sessions, newest first, cursor-paginated.
|
|
1981
2691
|
*/
|
|
1982
2692
|
get: {
|
|
1983
2693
|
parameters: {
|
|
1984
|
-
query?:
|
|
2694
|
+
query?: {
|
|
2695
|
+
/**
|
|
2696
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
2697
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
2698
|
+
*/
|
|
2699
|
+
after?: string;
|
|
2700
|
+
/**
|
|
2701
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
2702
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
2703
|
+
* only when the count is actually needed.
|
|
2704
|
+
*/
|
|
2705
|
+
includeCount?: boolean;
|
|
2706
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2707
|
+
limit?: number;
|
|
2708
|
+
};
|
|
1985
2709
|
header?: never;
|
|
1986
2710
|
path: {
|
|
1987
2711
|
/** @description URL-safe workspace identifier. */
|
|
1988
2712
|
workspaceSlug: string;
|
|
1989
|
-
/** @description Opaque identifier of the connection. */
|
|
1990
|
-
connectionId: components["schemas"]["ConnectionId"];
|
|
1991
2713
|
};
|
|
1992
2714
|
cookie?: never;
|
|
1993
2715
|
};
|
|
1994
2716
|
requestBody?: never;
|
|
1995
2717
|
responses: {
|
|
1996
2718
|
/**
|
|
1997
|
-
* @description
|
|
2719
|
+
* @description Generic paginated response wrapper.
|
|
1998
2720
|
*
|
|
1999
|
-
*
|
|
2000
|
-
*
|
|
2721
|
+
* Provides a consistent structure for all paginated API responses with
|
|
2722
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
2723
|
+
* are more items to fetch.
|
|
2001
2724
|
*/
|
|
2002
2725
|
200: {
|
|
2003
2726
|
headers: {
|
|
2004
2727
|
[name: string]: unknown;
|
|
2005
2728
|
};
|
|
2006
2729
|
content: {
|
|
2007
|
-
"application/json": components["schemas"]["
|
|
2730
|
+
"application/json": components["schemas"]["ChatSessionPage"];
|
|
2008
2731
|
};
|
|
2009
2732
|
};
|
|
2010
2733
|
/**
|
|
@@ -2037,6 +2760,63 @@ interface paths {
|
|
|
2037
2760
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2038
2761
|
};
|
|
2039
2762
|
};
|
|
2763
|
+
};
|
|
2764
|
+
};
|
|
2765
|
+
put?: never;
|
|
2766
|
+
/**
|
|
2767
|
+
* Create chat session
|
|
2768
|
+
* @description Opens a new assistant chat session in the workspace.
|
|
2769
|
+
*/
|
|
2770
|
+
post: {
|
|
2771
|
+
parameters: {
|
|
2772
|
+
query?: never;
|
|
2773
|
+
header?: never;
|
|
2774
|
+
path: {
|
|
2775
|
+
/** @description URL-safe workspace identifier. */
|
|
2776
|
+
workspaceSlug: string;
|
|
2777
|
+
};
|
|
2778
|
+
cookie?: never;
|
|
2779
|
+
};
|
|
2780
|
+
/** @description Request to create a chat session. */
|
|
2781
|
+
requestBody: {
|
|
2782
|
+
content: {
|
|
2783
|
+
"application/json": components["schemas"]["CreateChatSession"];
|
|
2784
|
+
};
|
|
2785
|
+
};
|
|
2786
|
+
responses: {
|
|
2787
|
+
/** @description A chat session. */
|
|
2788
|
+
201: {
|
|
2789
|
+
headers: {
|
|
2790
|
+
[name: string]: unknown;
|
|
2791
|
+
};
|
|
2792
|
+
content: {
|
|
2793
|
+
"application/json": components["schemas"]["ChatSession"];
|
|
2794
|
+
};
|
|
2795
|
+
};
|
|
2796
|
+
/** @description Failed to parse the request body as JSON */
|
|
2797
|
+
400: {
|
|
2798
|
+
headers: {
|
|
2799
|
+
[name: string]: unknown;
|
|
2800
|
+
};
|
|
2801
|
+
content: {
|
|
2802
|
+
"text/plain": string;
|
|
2803
|
+
};
|
|
2804
|
+
};
|
|
2805
|
+
/**
|
|
2806
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2807
|
+
*
|
|
2808
|
+
* This struct contains all the information needed to serialize an error
|
|
2809
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2810
|
+
* information, and user-friendly messages.
|
|
2811
|
+
*/
|
|
2812
|
+
401: {
|
|
2813
|
+
headers: {
|
|
2814
|
+
[name: string]: unknown;
|
|
2815
|
+
};
|
|
2816
|
+
content: {
|
|
2817
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2818
|
+
};
|
|
2819
|
+
};
|
|
2040
2820
|
/**
|
|
2041
2821
|
* @description HTTP error response representation with security-conscious design.
|
|
2042
2822
|
*
|
|
@@ -2044,7 +2824,7 @@ interface paths {
|
|
|
2044
2824
|
* response, including the error name, message, HTTP status code, resource
|
|
2045
2825
|
* information, and user-friendly messages.
|
|
2046
2826
|
*/
|
|
2047
|
-
|
|
2827
|
+
403: {
|
|
2048
2828
|
headers: {
|
|
2049
2829
|
[name: string]: unknown;
|
|
2050
2830
|
};
|
|
@@ -2052,13 +2832,45 @@ interface paths {
|
|
|
2052
2832
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2053
2833
|
};
|
|
2054
2834
|
};
|
|
2835
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2836
|
+
415: {
|
|
2837
|
+
headers: {
|
|
2838
|
+
[name: string]: unknown;
|
|
2839
|
+
};
|
|
2840
|
+
content: {
|
|
2841
|
+
"text/plain": string;
|
|
2842
|
+
};
|
|
2843
|
+
};
|
|
2844
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2845
|
+
422: {
|
|
2846
|
+
headers: {
|
|
2847
|
+
[name: string]: unknown;
|
|
2848
|
+
};
|
|
2849
|
+
content: {
|
|
2850
|
+
"text/plain": string;
|
|
2851
|
+
};
|
|
2852
|
+
};
|
|
2055
2853
|
};
|
|
2056
2854
|
};
|
|
2855
|
+
delete?: never;
|
|
2856
|
+
options?: never;
|
|
2857
|
+
head?: never;
|
|
2858
|
+
patch?: never;
|
|
2859
|
+
trace?: never;
|
|
2860
|
+
};
|
|
2861
|
+
"/workspaces/{workspaceSlug}/chat/sessions/{sessionId}/": {
|
|
2862
|
+
parameters: {
|
|
2863
|
+
query?: never;
|
|
2864
|
+
header?: never;
|
|
2865
|
+
path?: never;
|
|
2866
|
+
cookie?: never;
|
|
2867
|
+
};
|
|
2868
|
+
get?: never;
|
|
2057
2869
|
put?: never;
|
|
2058
2870
|
post?: never;
|
|
2059
2871
|
/**
|
|
2060
|
-
* Delete
|
|
2061
|
-
* @description Soft-deletes
|
|
2872
|
+
* Delete chat session
|
|
2873
|
+
* @description Soft-deletes a chat session.
|
|
2062
2874
|
*/
|
|
2063
2875
|
delete: {
|
|
2064
2876
|
parameters: {
|
|
@@ -2067,8 +2879,8 @@ interface paths {
|
|
|
2067
2879
|
path: {
|
|
2068
2880
|
/** @description URL-safe workspace identifier. */
|
|
2069
2881
|
workspaceSlug: string;
|
|
2070
|
-
/** @description
|
|
2071
|
-
|
|
2882
|
+
/** @description The session id. */
|
|
2883
|
+
sessionId: string;
|
|
2072
2884
|
};
|
|
2073
2885
|
cookie?: never;
|
|
2074
2886
|
};
|
|
@@ -2130,56 +2942,40 @@ interface paths {
|
|
|
2130
2942
|
};
|
|
2131
2943
|
options?: never;
|
|
2132
2944
|
head?: never;
|
|
2945
|
+
patch?: never;
|
|
2946
|
+
trace?: never;
|
|
2947
|
+
};
|
|
2948
|
+
"/workspaces/{workspaceSlug}/chat/sessions/{sessionId}/messages/": {
|
|
2949
|
+
parameters: {
|
|
2950
|
+
query?: never;
|
|
2951
|
+
header?: never;
|
|
2952
|
+
path?: never;
|
|
2953
|
+
cookie?: never;
|
|
2954
|
+
};
|
|
2133
2955
|
/**
|
|
2134
|
-
*
|
|
2135
|
-
* @description
|
|
2956
|
+
* List chat messages
|
|
2957
|
+
* @description Returns a session's messages in chronological order.
|
|
2136
2958
|
*/
|
|
2137
|
-
|
|
2959
|
+
get: {
|
|
2138
2960
|
parameters: {
|
|
2139
2961
|
query?: never;
|
|
2140
2962
|
header?: never;
|
|
2141
2963
|
path: {
|
|
2142
2964
|
/** @description URL-safe workspace identifier. */
|
|
2143
2965
|
workspaceSlug: string;
|
|
2144
|
-
/** @description
|
|
2145
|
-
|
|
2966
|
+
/** @description The session id. */
|
|
2967
|
+
sessionId: string;
|
|
2146
2968
|
};
|
|
2147
2969
|
cookie?: never;
|
|
2148
2970
|
};
|
|
2149
|
-
|
|
2150
|
-
requestBody: {
|
|
2151
|
-
content: {
|
|
2152
|
-
"application/json": components["schemas"]["UpdateConnection"];
|
|
2153
|
-
};
|
|
2154
|
-
};
|
|
2971
|
+
requestBody?: never;
|
|
2155
2972
|
responses: {
|
|
2156
|
-
/**
|
|
2157
|
-
* @description Response type for a workspace connection.
|
|
2158
|
-
*
|
|
2159
|
-
* Note: The encrypted connection data is never exposed in API responses.
|
|
2160
|
-
* Only metadata about the connection is returned.
|
|
2161
|
-
*/
|
|
2162
2973
|
200: {
|
|
2163
2974
|
headers: {
|
|
2164
2975
|
[name: string]: unknown;
|
|
2165
2976
|
};
|
|
2166
2977
|
content: {
|
|
2167
|
-
"application/json": components["schemas"]["
|
|
2168
|
-
};
|
|
2169
|
-
};
|
|
2170
|
-
/**
|
|
2171
|
-
* @description HTTP error response representation with security-conscious design.
|
|
2172
|
-
*
|
|
2173
|
-
* This struct contains all the information needed to serialize an error
|
|
2174
|
-
* response, including the error name, message, HTTP status code, resource
|
|
2175
|
-
* information, and user-friendly messages.
|
|
2176
|
-
*/
|
|
2177
|
-
400: {
|
|
2178
|
-
headers: {
|
|
2179
|
-
[name: string]: unknown;
|
|
2180
|
-
};
|
|
2181
|
-
content: {
|
|
2182
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
2978
|
+
"application/json": components["schemas"]["ChatMessage"][];
|
|
2183
2979
|
};
|
|
2184
2980
|
};
|
|
2185
2981
|
/**
|
|
@@ -2227,40 +3023,12 @@ interface paths {
|
|
|
2227
3023
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2228
3024
|
};
|
|
2229
3025
|
};
|
|
2230
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
2231
|
-
415: {
|
|
2232
|
-
headers: {
|
|
2233
|
-
[name: string]: unknown;
|
|
2234
|
-
};
|
|
2235
|
-
content: {
|
|
2236
|
-
"text/plain": string;
|
|
2237
|
-
};
|
|
2238
|
-
};
|
|
2239
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
2240
|
-
422: {
|
|
2241
|
-
headers: {
|
|
2242
|
-
[name: string]: unknown;
|
|
2243
|
-
};
|
|
2244
|
-
content: {
|
|
2245
|
-
"text/plain": string;
|
|
2246
|
-
};
|
|
2247
|
-
};
|
|
2248
3026
|
};
|
|
2249
3027
|
};
|
|
2250
|
-
trace?: never;
|
|
2251
|
-
};
|
|
2252
|
-
"/workspaces/{workspaceSlug}/connections/{connectionId}/verify/": {
|
|
2253
|
-
parameters: {
|
|
2254
|
-
query?: never;
|
|
2255
|
-
header?: never;
|
|
2256
|
-
path?: never;
|
|
2257
|
-
cookie?: never;
|
|
2258
|
-
};
|
|
2259
|
-
get?: never;
|
|
2260
3028
|
put?: never;
|
|
2261
3029
|
/**
|
|
2262
|
-
*
|
|
2263
|
-
* @description
|
|
3030
|
+
* Send chat message
|
|
3031
|
+
* @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.
|
|
2264
3032
|
*/
|
|
2265
3033
|
post: {
|
|
2266
3034
|
parameters: {
|
|
@@ -2269,20 +3037,34 @@ interface paths {
|
|
|
2269
3037
|
path: {
|
|
2270
3038
|
/** @description URL-safe workspace identifier. */
|
|
2271
3039
|
workspaceSlug: string;
|
|
2272
|
-
/** @description
|
|
2273
|
-
|
|
3040
|
+
/** @description The session id. */
|
|
3041
|
+
sessionId: string;
|
|
2274
3042
|
};
|
|
2275
3043
|
cookie?: never;
|
|
2276
3044
|
};
|
|
2277
|
-
|
|
3045
|
+
/** @description Request to send a message and stream the assistant's reply. */
|
|
3046
|
+
requestBody: {
|
|
3047
|
+
content: {
|
|
3048
|
+
"application/json": components["schemas"]["SendChatMessage"];
|
|
3049
|
+
};
|
|
3050
|
+
};
|
|
2278
3051
|
responses: {
|
|
2279
|
-
/** @description
|
|
3052
|
+
/** @description Server-sent event stream; each event's `data` is the payload below. */
|
|
2280
3053
|
200: {
|
|
2281
3054
|
headers: {
|
|
2282
3055
|
[name: string]: unknown;
|
|
2283
3056
|
};
|
|
2284
3057
|
content: {
|
|
2285
|
-
"
|
|
3058
|
+
"text/event-stream": components["schemas"]["ChatToken"];
|
|
3059
|
+
};
|
|
3060
|
+
};
|
|
3061
|
+
/** @description Failed to parse the request body as JSON */
|
|
3062
|
+
400: {
|
|
3063
|
+
headers: {
|
|
3064
|
+
[name: string]: unknown;
|
|
3065
|
+
};
|
|
3066
|
+
content: {
|
|
3067
|
+
"text/plain": string;
|
|
2286
3068
|
};
|
|
2287
3069
|
};
|
|
2288
3070
|
/**
|
|
@@ -2330,6 +3112,39 @@ interface paths {
|
|
|
2330
3112
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2331
3113
|
};
|
|
2332
3114
|
};
|
|
3115
|
+
/**
|
|
3116
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3117
|
+
*
|
|
3118
|
+
* This struct contains all the information needed to serialize an error
|
|
3119
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3120
|
+
* information, and user-friendly messages.
|
|
3121
|
+
*/
|
|
3122
|
+
409: {
|
|
3123
|
+
headers: {
|
|
3124
|
+
[name: string]: unknown;
|
|
3125
|
+
};
|
|
3126
|
+
content: {
|
|
3127
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3128
|
+
};
|
|
3129
|
+
};
|
|
3130
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
3131
|
+
415: {
|
|
3132
|
+
headers: {
|
|
3133
|
+
[name: string]: unknown;
|
|
3134
|
+
};
|
|
3135
|
+
content: {
|
|
3136
|
+
"text/plain": string;
|
|
3137
|
+
};
|
|
3138
|
+
};
|
|
3139
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
3140
|
+
422: {
|
|
3141
|
+
headers: {
|
|
3142
|
+
[name: string]: unknown;
|
|
3143
|
+
};
|
|
3144
|
+
content: {
|
|
3145
|
+
"text/plain": string;
|
|
3146
|
+
};
|
|
3147
|
+
};
|
|
2333
3148
|
};
|
|
2334
3149
|
};
|
|
2335
3150
|
delete?: never;
|
|
@@ -2357,6 +3172,12 @@ interface paths {
|
|
|
2357
3172
|
* Obtain this from the `nextCursor` field in the response.
|
|
2358
3173
|
*/
|
|
2359
3174
|
after?: string;
|
|
3175
|
+
/**
|
|
3176
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
3177
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
3178
|
+
* only when the count is actually needed.
|
|
3179
|
+
*/
|
|
3180
|
+
includeCount?: boolean;
|
|
2360
3181
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2361
3182
|
limit?: number;
|
|
2362
3183
|
/**
|
|
@@ -2601,6 +3422,12 @@ interface paths {
|
|
|
2601
3422
|
* Obtain this from the `nextCursor` field in the response.
|
|
2602
3423
|
*/
|
|
2603
3424
|
after?: string;
|
|
3425
|
+
/**
|
|
3426
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
3427
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
3428
|
+
* only when the count is actually needed.
|
|
3429
|
+
*/
|
|
3430
|
+
includeCount?: boolean;
|
|
2604
3431
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2605
3432
|
limit?: number;
|
|
2606
3433
|
};
|
|
@@ -2910,6 +3737,12 @@ interface paths {
|
|
|
2910
3737
|
* Obtain this from the `nextCursor` field in the response.
|
|
2911
3738
|
*/
|
|
2912
3739
|
after?: string;
|
|
3740
|
+
/**
|
|
3741
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
3742
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
3743
|
+
* only when the count is actually needed.
|
|
3744
|
+
*/
|
|
3745
|
+
includeCount?: boolean;
|
|
2913
3746
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2914
3747
|
limit?: number;
|
|
2915
3748
|
};
|
|
@@ -3137,7 +3970,7 @@ interface paths {
|
|
|
3137
3970
|
post?: never;
|
|
3138
3971
|
/**
|
|
3139
3972
|
* Delete file
|
|
3140
|
-
* @description
|
|
3973
|
+
* @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
3974
|
*/
|
|
3142
3975
|
delete: {
|
|
3143
3976
|
parameters: {
|
|
@@ -3348,12 +4181,14 @@ interface paths {
|
|
|
3348
4181
|
};
|
|
3349
4182
|
requestBody?: never;
|
|
3350
4183
|
responses: {
|
|
3351
|
-
/** @description
|
|
4184
|
+
/** @description The file content. */
|
|
3352
4185
|
200: {
|
|
3353
4186
|
headers: {
|
|
3354
4187
|
[name: string]: unknown;
|
|
3355
4188
|
};
|
|
3356
|
-
content
|
|
4189
|
+
content: {
|
|
4190
|
+
"application/octet-stream": unknown;
|
|
4191
|
+
};
|
|
3357
4192
|
};
|
|
3358
4193
|
/**
|
|
3359
4194
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -3429,6 +4264,12 @@ interface paths {
|
|
|
3429
4264
|
* Obtain this from the `nextCursor` field in the response.
|
|
3430
4265
|
*/
|
|
3431
4266
|
after?: string;
|
|
4267
|
+
/**
|
|
4268
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
4269
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
4270
|
+
* only when the count is actually needed.
|
|
4271
|
+
*/
|
|
4272
|
+
includeCount?: boolean;
|
|
3432
4273
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
3433
4274
|
limit?: number;
|
|
3434
4275
|
/** @description Search by pipeline name (trigram similarity). */
|
|
@@ -3894,6 +4735,12 @@ interface paths {
|
|
|
3894
4735
|
* Obtain this from the `nextCursor` field in the response.
|
|
3895
4736
|
*/
|
|
3896
4737
|
after?: string;
|
|
4738
|
+
/**
|
|
4739
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
4740
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
4741
|
+
* only when the count is actually needed.
|
|
4742
|
+
*/
|
|
4743
|
+
includeCount?: boolean;
|
|
3897
4744
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
3898
4745
|
limit?: number;
|
|
3899
4746
|
/** @description Filter by the source file the run analyzes. */
|
|
@@ -4005,6 +4852,12 @@ interface paths {
|
|
|
4005
4852
|
* Obtain this from the `nextCursor` field in the response.
|
|
4006
4853
|
*/
|
|
4007
4854
|
after?: string;
|
|
4855
|
+
/**
|
|
4856
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
4857
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
4858
|
+
* only when the count is actually needed.
|
|
4859
|
+
*/
|
|
4860
|
+
includeCount?: boolean;
|
|
4008
4861
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
4009
4862
|
limit?: number;
|
|
4010
4863
|
/** @description Filter by the source file the run analyzes. */
|
|
@@ -4660,7 +5513,7 @@ interface paths {
|
|
|
4660
5513
|
patch?: never;
|
|
4661
5514
|
trace?: never;
|
|
4662
5515
|
};
|
|
4663
|
-
"/workspaces/{workspaceSlug}/runs/{runId}/audit
|
|
5516
|
+
"/workspaces/{workspaceSlug}/runs/{runId}/audit": {
|
|
4664
5517
|
parameters: {
|
|
4665
5518
|
query?: never;
|
|
4666
5519
|
header?: never;
|
|
@@ -4668,12 +5521,15 @@ interface paths {
|
|
|
4668
5521
|
cookie?: never;
|
|
4669
5522
|
};
|
|
4670
5523
|
/**
|
|
4671
|
-
* Download run audit
|
|
4672
|
-
* @description Downloads the run's audit as a pretty-printed JSON file.
|
|
5524
|
+
* Download run audit
|
|
5525
|
+
* @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
5526
|
*/
|
|
4674
5527
|
get: {
|
|
4675
5528
|
parameters: {
|
|
4676
|
-
query?:
|
|
5529
|
+
query?: {
|
|
5530
|
+
/** @description Output format; defaults to `csv`. */
|
|
5531
|
+
format?: components["schemas"]["ExportFormat"];
|
|
5532
|
+
};
|
|
4677
5533
|
header?: never;
|
|
4678
5534
|
path: {
|
|
4679
5535
|
/** @description URL-safe workspace identifier. */
|
|
@@ -4685,114 +5541,15 @@ interface paths {
|
|
|
4685
5541
|
};
|
|
4686
5542
|
requestBody?: never;
|
|
4687
5543
|
responses: {
|
|
4688
|
-
/** @description
|
|
5544
|
+
/** @description The run's exported audit. */
|
|
4689
5545
|
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
5546
|
headers: {
|
|
4749
5547
|
[name: string]: unknown;
|
|
4750
5548
|
};
|
|
4751
5549
|
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;
|
|
5550
|
+
"application/zip": unknown;
|
|
5551
|
+
"application/json": unknown;
|
|
4794
5552
|
};
|
|
4795
|
-
content?: never;
|
|
4796
5553
|
};
|
|
4797
5554
|
/**
|
|
4798
5555
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -4883,6 +5640,12 @@ interface paths {
|
|
|
4883
5640
|
* Obtain this from the `nextCursor` field in the response.
|
|
4884
5641
|
*/
|
|
4885
5642
|
after?: string;
|
|
5643
|
+
/**
|
|
5644
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
5645
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
5646
|
+
* only when the count is actually needed.
|
|
5647
|
+
*/
|
|
5648
|
+
includeCount?: boolean;
|
|
4886
5649
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
4887
5650
|
limit?: number;
|
|
4888
5651
|
};
|
|
@@ -5463,6 +6226,12 @@ interface paths {
|
|
|
5463
6226
|
* Obtain this from the `nextCursor` field in the response.
|
|
5464
6227
|
*/
|
|
5465
6228
|
after?: string;
|
|
6229
|
+
/**
|
|
6230
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
6231
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
6232
|
+
* only when the count is actually needed.
|
|
6233
|
+
*/
|
|
6234
|
+
includeCount?: boolean;
|
|
5466
6235
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
5467
6236
|
limit?: number;
|
|
5468
6237
|
};
|
|
@@ -5857,6 +6626,12 @@ interface paths {
|
|
|
5857
6626
|
* Obtain this from the `nextCursor` field in the response.
|
|
5858
6627
|
*/
|
|
5859
6628
|
after?: string;
|
|
6629
|
+
/**
|
|
6630
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
6631
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
6632
|
+
* only when the count is actually needed.
|
|
6633
|
+
*/
|
|
6634
|
+
includeCount?: boolean;
|
|
5860
6635
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
5861
6636
|
limit?: number;
|
|
5862
6637
|
};
|
|
@@ -6163,6 +6938,12 @@ interface paths {
|
|
|
6163
6938
|
* Obtain this from the `nextCursor` field in the response.
|
|
6164
6939
|
*/
|
|
6165
6940
|
after?: string;
|
|
6941
|
+
/**
|
|
6942
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
6943
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
6944
|
+
* only when the count is actually needed.
|
|
6945
|
+
*/
|
|
6946
|
+
includeCount?: boolean;
|
|
6166
6947
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
6167
6948
|
limit?: number;
|
|
6168
6949
|
};
|
|
@@ -6873,6 +7654,12 @@ interface paths {
|
|
|
6873
7654
|
* Obtain this from the `nextCursor` field in the response.
|
|
6874
7655
|
*/
|
|
6875
7656
|
after?: string;
|
|
7657
|
+
/**
|
|
7658
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
7659
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
7660
|
+
* only when the count is actually needed.
|
|
7661
|
+
*/
|
|
7662
|
+
includeCount?: boolean;
|
|
6876
7663
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
6877
7664
|
limit?: number;
|
|
6878
7665
|
};
|
|
@@ -7901,6 +8688,25 @@ interface components {
|
|
|
7901
8688
|
/** @description Handle of the workspace this activity belongs to. */
|
|
7902
8689
|
workspaceSlug: components["schemas"]["Handle"];
|
|
7903
8690
|
};
|
|
8691
|
+
/**
|
|
8692
|
+
* @description Query parameters for the activity export: a `from`/`to` day range (inclusive)
|
|
8693
|
+
* and the output `format`. See [`DateWindow`] for the range defaults and bounds.
|
|
8694
|
+
*/
|
|
8695
|
+
ActivityExportQuery: {
|
|
8696
|
+
/** @description Output format; defaults to `csv`. */
|
|
8697
|
+
format?: components["schemas"]["ExportFormat"];
|
|
8698
|
+
/**
|
|
8699
|
+
* Format: date
|
|
8700
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
8701
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
8702
|
+
*/
|
|
8703
|
+
from?: string;
|
|
8704
|
+
/**
|
|
8705
|
+
* Format: date
|
|
8706
|
+
* @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC).
|
|
8707
|
+
*/
|
|
8708
|
+
to?: string;
|
|
8709
|
+
};
|
|
7904
8710
|
/**
|
|
7905
8711
|
* @description Generic paginated response wrapper.
|
|
7906
8712
|
*
|
|
@@ -8555,21 +9361,21 @@ interface components {
|
|
|
8555
9361
|
* audible but not painful, and never clips.
|
|
8556
9362
|
* @default 0.5
|
|
8557
9363
|
*/
|
|
8558
|
-
amplitude
|
|
9364
|
+
amplitude?: number;
|
|
8559
9365
|
/**
|
|
8560
9366
|
* Format: float
|
|
8561
9367
|
* @description Tone frequency in Hertz. Default 1 kHz, the broadcast
|
|
8562
9368
|
* convention.
|
|
8563
9369
|
* @default 1000
|
|
8564
9370
|
*/
|
|
8565
|
-
hz
|
|
9371
|
+
hz?: number;
|
|
8566
9372
|
/** @constant */
|
|
8567
9373
|
kind: "beep";
|
|
8568
9374
|
/**
|
|
8569
9375
|
* @description Tone shape. Default sine.
|
|
8570
9376
|
* @default sine
|
|
8571
9377
|
*/
|
|
8572
|
-
waveform
|
|
9378
|
+
waveform?: components["schemas"]["Waveform"];
|
|
8573
9379
|
};
|
|
8574
9380
|
/**
|
|
8575
9381
|
* @description What detection found in one document.
|
|
@@ -8624,6 +9430,18 @@ interface components {
|
|
|
8624
9430
|
parts?: {
|
|
8625
9431
|
[key: string]: components["schemas"]["EntityGroup"];
|
|
8626
9432
|
};
|
|
9433
|
+
/**
|
|
9434
|
+
* @description What the analyze pass cost: one entry per recognizer and
|
|
9435
|
+
* enricher that ran, each self-identifying by the name the
|
|
9436
|
+
* deployment configured it under.
|
|
9437
|
+
*
|
|
9438
|
+
* Empty when nothing model-backed ran, which is the common
|
|
9439
|
+
* case for a pattern-only pass. Recorded on analyze and not
|
|
9440
|
+
* re-derived at anonymize time, so a host that bills or rate
|
|
9441
|
+
* limits on model spend reads it straight off the returned
|
|
9442
|
+
* [`Audit`].
|
|
9443
|
+
*/
|
|
9444
|
+
usage?: components["schemas"]["UsageReport"];
|
|
8627
9445
|
};
|
|
8628
9446
|
/**
|
|
8629
9447
|
* @description Recognition-side facts that travel from analyze to anonymize.
|
|
@@ -8675,7 +9493,7 @@ interface components {
|
|
|
8675
9493
|
* time; anonymize re-uses them verbatim.
|
|
8676
9494
|
* @default []
|
|
8677
9495
|
*/
|
|
8678
|
-
languages
|
|
9496
|
+
languages?: components["schemas"]["Languages"];
|
|
8679
9497
|
/**
|
|
8680
9498
|
* @description Free-form request context: document tags, request purpose,
|
|
8681
9499
|
* output audience. See elide's [`ScopeMetadata`].
|
|
@@ -8692,7 +9510,7 @@ interface components {
|
|
|
8692
9510
|
* "kind": "auto"
|
|
8693
9511
|
* }
|
|
8694
9512
|
*/
|
|
8695
|
-
rasterMode
|
|
9513
|
+
rasterMode?: components["schemas"]["RasterMode"];
|
|
8696
9514
|
};
|
|
8697
9515
|
/**
|
|
8698
9516
|
* @description A 32-byte BLAKE3 digest.
|
|
@@ -8750,25 +9568,16 @@ interface components {
|
|
|
8750
9568
|
* responses.
|
|
8751
9569
|
*/
|
|
8752
9570
|
AzureCredentials: {
|
|
8753
|
-
/**
|
|
8754
|
-
|
|
8755
|
-
* @default null
|
|
8756
|
-
*/
|
|
8757
|
-
accessKey: string;
|
|
9571
|
+
/** @description Storage account access key. */
|
|
9572
|
+
accessKey?: string;
|
|
8758
9573
|
/** @description Azure storage account name. */
|
|
8759
9574
|
accountName: string;
|
|
8760
9575
|
/** @description Azure storage container name. */
|
|
8761
9576
|
container: string;
|
|
8762
|
-
/**
|
|
8763
|
-
|
|
8764
|
-
|
|
8765
|
-
|
|
8766
|
-
endpoint: string;
|
|
8767
|
-
/**
|
|
8768
|
-
* @description Shared Access Signature token.
|
|
8769
|
-
* @default null
|
|
8770
|
-
*/
|
|
8771
|
-
sasToken: string;
|
|
9577
|
+
/** @description Custom endpoint URL (for Azure Stack or Azurite). */
|
|
9578
|
+
endpoint?: string;
|
|
9579
|
+
/** @description Shared Access Signature token. */
|
|
9580
|
+
sasToken?: string;
|
|
8772
9581
|
};
|
|
8773
9582
|
/**
|
|
8774
9583
|
* @description Axis-aligned rectangle, given by its minimum and maximum corners.
|
|
@@ -8806,6 +9615,90 @@ interface components {
|
|
|
8806
9615
|
* [`tags`]: super::Label::tags
|
|
8807
9616
|
*/
|
|
8808
9617
|
Category: string;
|
|
9618
|
+
/** @description A single chat message. */
|
|
9619
|
+
ChatMessage: {
|
|
9620
|
+
/** @description Message text. */
|
|
9621
|
+
content: string;
|
|
9622
|
+
/**
|
|
9623
|
+
* Format: date-time
|
|
9624
|
+
* @description When the message was created.
|
|
9625
|
+
*/
|
|
9626
|
+
createdAt: string;
|
|
9627
|
+
/**
|
|
9628
|
+
* Format: uuid
|
|
9629
|
+
* @description Unique message identifier.
|
|
9630
|
+
*/
|
|
9631
|
+
id: string;
|
|
9632
|
+
/**
|
|
9633
|
+
* Format: uuid
|
|
9634
|
+
* @description Parent in the conversation tree; absent for a root.
|
|
9635
|
+
*/
|
|
9636
|
+
parentId?: string;
|
|
9637
|
+
/** @description Author of the message. */
|
|
9638
|
+
role: components["schemas"]["ChatRole"];
|
|
9639
|
+
};
|
|
9640
|
+
/**
|
|
9641
|
+
* @description The author of a chat message.
|
|
9642
|
+
*
|
|
9643
|
+
* Corresponds to the `CHAT_ROLE` PostgreSQL enum.
|
|
9644
|
+
*/
|
|
9645
|
+
ChatRole: "system" | "user" | "assistant";
|
|
9646
|
+
/** @description A chat session. */
|
|
9647
|
+
ChatSession: {
|
|
9648
|
+
/**
|
|
9649
|
+
* Format: date-time
|
|
9650
|
+
* @description When the session was created.
|
|
9651
|
+
*/
|
|
9652
|
+
createdAt: string;
|
|
9653
|
+
/**
|
|
9654
|
+
* Format: uuid
|
|
9655
|
+
* @description Active leaf of the message tree (the conversation's resume point).
|
|
9656
|
+
*/
|
|
9657
|
+
currentMessageId?: string;
|
|
9658
|
+
/**
|
|
9659
|
+
* Format: uuid
|
|
9660
|
+
* @description Unique session identifier.
|
|
9661
|
+
*/
|
|
9662
|
+
id: string;
|
|
9663
|
+
/** @description Human-readable title. */
|
|
9664
|
+
title: string;
|
|
9665
|
+
/**
|
|
9666
|
+
* Format: date-time
|
|
9667
|
+
* @description When the session was last active.
|
|
9668
|
+
*/
|
|
9669
|
+
updatedAt: string;
|
|
9670
|
+
};
|
|
9671
|
+
/**
|
|
9672
|
+
* @description Generic paginated response wrapper.
|
|
9673
|
+
*
|
|
9674
|
+
* Provides a consistent structure for all paginated API responses with
|
|
9675
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
9676
|
+
* are more items to fetch.
|
|
9677
|
+
*/
|
|
9678
|
+
ChatSessionPage: {
|
|
9679
|
+
/** @description Items in this page. */
|
|
9680
|
+
items: components["schemas"]["ChatSession"][];
|
|
9681
|
+
/** @description Cursor to fetch the next page. Present only when more items exist. */
|
|
9682
|
+
nextCursor?: string;
|
|
9683
|
+
/**
|
|
9684
|
+
* Format: int64
|
|
9685
|
+
* @description Total count of items matching the query (if requested).
|
|
9686
|
+
*/
|
|
9687
|
+
total?: number;
|
|
9688
|
+
};
|
|
9689
|
+
/** @description Path parameters for a chat session. */
|
|
9690
|
+
ChatSessionPathParams: {
|
|
9691
|
+
/**
|
|
9692
|
+
* Format: uuid
|
|
9693
|
+
* @description The session id.
|
|
9694
|
+
*/
|
|
9695
|
+
sessionId: string;
|
|
9696
|
+
};
|
|
9697
|
+
/** @description One streamed chunk of the assistant's reply. */
|
|
9698
|
+
ChatToken: {
|
|
9699
|
+
/** @description The text delta. */
|
|
9700
|
+
delta: string;
|
|
9701
|
+
};
|
|
8809
9702
|
/**
|
|
8810
9703
|
* @description Text a [`TextRedaction::Clamp`] emits for out-of-range values.
|
|
8811
9704
|
*
|
|
@@ -8913,6 +9806,8 @@ interface components {
|
|
|
8913
9806
|
isActive: boolean;
|
|
8914
9807
|
/** @description Provider identifier (`s3`, `azure`, `gcs`, `openai`, `ollama`, ...). */
|
|
8915
9808
|
provider: string;
|
|
9809
|
+
/** @description Capability category of the provider (object store, language model, ...). */
|
|
9810
|
+
providerType: components["schemas"]["ProviderType"];
|
|
8916
9811
|
/** @description Sync configuration; present only for sync-capable connections. */
|
|
8917
9812
|
sync?: components["schemas"]["SyncSchedule"];
|
|
8918
9813
|
/**
|
|
@@ -9073,7 +9968,7 @@ interface components {
|
|
|
9073
9968
|
* matches if it uses any of the given providers. Empty means no filter.
|
|
9074
9969
|
* @default []
|
|
9075
9970
|
*/
|
|
9076
|
-
provider
|
|
9971
|
+
provider?: string[];
|
|
9077
9972
|
};
|
|
9078
9973
|
/**
|
|
9079
9974
|
* @description [ISO 3166-1] country, identified by its code.
|
|
@@ -9098,6 +9993,11 @@ interface components {
|
|
|
9098
9993
|
/** @description When the token expires. */
|
|
9099
9994
|
expiresIn: components["schemas"]["TokenExpiration"];
|
|
9100
9995
|
};
|
|
9996
|
+
/** @description Request to create a chat session. */
|
|
9997
|
+
CreateChatSession: {
|
|
9998
|
+
/** @description Optional title. Defaults to a title seeded from the first message. */
|
|
9999
|
+
title?: string;
|
|
10000
|
+
};
|
|
9101
10001
|
/** @description Request payload for creating a new workspace connection. */
|
|
9102
10002
|
CreateConnection: {
|
|
9103
10003
|
/**
|
|
@@ -9263,6 +10163,13 @@ interface components {
|
|
|
9263
10163
|
* Obtain this from the `nextCursor` field in the response.
|
|
9264
10164
|
*/
|
|
9265
10165
|
after?: string;
|
|
10166
|
+
/**
|
|
10167
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
10168
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
10169
|
+
* only when the count is actually needed.
|
|
10170
|
+
* @default false
|
|
10171
|
+
*/
|
|
10172
|
+
includeCount?: boolean;
|
|
9266
10173
|
/**
|
|
9267
10174
|
* Format: uint32
|
|
9268
10175
|
* @description The maximum number of records to return (1-100, default: 20).
|
|
@@ -9287,6 +10194,24 @@ interface components {
|
|
|
9287
10194
|
* author, who knows the corpus's convention, sets it.
|
|
9288
10195
|
*/
|
|
9289
10196
|
DateStyle: "iso" | "us";
|
|
10197
|
+
/**
|
|
10198
|
+
* @description A `from`/`to` day range (inclusive), both optional. Flatten it into an
|
|
10199
|
+
* endpoint's query struct with `#[serde(flatten)]`, or use it directly when the
|
|
10200
|
+
* range is the only parameter.
|
|
10201
|
+
*/
|
|
10202
|
+
DateWindow: {
|
|
10203
|
+
/**
|
|
10204
|
+
* Format: date
|
|
10205
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
10206
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
10207
|
+
*/
|
|
10208
|
+
from?: string;
|
|
10209
|
+
/**
|
|
10210
|
+
* Format: date
|
|
10211
|
+
* @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC).
|
|
10212
|
+
*/
|
|
10213
|
+
to?: string;
|
|
10214
|
+
};
|
|
9290
10215
|
/**
|
|
9291
10216
|
* @description Pixel dimensions of an image or any 2-D canvas.
|
|
9292
10217
|
*
|
|
@@ -9387,6 +10312,17 @@ interface components {
|
|
|
9387
10312
|
/** @description Validation error details for field-specific errors */
|
|
9388
10313
|
validation?: components["schemas"]["ValidationErrorDetail"][];
|
|
9389
10314
|
};
|
|
10315
|
+
/** @description The file format an export is rendered as. */
|
|
10316
|
+
ExportFormat: "csv" | "json";
|
|
10317
|
+
/**
|
|
10318
|
+
* @description Query parameters for an export whose only choice is the output format. Used by
|
|
10319
|
+
* endpoints that already scope their data another way (e.g. by path), so the
|
|
10320
|
+
* format is all the query carries.
|
|
10321
|
+
*/
|
|
10322
|
+
ExportQuery: {
|
|
10323
|
+
/** @description Output format; defaults to `csv`. */
|
|
10324
|
+
format?: components["schemas"]["ExportFormat"];
|
|
10325
|
+
};
|
|
9390
10326
|
/** @description Represents a file in responses. */
|
|
9391
10327
|
File: {
|
|
9392
10328
|
/**
|
|
@@ -9484,21 +10420,12 @@ interface components {
|
|
|
9484
10420
|
GcsCredentials: {
|
|
9485
10421
|
/** @description GCS bucket name. */
|
|
9486
10422
|
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;
|
|
10423
|
+
/** @description Custom endpoint URL (for testing with a fake GCS server). */
|
|
10424
|
+
endpoint?: string;
|
|
10425
|
+
/** @description Inline service account key JSON (the file contents, not a path). */
|
|
10426
|
+
serviceAccountKeyJson?: string;
|
|
10427
|
+
/** @description Path to a service account key JSON file on the local filesystem. */
|
|
10428
|
+
serviceAccountPath?: string;
|
|
9502
10429
|
};
|
|
9503
10430
|
/**
|
|
9504
10431
|
* @description Which operator to apply to Article 9 special-category entities.
|
|
@@ -10009,7 +10936,7 @@ interface components {
|
|
|
10009
10936
|
* Larger is blurrier (and harder to reverse).
|
|
10010
10937
|
* @default 16
|
|
10011
10938
|
*/
|
|
10012
|
-
sigma
|
|
10939
|
+
sigma?: number;
|
|
10013
10940
|
} | {
|
|
10014
10941
|
/**
|
|
10015
10942
|
* Format: uint32
|
|
@@ -10017,7 +10944,7 @@ interface components {
|
|
|
10017
10944
|
* blocks are coarser (and harder to reverse).
|
|
10018
10945
|
* @default 16
|
|
10019
10946
|
*/
|
|
10020
|
-
block_size
|
|
10947
|
+
block_size?: number;
|
|
10021
10948
|
/** @constant */
|
|
10022
10949
|
kind: "pixelate";
|
|
10023
10950
|
} | {
|
|
@@ -10029,7 +10956,7 @@ interface components {
|
|
|
10029
10956
|
* "r": 0
|
|
10030
10957
|
* }
|
|
10031
10958
|
*/
|
|
10032
|
-
color
|
|
10959
|
+
color?: components["schemas"]["Color"];
|
|
10033
10960
|
/** @constant */
|
|
10034
10961
|
kind: "blackbox";
|
|
10035
10962
|
};
|
|
@@ -10514,7 +11441,7 @@ interface components {
|
|
|
10514
11441
|
* @description Whether to remember this device for extended session. Defaults to false.
|
|
10515
11442
|
* @default false
|
|
10516
11443
|
*/
|
|
10517
|
-
rememberMe
|
|
11444
|
+
rememberMe?: boolean;
|
|
10518
11445
|
};
|
|
10519
11446
|
/** @description Response type for a mark-all-read action. */
|
|
10520
11447
|
MarkedReadStatus: {
|
|
@@ -10623,6 +11550,39 @@ interface components {
|
|
|
10623
11550
|
/** @description Model version string, when known. */
|
|
10624
11551
|
version?: string;
|
|
10625
11552
|
};
|
|
11553
|
+
/**
|
|
11554
|
+
* @description Model detail for a model-backed recognizer or enricher: which model it
|
|
11555
|
+
* called and the tokens that cost. Absent from a pure-CPU component (a
|
|
11556
|
+
* pattern recognizer, a language enricher).
|
|
11557
|
+
*/
|
|
11558
|
+
ModelUsage: {
|
|
11559
|
+
/** @description Model name the backend called (e.g. `"gpt-4o"`, `"gliner-multi"`). */
|
|
11560
|
+
model: string;
|
|
11561
|
+
/** @description Tokens the call spent, as far as the provider reports them. */
|
|
11562
|
+
tokens?: components["schemas"]["TokenCounts"];
|
|
11563
|
+
/** @description Model version, when the backend reports one. */
|
|
11564
|
+
version?: string;
|
|
11565
|
+
};
|
|
11566
|
+
/** @description One model's token usage across a workspace's runs. */
|
|
11567
|
+
ModelUsageEntry: {
|
|
11568
|
+
/**
|
|
11569
|
+
* Format: int64
|
|
11570
|
+
* @description Input/prompt tokens summed for this model (`0` if never reported).
|
|
11571
|
+
*/
|
|
11572
|
+
inputTokens: number;
|
|
11573
|
+
/** @description The model. */
|
|
11574
|
+
model: string;
|
|
11575
|
+
/**
|
|
11576
|
+
* Format: int64
|
|
11577
|
+
* @description Output/completion tokens summed for this model (`0` if never reported).
|
|
11578
|
+
*/
|
|
11579
|
+
outputTokens: number;
|
|
11580
|
+
/**
|
|
11581
|
+
* Format: int64
|
|
11582
|
+
* @description Reported total tokens summed for this model (`0` if never reported).
|
|
11583
|
+
*/
|
|
11584
|
+
totalTokens: number;
|
|
11585
|
+
};
|
|
10626
11586
|
/**
|
|
10627
11587
|
* @description Response type for an account notification.
|
|
10628
11588
|
*
|
|
@@ -11439,7 +12399,7 @@ interface components {
|
|
|
11439
12399
|
* addresses under the §(R) catch-all reading.
|
|
11440
12400
|
* @default standard
|
|
11441
12401
|
*/
|
|
11442
|
-
accounts
|
|
12402
|
+
accounts?: components["schemas"]["HipaaAccountNumbers"];
|
|
11443
12403
|
/** @constant */
|
|
11444
12404
|
kind: "hipaa_deidentification";
|
|
11445
12405
|
/**
|
|
@@ -11460,7 +12420,7 @@ interface components {
|
|
|
11460
12420
|
* Article 10 criminal-justice data.
|
|
11461
12421
|
* @default article9
|
|
11462
12422
|
*/
|
|
11463
|
-
scope
|
|
12423
|
+
scope?: components["schemas"]["GdprSensitiveScope"];
|
|
11464
12424
|
/**
|
|
11465
12425
|
* @description Which operator to apply to matches. See
|
|
11466
12426
|
* [`GdprArticle9Treatment`] for the tradeoff.
|
|
@@ -11539,6 +12499,16 @@ interface components {
|
|
|
11539
12499
|
/** @description Negated predicate. */
|
|
11540
12500
|
not: components["schemas"]["Predicate"];
|
|
11541
12501
|
};
|
|
12502
|
+
/**
|
|
12503
|
+
* @description The capability category of a connection's provider.
|
|
12504
|
+
*
|
|
12505
|
+
* Corresponds to the `PROVIDER_TYPE` PostgreSQL enum. A stable, closed set:
|
|
12506
|
+
* the concrete provider (the `provider` column, e.g. `s3` or `anthropic`) stays
|
|
12507
|
+
* open and extensible, while its capability is one of these types. Lets a
|
|
12508
|
+
* connection be found by what it can do — e.g. a workspace's language model —
|
|
12509
|
+
* without decrypting its config.
|
|
12510
|
+
*/
|
|
12511
|
+
ProviderType: "object_store" | "language_model";
|
|
11542
12512
|
/**
|
|
11543
12513
|
* @description Public view of an account, returned when looking up someone other than the
|
|
11544
12514
|
* authenticated caller. Carries only the fields safe to share with a
|
|
@@ -11598,6 +12568,22 @@ interface components {
|
|
|
11598
12568
|
/** @description NER (named-entity recognition) recognizers. */
|
|
11599
12569
|
ner: components["schemas"]["RegisteredRecognizer"][];
|
|
11600
12570
|
};
|
|
12571
|
+
/**
|
|
12572
|
+
* @description Identifies a recognizer (name + version).
|
|
12573
|
+
*
|
|
12574
|
+
* Pairs a stable name with a free-form version string so the audit
|
|
12575
|
+
* trail records not just *which* recognizer fired but *which build* of
|
|
12576
|
+
* it: a rerun against an updated ruleset or model is then
|
|
12577
|
+
* distinguishable from the original. The version is opaque text (a
|
|
12578
|
+
* semver, a checkpoint hash, a ruleset date); the core attaches no
|
|
12579
|
+
* ordering or comparison semantics to it.
|
|
12580
|
+
*/
|
|
12581
|
+
RecognizerId: {
|
|
12582
|
+
/** @description Stable, human-readable recognizer name (e.g. `"us-ssn-pattern"`). */
|
|
12583
|
+
name: string;
|
|
12584
|
+
/** @description Recognizer's version at the time it ran. */
|
|
12585
|
+
version: string;
|
|
12586
|
+
};
|
|
11601
12587
|
/**
|
|
11602
12588
|
* @description Public view of one recognizer in the engine's NER or LLM
|
|
11603
12589
|
* lineup.
|
|
@@ -11669,16 +12655,10 @@ interface components {
|
|
|
11669
12655
|
* override and always follow the workspace baseline.
|
|
11670
12656
|
*/
|
|
11671
12657
|
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"];
|
|
12658
|
+
/** @description Overrides audit-blob retention when set. */
|
|
12659
|
+
auditLogs?: components["schemas"]["Retention"];
|
|
12660
|
+
/** @description Overrides redacted-document retention when set. */
|
|
12661
|
+
redactedDocuments?: components["schemas"]["Retention"];
|
|
11682
12662
|
};
|
|
11683
12663
|
/**
|
|
11684
12664
|
* @description Retention for every scope. Missing fields default to [`Retention::Forever`],
|
|
@@ -11691,21 +12671,21 @@ interface components {
|
|
|
11691
12671
|
* "mode": "forever"
|
|
11692
12672
|
* }
|
|
11693
12673
|
*/
|
|
11694
|
-
auditLogs
|
|
12674
|
+
auditLogs?: components["schemas"]["Retention"];
|
|
11695
12675
|
/**
|
|
11696
12676
|
* @description Retention for uploaded/imported source documents.
|
|
11697
12677
|
* @default {
|
|
11698
12678
|
* "mode": "forever"
|
|
11699
12679
|
* }
|
|
11700
12680
|
*/
|
|
11701
|
-
originalDocuments
|
|
12681
|
+
originalDocuments?: components["schemas"]["Retention"];
|
|
11702
12682
|
/**
|
|
11703
12683
|
* @description Retention for generated redacted documents.
|
|
11704
12684
|
* @default {
|
|
11705
12685
|
* "mode": "forever"
|
|
11706
12686
|
* }
|
|
11707
12687
|
*/
|
|
11708
|
-
redactedDocuments
|
|
12688
|
+
redactedDocuments?: components["schemas"]["Retention"];
|
|
11709
12689
|
};
|
|
11710
12690
|
/**
|
|
11711
12691
|
* @description A reviewer-supplied redaction override with the policy
|
|
@@ -11760,6 +12740,80 @@ interface components {
|
|
|
11760
12740
|
} | {
|
|
11761
12741
|
tag: string;
|
|
11762
12742
|
} | "predicate" | "fallback";
|
|
12743
|
+
/** @description Pipeline-run health for a workspace. */
|
|
12744
|
+
RunAnalytics: {
|
|
12745
|
+
/**
|
|
12746
|
+
* Format: int64
|
|
12747
|
+
* @description Mean completed-run duration in milliseconds; omitted until a run completes.
|
|
12748
|
+
*/
|
|
12749
|
+
avgDurationMs?: number;
|
|
12750
|
+
/**
|
|
12751
|
+
* @description Per-status breakdown, one entry per run status (zero-filled), in a stable
|
|
12752
|
+
* order.
|
|
12753
|
+
*/
|
|
12754
|
+
byStatus: components["schemas"]["RunStatusEntry"][];
|
|
12755
|
+
/**
|
|
12756
|
+
* Format: double
|
|
12757
|
+
* @description Failed / (completed + failed). Omitted when no run has reached a terminal
|
|
12758
|
+
* state (genuinely no signal, not zero).
|
|
12759
|
+
*/
|
|
12760
|
+
errorRate?: number;
|
|
12761
|
+
/**
|
|
12762
|
+
* Format: int64
|
|
12763
|
+
* @description 95th-percentile completed-run duration in milliseconds; omitted until a run
|
|
12764
|
+
* completes.
|
|
12765
|
+
*/
|
|
12766
|
+
p95DurationMs?: number;
|
|
12767
|
+
/**
|
|
12768
|
+
* Format: int64
|
|
12769
|
+
* @description Total number of runs.
|
|
12770
|
+
*/
|
|
12771
|
+
total: number;
|
|
12772
|
+
};
|
|
12773
|
+
/** @description A single day of run activity. */
|
|
12774
|
+
RunDayEntry: {
|
|
12775
|
+
/**
|
|
12776
|
+
* Format: int64
|
|
12777
|
+
* @description Mean completed-run duration (milliseconds) this day; omitted if none completed.
|
|
12778
|
+
*/
|
|
12779
|
+
avgDurationMs?: number;
|
|
12780
|
+
/**
|
|
12781
|
+
* Format: date
|
|
12782
|
+
* @description The day (`YYYY-MM-DD`, UTC).
|
|
12783
|
+
*/
|
|
12784
|
+
date: string;
|
|
12785
|
+
/**
|
|
12786
|
+
* Format: double
|
|
12787
|
+
* @description Failed / (completed + failed) for this day; omitted when no run reached a
|
|
12788
|
+
* terminal state that day.
|
|
12789
|
+
*/
|
|
12790
|
+
errorRate?: number;
|
|
12791
|
+
/**
|
|
12792
|
+
* Format: int64
|
|
12793
|
+
* @description Input/prompt tokens spent by this day's runs; omitted when none used a model.
|
|
12794
|
+
*/
|
|
12795
|
+
inputTokens?: number;
|
|
12796
|
+
/**
|
|
12797
|
+
* Format: int64
|
|
12798
|
+
* @description Output/completion tokens spent this day; omitted when none used a model.
|
|
12799
|
+
*/
|
|
12800
|
+
outputTokens?: number;
|
|
12801
|
+
/**
|
|
12802
|
+
* Format: int64
|
|
12803
|
+
* @description 95th-percentile completed-run duration (milliseconds) this day; omitted if none.
|
|
12804
|
+
*/
|
|
12805
|
+
p95DurationMs?: number;
|
|
12806
|
+
/**
|
|
12807
|
+
* Format: int64
|
|
12808
|
+
* @description Runs started this day (`0` on a quiet day).
|
|
12809
|
+
*/
|
|
12810
|
+
runs: number;
|
|
12811
|
+
/**
|
|
12812
|
+
* Format: int64
|
|
12813
|
+
* @description Reported total tokens this day; omitted when none used a model.
|
|
12814
|
+
*/
|
|
12815
|
+
totalTokens?: number;
|
|
12816
|
+
};
|
|
11763
12817
|
/** @description Opaque run identifier (run_<uuid>). */
|
|
11764
12818
|
RunId: string;
|
|
11765
12819
|
/** @description Structured metadata for a pipeline run. */
|
|
@@ -11768,6 +12822,23 @@ interface components {
|
|
|
11768
12822
|
error?: string;
|
|
11769
12823
|
/** @description Free-form labels attached to the run. */
|
|
11770
12824
|
tags?: string[];
|
|
12825
|
+
/**
|
|
12826
|
+
* @description The engine's full per-recognizer usage report (durations, per-model token
|
|
12827
|
+
* counts), stored opaquely for drill-down. Per-model token totals for
|
|
12828
|
+
* aggregation live in the `workspace_pipeline_run_usage` table; this keeps
|
|
12829
|
+
* the detail. Absent when the run produced no usage.
|
|
12830
|
+
*/
|
|
12831
|
+
usage?: unknown;
|
|
12832
|
+
};
|
|
12833
|
+
/** @description One status's share of a workspace's runs. */
|
|
12834
|
+
RunStatusEntry: {
|
|
12835
|
+
/**
|
|
12836
|
+
* Format: int64
|
|
12837
|
+
* @description Number of runs in this status.
|
|
12838
|
+
*/
|
|
12839
|
+
count: number;
|
|
12840
|
+
/** @description The run status. */
|
|
12841
|
+
status: components["schemas"]["PipelineRunStatus"];
|
|
11771
12842
|
};
|
|
11772
12843
|
/**
|
|
11773
12844
|
* @description A run's status change, broadcast on the core-NATS subject [`run_subject`].
|
|
@@ -11784,6 +12855,14 @@ interface components {
|
|
|
11784
12855
|
/** @description The run's new status. */
|
|
11785
12856
|
status: components["schemas"]["PipelineRunStatus"];
|
|
11786
12857
|
};
|
|
12858
|
+
/**
|
|
12859
|
+
* @description A workspace's daily run activity over a window: one point per day, dense
|
|
12860
|
+
* (quiet days included with `runs: 0`), ready to plot as a continuous series.
|
|
12861
|
+
*/
|
|
12862
|
+
RunTimeSeries: {
|
|
12863
|
+
/** @description One entry per day in the requested window, oldest first. */
|
|
12864
|
+
points: components["schemas"]["RunDayEntry"][];
|
|
12865
|
+
};
|
|
11787
12866
|
/**
|
|
11788
12867
|
* @description Typed credentials for S3-compatible provider.
|
|
11789
12868
|
*
|
|
@@ -11792,34 +12871,24 @@ interface components {
|
|
|
11792
12871
|
* responses.
|
|
11793
12872
|
*/
|
|
11794
12873
|
S3Credentials: {
|
|
11795
|
-
/**
|
|
11796
|
-
|
|
11797
|
-
* @default null
|
|
11798
|
-
*/
|
|
11799
|
-
accessKeyId: string;
|
|
12874
|
+
/** @description Access key ID for static credentials. */
|
|
12875
|
+
accessKeyId?: string;
|
|
11800
12876
|
/** @description S3 bucket name. */
|
|
11801
12877
|
bucket: string;
|
|
11802
12878
|
/**
|
|
11803
12879
|
* @description Endpoint URL (e.g. `http://localhost:9000` for MinIO).
|
|
11804
12880
|
* Required for non-AWS S3-compatible services.
|
|
11805
|
-
* @default null
|
|
11806
12881
|
*/
|
|
11807
|
-
endpoint
|
|
12882
|
+
endpoint?: string;
|
|
11808
12883
|
/**
|
|
11809
12884
|
* @description AWS region (defaults to `us-east-1`).
|
|
11810
12885
|
* @default us-east-1
|
|
11811
12886
|
*/
|
|
11812
|
-
region
|
|
11813
|
-
/**
|
|
11814
|
-
|
|
11815
|
-
|
|
11816
|
-
|
|
11817
|
-
secretAccessKey: string;
|
|
11818
|
-
/**
|
|
11819
|
-
* @description Session token for temporary credentials.
|
|
11820
|
-
* @default null
|
|
11821
|
-
*/
|
|
11822
|
-
sessionToken: string;
|
|
12887
|
+
region?: string;
|
|
12888
|
+
/** @description Secret access key for static credentials. */
|
|
12889
|
+
secretAccessKey?: string;
|
|
12890
|
+
/** @description Session token for temporary credentials. */
|
|
12891
|
+
sessionToken?: string;
|
|
11823
12892
|
};
|
|
11824
12893
|
/**
|
|
11825
12894
|
* @description Caller-asserted scope shared across every payload of one analysis.
|
|
@@ -11865,15 +12934,14 @@ interface components {
|
|
|
11865
12934
|
* selected differently per audience. May hold several.
|
|
11866
12935
|
* @default []
|
|
11867
12936
|
*/
|
|
11868
|
-
audience
|
|
12937
|
+
audience?: string[];
|
|
11869
12938
|
/**
|
|
11870
12939
|
* @description The caller-asserted business purpose driving this request (e.g.
|
|
11871
12940
|
* `"fraud_detection"`, `"gdpr_erasure_request"`). A scope-aware operator
|
|
11872
12941
|
* predicate may skip or swap a rule based on it; a recognizer may bias
|
|
11873
12942
|
* detection on it. `None` when the caller asserts no purpose.
|
|
11874
|
-
* @default null
|
|
11875
12943
|
*/
|
|
11876
|
-
purpose
|
|
12944
|
+
purpose?: string;
|
|
11877
12945
|
/**
|
|
11878
12946
|
* @description Document-level classification tags (e.g. `"medical"`,
|
|
11879
12947
|
* `"gdpr-request"`). Recognizers may use these to bias their behavior
|
|
@@ -11888,7 +12956,7 @@ interface components {
|
|
|
11888
12956
|
* [`LabelCatalog`]: crate::entity::LabelCatalog
|
|
11889
12957
|
* @default []
|
|
11890
12958
|
*/
|
|
11891
|
-
tags
|
|
12959
|
+
tags?: string[];
|
|
11892
12960
|
};
|
|
11893
12961
|
/**
|
|
11894
12962
|
* @description Caller-asserted scope for one request.
|
|
@@ -11918,13 +12986,25 @@ interface components {
|
|
|
11918
12986
|
* (if a language enricher runs) to fill in.
|
|
11919
12987
|
* @default []
|
|
11920
12988
|
*/
|
|
11921
|
-
languages
|
|
12989
|
+
languages?: components["schemas"]["Languages"];
|
|
11922
12990
|
/**
|
|
11923
12991
|
* @description Free-form request context: document tags, request purpose,
|
|
11924
12992
|
* output audience. See elide's [`ScopeMetadata`].
|
|
11925
12993
|
*/
|
|
11926
12994
|
metadata?: components["schemas"]["ScopeMetadata"];
|
|
11927
12995
|
};
|
|
12996
|
+
/** @description Request to send a message and stream the assistant's reply. */
|
|
12997
|
+
SendChatMessage: {
|
|
12998
|
+
/** @description The user's message. */
|
|
12999
|
+
content: string;
|
|
13000
|
+
/**
|
|
13001
|
+
* Format: uuid
|
|
13002
|
+
* @description The message this turn replies to (the branch being extended). Omit to
|
|
13003
|
+
* continue from the session's current leaf; use an earlier message's id to
|
|
13004
|
+
* branch (e.g. edit-and-resend).
|
|
13005
|
+
*/
|
|
13006
|
+
parentId?: string;
|
|
13007
|
+
};
|
|
11928
13008
|
/**
|
|
11929
13009
|
* @description Which SHA-2 variant a hashing operator uses.
|
|
11930
13010
|
*
|
|
@@ -11951,7 +13031,7 @@ interface components {
|
|
|
11951
13031
|
* @description Whether to remember the device for extended session. Defaults to false.
|
|
11952
13032
|
* @default false
|
|
11953
13033
|
*/
|
|
11954
|
-
rememberMe
|
|
13034
|
+
rememberMe?: boolean;
|
|
11955
13035
|
/** @description Public account handle, unique across all accounts. */
|
|
11956
13036
|
username: components["schemas"]["Handle"];
|
|
11957
13037
|
};
|
|
@@ -11988,6 +13068,24 @@ interface components {
|
|
|
11988
13068
|
/** @description The raw source byte range. */
|
|
11989
13069
|
range: components["schemas"]["Range_of_uint"];
|
|
11990
13070
|
};
|
|
13071
|
+
/** @description Storage totals across a workspace's live files. */
|
|
13072
|
+
StorageAnalytics: {
|
|
13073
|
+
/**
|
|
13074
|
+
* @description Per-kind breakdown, one entry per `file_kind` (zero-filled), in a stable
|
|
13075
|
+
* order.
|
|
13076
|
+
*/
|
|
13077
|
+
byKind: components["schemas"]["StorageKindEntry"][];
|
|
13078
|
+
/**
|
|
13079
|
+
* Format: int64
|
|
13080
|
+
* @description Number of live files.
|
|
13081
|
+
*/
|
|
13082
|
+
fileCount: number;
|
|
13083
|
+
/**
|
|
13084
|
+
* Format: int64
|
|
13085
|
+
* @description Total bytes of all live files.
|
|
13086
|
+
*/
|
|
13087
|
+
totalBytes: number;
|
|
13088
|
+
};
|
|
11991
13089
|
/**
|
|
11992
13090
|
* @description A fully-typed object-store connection configuration.
|
|
11993
13091
|
*
|
|
@@ -12022,6 +13120,21 @@ interface components {
|
|
|
12022
13120
|
/** @description Optional root prefix within the bucket; keys resolve relative to it. */
|
|
12023
13121
|
rootPath?: string;
|
|
12024
13122
|
};
|
|
13123
|
+
/** @description One `file_kind`'s share of a workspace's storage. */
|
|
13124
|
+
StorageKindEntry: {
|
|
13125
|
+
/**
|
|
13126
|
+
* Format: int64
|
|
13127
|
+
* @description Number of live files of this kind.
|
|
13128
|
+
*/
|
|
13129
|
+
fileCount: number;
|
|
13130
|
+
/** @description The file kind. */
|
|
13131
|
+
kind: components["schemas"]["FileKind"];
|
|
13132
|
+
/**
|
|
13133
|
+
* Format: int64
|
|
13134
|
+
* @description Total bytes of live files of this kind.
|
|
13135
|
+
*/
|
|
13136
|
+
totalBytes: number;
|
|
13137
|
+
};
|
|
12025
13138
|
/**
|
|
12026
13139
|
* @description Request payload to trigger a connection sync.
|
|
12027
13140
|
*
|
|
@@ -12080,14 +13193,14 @@ interface components {
|
|
|
12080
13193
|
* @description How an import reconciles files whose source object was deleted.
|
|
12081
13194
|
* @default ignore
|
|
12082
13195
|
*/
|
|
12083
|
-
deletionPolicy
|
|
13196
|
+
deletionPolicy?: components["schemas"]["SyncDeletionPolicy"];
|
|
12084
13197
|
/** @description Cron expression for scheduled imports; omit for manual-only. */
|
|
12085
13198
|
scheduleCron?: string;
|
|
12086
13199
|
/**
|
|
12087
13200
|
* @description Whether the connection imports data in or exports data out.
|
|
12088
13201
|
* @default import
|
|
12089
13202
|
*/
|
|
12090
|
-
syncMode
|
|
13203
|
+
syncMode?: components["schemas"]["SyncMode"];
|
|
12091
13204
|
};
|
|
12092
13205
|
/**
|
|
12093
13206
|
* @description Defines the execution status of a connection sync run.
|
|
@@ -12586,7 +13699,7 @@ interface components {
|
|
|
12586
13699
|
* @description Template string. Default `[{label}]`.
|
|
12587
13700
|
* @default [{label}]
|
|
12588
13701
|
*/
|
|
12589
|
-
template
|
|
13702
|
+
template?: string;
|
|
12590
13703
|
} | {
|
|
12591
13704
|
/**
|
|
12592
13705
|
* Format: uint
|
|
@@ -12604,7 +13717,7 @@ interface components {
|
|
|
12604
13717
|
* @description The character that replaces masked positions.
|
|
12605
13718
|
* @default *
|
|
12606
13719
|
*/
|
|
12607
|
-
mask_char
|
|
13720
|
+
mask_char?: string;
|
|
12608
13721
|
};
|
|
12609
13722
|
/** @description Request payload for testing a webhook. */
|
|
12610
13723
|
TestWebhook: {
|
|
@@ -13019,7 +14132,7 @@ interface components {
|
|
|
13019
14132
|
* @description The character that replaces masked positions.
|
|
13020
14133
|
* @default *
|
|
13021
14134
|
*/
|
|
13022
|
-
mask_char
|
|
14135
|
+
mask_char?: string;
|
|
13023
14136
|
} | {
|
|
13024
14137
|
/** @constant */
|
|
13025
14138
|
kind: "replace";
|
|
@@ -13027,13 +14140,13 @@ interface components {
|
|
|
13027
14140
|
* @description Template string. Default `[{label}]`.
|
|
13028
14141
|
* @default [{label}]
|
|
13029
14142
|
*/
|
|
13030
|
-
template
|
|
14143
|
+
template?: string;
|
|
13031
14144
|
} | {
|
|
13032
14145
|
/**
|
|
13033
14146
|
* @description SHA-256 (default) or SHA-512.
|
|
13034
14147
|
* @default sha256
|
|
13035
14148
|
*/
|
|
13036
|
-
algorithm
|
|
14149
|
+
algorithm?: components["schemas"]["Sha2Algorithm"];
|
|
13037
14150
|
/** @constant */
|
|
13038
14151
|
kind: "hash";
|
|
13039
14152
|
/** @description Salt prepended to the value before hashing. */
|
|
@@ -13053,7 +14166,7 @@ interface components {
|
|
|
13053
14166
|
* [`Replace`]: TextRedaction::Replace
|
|
13054
14167
|
* @default [{label}]
|
|
13055
14168
|
*/
|
|
13056
|
-
fallback_template
|
|
14169
|
+
fallback_template?: string;
|
|
13057
14170
|
/** @constant */
|
|
13058
14171
|
kind: "fake";
|
|
13059
14172
|
/**
|
|
@@ -13074,7 +14187,7 @@ interface components {
|
|
|
13074
14187
|
* @description HMAC-SHA-256 (default) or HMAC-SHA-512.
|
|
13075
14188
|
* @default sha256
|
|
13076
14189
|
*/
|
|
13077
|
-
algorithm
|
|
14190
|
+
algorithm?: components["schemas"]["Sha2Algorithm"];
|
|
13078
14191
|
/** @constant */
|
|
13079
14192
|
kind: "hmac_hash";
|
|
13080
14193
|
} | {
|
|
@@ -13130,14 +14243,14 @@ interface components {
|
|
|
13130
14243
|
* @description Coarseness of the output. Default `Year`.
|
|
13131
14244
|
* @default year
|
|
13132
14245
|
*/
|
|
13133
|
-
granularity
|
|
14246
|
+
granularity?: components["schemas"]["DateGranularity"];
|
|
13134
14247
|
/** @constant */
|
|
13135
14248
|
kind: "generalize_date";
|
|
13136
14249
|
/**
|
|
13137
14250
|
* @description Which input convention to accept. Default `Iso`.
|
|
13138
14251
|
* @default iso
|
|
13139
14252
|
*/
|
|
13140
|
-
style
|
|
14253
|
+
style?: components["schemas"]["DateStyle"];
|
|
13141
14254
|
};
|
|
13142
14255
|
/**
|
|
13143
14256
|
* @description Half-open `[start, end)` stream interval, measured in microseconds.
|
|
@@ -13171,6 +14284,27 @@ interface components {
|
|
|
13171
14284
|
*/
|
|
13172
14285
|
start_us: number;
|
|
13173
14286
|
};
|
|
14287
|
+
/**
|
|
14288
|
+
* @description Token counts a model reported, each optional because providers differ in
|
|
14289
|
+
* what they return — some give only a total, some none at all.
|
|
14290
|
+
*/
|
|
14291
|
+
TokenCounts: {
|
|
14292
|
+
/**
|
|
14293
|
+
* Format: uint64
|
|
14294
|
+
* @description Prompt / input tokens.
|
|
14295
|
+
*/
|
|
14296
|
+
input?: number;
|
|
14297
|
+
/**
|
|
14298
|
+
* Format: uint64
|
|
14299
|
+
* @description Completion / output tokens.
|
|
14300
|
+
*/
|
|
14301
|
+
output?: number;
|
|
14302
|
+
/**
|
|
14303
|
+
* Format: uint64
|
|
14304
|
+
* @description Total tokens — may be reported even when the input/output split is not.
|
|
14305
|
+
*/
|
|
14306
|
+
total?: number;
|
|
14307
|
+
};
|
|
13174
14308
|
/** @description Expiration options for API tokens. */
|
|
13175
14309
|
TokenExpiration: "never" | "in7Days" | "in30Days" | "in90Days" | "in1Year";
|
|
13176
14310
|
/**
|
|
@@ -13345,6 +14479,59 @@ interface components {
|
|
|
13345
14479
|
*/
|
|
13346
14480
|
settings?: components["schemas"]["WorkspaceSettings"];
|
|
13347
14481
|
};
|
|
14482
|
+
/**
|
|
14483
|
+
* @description One recognizer's or enricher's resource usage for one payload.
|
|
14484
|
+
*
|
|
14485
|
+
* `id` and `duration` are always present; `count` (entities or spans found,
|
|
14486
|
+
* artifacts produced) and `model` are present only where they mean
|
|
14487
|
+
* something. `duration` serializes as a whole number of milliseconds.
|
|
14488
|
+
*/
|
|
14489
|
+
Usage: {
|
|
14490
|
+
/**
|
|
14491
|
+
* Format: uint64
|
|
14492
|
+
* @description Entities or spans found (recognizer) or artifacts produced (enricher);
|
|
14493
|
+
* `None` when a count is not meaningful for the component.
|
|
14494
|
+
*/
|
|
14495
|
+
count?: number;
|
|
14496
|
+
/**
|
|
14497
|
+
* Format: uint64
|
|
14498
|
+
* @description Wall-clock execution time. Serialized as integer milliseconds.
|
|
14499
|
+
*/
|
|
14500
|
+
duration: number;
|
|
14501
|
+
/** @description Which recognizer / enricher this describes. */
|
|
14502
|
+
id: components["schemas"]["RecognizerId"];
|
|
14503
|
+
/** @description Model / token detail; `None` for a pure-CPU component. */
|
|
14504
|
+
model?: components["schemas"]["ModelUsage"];
|
|
14505
|
+
};
|
|
14506
|
+
/** @description Inference token usage across a workspace's runs. */
|
|
14507
|
+
UsageAnalytics: {
|
|
14508
|
+
/** @description Per-model breakdown, one entry per model used, in a stable order. */
|
|
14509
|
+
byModel: components["schemas"]["ModelUsageEntry"][];
|
|
14510
|
+
/**
|
|
14511
|
+
* Format: int64
|
|
14512
|
+
* @description Total input/prompt tokens across all models.
|
|
14513
|
+
*/
|
|
14514
|
+
inputTokens: number;
|
|
14515
|
+
/**
|
|
14516
|
+
* Format: int64
|
|
14517
|
+
* @description Total output/completion tokens across all models.
|
|
14518
|
+
*/
|
|
14519
|
+
outputTokens: number;
|
|
14520
|
+
/**
|
|
14521
|
+
* Format: int64
|
|
14522
|
+
* @description Total tokens as reported across all models (not necessarily input +
|
|
14523
|
+
* output).
|
|
14524
|
+
*/
|
|
14525
|
+
totalTokens: number;
|
|
14526
|
+
};
|
|
14527
|
+
/**
|
|
14528
|
+
* @description Every recognizer/enricher's [`Usage`] across a whole document analysis, in
|
|
14529
|
+
* the order the components ran (the body first, then each part).
|
|
14530
|
+
*/
|
|
14531
|
+
UsageReport: {
|
|
14532
|
+
/** @description The per-component usage entries, each self-identifying via its `id`. */
|
|
14533
|
+
entries: components["schemas"]["Usage"][];
|
|
14534
|
+
};
|
|
13348
14535
|
/** @description Validation error details for field-specific errors. */
|
|
13349
14536
|
ValidationErrorDetail: {
|
|
13350
14537
|
/** @description Error code for the validation failure */
|
|
@@ -13567,6 +14754,18 @@ interface components {
|
|
|
13567
14754
|
/** @description Slug of the workspace acted on. */
|
|
13568
14755
|
workspaceSlug: components["schemas"]["Handle"];
|
|
13569
14756
|
};
|
|
14757
|
+
/**
|
|
14758
|
+
* @description Aggregate analytics for a workspace: what it stores, how its runs fare, and
|
|
14759
|
+
* the inference tokens they spent.
|
|
14760
|
+
*/
|
|
14761
|
+
WorkspaceAnalytics: {
|
|
14762
|
+
/** @description Pipeline-run health: volume, status mix, and durations. */
|
|
14763
|
+
runs: components["schemas"]["RunAnalytics"];
|
|
14764
|
+
/** @description Stored-file totals and their per-kind breakdown. */
|
|
14765
|
+
storage: components["schemas"]["StorageAnalytics"];
|
|
14766
|
+
/** @description Inference token usage: workspace totals and a per-model breakdown. */
|
|
14767
|
+
usage: components["schemas"]["UsageAnalytics"];
|
|
14768
|
+
};
|
|
13570
14769
|
/** @description Path parameters for file operations within a workspace context. */
|
|
13571
14770
|
WorkspaceFilePathParams: {
|
|
13572
14771
|
/**
|
|
@@ -13632,12 +14831,12 @@ interface components {
|
|
|
13632
14831
|
* @description How documents are rendered for OCR during detection.
|
|
13633
14832
|
* @default auto
|
|
13634
14833
|
*/
|
|
13635
|
-
ocr
|
|
14834
|
+
ocr?: components["schemas"]["OcrPolicy"];
|
|
13636
14835
|
/**
|
|
13637
14836
|
* @description Whether approval is required before processed files become visible.
|
|
13638
14837
|
* @default true
|
|
13639
14838
|
*/
|
|
13640
|
-
requireApproval
|
|
14839
|
+
requireApproval?: boolean;
|
|
13641
14840
|
/**
|
|
13642
14841
|
* @description Data-retention rules for the workspace.
|
|
13643
14842
|
* @default {
|
|
@@ -13652,7 +14851,7 @@ interface components {
|
|
|
13652
14851
|
* }
|
|
13653
14852
|
* }
|
|
13654
14853
|
*/
|
|
13655
|
-
retention
|
|
14854
|
+
retention?: components["schemas"]["RetentionSettings"];
|
|
13656
14855
|
};
|
|
13657
14856
|
/** @description Query parameters for listing all syncs across a workspace. */
|
|
13658
14857
|
WorkspaceSyncsQuery: {
|
|
@@ -13662,7 +14861,7 @@ interface components {
|
|
|
13662
14861
|
* provider filter.
|
|
13663
14862
|
* @default []
|
|
13664
14863
|
*/
|
|
13665
|
-
provider
|
|
14864
|
+
provider?: string[];
|
|
13666
14865
|
/** @description Filter by sync status. */
|
|
13667
14866
|
status?: components["schemas"]["SyncStatus"];
|
|
13668
14867
|
};
|
|
@@ -13675,141 +14874,176 @@ interface components {
|
|
|
13675
14874
|
}
|
|
13676
14875
|
//#endregion
|
|
13677
14876
|
//#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$
|
|
14877
|
+
type Schemas$22 = components["schemas"];
|
|
14878
|
+
type Handle = Schemas$22["Handle"];
|
|
14879
|
+
type Account = Schemas$22["Account"];
|
|
14880
|
+
type PublicAccount = Schemas$22["PublicAccount"];
|
|
14881
|
+
type UpdateAccount = Schemas$22["UpdateAccount"];
|
|
14882
|
+
type PasswordChange = Schemas$22["PasswordChange"];
|
|
14883
|
+
type AccountRef = Schemas$22["AccountRef"];
|
|
13685
14884
|
//#endregion
|
|
13686
14885
|
//#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
|
|
14886
|
+
type Schemas$21 = components["schemas"];
|
|
14887
|
+
type Activity = Schemas$21["Activity"];
|
|
14888
|
+
type ActivityPage = Schemas$21["ActivityPage"];
|
|
14889
|
+
type ActivityExportQuery = Schemas$21["ActivityExportQuery"];
|
|
14890
|
+
type ActivityPayload = Schemas$21["ActivityPayload"];
|
|
14891
|
+
type WorkspaceActivityParams = Schemas$21["WorkspaceActivityParams"];
|
|
14892
|
+
type MemberActivityParams = Schemas$21["MemberActivityParams"];
|
|
14893
|
+
type InviteActivityParams = Schemas$21["InviteActivityParams"];
|
|
14894
|
+
type ConnectionActivityParams = Schemas$21["ConnectionActivityParams"];
|
|
14895
|
+
type PipelineActivityParams = Schemas$21["PipelineActivityParams"];
|
|
14896
|
+
type PipelineRunActivityParams = Schemas$21["PipelineRunActivityParams"];
|
|
14897
|
+
type PolicyActivityParams = Schemas$21["PolicyActivityParams"];
|
|
14898
|
+
type FileActivityParams = Schemas$21["FileActivityParams"];
|
|
14899
|
+
type WebhookActivityParams = Schemas$21["WebhookActivityParams"];
|
|
14900
|
+
//#endregion
|
|
14901
|
+
//#region src/datatypes/analytics.d.ts
|
|
14902
|
+
type Schemas$20 = components["schemas"];
|
|
14903
|
+
type WorkspaceAnalytics = Schemas$20["WorkspaceAnalytics"];
|
|
14904
|
+
type StorageAnalytics = Schemas$20["StorageAnalytics"];
|
|
14905
|
+
type StorageKindEntry = Schemas$20["StorageKindEntry"];
|
|
14906
|
+
type RunAnalytics = Schemas$20["RunAnalytics"];
|
|
14907
|
+
type RunStatusEntry = Schemas$20["RunStatusEntry"];
|
|
14908
|
+
type UsageAnalytics = Schemas$20["UsageAnalytics"];
|
|
14909
|
+
type ModelUsage = Schemas$20["ModelUsage"];
|
|
14910
|
+
type ModelUsageEntry = Schemas$20["ModelUsageEntry"];
|
|
14911
|
+
type Usage = Schemas$20["Usage"];
|
|
14912
|
+
type UsageReport = Schemas$20["UsageReport"];
|
|
14913
|
+
type TokenCounts = Schemas$20["TokenCounts"];
|
|
14914
|
+
type ProviderType = Schemas$20["ProviderType"];
|
|
14915
|
+
type RecognizerId = Schemas$20["RecognizerId"];
|
|
14916
|
+
type RunTimeSeries = Schemas$20["RunTimeSeries"];
|
|
14917
|
+
type RunDayEntry = Schemas$20["RunDayEntry"];
|
|
13700
14918
|
//#endregion
|
|
13701
14919
|
//#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$
|
|
14920
|
+
type Schemas$19 = components["schemas"];
|
|
14921
|
+
type ApiToken = Schemas$19["ApiToken"];
|
|
14922
|
+
type ApiTokenWithJWT = Schemas$19["ApiTokenWithJWT"];
|
|
14923
|
+
type ApiTokenType = Schemas$19["ApiTokenType"];
|
|
14924
|
+
type CreateApiToken = Schemas$19["CreateApiToken"];
|
|
14925
|
+
type UpdateApiToken = Schemas$19["UpdateApiToken"];
|
|
14926
|
+
type TokenExpiration = Schemas$19["TokenExpiration"];
|
|
14927
|
+
type ApiTokenPage = Schemas$19["ApiTokenPage"];
|
|
13710
14928
|
//#endregion
|
|
13711
14929
|
//#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$
|
|
14930
|
+
type Schemas$18 = components["schemas"];
|
|
14931
|
+
type EntityGroup = Schemas$18["EntityGroup"];
|
|
14932
|
+
type AuditContext = Schemas$18["AuditContext"];
|
|
14933
|
+
type EntityCoRef = Schemas$18["EntityCoRef"];
|
|
14934
|
+
type RasterMode = Schemas$18["RasterMode"];
|
|
14935
|
+
type Dpi = Schemas$18["Dpi"];
|
|
14936
|
+
type Review = Schemas$18["Review"];
|
|
14937
|
+
type Attribution = Schemas$18["Attribution"];
|
|
14938
|
+
type AttributionKind = Schemas$18["AttributionKind"];
|
|
14939
|
+
type LeakProfile = Schemas$18["LeakProfile"];
|
|
14940
|
+
type RuleMatch = Schemas$18["RuleMatch"];
|
|
14941
|
+
type ModelEvent = Schemas$18["ModelEvent"];
|
|
14942
|
+
type PatternEvent = Schemas$18["PatternEvent"];
|
|
14943
|
+
type OperatorId = Schemas$18["OperatorId"];
|
|
14944
|
+
type AuditHash = Schemas$18["AuditHash"];
|
|
14945
|
+
type Category = Schemas$18["Category"];
|
|
13728
14946
|
/** 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$
|
|
14947
|
+
type RangeOfUint = Schemas$18["Range_of_uint"];
|
|
14948
|
+
type SourceRef = Schemas$18["SourceRef"];
|
|
14949
|
+
type BoundingBox = Schemas$18["BoundingBox"];
|
|
14950
|
+
type Point = Schemas$18["Point"];
|
|
14951
|
+
type Polygon = Schemas$18["Polygon"];
|
|
14952
|
+
type Dimensions = Schemas$18["Dimensions"];
|
|
14953
|
+
type TimeSpan = Schemas$18["TimeSpan"];
|
|
14954
|
+
type TextEntity = Schemas$18["TextEntity"];
|
|
14955
|
+
type TextEntityRecord = Schemas$18["TextEntityRecord"];
|
|
14956
|
+
type TextAuditEvent = Schemas$18["TextAuditEvent"];
|
|
14957
|
+
type TextAuditKind = Schemas$18["TextAuditKind"];
|
|
14958
|
+
type TextHint = Schemas$18["TextHint"];
|
|
14959
|
+
type TextLocation = Schemas$18["TextLocation"];
|
|
14960
|
+
type TextAuditLog = Schemas$18["TextAuditLog"];
|
|
14961
|
+
type TextData = Schemas$18["TextData"];
|
|
14962
|
+
type ImageEntity = Schemas$18["ImageEntity"];
|
|
14963
|
+
type ImageEntityRecord = Schemas$18["ImageEntityRecord"];
|
|
14964
|
+
type ImageAuditEvent = Schemas$18["ImageAuditEvent"];
|
|
14965
|
+
type ImageAuditKind = Schemas$18["ImageAuditKind"];
|
|
14966
|
+
type ImageHint = Schemas$18["ImageHint"];
|
|
14967
|
+
type ImageLocation = Schemas$18["ImageLocation"];
|
|
14968
|
+
type ImageAuditLog = Schemas$18["ImageAuditLog"];
|
|
14969
|
+
type ImageData = Schemas$18["ImageData"];
|
|
14970
|
+
type AudioEntity = Schemas$18["AudioEntity"];
|
|
14971
|
+
type AudioEntityRecord = Schemas$18["AudioEntityRecord"];
|
|
14972
|
+
type AudioAuditEvent = Schemas$18["AudioAuditEvent"];
|
|
14973
|
+
type AudioAuditKind = Schemas$18["AudioAuditKind"];
|
|
14974
|
+
type AudioHint = Schemas$18["AudioHint"];
|
|
14975
|
+
type AudioLocation = Schemas$18["AudioLocation"];
|
|
14976
|
+
type AudioAuditLog = Schemas$18["AudioAuditLog"];
|
|
14977
|
+
type AudioData = Schemas$18["AudioData"];
|
|
14978
|
+
type TabularEntity = Schemas$18["TabularEntity"];
|
|
14979
|
+
type TabularEntityRecord = Schemas$18["TabularEntityRecord"];
|
|
14980
|
+
type TabularAuditEvent = Schemas$18["TabularAuditEvent"];
|
|
14981
|
+
type TabularAuditKind = Schemas$18["TabularAuditKind"];
|
|
14982
|
+
type TabularHint = Schemas$18["TabularHint"];
|
|
14983
|
+
type TabularLocation = Schemas$18["TabularLocation"];
|
|
14984
|
+
type TabularAuditLog = Schemas$18["TabularAuditLog"];
|
|
13767
14985
|
//#endregion
|
|
13768
14986
|
//#region src/datatypes/auth.d.ts
|
|
13769
|
-
type Schemas$
|
|
13770
|
-
type Login = Schemas$
|
|
13771
|
-
type Signup = Schemas$
|
|
13772
|
-
type AuthToken = Schemas$
|
|
14987
|
+
type Schemas$17 = components["schemas"];
|
|
14988
|
+
type Login = Schemas$17["Login"];
|
|
14989
|
+
type Signup = Schemas$17["Signup"];
|
|
14990
|
+
type AuthToken = Schemas$17["AuthToken"];
|
|
13773
14991
|
//#endregion
|
|
13774
14992
|
//#region src/datatypes/catalog.d.ts
|
|
13775
|
-
type Schemas$
|
|
14993
|
+
type Schemas$16 = components["schemas"];
|
|
13776
14994
|
/** Registry of the deployment's built-in labels, keyed by id. */
|
|
13777
|
-
type LabelCatalog = Schemas$
|
|
14995
|
+
type LabelCatalog = Schemas$16["LabelCatalog"];
|
|
13778
14996
|
/** The engine's registered recognizers, grouped into NER and LLM. */
|
|
13779
|
-
type RecognizerCatalog = Schemas$
|
|
13780
|
-
type RegisteredRecognizer = Schemas$
|
|
14997
|
+
type RecognizerCatalog = Schemas$16["RecognizerCatalog"];
|
|
14998
|
+
type RegisteredRecognizer = Schemas$16["RegisteredRecognizer"];
|
|
14999
|
+
//#endregion
|
|
15000
|
+
//#region src/datatypes/chat.d.ts
|
|
15001
|
+
type Schemas$15 = components["schemas"];
|
|
15002
|
+
type ChatSession = Schemas$15["ChatSession"];
|
|
15003
|
+
type ChatSessionPage = Schemas$15["ChatSessionPage"];
|
|
15004
|
+
type CreateChatSession = Schemas$15["CreateChatSession"];
|
|
15005
|
+
type ChatMessage = Schemas$15["ChatMessage"];
|
|
15006
|
+
type ChatRole = Schemas$15["ChatRole"];
|
|
15007
|
+
type SendChatMessage = Schemas$15["SendChatMessage"];
|
|
15008
|
+
type ChatToken = Schemas$15["ChatToken"];
|
|
13781
15009
|
//#endregion
|
|
13782
15010
|
//#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$
|
|
15011
|
+
type Schemas$14 = components["schemas"];
|
|
15012
|
+
type ConnectionId = Schemas$14["ConnectionId"];
|
|
15013
|
+
type Connection = Schemas$14["Connection"];
|
|
15014
|
+
type CreateConnection = Schemas$14["CreateConnection"];
|
|
15015
|
+
type UpdateConnection = Schemas$14["UpdateConnection"];
|
|
15016
|
+
type ConnectionsQuery = Schemas$14["ConnectionsQuery"];
|
|
15017
|
+
type ConnectionPage = Schemas$14["ConnectionPage"];
|
|
15018
|
+
type SyncConnection = Schemas$14["SyncConnection"];
|
|
15019
|
+
type ConnectionSync = Schemas$14["ConnectionSync"];
|
|
15020
|
+
type ConnectionSyncPage = Schemas$14["ConnectionSyncPage"];
|
|
15021
|
+
type ConnectionVerification = Schemas$14["ConnectionVerification"];
|
|
15022
|
+
type SyncMode = Schemas$14["SyncMode"];
|
|
15023
|
+
type SyncStatus = Schemas$14["SyncStatus"];
|
|
15024
|
+
type SyncTriggerType = Schemas$14["SyncTriggerType"];
|
|
15025
|
+
type SyncDeletionPolicy = Schemas$14["SyncDeletionPolicy"];
|
|
15026
|
+
type ConnectionConfig = Schemas$14["ConnectionConfig"];
|
|
15027
|
+
type StorageConfig = Schemas$14["StorageConfig"];
|
|
15028
|
+
type S3Credentials = Schemas$14["S3Credentials"];
|
|
15029
|
+
type AzureCredentials = Schemas$14["AzureCredentials"];
|
|
15030
|
+
type GcsCredentials = Schemas$14["GcsCredentials"];
|
|
15031
|
+
type LlmConfig = Schemas$14["LlmConfig"];
|
|
15032
|
+
type AnthropicCredentials = Schemas$14["AnthropicCredentials"];
|
|
15033
|
+
type OpenAiCredentials = Schemas$14["OpenAiCredentials"];
|
|
15034
|
+
type SyncSchedule = Schemas$14["SyncSchedule"];
|
|
15035
|
+
type SyncScheduleInput = Schemas$14["SyncScheduleInput"];
|
|
13808
15036
|
//#endregion
|
|
13809
15037
|
//#region src/datatypes/error.d.ts
|
|
15038
|
+
type Schemas$13 = components["schemas"];
|
|
15039
|
+
type ErrorResponse = Schemas$13["ErrorResponse"];
|
|
15040
|
+
type ValidationErrorDetail = Schemas$13["ValidationErrorDetail"];
|
|
15041
|
+
//#endregion
|
|
15042
|
+
//#region src/datatypes/export.d.ts
|
|
13810
15043
|
type Schemas$12 = components["schemas"];
|
|
13811
|
-
type
|
|
13812
|
-
type
|
|
15044
|
+
type ExportFormat = Schemas$12["ExportFormat"];
|
|
15045
|
+
type ExportQuery = Schemas$12["ExportQuery"];
|
|
15046
|
+
type DateWindow = Schemas$12["DateWindow"];
|
|
13813
15047
|
//#endregion
|
|
13814
15048
|
//#region src/datatypes/file.d.ts
|
|
13815
15049
|
type Schemas$11 = components["schemas"];
|
|
@@ -13977,5 +15211,5 @@ type Retention = Schemas["Retention"];
|
|
|
13977
15211
|
type RetentionSettings = Schemas["RetentionSettings"];
|
|
13978
15212
|
type RetentionOverride = Schemas["RetentionOverride"];
|
|
13979
15213
|
//#endregion
|
|
13980
|
-
export { LabelRef as $,
|
|
13981
|
-
//# sourceMappingURL=index-
|
|
15214
|
+
export { LabelRef as $, ChatRole as $n, TabularHint as $r, UpdateMember as $t, CreatePipelineRun as A, UsageReport as Ai, Connection as An, ImageAuditKind as Ar, CursorPagination as At, Color as B, PipelineActivityParams as Bi, LlmConfig as Bn, PatternEvent as Br, NotificationSettings as Bt, Language as C, RunStatusEntry as Ci, DateWindow as Cn, BoundingBox as Cr, PipelineDefinition as Ct, ScopeMetadata as D, TokenCounts as Di, ValidationErrorDetail as Dn, EntityCoRef as Dr, PipelineSummaryPage as Dt, Languages as E, StorageKindEntry as Ei, ErrorResponse as En, Dpi as Er, PipelineSummary as Et, RunId as F, ActivityPayload as Fi, ConnectionSyncPage as Fn, ImageHint as Fr, MemberJoinedParams as Ft, GdprArticle9Treatment as G, Account as Gi, SyncDeletionPolicy as Gn, Review as Gr, SystemReportParams as Gt, CreatePolicy as H, PolicyActivityParams as Hi, S3Credentials as Hn, Polygon as Hr, PipelineRunCompletedParams as Ht, RunMetadata as I, ConnectionActivityParams as Ii, ConnectionVerification as In, ImageLocation as Ir, Notification as It, HipaaDeidMethod as J, PasswordChange as Ji, SyncScheduleInput as Jn, TabularAuditEvent as Jr, UpdateNotificationSettings as Jt, GdprSensitiveScope as K, AccountRef as Ki, SyncMode as Kn, RuleMatch as Kr, UnreadCountEvent as Kt, RunStatusEvent as L, FileActivityParams as Li, ConnectionsQuery as Ln, LeakProfile as Lr, NotificationEvent as Lt, PipelineRunPage as M, Activity as Mi, ConnectionId as Mn, ImageData as Mr, ConnectionSyncFailedParams as Mt, PipelineRunStatus as N, ActivityExportQuery as Ni, ConnectionPage as Nn, ImageEntity as Nr, MarkedReadStatus as Nt, ScopeParams as O, Usage as Oi, AnthropicCredentials as On, EntityGroup as Or, PipelineTriggerType as Ot, PipelineRunsQuery as P, ActivityPage as Pi, ConnectionSync as Pn, ImageEntityRecord as Pr, MemberInvitedParams as Pt, LabelLocale as Q, ChatMessage as Qn, TabularEntityRecord as Qr, MemberSortField as Qt, AudioRedaction as R, InviteActivityParams as Ri, CreateConnection as Rn, ModelEvent as Rr, NotificationPage as Rt, CountryCode as S, RunDayEntry as Si, UpdateFile as Sn, AuditHash as Sr, Pipeline as St, LanguageSpan as T, StorageAnalytics as Ti, ExportQuery as Tn, Dimensions as Tr, PipelineStatus as Tt, DateGranularity as U, WebhookActivityParams as Ui, StorageConfig as Un, RangeOfUint as Ur, PipelineRunFailedParams as Ut, ConfidenceThreshold as V, PipelineRunActivityParams as Vi, OpenAiCredentials as Vn, Point as Vr, PipelineRunAnalyzedParams as Vt, DateStyle as W, WorkspaceActivityParams as Wi, SyncConnection as Wn, RasterMode as Wr, SystemAnnouncementParams as Wt, Label as X, UpdateAccount as Xi, SyncTriggerType as Xn, TabularAuditLog as Xr, Member as Xt, ImageRedaction as Y, PublicAccount as Yi, SyncStatus as Yn, TabularAuditKind as Yr, ListMembers as Yt, LabelEntry as Z, paths as Zi, UpdateConnection as Zn, TabularEntity as Zr, MemberPage as Zt, WebhookId as _, ModelUsage as _i, FileKind as _n, AudioEntity as _r, TerminalFallback as _t, RetentionSettings as a, TextEntity as ai, InvitePage as an, LabelCatalog as ar, PciPanRender as at, WebhookStatus as b, RecognizerId as bi, ListFiles as bn, AudioLocation as br, Waveform as bt, WorkspacePage as c, TextLocation as ci, InviteSortField as cn, AuthToken as cr, PolicyDraft as ct, CreateWebhook as d, ApiTokenPage as di, ReplyInvite as dn, Attribution as dr, PolicySummaryPage as dt, TabularLocation as ei, CreateInvite as en, ChatSession as er, LabelScope as et, TestWebhook as f, ApiTokenType as fi, SortOrder as fn, AttributionKind as fr, PolicyTemplate as ft, WebhookEvent as g, UpdateApiToken as gi, File as gn, AudioData as gr, TemplateOrigin as gt, WebhookCreated as h, TokenExpiration as hi, HealthStatus as hn, AudioAuditLog as hr, TabularRedaction as ht, RetentionOverride as i, TextData as ii, InviteExpiration as in, SendChatMessage as ir, PciDssPart as it, PipelineRun as j, WorkspaceAnalytics as ji, ConnectionConfig as jn, ImageAuditLog as jr, ConnectionSyncCompletedParams as jt, Audit as k, UsageAnalytics as ki, AzureCredentials as kn, ImageAuditEvent as kr, UpdatePipeline as kt, WorkspaceRole as l, TimeSpan as li, InviteStatus as ln, Login as lr, PolicyRule as lt, Webhook as m, CreateApiToken as mi, Health as mn, AudioAuditKind as mr, Sha2Algorithm as mt, OcrPolicy as n, TextAuditKind as ni, Invite as nn, ChatToken as nr, LocalizedText as nt, UpdateWorkspace as o, TextEntityRecord as oi, InvitePreview as on, RecognizerCatalog as or, Policy as ot, UpdateWebhook as p, ApiTokenWithJWT as pi, ComponentHealth as pn, AudioAuditEvent as pr, Predicate as pt, HipaaAccountNumbers as q, Handle as qi, SyncSchedule as qn, SourceRef as qr, UnreadStatus as qt, Retention as r, TextAuditLog as ri, InviteCode as rn, CreateChatSession as rr, ModalityRedactions as rt, Workspace as s, TextHint as si, InviteSent as sn, RegisteredRecognizer as sr, PolicyDefinition as st, CreateWorkspace as t, TextAuditEvent as ti, GenerateInviteCode as tn, ChatSessionPage as tr, LanguageTag as tt, WorkspaceSettings as u, ApiToken as ui, ListInvites as un, Signup as ur, PolicySummary as ut, WebhookPage as v, ModelUsageEntry as vi, FilePage as vn, AudioEntityRecord as vr, TextRedaction as vt, LanguageProvenance as w, RunTimeSeries as wi, ExportFormat as wn, Category as wr, PipelineFilter as wt, Confidence as x, RunAnalytics as xi, ModalityToken as xn, AuditContext as xr, CreatePipeline as xt, WebhookResult as y, ProviderType as yi, FormatToken as yn, AudioHint as yr, UpdatePolicy as yt, ClampBucket as z, MemberActivityParams as zi, GcsCredentials as zn, OperatorId as zr, NotificationPayload as zt };
|
|
15215
|
+
//# sourceMappingURL=index-CiQYVPsR.d.ts.map
|