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