@arizeai/phoenix-client 6.12.2 → 6.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -0
- package/dist/esm/__generated__/api/v1.d.ts +669 -29
- package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
- package/dist/esm/authFetch.d.ts +30 -0
- package/dist/esm/authFetch.d.ts.map +1 -0
- package/dist/esm/authFetch.js +49 -0
- package/dist/esm/authFetch.js.map +1 -0
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +2 -2
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/errors.d.ts +15 -0
- package/dist/esm/errors.d.ts.map +1 -0
- package/dist/esm/errors.js +22 -0
- package/dist/esm/errors.js.map +1 -0
- package/dist/esm/index.d.ts +2 -0
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +2 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/spans/logSpans.d.ts.map +1 -1
- package/dist/esm/spans/logSpans.js +32 -9
- package/dist/esm/spans/logSpans.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/src/__generated__/api/v1.d.ts +669 -29
- package/dist/src/__generated__/api/v1.d.ts.map +1 -1
- package/dist/src/authFetch.d.ts +30 -0
- package/dist/src/authFetch.d.ts.map +1 -0
- package/dist/src/authFetch.js +52 -0
- package/dist/src/authFetch.js.map +1 -0
- package/dist/src/client.d.ts.map +1 -1
- package/dist/src/client.js +2 -2
- package/dist/src/client.js.map +1 -1
- package/dist/src/errors.d.ts +15 -0
- package/dist/src/errors.d.ts.map +1 -0
- package/dist/src/errors.js +22 -0
- package/dist/src/errors.js.map +1 -0
- package/dist/src/index.d.ts +2 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +2 -0
- package/dist/src/index.js.map +1 -1
- package/dist/src/spans/logSpans.d.ts.map +1 -1
- package/dist/src/spans/logSpans.js +32 -9
- package/dist/src/spans/logSpans.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/docs/overview.mdx +1 -0
- package/package.json +14 -13
- package/src/__generated__/api/v1.ts +669 -29
- package/src/authFetch.ts +87 -0
- package/src/client.ts +2 -4
- package/src/errors.ts +22 -0
- package/src/index.ts +2 -0
- package/src/spans/logSpans.ts +27 -4
|
@@ -14,10 +14,10 @@ export interface paths {
|
|
|
14
14
|
* List annotation configurations
|
|
15
15
|
* @description Retrieve a paginated list of all annotation configurations in the system.
|
|
16
16
|
*/
|
|
17
|
-
get: operations["
|
|
17
|
+
get: operations["listAnnotationConfigs"];
|
|
18
18
|
put?: never;
|
|
19
19
|
/** Create an annotation configuration */
|
|
20
|
-
post: operations["
|
|
20
|
+
post: operations["createAnnotationConfig"];
|
|
21
21
|
delete?: never;
|
|
22
22
|
options?: never;
|
|
23
23
|
head?: never;
|
|
@@ -32,7 +32,7 @@ export interface paths {
|
|
|
32
32
|
cookie?: never;
|
|
33
33
|
};
|
|
34
34
|
/** Get an annotation configuration by ID or name */
|
|
35
|
-
get: operations["
|
|
35
|
+
get: operations["getAnnotationConfig"];
|
|
36
36
|
put?: never;
|
|
37
37
|
post?: never;
|
|
38
38
|
delete?: never;
|
|
@@ -50,10 +50,10 @@ export interface paths {
|
|
|
50
50
|
};
|
|
51
51
|
get?: never;
|
|
52
52
|
/** Update an annotation configuration */
|
|
53
|
-
put: operations["
|
|
53
|
+
put: operations["updateAnnotationConfig"];
|
|
54
54
|
post?: never;
|
|
55
55
|
/** Delete an annotation configuration */
|
|
56
|
-
delete: operations["
|
|
56
|
+
delete: operations["deleteAnnotationConfig"];
|
|
57
57
|
options?: never;
|
|
58
58
|
head?: never;
|
|
59
59
|
patch?: never;
|
|
@@ -1189,7 +1189,7 @@ export interface paths {
|
|
|
1189
1189
|
};
|
|
1190
1190
|
get?: never;
|
|
1191
1191
|
put?: never;
|
|
1192
|
-
/**
|
|
1192
|
+
/** Create span document annotations */
|
|
1193
1193
|
post: operations["annotateSpanDocuments"];
|
|
1194
1194
|
delete?: never;
|
|
1195
1195
|
options?: never;
|
|
@@ -1281,6 +1281,114 @@ export interface paths {
|
|
|
1281
1281
|
patch?: never;
|
|
1282
1282
|
trace?: never;
|
|
1283
1283
|
};
|
|
1284
|
+
"/v1/user/api_keys": {
|
|
1285
|
+
parameters: {
|
|
1286
|
+
query?: never;
|
|
1287
|
+
header?: never;
|
|
1288
|
+
path?: never;
|
|
1289
|
+
cookie?: never;
|
|
1290
|
+
};
|
|
1291
|
+
/**
|
|
1292
|
+
* List the authenticated user's API keys
|
|
1293
|
+
* @description Retrieve the API keys belonging to the currently authenticated user. The keys themselves are not recoverable and are never included in the response.
|
|
1294
|
+
*/
|
|
1295
|
+
get: operations["getUserApiKeys"];
|
|
1296
|
+
put?: never;
|
|
1297
|
+
/**
|
|
1298
|
+
* Create an API key for the authenticated user
|
|
1299
|
+
* @description Create a personal API key for the currently authenticated user. The key inherits the user's role, so it grants no more access than the user already has. Creation requires an access-token session; API keys cannot mint replacement keys. The response contains the key itself, which is shown only once and cannot be retrieved afterwards.
|
|
1300
|
+
*/
|
|
1301
|
+
post: operations["createUserApiKey"];
|
|
1302
|
+
delete?: never;
|
|
1303
|
+
options?: never;
|
|
1304
|
+
head?: never;
|
|
1305
|
+
patch?: never;
|
|
1306
|
+
trace?: never;
|
|
1307
|
+
};
|
|
1308
|
+
"/v1/users/api_keys": {
|
|
1309
|
+
parameters: {
|
|
1310
|
+
query?: never;
|
|
1311
|
+
header?: never;
|
|
1312
|
+
path?: never;
|
|
1313
|
+
cookie?: never;
|
|
1314
|
+
};
|
|
1315
|
+
/**
|
|
1316
|
+
* List all user API keys
|
|
1317
|
+
* @description Retrieve API keys belonging to human users across the organization. System API keys are excluded. Restricted to admins.
|
|
1318
|
+
*/
|
|
1319
|
+
get: operations["getAllUserApiKeys"];
|
|
1320
|
+
put?: never;
|
|
1321
|
+
post?: never;
|
|
1322
|
+
delete?: never;
|
|
1323
|
+
options?: never;
|
|
1324
|
+
head?: never;
|
|
1325
|
+
patch?: never;
|
|
1326
|
+
trace?: never;
|
|
1327
|
+
};
|
|
1328
|
+
"/v1/user/api_keys/{api_key_id}": {
|
|
1329
|
+
parameters: {
|
|
1330
|
+
query?: never;
|
|
1331
|
+
header?: never;
|
|
1332
|
+
path?: never;
|
|
1333
|
+
cookie?: never;
|
|
1334
|
+
};
|
|
1335
|
+
get?: never;
|
|
1336
|
+
put?: never;
|
|
1337
|
+
post?: never;
|
|
1338
|
+
/**
|
|
1339
|
+
* Delete a user API key
|
|
1340
|
+
* @description Permanently revoke a user API key. Users can revoke their own keys, and admins can revoke keys belonging to other users. The key stops working immediately.
|
|
1341
|
+
*/
|
|
1342
|
+
delete: operations["deleteUserApiKey"];
|
|
1343
|
+
options?: never;
|
|
1344
|
+
head?: never;
|
|
1345
|
+
patch?: never;
|
|
1346
|
+
trace?: never;
|
|
1347
|
+
};
|
|
1348
|
+
"/v1/system/api_keys": {
|
|
1349
|
+
parameters: {
|
|
1350
|
+
query?: never;
|
|
1351
|
+
header?: never;
|
|
1352
|
+
path?: never;
|
|
1353
|
+
cookie?: never;
|
|
1354
|
+
};
|
|
1355
|
+
/**
|
|
1356
|
+
* List system API keys
|
|
1357
|
+
* @description Retrieve all system API keys. System keys belong to the system user rather than to any human, so this endpoint is restricted to admins. The keys themselves are not recoverable and are never included in the response.
|
|
1358
|
+
*/
|
|
1359
|
+
get: operations["getSystemApiKeys"];
|
|
1360
|
+
put?: never;
|
|
1361
|
+
/**
|
|
1362
|
+
* Create a system API key
|
|
1363
|
+
* @description Create a system API key. System keys belong to the system user rather than to any human, so this endpoint is restricted to admins. Creation requires an admin access-token session or the configured admin secret; API keys cannot mint keys. The response contains the key itself, which is shown only once and cannot be retrieved afterwards.
|
|
1364
|
+
*/
|
|
1365
|
+
post: operations["createSystemApiKey"];
|
|
1366
|
+
delete?: never;
|
|
1367
|
+
options?: never;
|
|
1368
|
+
head?: never;
|
|
1369
|
+
patch?: never;
|
|
1370
|
+
trace?: never;
|
|
1371
|
+
};
|
|
1372
|
+
"/v1/system/api_keys/{api_key_id}": {
|
|
1373
|
+
parameters: {
|
|
1374
|
+
query?: never;
|
|
1375
|
+
header?: never;
|
|
1376
|
+
path?: never;
|
|
1377
|
+
cookie?: never;
|
|
1378
|
+
};
|
|
1379
|
+
get?: never;
|
|
1380
|
+
put?: never;
|
|
1381
|
+
post?: never;
|
|
1382
|
+
/**
|
|
1383
|
+
* Delete a system API key
|
|
1384
|
+
* @description Permanently revoke a system API key. The key stops working immediately. Restricted to admins.
|
|
1385
|
+
*/
|
|
1386
|
+
delete: operations["deleteSystemApiKey"];
|
|
1387
|
+
options?: never;
|
|
1388
|
+
head?: never;
|
|
1389
|
+
patch?: never;
|
|
1390
|
+
trace?: never;
|
|
1391
|
+
};
|
|
1284
1392
|
"/auth/login": {
|
|
1285
1393
|
parameters: {
|
|
1286
1394
|
query?: never;
|
|
@@ -1653,6 +1761,49 @@ export interface components {
|
|
|
1653
1761
|
*/
|
|
1654
1762
|
auth_method: "ANONYMOUS";
|
|
1655
1763
|
};
|
|
1764
|
+
/** ApiKey */
|
|
1765
|
+
ApiKey: {
|
|
1766
|
+
/** Id */
|
|
1767
|
+
id: string;
|
|
1768
|
+
/** Name */
|
|
1769
|
+
name: string;
|
|
1770
|
+
/** Description */
|
|
1771
|
+
description?: string | null;
|
|
1772
|
+
/**
|
|
1773
|
+
* Created At
|
|
1774
|
+
* Format: date-time
|
|
1775
|
+
*/
|
|
1776
|
+
created_at: string;
|
|
1777
|
+
/** Expires At */
|
|
1778
|
+
expires_at?: string | null;
|
|
1779
|
+
};
|
|
1780
|
+
/** ApiKeyData */
|
|
1781
|
+
ApiKeyData: {
|
|
1782
|
+
/**
|
|
1783
|
+
* Name
|
|
1784
|
+
* @description A human-readable name for the API key.
|
|
1785
|
+
*/
|
|
1786
|
+
name: string;
|
|
1787
|
+
/**
|
|
1788
|
+
* Description
|
|
1789
|
+
* @description An optional description of what the API key is for.
|
|
1790
|
+
*/
|
|
1791
|
+
description?: string | null;
|
|
1792
|
+
/**
|
|
1793
|
+
* Expires At
|
|
1794
|
+
* @description When the API key expires. The key never expires when omitted.
|
|
1795
|
+
*/
|
|
1796
|
+
expires_at?: string | null;
|
|
1797
|
+
};
|
|
1798
|
+
/** ApiKeyUser */
|
|
1799
|
+
ApiKeyUser: {
|
|
1800
|
+
/** Id */
|
|
1801
|
+
id: string;
|
|
1802
|
+
/** Username */
|
|
1803
|
+
username: string;
|
|
1804
|
+
/** Email */
|
|
1805
|
+
email: string | null;
|
|
1806
|
+
};
|
|
1656
1807
|
/**
|
|
1657
1808
|
* AppContext
|
|
1658
1809
|
* @description Per-turn browser clock context for resolving relative time requests.
|
|
@@ -1678,9 +1829,15 @@ export interface components {
|
|
|
1678
1829
|
* @description Wire schema for the chat stream's `message_metadata` payload.
|
|
1679
1830
|
*/
|
|
1680
1831
|
AssistantMessageMetadata: {
|
|
1832
|
+
/**
|
|
1833
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1834
|
+
* @enum {string}
|
|
1835
|
+
*/
|
|
1836
|
+
type: "assistant";
|
|
1681
1837
|
/** Sessionid */
|
|
1682
1838
|
sessionId: string;
|
|
1683
1839
|
trace?: components["schemas"]["AssistantMessageMetadataTraceIds"] | null;
|
|
1840
|
+
turnTraceContext?: components["schemas"]["TurnTraceContext"] | null;
|
|
1684
1841
|
usage?: components["schemas"]["AssistantMessageMetadataUsage"] | null;
|
|
1685
1842
|
};
|
|
1686
1843
|
/** AssistantMessageMetadataTraceIds */
|
|
@@ -1711,22 +1868,6 @@ export interface components {
|
|
|
1711
1868
|
/** Total */
|
|
1712
1869
|
total: number;
|
|
1713
1870
|
};
|
|
1714
|
-
/**
|
|
1715
|
-
* AssistantMetadataUIMessage
|
|
1716
|
-
* @description `UIMessage` with `metadata` narrowed to `AssistantMessageMetadata`.
|
|
1717
|
-
*/
|
|
1718
|
-
AssistantMetadataUIMessage: {
|
|
1719
|
-
/** Id */
|
|
1720
|
-
id: string;
|
|
1721
|
-
/**
|
|
1722
|
-
* Role
|
|
1723
|
-
* @enum {string}
|
|
1724
|
-
*/
|
|
1725
|
-
role: "system" | "user" | "assistant";
|
|
1726
|
-
metadata?: components["schemas"]["AssistantMessageMetadata"] | null;
|
|
1727
|
-
/** Parts */
|
|
1728
|
-
parts: (components["schemas"]["TextUIPart"] | components["schemas"]["ReasoningUIPart"] | components["schemas"]["ToolInputStreamingPart"] | components["schemas"]["ToolInputAvailablePart"] | components["schemas"]["ToolOutputAvailablePart"] | components["schemas"]["ToolOutputErrorPart"] | components["schemas"]["ToolApprovalRequestedPart"] | components["schemas"]["ToolApprovalRespondedPart"] | components["schemas"]["ToolOutputDeniedPart"] | components["schemas"]["DynamicToolInputStreamingPart"] | components["schemas"]["DynamicToolInputAvailablePart"] | components["schemas"]["DynamicToolOutputAvailablePart"] | components["schemas"]["DynamicToolOutputErrorPart"] | components["schemas"]["DynamicToolApprovalRequestedPart"] | components["schemas"]["DynamicToolApprovalRespondedPart"] | components["schemas"]["DynamicToolOutputDeniedPart"] | components["schemas"]["SourceUrlUIPart"] | components["schemas"]["SourceDocumentUIPart"] | components["schemas"]["FileUIPart"] | components["schemas"]["DataUIPart"] | components["schemas"]["StepStartUIPart"])[];
|
|
1729
|
-
};
|
|
1730
1871
|
/**
|
|
1731
1872
|
* BuiltInProviderModelSelection
|
|
1732
1873
|
* @description Chat against a Phoenix built-in provider.
|
|
@@ -1809,7 +1950,7 @@ export interface components {
|
|
|
1809
1950
|
/** Id */
|
|
1810
1951
|
id: string;
|
|
1811
1952
|
/** Messages */
|
|
1812
|
-
messages: components["schemas"]["
|
|
1953
|
+
messages: components["schemas"]["PhoenixUIMessage"][];
|
|
1813
1954
|
/** Messageid */
|
|
1814
1955
|
messageId?: string | null;
|
|
1815
1956
|
/**
|
|
@@ -1843,6 +1984,7 @@ export interface components {
|
|
|
1843
1984
|
requestedSkills?: string[];
|
|
1844
1985
|
/** Model */
|
|
1845
1986
|
model: components["schemas"]["CustomProviderModelSelection"] | components["schemas"]["BuiltInProviderModelSelection"];
|
|
1987
|
+
turnTraceContext?: components["schemas"]["TurnTraceContext"] | null;
|
|
1846
1988
|
} & {
|
|
1847
1989
|
[key: string]: unknown;
|
|
1848
1990
|
};
|
|
@@ -1864,7 +2006,7 @@ export interface components {
|
|
|
1864
2006
|
/** Id */
|
|
1865
2007
|
id: string;
|
|
1866
2008
|
/** Messages */
|
|
1867
|
-
messages: components["schemas"]["
|
|
2009
|
+
messages: components["schemas"]["PhoenixUIMessage"][];
|
|
1868
2010
|
/**
|
|
1869
2011
|
* Ingesttraces
|
|
1870
2012
|
* @default false
|
|
@@ -1896,6 +2038,7 @@ export interface components {
|
|
|
1896
2038
|
requestedSkills?: string[];
|
|
1897
2039
|
/** Model */
|
|
1898
2040
|
model: components["schemas"]["CustomProviderModelSelection"] | components["schemas"]["BuiltInProviderModelSelection"];
|
|
2041
|
+
turnTraceContext?: components["schemas"]["TurnTraceContext"] | null;
|
|
1899
2042
|
} & {
|
|
1900
2043
|
[key: string]: unknown;
|
|
1901
2044
|
};
|
|
@@ -1955,6 +2098,14 @@ export interface components {
|
|
|
1955
2098
|
/** Data */
|
|
1956
2099
|
data: components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
|
|
1957
2100
|
};
|
|
2101
|
+
/** CreateApiKeyRequestBody */
|
|
2102
|
+
CreateApiKeyRequestBody: {
|
|
2103
|
+
data: components["schemas"]["ApiKeyData"];
|
|
2104
|
+
};
|
|
2105
|
+
/** CreateApiKeyResponseBody */
|
|
2106
|
+
CreateApiKeyResponseBody: {
|
|
2107
|
+
data: components["schemas"]["CreatedApiKey"];
|
|
2108
|
+
};
|
|
1958
2109
|
/** CreateDatasetLabelRequestBody */
|
|
1959
2110
|
CreateDatasetLabelRequestBody: {
|
|
1960
2111
|
/**
|
|
@@ -2149,6 +2300,27 @@ export interface components {
|
|
|
2149
2300
|
/** Data */
|
|
2150
2301
|
data: components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"] | components["schemas"]["LDAPUser"];
|
|
2151
2302
|
};
|
|
2303
|
+
/** CreatedApiKey */
|
|
2304
|
+
CreatedApiKey: {
|
|
2305
|
+
/** Id */
|
|
2306
|
+
id: string;
|
|
2307
|
+
/** Name */
|
|
2308
|
+
name: string;
|
|
2309
|
+
/** Description */
|
|
2310
|
+
description?: string | null;
|
|
2311
|
+
/**
|
|
2312
|
+
* Created At
|
|
2313
|
+
* Format: date-time
|
|
2314
|
+
*/
|
|
2315
|
+
created_at: string;
|
|
2316
|
+
/** Expires At */
|
|
2317
|
+
expires_at?: string | null;
|
|
2318
|
+
/**
|
|
2319
|
+
* Key
|
|
2320
|
+
* @description The API key. This is the only time it is returned; it cannot be recovered from the listing endpoints.
|
|
2321
|
+
*/
|
|
2322
|
+
key: string;
|
|
2323
|
+
};
|
|
2152
2324
|
/**
|
|
2153
2325
|
* CustomProviderModelSelection
|
|
2154
2326
|
* @description Chat against a stored custom provider record.
|
|
@@ -2777,6 +2949,13 @@ export interface components {
|
|
|
2777
2949
|
/** Upper Bound */
|
|
2778
2950
|
upper_bound?: number | null;
|
|
2779
2951
|
};
|
|
2952
|
+
/** GetAllUserApiKeysResponseBody */
|
|
2953
|
+
GetAllUserApiKeysResponseBody: {
|
|
2954
|
+
/** Data */
|
|
2955
|
+
data: components["schemas"]["UserApiKey"][];
|
|
2956
|
+
/** Next Cursor */
|
|
2957
|
+
next_cursor: string | null;
|
|
2958
|
+
};
|
|
2780
2959
|
/** GetAnnotationConfigResponseBody */
|
|
2781
2960
|
GetAnnotationConfigResponseBody: {
|
|
2782
2961
|
/** Data */
|
|
@@ -2789,6 +2968,11 @@ export interface components {
|
|
|
2789
2968
|
/** Next Cursor */
|
|
2790
2969
|
next_cursor: string | null;
|
|
2791
2970
|
};
|
|
2971
|
+
/** GetApiKeysResponseBody */
|
|
2972
|
+
GetApiKeysResponseBody: {
|
|
2973
|
+
/** Data */
|
|
2974
|
+
data: components["schemas"]["ApiKey"][];
|
|
2975
|
+
};
|
|
2792
2976
|
/** GetDatasetLabelResponseBody */
|
|
2793
2977
|
GetDatasetLabelResponseBody: {
|
|
2794
2978
|
data: components["schemas"]["DatasetLabel"];
|
|
@@ -3403,6 +3587,23 @@ export interface components {
|
|
|
3403
3587
|
*/
|
|
3404
3588
|
message?: string | null;
|
|
3405
3589
|
};
|
|
3590
|
+
/**
|
|
3591
|
+
* PhoenixUIMessage
|
|
3592
|
+
* @description `UIMessage` with `metadata` narrowed to the Phoenix wire shapes.
|
|
3593
|
+
*/
|
|
3594
|
+
PhoenixUIMessage: {
|
|
3595
|
+
/** Id */
|
|
3596
|
+
id: string;
|
|
3597
|
+
/**
|
|
3598
|
+
* Role
|
|
3599
|
+
* @enum {string}
|
|
3600
|
+
*/
|
|
3601
|
+
role: "system" | "user" | "assistant";
|
|
3602
|
+
/** Metadata */
|
|
3603
|
+
metadata?: (components["schemas"]["AssistantMessageMetadata"] | components["schemas"]["UserMessageMetadata"]) | null;
|
|
3604
|
+
/** Parts */
|
|
3605
|
+
parts: (components["schemas"]["TextUIPart"] | components["schemas"]["ReasoningUIPart"] | components["schemas"]["ToolInputStreamingPart"] | components["schemas"]["ToolInputAvailablePart"] | components["schemas"]["ToolOutputAvailablePart"] | components["schemas"]["ToolOutputErrorPart"] | components["schemas"]["ToolApprovalRequestedPart"] | components["schemas"]["ToolApprovalRespondedPart"] | components["schemas"]["ToolOutputDeniedPart"] | components["schemas"]["DynamicToolInputStreamingPart"] | components["schemas"]["DynamicToolInputAvailablePart"] | components["schemas"]["DynamicToolOutputAvailablePart"] | components["schemas"]["DynamicToolOutputErrorPart"] | components["schemas"]["DynamicToolApprovalRequestedPart"] | components["schemas"]["DynamicToolApprovalRespondedPart"] | components["schemas"]["DynamicToolOutputDeniedPart"] | components["schemas"]["SourceUrlUIPart"] | components["schemas"]["SourceDocumentUIPart"] | components["schemas"]["FileUIPart"] | components["schemas"]["DataUIPart"] | components["schemas"]["StepStartUIPart"])[];
|
|
3606
|
+
};
|
|
3406
3607
|
/**
|
|
3407
3608
|
* PlaygroundBuiltinModelContext
|
|
3408
3609
|
* @description Built-in playground model selection.
|
|
@@ -5463,6 +5664,18 @@ export interface components {
|
|
|
5463
5664
|
*/
|
|
5464
5665
|
end_time: string;
|
|
5465
5666
|
};
|
|
5667
|
+
/** TurnTraceContext */
|
|
5668
|
+
TurnTraceContext: {
|
|
5669
|
+
/** Traceid */
|
|
5670
|
+
traceId: string;
|
|
5671
|
+
/** Rootspanid */
|
|
5672
|
+
rootSpanId: string;
|
|
5673
|
+
/**
|
|
5674
|
+
* Startedat
|
|
5675
|
+
* Format: date-time
|
|
5676
|
+
*/
|
|
5677
|
+
startedAt: string;
|
|
5678
|
+
};
|
|
5466
5679
|
/**
|
|
5467
5680
|
* UIMessage
|
|
5468
5681
|
* @description A message as displayed in the UI by Vercel AI Elements.
|
|
@@ -5643,6 +5856,38 @@ export interface components {
|
|
|
5643
5856
|
/** Deleted Keys */
|
|
5644
5857
|
deleted_keys: string[];
|
|
5645
5858
|
};
|
|
5859
|
+
/** UserApiKey */
|
|
5860
|
+
UserApiKey: {
|
|
5861
|
+
/** Id */
|
|
5862
|
+
id: string;
|
|
5863
|
+
/** Name */
|
|
5864
|
+
name: string;
|
|
5865
|
+
/** Description */
|
|
5866
|
+
description?: string | null;
|
|
5867
|
+
/**
|
|
5868
|
+
* Created At
|
|
5869
|
+
* Format: date-time
|
|
5870
|
+
*/
|
|
5871
|
+
created_at: string;
|
|
5872
|
+
/** Expires At */
|
|
5873
|
+
expires_at?: string | null;
|
|
5874
|
+
user: components["schemas"]["ApiKeyUser"];
|
|
5875
|
+
};
|
|
5876
|
+
/**
|
|
5877
|
+
* UserMessageMetadata
|
|
5878
|
+
* @description Wire schema for metadata the browser attaches to outgoing user messages.
|
|
5879
|
+
*/
|
|
5880
|
+
UserMessageMetadata: {
|
|
5881
|
+
/**
|
|
5882
|
+
* @description discriminator enum property added by openapi-typescript
|
|
5883
|
+
* @enum {string}
|
|
5884
|
+
*/
|
|
5885
|
+
type: "user";
|
|
5886
|
+
/** Currentdatetime */
|
|
5887
|
+
currentDateTime: string;
|
|
5888
|
+
/** Timezone */
|
|
5889
|
+
timeZone: string;
|
|
5890
|
+
};
|
|
5646
5891
|
/** ValidationError */
|
|
5647
5892
|
ValidationError: {
|
|
5648
5893
|
/** Location */
|
|
@@ -5703,6 +5948,34 @@ export interface components {
|
|
|
5703
5948
|
/** Summary */
|
|
5704
5949
|
summary: string;
|
|
5705
5950
|
};
|
|
5951
|
+
/**
|
|
5952
|
+
* ToolCallCallbackProviderMetadata
|
|
5953
|
+
* @description Shape of the ``phoenix`` namespace the browser returns in
|
|
5954
|
+
* ``callProviderMetadata`` on resolved tool parts: the server-stamped fields
|
|
5955
|
+
* plus browser-recorded execution timings.
|
|
5956
|
+
*/
|
|
5957
|
+
ToolCallCallbackProviderMetadata: {
|
|
5958
|
+
/**
|
|
5959
|
+
* Tool Execution Environment
|
|
5960
|
+
* @enum {string}
|
|
5961
|
+
*/
|
|
5962
|
+
tool_execution_environment: "client" | "server";
|
|
5963
|
+
/**
|
|
5964
|
+
* Tool Input Emitted At
|
|
5965
|
+
* @default null
|
|
5966
|
+
*/
|
|
5967
|
+
tool_input_emitted_at?: string | null;
|
|
5968
|
+
/**
|
|
5969
|
+
* Client Started At
|
|
5970
|
+
* @default null
|
|
5971
|
+
*/
|
|
5972
|
+
client_started_at?: string | null;
|
|
5973
|
+
/**
|
|
5974
|
+
* Client Ended At
|
|
5975
|
+
* @default null
|
|
5976
|
+
*/
|
|
5977
|
+
client_ended_at?: string | null;
|
|
5978
|
+
};
|
|
5706
5979
|
/**
|
|
5707
5980
|
* ToolCallProviderMetadata
|
|
5708
5981
|
* @description Payload Phoenix stamps under the ``phoenix`` namespace of Vercel AI
|
|
@@ -5715,6 +5988,11 @@ export interface components {
|
|
|
5715
5988
|
* @enum {string}
|
|
5716
5989
|
*/
|
|
5717
5990
|
tool_execution_environment: "client" | "server";
|
|
5991
|
+
/**
|
|
5992
|
+
* Tool Input Emitted At
|
|
5993
|
+
* @default null
|
|
5994
|
+
*/
|
|
5995
|
+
tool_input_emitted_at?: string | null;
|
|
5718
5996
|
};
|
|
5719
5997
|
};
|
|
5720
5998
|
responses: never;
|
|
@@ -5725,7 +6003,7 @@ export interface components {
|
|
|
5725
6003
|
}
|
|
5726
6004
|
export type $defs = Record<string, never>;
|
|
5727
6005
|
export interface operations {
|
|
5728
|
-
|
|
6006
|
+
listAnnotationConfigs: {
|
|
5729
6007
|
parameters: {
|
|
5730
6008
|
query?: {
|
|
5731
6009
|
/** @description Cursor for pagination (base64-encoded annotation config ID) */
|
|
@@ -5768,7 +6046,7 @@ export interface operations {
|
|
|
5768
6046
|
};
|
|
5769
6047
|
};
|
|
5770
6048
|
};
|
|
5771
|
-
|
|
6049
|
+
createAnnotationConfig: {
|
|
5772
6050
|
parameters: {
|
|
5773
6051
|
query?: never;
|
|
5774
6052
|
header?: never;
|
|
@@ -5810,7 +6088,7 @@ export interface operations {
|
|
|
5810
6088
|
};
|
|
5811
6089
|
};
|
|
5812
6090
|
};
|
|
5813
|
-
|
|
6091
|
+
getAnnotationConfig: {
|
|
5814
6092
|
parameters: {
|
|
5815
6093
|
query?: never;
|
|
5816
6094
|
header?: never;
|
|
@@ -5851,7 +6129,7 @@ export interface operations {
|
|
|
5851
6129
|
};
|
|
5852
6130
|
};
|
|
5853
6131
|
};
|
|
5854
|
-
|
|
6132
|
+
updateAnnotationConfig: {
|
|
5855
6133
|
parameters: {
|
|
5856
6134
|
query?: never;
|
|
5857
6135
|
header?: never;
|
|
@@ -5896,7 +6174,7 @@ export interface operations {
|
|
|
5896
6174
|
};
|
|
5897
6175
|
};
|
|
5898
6176
|
};
|
|
5899
|
-
|
|
6177
|
+
deleteAnnotationConfig: {
|
|
5900
6178
|
parameters: {
|
|
5901
6179
|
query?: never;
|
|
5902
6180
|
header?: never;
|
|
@@ -10026,6 +10304,368 @@ export interface operations {
|
|
|
10026
10304
|
};
|
|
10027
10305
|
};
|
|
10028
10306
|
};
|
|
10307
|
+
getUserApiKeys: {
|
|
10308
|
+
parameters: {
|
|
10309
|
+
query?: never;
|
|
10310
|
+
header?: never;
|
|
10311
|
+
path?: never;
|
|
10312
|
+
cookie?: never;
|
|
10313
|
+
};
|
|
10314
|
+
requestBody?: never;
|
|
10315
|
+
responses: {
|
|
10316
|
+
/** @description The authenticated user's API keys. */
|
|
10317
|
+
200: {
|
|
10318
|
+
headers: {
|
|
10319
|
+
[name: string]: unknown;
|
|
10320
|
+
};
|
|
10321
|
+
content: {
|
|
10322
|
+
"application/json": components["schemas"]["GetApiKeysResponseBody"];
|
|
10323
|
+
};
|
|
10324
|
+
};
|
|
10325
|
+
/** @description Unauthorized */
|
|
10326
|
+
401: {
|
|
10327
|
+
headers: {
|
|
10328
|
+
[name: string]: unknown;
|
|
10329
|
+
};
|
|
10330
|
+
content: {
|
|
10331
|
+
"text/plain": string;
|
|
10332
|
+
};
|
|
10333
|
+
};
|
|
10334
|
+
/** @description Forbidden */
|
|
10335
|
+
403: {
|
|
10336
|
+
headers: {
|
|
10337
|
+
[name: string]: unknown;
|
|
10338
|
+
};
|
|
10339
|
+
content: {
|
|
10340
|
+
"text/plain": string;
|
|
10341
|
+
};
|
|
10342
|
+
};
|
|
10343
|
+
};
|
|
10344
|
+
};
|
|
10345
|
+
createUserApiKey: {
|
|
10346
|
+
parameters: {
|
|
10347
|
+
query?: never;
|
|
10348
|
+
header?: never;
|
|
10349
|
+
path?: never;
|
|
10350
|
+
cookie?: never;
|
|
10351
|
+
};
|
|
10352
|
+
requestBody: {
|
|
10353
|
+
content: {
|
|
10354
|
+
"application/json": components["schemas"]["CreateApiKeyRequestBody"];
|
|
10355
|
+
};
|
|
10356
|
+
};
|
|
10357
|
+
responses: {
|
|
10358
|
+
/** @description The newly created API key, including the key itself. */
|
|
10359
|
+
201: {
|
|
10360
|
+
headers: {
|
|
10361
|
+
[name: string]: unknown;
|
|
10362
|
+
};
|
|
10363
|
+
content: {
|
|
10364
|
+
"application/json": components["schemas"]["CreateApiKeyResponseBody"];
|
|
10365
|
+
};
|
|
10366
|
+
};
|
|
10367
|
+
/** @description Unauthorized */
|
|
10368
|
+
401: {
|
|
10369
|
+
headers: {
|
|
10370
|
+
[name: string]: unknown;
|
|
10371
|
+
};
|
|
10372
|
+
content: {
|
|
10373
|
+
"text/plain": string;
|
|
10374
|
+
};
|
|
10375
|
+
};
|
|
10376
|
+
/** @description Forbidden */
|
|
10377
|
+
403: {
|
|
10378
|
+
headers: {
|
|
10379
|
+
[name: string]: unknown;
|
|
10380
|
+
};
|
|
10381
|
+
content: {
|
|
10382
|
+
"text/plain": string;
|
|
10383
|
+
};
|
|
10384
|
+
};
|
|
10385
|
+
/** @description Unprocessable Entity */
|
|
10386
|
+
422: {
|
|
10387
|
+
headers: {
|
|
10388
|
+
[name: string]: unknown;
|
|
10389
|
+
};
|
|
10390
|
+
content: {
|
|
10391
|
+
"text/plain": string;
|
|
10392
|
+
};
|
|
10393
|
+
};
|
|
10394
|
+
/** @description Insufficient Storage */
|
|
10395
|
+
507: {
|
|
10396
|
+
headers: {
|
|
10397
|
+
[name: string]: unknown;
|
|
10398
|
+
};
|
|
10399
|
+
content: {
|
|
10400
|
+
"text/plain": string;
|
|
10401
|
+
};
|
|
10402
|
+
};
|
|
10403
|
+
};
|
|
10404
|
+
};
|
|
10405
|
+
getAllUserApiKeys: {
|
|
10406
|
+
parameters: {
|
|
10407
|
+
query?: {
|
|
10408
|
+
/** @description Cursor for pagination (a UserApiKey GlobalID). */
|
|
10409
|
+
cursor?: string | null;
|
|
10410
|
+
/** @description The maximum number of API keys to return (at most 1000). */
|
|
10411
|
+
limit?: number;
|
|
10412
|
+
};
|
|
10413
|
+
header?: never;
|
|
10414
|
+
path?: never;
|
|
10415
|
+
cookie?: never;
|
|
10416
|
+
};
|
|
10417
|
+
requestBody?: never;
|
|
10418
|
+
responses: {
|
|
10419
|
+
/** @description A paginated list of user API keys and their owners. */
|
|
10420
|
+
200: {
|
|
10421
|
+
headers: {
|
|
10422
|
+
[name: string]: unknown;
|
|
10423
|
+
};
|
|
10424
|
+
content: {
|
|
10425
|
+
"application/json": components["schemas"]["GetAllUserApiKeysResponseBody"];
|
|
10426
|
+
};
|
|
10427
|
+
};
|
|
10428
|
+
/** @description Unauthorized */
|
|
10429
|
+
401: {
|
|
10430
|
+
headers: {
|
|
10431
|
+
[name: string]: unknown;
|
|
10432
|
+
};
|
|
10433
|
+
content: {
|
|
10434
|
+
"text/plain": string;
|
|
10435
|
+
};
|
|
10436
|
+
};
|
|
10437
|
+
/** @description Forbidden */
|
|
10438
|
+
403: {
|
|
10439
|
+
headers: {
|
|
10440
|
+
[name: string]: unknown;
|
|
10441
|
+
};
|
|
10442
|
+
content: {
|
|
10443
|
+
"text/plain": string;
|
|
10444
|
+
};
|
|
10445
|
+
};
|
|
10446
|
+
/** @description Unprocessable Entity */
|
|
10447
|
+
422: {
|
|
10448
|
+
headers: {
|
|
10449
|
+
[name: string]: unknown;
|
|
10450
|
+
};
|
|
10451
|
+
content: {
|
|
10452
|
+
"text/plain": string;
|
|
10453
|
+
};
|
|
10454
|
+
};
|
|
10455
|
+
};
|
|
10456
|
+
};
|
|
10457
|
+
deleteUserApiKey: {
|
|
10458
|
+
parameters: {
|
|
10459
|
+
query?: never;
|
|
10460
|
+
header?: never;
|
|
10461
|
+
path: {
|
|
10462
|
+
/** @description The GlobalID of the API key. */
|
|
10463
|
+
api_key_id: string;
|
|
10464
|
+
};
|
|
10465
|
+
cookie?: never;
|
|
10466
|
+
};
|
|
10467
|
+
requestBody?: never;
|
|
10468
|
+
responses: {
|
|
10469
|
+
/** @description No content returned on successful deletion. */
|
|
10470
|
+
204: {
|
|
10471
|
+
headers: {
|
|
10472
|
+
[name: string]: unknown;
|
|
10473
|
+
};
|
|
10474
|
+
content?: never;
|
|
10475
|
+
};
|
|
10476
|
+
/** @description Unauthorized */
|
|
10477
|
+
401: {
|
|
10478
|
+
headers: {
|
|
10479
|
+
[name: string]: unknown;
|
|
10480
|
+
};
|
|
10481
|
+
content: {
|
|
10482
|
+
"text/plain": string;
|
|
10483
|
+
};
|
|
10484
|
+
};
|
|
10485
|
+
/** @description Forbidden */
|
|
10486
|
+
403: {
|
|
10487
|
+
headers: {
|
|
10488
|
+
[name: string]: unknown;
|
|
10489
|
+
};
|
|
10490
|
+
content: {
|
|
10491
|
+
"text/plain": string;
|
|
10492
|
+
};
|
|
10493
|
+
};
|
|
10494
|
+
/** @description API key not found. */
|
|
10495
|
+
404: {
|
|
10496
|
+
headers: {
|
|
10497
|
+
[name: string]: unknown;
|
|
10498
|
+
};
|
|
10499
|
+
content: {
|
|
10500
|
+
"text/plain": string;
|
|
10501
|
+
};
|
|
10502
|
+
};
|
|
10503
|
+
/** @description Unprocessable Entity */
|
|
10504
|
+
422: {
|
|
10505
|
+
headers: {
|
|
10506
|
+
[name: string]: unknown;
|
|
10507
|
+
};
|
|
10508
|
+
content: {
|
|
10509
|
+
"text/plain": string;
|
|
10510
|
+
};
|
|
10511
|
+
};
|
|
10512
|
+
};
|
|
10513
|
+
};
|
|
10514
|
+
getSystemApiKeys: {
|
|
10515
|
+
parameters: {
|
|
10516
|
+
query?: never;
|
|
10517
|
+
header?: never;
|
|
10518
|
+
path?: never;
|
|
10519
|
+
cookie?: never;
|
|
10520
|
+
};
|
|
10521
|
+
requestBody?: never;
|
|
10522
|
+
responses: {
|
|
10523
|
+
/** @description The system API keys. */
|
|
10524
|
+
200: {
|
|
10525
|
+
headers: {
|
|
10526
|
+
[name: string]: unknown;
|
|
10527
|
+
};
|
|
10528
|
+
content: {
|
|
10529
|
+
"application/json": components["schemas"]["GetApiKeysResponseBody"];
|
|
10530
|
+
};
|
|
10531
|
+
};
|
|
10532
|
+
/** @description Unauthorized */
|
|
10533
|
+
401: {
|
|
10534
|
+
headers: {
|
|
10535
|
+
[name: string]: unknown;
|
|
10536
|
+
};
|
|
10537
|
+
content: {
|
|
10538
|
+
"text/plain": string;
|
|
10539
|
+
};
|
|
10540
|
+
};
|
|
10541
|
+
/** @description Forbidden */
|
|
10542
|
+
403: {
|
|
10543
|
+
headers: {
|
|
10544
|
+
[name: string]: unknown;
|
|
10545
|
+
};
|
|
10546
|
+
content: {
|
|
10547
|
+
"text/plain": string;
|
|
10548
|
+
};
|
|
10549
|
+
};
|
|
10550
|
+
};
|
|
10551
|
+
};
|
|
10552
|
+
createSystemApiKey: {
|
|
10553
|
+
parameters: {
|
|
10554
|
+
query?: never;
|
|
10555
|
+
header?: never;
|
|
10556
|
+
path?: never;
|
|
10557
|
+
cookie?: never;
|
|
10558
|
+
};
|
|
10559
|
+
requestBody: {
|
|
10560
|
+
content: {
|
|
10561
|
+
"application/json": components["schemas"]["CreateApiKeyRequestBody"];
|
|
10562
|
+
};
|
|
10563
|
+
};
|
|
10564
|
+
responses: {
|
|
10565
|
+
/** @description The newly created system API key, including the key itself. */
|
|
10566
|
+
201: {
|
|
10567
|
+
headers: {
|
|
10568
|
+
[name: string]: unknown;
|
|
10569
|
+
};
|
|
10570
|
+
content: {
|
|
10571
|
+
"application/json": components["schemas"]["CreateApiKeyResponseBody"];
|
|
10572
|
+
};
|
|
10573
|
+
};
|
|
10574
|
+
/** @description Unauthorized */
|
|
10575
|
+
401: {
|
|
10576
|
+
headers: {
|
|
10577
|
+
[name: string]: unknown;
|
|
10578
|
+
};
|
|
10579
|
+
content: {
|
|
10580
|
+
"text/plain": string;
|
|
10581
|
+
};
|
|
10582
|
+
};
|
|
10583
|
+
/** @description Forbidden */
|
|
10584
|
+
403: {
|
|
10585
|
+
headers: {
|
|
10586
|
+
[name: string]: unknown;
|
|
10587
|
+
};
|
|
10588
|
+
content: {
|
|
10589
|
+
"text/plain": string;
|
|
10590
|
+
};
|
|
10591
|
+
};
|
|
10592
|
+
/** @description Unprocessable Entity */
|
|
10593
|
+
422: {
|
|
10594
|
+
headers: {
|
|
10595
|
+
[name: string]: unknown;
|
|
10596
|
+
};
|
|
10597
|
+
content: {
|
|
10598
|
+
"text/plain": string;
|
|
10599
|
+
};
|
|
10600
|
+
};
|
|
10601
|
+
/** @description Insufficient Storage */
|
|
10602
|
+
507: {
|
|
10603
|
+
headers: {
|
|
10604
|
+
[name: string]: unknown;
|
|
10605
|
+
};
|
|
10606
|
+
content: {
|
|
10607
|
+
"text/plain": string;
|
|
10608
|
+
};
|
|
10609
|
+
};
|
|
10610
|
+
};
|
|
10611
|
+
};
|
|
10612
|
+
deleteSystemApiKey: {
|
|
10613
|
+
parameters: {
|
|
10614
|
+
query?: never;
|
|
10615
|
+
header?: never;
|
|
10616
|
+
path: {
|
|
10617
|
+
/** @description The GlobalID of the system API key. */
|
|
10618
|
+
api_key_id: string;
|
|
10619
|
+
};
|
|
10620
|
+
cookie?: never;
|
|
10621
|
+
};
|
|
10622
|
+
requestBody?: never;
|
|
10623
|
+
responses: {
|
|
10624
|
+
/** @description No content returned on successful deletion. */
|
|
10625
|
+
204: {
|
|
10626
|
+
headers: {
|
|
10627
|
+
[name: string]: unknown;
|
|
10628
|
+
};
|
|
10629
|
+
content?: never;
|
|
10630
|
+
};
|
|
10631
|
+
/** @description Unauthorized */
|
|
10632
|
+
401: {
|
|
10633
|
+
headers: {
|
|
10634
|
+
[name: string]: unknown;
|
|
10635
|
+
};
|
|
10636
|
+
content: {
|
|
10637
|
+
"text/plain": string;
|
|
10638
|
+
};
|
|
10639
|
+
};
|
|
10640
|
+
/** @description Forbidden */
|
|
10641
|
+
403: {
|
|
10642
|
+
headers: {
|
|
10643
|
+
[name: string]: unknown;
|
|
10644
|
+
};
|
|
10645
|
+
content: {
|
|
10646
|
+
"text/plain": string;
|
|
10647
|
+
};
|
|
10648
|
+
};
|
|
10649
|
+
/** @description System API key not found. */
|
|
10650
|
+
404: {
|
|
10651
|
+
headers: {
|
|
10652
|
+
[name: string]: unknown;
|
|
10653
|
+
};
|
|
10654
|
+
content: {
|
|
10655
|
+
"text/plain": string;
|
|
10656
|
+
};
|
|
10657
|
+
};
|
|
10658
|
+
/** @description Unprocessable Entity */
|
|
10659
|
+
422: {
|
|
10660
|
+
headers: {
|
|
10661
|
+
[name: string]: unknown;
|
|
10662
|
+
};
|
|
10663
|
+
content: {
|
|
10664
|
+
"text/plain": string;
|
|
10665
|
+
};
|
|
10666
|
+
};
|
|
10667
|
+
};
|
|
10668
|
+
};
|
|
10029
10669
|
_login_auth_login_post: {
|
|
10030
10670
|
parameters: {
|
|
10031
10671
|
query?: never;
|