@epam/ai-dial-typescript-sdk 0.1.0-dev.15 → 0.1.0-dev.16
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 +1 -0
- package/dist/index.cjs +28 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1050 -515
- package/dist/index.d.ts +1050 -515
- package/dist/index.js +28 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
interface paths {
|
|
6
|
-
|
|
6
|
+
'/openai/deployments/{deployment_name}/chat/completions': {
|
|
7
7
|
parameters: {
|
|
8
8
|
query?: never;
|
|
9
9
|
header?: never;
|
|
@@ -16,14 +16,14 @@ interface paths {
|
|
|
16
16
|
* /openai/deployments/{deployment_name}/chat/completions
|
|
17
17
|
* @description This API is based on the OpenAI Azure API and extended to support working with advanced DIAL agents and applications.
|
|
18
18
|
*/
|
|
19
|
-
post: operations[
|
|
19
|
+
post: operations['sendChatCompletionRequest'];
|
|
20
20
|
delete?: never;
|
|
21
21
|
options?: never;
|
|
22
22
|
head?: never;
|
|
23
23
|
patch?: never;
|
|
24
24
|
trace?: never;
|
|
25
25
|
};
|
|
26
|
-
|
|
26
|
+
'/v1/deployments/{deployment_name}/configuration': {
|
|
27
27
|
parameters: {
|
|
28
28
|
query?: never;
|
|
29
29
|
header?: never;
|
|
@@ -38,7 +38,7 @@ interface paths {
|
|
|
38
38
|
* <br><br>
|
|
39
39
|
* A deployment supports configuration if its listing, retrieved by `GET /openai/deployments/{deployment_name}`, has a field `features.configuration` set to `true`.
|
|
40
40
|
*/
|
|
41
|
-
get: operations[
|
|
41
|
+
get: operations['configurationDeployment'];
|
|
42
42
|
put?: never;
|
|
43
43
|
post?: never;
|
|
44
44
|
delete?: never;
|
|
@@ -47,7 +47,7 @@ interface paths {
|
|
|
47
47
|
patch?: never;
|
|
48
48
|
trace?: never;
|
|
49
49
|
};
|
|
50
|
-
|
|
50
|
+
'/openai/deployments/{deployment_name}/embeddings': {
|
|
51
51
|
parameters: {
|
|
52
52
|
query?: never;
|
|
53
53
|
header?: never;
|
|
@@ -60,14 +60,14 @@ interface paths {
|
|
|
60
60
|
* /openai/deployments/{deployment_name}/embeddings
|
|
61
61
|
* @description Call this endpoint to get a vector representation of a given input.
|
|
62
62
|
*/
|
|
63
|
-
post: operations[
|
|
63
|
+
post: operations['sendEmbeddingsRequest'];
|
|
64
64
|
delete?: never;
|
|
65
65
|
options?: never;
|
|
66
66
|
head?: never;
|
|
67
67
|
patch?: never;
|
|
68
68
|
trace?: never;
|
|
69
69
|
};
|
|
70
|
-
|
|
70
|
+
'/v1/{deployment_name}/rate': {
|
|
71
71
|
parameters: {
|
|
72
72
|
query?: never;
|
|
73
73
|
header?: never;
|
|
@@ -80,14 +80,14 @@ interface paths {
|
|
|
80
80
|
* /v1/{deployment_name}/rate
|
|
81
81
|
* @description Call this endpoint to rate the response received from the chat completions endpoint.
|
|
82
82
|
*/
|
|
83
|
-
post: operations[
|
|
83
|
+
post: operations['rateDeployment'];
|
|
84
84
|
delete?: never;
|
|
85
85
|
options?: never;
|
|
86
86
|
head?: never;
|
|
87
87
|
patch?: never;
|
|
88
88
|
trace?: never;
|
|
89
89
|
};
|
|
90
|
-
|
|
90
|
+
'/v1/user/info': {
|
|
91
91
|
parameters: {
|
|
92
92
|
query?: never;
|
|
93
93
|
header?: never;
|
|
@@ -98,7 +98,7 @@ interface paths {
|
|
|
98
98
|
* /v1/user/info
|
|
99
99
|
* @description Call this endpoint to retrieve information about a user. To access the endpoint, a user must be authenticated with API key or access token.
|
|
100
100
|
*/
|
|
101
|
-
get: operations[
|
|
101
|
+
get: operations['getUserInfo'];
|
|
102
102
|
put?: never;
|
|
103
103
|
post?: never;
|
|
104
104
|
delete?: never;
|
|
@@ -107,7 +107,7 @@ interface paths {
|
|
|
107
107
|
patch?: never;
|
|
108
108
|
trace?: never;
|
|
109
109
|
};
|
|
110
|
-
|
|
110
|
+
'/v1/toolset/{toolset_name}/mcp': {
|
|
111
111
|
parameters: {
|
|
112
112
|
query?: never;
|
|
113
113
|
header?: never;
|
|
@@ -120,14 +120,34 @@ interface paths {
|
|
|
120
120
|
* /v1/toolset/{toolset_name}/mcp
|
|
121
121
|
* @description This endpoint implements MCP-based communication using [HTTP transport](https://modelcontextprotocol.io/specification/2025-06-18/basic/transports#streamable-http).
|
|
122
122
|
*/
|
|
123
|
-
post: operations[
|
|
123
|
+
post: operations['callToolSet'];
|
|
124
124
|
delete?: never;
|
|
125
125
|
options?: never;
|
|
126
126
|
head?: never;
|
|
127
127
|
patch?: never;
|
|
128
128
|
trace?: never;
|
|
129
129
|
};
|
|
130
|
-
|
|
130
|
+
'/v1/deployments/{deployment_id}/mcp': {
|
|
131
|
+
parameters: {
|
|
132
|
+
query?: never;
|
|
133
|
+
header?: never;
|
|
134
|
+
path?: never;
|
|
135
|
+
cookie?: never;
|
|
136
|
+
};
|
|
137
|
+
get?: never;
|
|
138
|
+
put?: never;
|
|
139
|
+
/**
|
|
140
|
+
* /v1/deployments/{deployment_id}/mcp
|
|
141
|
+
* @description This endpoint implements MCP-based communication with application deployment using [HTTP transport](https://modelcontextprotocol.io/specification/2025-06-18/basic/transports#streamable-http).
|
|
142
|
+
*/
|
|
143
|
+
post: operations['callMcp'];
|
|
144
|
+
delete?: never;
|
|
145
|
+
options?: never;
|
|
146
|
+
head?: never;
|
|
147
|
+
patch?: never;
|
|
148
|
+
trace?: never;
|
|
149
|
+
};
|
|
150
|
+
'/v1/ops/application/deploy': {
|
|
131
151
|
parameters: {
|
|
132
152
|
query?: never;
|
|
133
153
|
header?: never;
|
|
@@ -140,14 +160,14 @@ interface paths {
|
|
|
140
160
|
* /v1/ops/application/deploy
|
|
141
161
|
* @description Call this endpoint to deploy an application.
|
|
142
162
|
*/
|
|
143
|
-
post: operations[
|
|
163
|
+
post: operations['deployApplication'];
|
|
144
164
|
delete?: never;
|
|
145
165
|
options?: never;
|
|
146
166
|
head?: never;
|
|
147
167
|
patch?: never;
|
|
148
168
|
trace?: never;
|
|
149
169
|
};
|
|
150
|
-
|
|
170
|
+
'/v1/ops/application/undeploy': {
|
|
151
171
|
parameters: {
|
|
152
172
|
query?: never;
|
|
153
173
|
header?: never;
|
|
@@ -160,14 +180,14 @@ interface paths {
|
|
|
160
180
|
* /v1/ops/application/undeploy
|
|
161
181
|
* @description Call this endpoint to undeploy an application. After undeploying, the application will no longer be accessible until it is [deployed](#tag/Applications/operation/deployApplication) again. Use [redeploy](#tag/Applications/operation/redeployApplication) to apply changes without downtime.
|
|
162
182
|
*/
|
|
163
|
-
post: operations[
|
|
183
|
+
post: operations['undeployApplication'];
|
|
164
184
|
delete?: never;
|
|
165
185
|
options?: never;
|
|
166
186
|
head?: never;
|
|
167
187
|
patch?: never;
|
|
168
188
|
trace?: never;
|
|
169
189
|
};
|
|
170
|
-
|
|
190
|
+
'/v1/ops/application/redeploy': {
|
|
171
191
|
parameters: {
|
|
172
192
|
query?: never;
|
|
173
193
|
header?: never;
|
|
@@ -180,14 +200,14 @@ interface paths {
|
|
|
180
200
|
* /v1/ops/application/redeploy
|
|
181
201
|
* @description Call this endpoint to redeploy an application. This is useful when you want to apply changes made to the application without downtime, contrary to the [undeploy](#tag/Applications/operation/undeployApplication) and deploy process.
|
|
182
202
|
*/
|
|
183
|
-
post: operations[
|
|
203
|
+
post: operations['redeployApplication'];
|
|
184
204
|
delete?: never;
|
|
185
205
|
options?: never;
|
|
186
206
|
head?: never;
|
|
187
207
|
patch?: never;
|
|
188
208
|
trace?: never;
|
|
189
209
|
};
|
|
190
|
-
|
|
210
|
+
'/v1/ops/application/logs': {
|
|
191
211
|
parameters: {
|
|
192
212
|
query?: never;
|
|
193
213
|
header?: never;
|
|
@@ -200,14 +220,14 @@ interface paths {
|
|
|
200
220
|
* /v1/ops/application/logs
|
|
201
221
|
* @description Call this endpoint to get application logs
|
|
202
222
|
*/
|
|
203
|
-
post: operations[
|
|
223
|
+
post: operations['getApplicationLogs'];
|
|
204
224
|
delete?: never;
|
|
205
225
|
options?: never;
|
|
206
226
|
head?: never;
|
|
207
227
|
patch?: never;
|
|
208
228
|
trace?: never;
|
|
209
229
|
};
|
|
210
|
-
|
|
230
|
+
'/v1/application_type_schemas/schemas': {
|
|
211
231
|
parameters: {
|
|
212
232
|
query?: never;
|
|
213
233
|
header?: never;
|
|
@@ -218,7 +238,7 @@ interface paths {
|
|
|
218
238
|
* /v1/application_type_schemas/schemas
|
|
219
239
|
* @description Call this endpoint to get a list of available application types schemas. Refer to [/v1/application_type_schemas/schema](/dial_api#tag/Applications/operation/getCustomApplicationSchema) to see a real example of Quick app schema.
|
|
220
240
|
*/
|
|
221
|
-
get: operations[
|
|
241
|
+
get: operations['listCustomApplicationSchemas'];
|
|
222
242
|
put?: never;
|
|
223
243
|
post?: never;
|
|
224
244
|
delete?: never;
|
|
@@ -227,7 +247,7 @@ interface paths {
|
|
|
227
247
|
patch?: never;
|
|
228
248
|
trace?: never;
|
|
229
249
|
};
|
|
230
|
-
|
|
250
|
+
'/v1/application_type_schemas/meta_schema': {
|
|
231
251
|
parameters: {
|
|
232
252
|
query?: never;
|
|
233
253
|
header?: never;
|
|
@@ -238,7 +258,7 @@ interface paths {
|
|
|
238
258
|
* /v1/application_type_schemas/meta_schema
|
|
239
259
|
* @description Call this endpoint to get metaschema of custom application schema.
|
|
240
260
|
*/
|
|
241
|
-
get: operations[
|
|
261
|
+
get: operations['getMetaSchemaOfCustomApplicationSchema'];
|
|
242
262
|
put?: never;
|
|
243
263
|
post?: never;
|
|
244
264
|
delete?: never;
|
|
@@ -247,7 +267,7 @@ interface paths {
|
|
|
247
267
|
patch?: never;
|
|
248
268
|
trace?: never;
|
|
249
269
|
};
|
|
250
|
-
|
|
270
|
+
'/v1/application_type_schemas/schema': {
|
|
251
271
|
parameters: {
|
|
252
272
|
query?: never;
|
|
253
273
|
header?: never;
|
|
@@ -258,7 +278,7 @@ interface paths {
|
|
|
258
278
|
* /v1/application_type_schemas/schema
|
|
259
279
|
* @description Call this endpoint to get the application type schema by its id
|
|
260
280
|
*/
|
|
261
|
-
get: operations[
|
|
281
|
+
get: operations['getCustomApplicationSchema'];
|
|
262
282
|
put?: never;
|
|
263
283
|
post?: never;
|
|
264
284
|
delete?: never;
|
|
@@ -267,7 +287,7 @@ interface paths {
|
|
|
267
287
|
patch?: never;
|
|
268
288
|
trace?: never;
|
|
269
289
|
};
|
|
270
|
-
|
|
290
|
+
'/v1/applications/{Bucket}/{application_path}': {
|
|
271
291
|
parameters: {
|
|
272
292
|
query?: never;
|
|
273
293
|
header?: never;
|
|
@@ -278,24 +298,24 @@ interface paths {
|
|
|
278
298
|
* /v1/applications/{Bucket}/{application_path}
|
|
279
299
|
* @description Call this endpoint to get the application structure described in JSON format.
|
|
280
300
|
*/
|
|
281
|
-
get: operations[
|
|
301
|
+
get: operations['getCustomApplication'];
|
|
282
302
|
/**
|
|
283
303
|
* /v1/applications/{Bucket}/{application_path}
|
|
284
304
|
* @description Call this endpoint to add an application to the specified bucket and path. **Note**, that requests differ for apps with and without schemas. See the details in the REQUEST BODY SCHEMA section. Refer to [Documentation](https://docs.dialx.ai/platform/core/apps) to learn more about applications in DIAL.
|
|
285
305
|
*/
|
|
286
|
-
put: operations[
|
|
306
|
+
put: operations['saveCustomApplication'];
|
|
287
307
|
post?: never;
|
|
288
308
|
/**
|
|
289
309
|
* /v1/applications/{Bucket}/{application_path}
|
|
290
310
|
* @description Call this endpoint to delete the application.
|
|
291
311
|
*/
|
|
292
|
-
delete: operations[
|
|
312
|
+
delete: operations['deleteCustomApplication'];
|
|
293
313
|
options?: never;
|
|
294
314
|
head?: never;
|
|
295
315
|
patch?: never;
|
|
296
316
|
trace?: never;
|
|
297
317
|
};
|
|
298
|
-
|
|
318
|
+
'/v1/metadata/applications/{Bucket}/{Path}': {
|
|
299
319
|
parameters: {
|
|
300
320
|
query?: never;
|
|
301
321
|
header?: never;
|
|
@@ -308,7 +328,7 @@ interface paths {
|
|
|
308
328
|
* If the path is a folder, it must end with a "/".
|
|
309
329
|
* If it is called for a folder, there can be optional `nextToken` field in the response to be used to request next items if present.
|
|
310
330
|
*/
|
|
311
|
-
get: operations[
|
|
331
|
+
get: operations['getApplicationMetadata'];
|
|
312
332
|
put?: never;
|
|
313
333
|
post?: never;
|
|
314
334
|
delete?: never;
|
|
@@ -317,7 +337,7 @@ interface paths {
|
|
|
317
337
|
patch?: never;
|
|
318
338
|
trace?: never;
|
|
319
339
|
};
|
|
320
|
-
|
|
340
|
+
'/v1/bucket': {
|
|
321
341
|
parameters: {
|
|
322
342
|
query?: never;
|
|
323
343
|
header?: never;
|
|
@@ -328,7 +348,7 @@ interface paths {
|
|
|
328
348
|
* /v1/bucket
|
|
329
349
|
* @description Call this endpoint to get a bucket.
|
|
330
350
|
*/
|
|
331
|
-
get: operations[
|
|
351
|
+
get: operations['getUserBucket'];
|
|
332
352
|
put?: never;
|
|
333
353
|
post?: never;
|
|
334
354
|
delete?: never;
|
|
@@ -337,7 +357,7 @@ interface paths {
|
|
|
337
357
|
patch?: never;
|
|
338
358
|
trace?: never;
|
|
339
359
|
};
|
|
340
|
-
|
|
360
|
+
'/v1/files/{Bucket}/{file_path}': {
|
|
341
361
|
parameters: {
|
|
342
362
|
query?: never;
|
|
343
363
|
header?: never;
|
|
@@ -348,24 +368,24 @@ interface paths {
|
|
|
348
368
|
* /v1/files/{Bucket}/{file_path}
|
|
349
369
|
* @description Call this endpoint to get a file content.
|
|
350
370
|
*/
|
|
351
|
-
get: operations[
|
|
371
|
+
get: operations['downloadFile'];
|
|
352
372
|
/**
|
|
353
373
|
* /v1/files/{Bucket}/{file_path}
|
|
354
374
|
* @description Call this endpoint to upload a file to the specified bucket and path.
|
|
355
375
|
*/
|
|
356
|
-
put: operations[
|
|
376
|
+
put: operations['uploadFile'];
|
|
357
377
|
post?: never;
|
|
358
378
|
/**
|
|
359
379
|
* /v1/files/{Bucket}/{file_path}
|
|
360
380
|
* @description Call this endpoint to delete the file.
|
|
361
381
|
*/
|
|
362
|
-
delete: operations[
|
|
382
|
+
delete: operations['deleteFile'];
|
|
363
383
|
options?: never;
|
|
364
384
|
head?: never;
|
|
365
385
|
patch?: never;
|
|
366
386
|
trace?: never;
|
|
367
387
|
};
|
|
368
|
-
|
|
388
|
+
'/v1/metadata/files/{Bucket}/{Path}': {
|
|
369
389
|
parameters: {
|
|
370
390
|
query?: never;
|
|
371
391
|
header?: never;
|
|
@@ -378,7 +398,7 @@ interface paths {
|
|
|
378
398
|
* If the path is a folder, it must end with a "/".
|
|
379
399
|
* If it is called for a folder, there can be optional `nextToken` field in the response to be used to request next items if present.
|
|
380
400
|
*/
|
|
381
|
-
get: operations[
|
|
401
|
+
get: operations['getFileMetadata'];
|
|
382
402
|
put?: never;
|
|
383
403
|
post?: never;
|
|
384
404
|
delete?: never;
|
|
@@ -387,7 +407,7 @@ interface paths {
|
|
|
387
407
|
patch?: never;
|
|
388
408
|
trace?: never;
|
|
389
409
|
};
|
|
390
|
-
|
|
410
|
+
'/v1/ops/resource/move': {
|
|
391
411
|
parameters: {
|
|
392
412
|
query?: never;
|
|
393
413
|
header?: never;
|
|
@@ -400,14 +420,14 @@ interface paths {
|
|
|
400
420
|
* /v1/ops/resource/move
|
|
401
421
|
* @description Moves the source resource to the destination.
|
|
402
422
|
*/
|
|
403
|
-
post: operations[
|
|
423
|
+
post: operations['moveResource'];
|
|
404
424
|
delete?: never;
|
|
405
425
|
options?: never;
|
|
406
426
|
head?: never;
|
|
407
427
|
patch?: never;
|
|
408
428
|
trace?: never;
|
|
409
429
|
};
|
|
410
|
-
|
|
430
|
+
'/v1/ops/resource/copy': {
|
|
411
431
|
parameters: {
|
|
412
432
|
query?: never;
|
|
413
433
|
header?: never;
|
|
@@ -420,14 +440,14 @@ interface paths {
|
|
|
420
440
|
* /v1/ops/resource/copy
|
|
421
441
|
* @description Copies the source resource to the destination.
|
|
422
442
|
*/
|
|
423
|
-
post: operations[
|
|
443
|
+
post: operations['copyResource'];
|
|
424
444
|
delete?: never;
|
|
425
445
|
options?: never;
|
|
426
446
|
head?: never;
|
|
427
447
|
patch?: never;
|
|
428
448
|
trace?: never;
|
|
429
449
|
};
|
|
430
|
-
|
|
450
|
+
'/v1/conversations/{Bucket}/{conversation_path}': {
|
|
431
451
|
parameters: {
|
|
432
452
|
query?: never;
|
|
433
453
|
header?: never;
|
|
@@ -438,24 +458,24 @@ interface paths {
|
|
|
438
458
|
* /v1/conversations/{Bucket}/{conversation_path}
|
|
439
459
|
* @description Call this endpoint to get the conversation.
|
|
440
460
|
*/
|
|
441
|
-
get: operations[
|
|
461
|
+
get: operations['getConversation'];
|
|
442
462
|
/**
|
|
443
463
|
* /v1/conversations/{Bucket}/{conversation_path}
|
|
444
464
|
* @description Call this endpoint to add a conversation to the specified bucket and path.
|
|
445
465
|
*/
|
|
446
|
-
put: operations[
|
|
466
|
+
put: operations['saveConversation'];
|
|
447
467
|
post?: never;
|
|
448
468
|
/**
|
|
449
469
|
* /v1/conversations/{Bucket}/{conversation_path}
|
|
450
470
|
* @description Call this endpoint to delete the conversation.
|
|
451
471
|
*/
|
|
452
|
-
delete: operations[
|
|
472
|
+
delete: operations['deleteConversation'];
|
|
453
473
|
options?: never;
|
|
454
474
|
head?: never;
|
|
455
475
|
patch?: never;
|
|
456
476
|
trace?: never;
|
|
457
477
|
};
|
|
458
|
-
|
|
478
|
+
'/v1/metadata/conversations/{Bucket}/{Path}': {
|
|
459
479
|
parameters: {
|
|
460
480
|
query?: never;
|
|
461
481
|
header?: never;
|
|
@@ -468,7 +488,7 @@ interface paths {
|
|
|
468
488
|
* If the path is a folder, it must end with a "/".
|
|
469
489
|
* If it is called for a folder, there can be optional `nextToken` field in the response to be used to request next items if present.
|
|
470
490
|
*/
|
|
471
|
-
get: operations[
|
|
491
|
+
get: operations['getConversationMetadata'];
|
|
472
492
|
put?: never;
|
|
473
493
|
post?: never;
|
|
474
494
|
delete?: never;
|
|
@@ -477,7 +497,7 @@ interface paths {
|
|
|
477
497
|
patch?: never;
|
|
478
498
|
trace?: never;
|
|
479
499
|
};
|
|
480
|
-
|
|
500
|
+
'/v1/prompts/{Bucket}/{prompt_path}': {
|
|
481
501
|
parameters: {
|
|
482
502
|
query?: never;
|
|
483
503
|
header?: never;
|
|
@@ -488,24 +508,24 @@ interface paths {
|
|
|
488
508
|
* /v1/prompts/{Bucket}/{prompt_path}
|
|
489
509
|
* @description Call this endpoint to get the prompt.
|
|
490
510
|
*/
|
|
491
|
-
get: operations[
|
|
511
|
+
get: operations['getPrompt'];
|
|
492
512
|
/**
|
|
493
513
|
* /v1/prompts/{Bucket}/{prompt_path}
|
|
494
514
|
* @description Call this endpoint to add a prompt to the specified bucket and path.
|
|
495
515
|
*/
|
|
496
|
-
put: operations[
|
|
516
|
+
put: operations['savePrompt'];
|
|
497
517
|
post?: never;
|
|
498
518
|
/**
|
|
499
519
|
* /v1/prompts/{Bucket}/{prompt_path}
|
|
500
520
|
* @description Call this endpoint to delete the prompt.
|
|
501
521
|
*/
|
|
502
|
-
delete: operations[
|
|
522
|
+
delete: operations['deletePrompt'];
|
|
503
523
|
options?: never;
|
|
504
524
|
head?: never;
|
|
505
525
|
patch?: never;
|
|
506
526
|
trace?: never;
|
|
507
527
|
};
|
|
508
|
-
|
|
528
|
+
'/v1/metadata/prompts/{Bucket}/{Path}': {
|
|
509
529
|
parameters: {
|
|
510
530
|
query?: never;
|
|
511
531
|
header?: never;
|
|
@@ -518,7 +538,7 @@ interface paths {
|
|
|
518
538
|
* If the path is a folder, it must end with a "/".
|
|
519
539
|
* If it is called for a folder, there can be optional `nextToken` field in the response to be used to request next items if present.
|
|
520
540
|
*/
|
|
521
|
-
get: operations[
|
|
541
|
+
get: operations['getPromptMetadata'];
|
|
522
542
|
put?: never;
|
|
523
543
|
post?: never;
|
|
524
544
|
delete?: never;
|
|
@@ -527,7 +547,7 @@ interface paths {
|
|
|
527
547
|
patch?: never;
|
|
528
548
|
trace?: never;
|
|
529
549
|
};
|
|
530
|
-
|
|
550
|
+
'/v1/toolsets/{Bucket}/{toolset_path}': {
|
|
531
551
|
parameters: {
|
|
532
552
|
query?: never;
|
|
533
553
|
header?: never;
|
|
@@ -538,24 +558,64 @@ interface paths {
|
|
|
538
558
|
* /v1/toolsets/{Bucket}/{toolset_path}
|
|
539
559
|
* @description Call this endpoint to retrieve a specific toolset.
|
|
540
560
|
*/
|
|
541
|
-
get: operations[
|
|
561
|
+
get: operations['getCustomToolSet'];
|
|
542
562
|
/**
|
|
543
563
|
* /v1/toolsets/{Bucket}/{toolset_path}
|
|
544
564
|
* @description Call this endpoint to add a toolset to the specified bucket and path or update the existing toolset.
|
|
545
565
|
*/
|
|
546
|
-
put: operations[
|
|
566
|
+
put: operations['saveToolSet'];
|
|
547
567
|
post?: never;
|
|
548
568
|
/**
|
|
549
569
|
* /v1/toolsets/{Bucket}/{toolset_path}
|
|
550
570
|
* @description Call this endpoint to delete a toolset from the specified path.
|
|
551
571
|
*/
|
|
552
|
-
delete: operations[
|
|
572
|
+
delete: operations['deleteToolSet'];
|
|
553
573
|
options?: never;
|
|
554
574
|
head?: never;
|
|
555
575
|
patch?: never;
|
|
556
576
|
trace?: never;
|
|
557
577
|
};
|
|
558
|
-
|
|
578
|
+
'/v1/toolset/{toolset_id}/tools': {
|
|
579
|
+
parameters: {
|
|
580
|
+
query?: never;
|
|
581
|
+
header?: never;
|
|
582
|
+
path?: never;
|
|
583
|
+
cookie?: never;
|
|
584
|
+
};
|
|
585
|
+
/**
|
|
586
|
+
* /v1/toolset/{toolset_id}/tools
|
|
587
|
+
* @description Call this endpoint to retrieve all tools supported by a specific MCP server. Available to admins and toolset owners. Used during toolset configuration to select allowed tools.
|
|
588
|
+
*/
|
|
589
|
+
get: operations['getAllToolSetTools'];
|
|
590
|
+
put?: never;
|
|
591
|
+
post?: never;
|
|
592
|
+
delete?: never;
|
|
593
|
+
options?: never;
|
|
594
|
+
head?: never;
|
|
595
|
+
patch?: never;
|
|
596
|
+
trace?: never;
|
|
597
|
+
};
|
|
598
|
+
'/v1/toolset/{toolset_id}/allowed-tools': {
|
|
599
|
+
parameters: {
|
|
600
|
+
query?: never;
|
|
601
|
+
header?: never;
|
|
602
|
+
path?: never;
|
|
603
|
+
cookie?: never;
|
|
604
|
+
};
|
|
605
|
+
/**
|
|
606
|
+
* /v1/toolset/{toolset_id}/allowed-tools
|
|
607
|
+
* @description Call this endpoint to retrieve a filtered list of all allowed tools for a specific MCP server.
|
|
608
|
+
*/
|
|
609
|
+
get: operations['getAllToolSetAllowedTools'];
|
|
610
|
+
put?: never;
|
|
611
|
+
post?: never;
|
|
612
|
+
delete?: never;
|
|
613
|
+
options?: never;
|
|
614
|
+
head?: never;
|
|
615
|
+
patch?: never;
|
|
616
|
+
trace?: never;
|
|
617
|
+
};
|
|
618
|
+
'/v1/ops/toolset/signin': {
|
|
559
619
|
parameters: {
|
|
560
620
|
query?: never;
|
|
561
621
|
header?: never;
|
|
@@ -568,14 +628,14 @@ interface paths {
|
|
|
568
628
|
* /v1/ops/toolset/signin
|
|
569
629
|
* @description Authenticates a user with a specified Toolset using OAUTH or API_KEY.
|
|
570
630
|
*/
|
|
571
|
-
post: operations[
|
|
631
|
+
post: operations['toolsetSignin'];
|
|
572
632
|
delete?: never;
|
|
573
633
|
options?: never;
|
|
574
634
|
head?: never;
|
|
575
635
|
patch?: never;
|
|
576
636
|
trace?: never;
|
|
577
637
|
};
|
|
578
|
-
|
|
638
|
+
'/v1/ops/toolset/signout': {
|
|
579
639
|
parameters: {
|
|
580
640
|
query?: never;
|
|
581
641
|
header?: never;
|
|
@@ -588,14 +648,14 @@ interface paths {
|
|
|
588
648
|
* /v1/ops/toolset/signout
|
|
589
649
|
* @description Logs the user out from the Toolset by removing the associated credentials.
|
|
590
650
|
*/
|
|
591
|
-
post: operations[
|
|
651
|
+
post: operations['toolSetSignout'];
|
|
592
652
|
delete?: never;
|
|
593
653
|
options?: never;
|
|
594
654
|
head?: never;
|
|
595
655
|
patch?: never;
|
|
596
656
|
trace?: never;
|
|
597
657
|
};
|
|
598
|
-
|
|
658
|
+
'/v1/metadata/toolsets/{Bucket}/{Path}': {
|
|
599
659
|
parameters: {
|
|
600
660
|
query?: never;
|
|
601
661
|
header?: never;
|
|
@@ -608,7 +668,7 @@ interface paths {
|
|
|
608
668
|
* If the path is a folder, it must end with a "/".
|
|
609
669
|
* If it is called for a folder, there can be optional `nextToken` field in the response to be used to request next items if present.
|
|
610
670
|
*/
|
|
611
|
-
get: operations[
|
|
671
|
+
get: operations['getToolSetMetadata'];
|
|
612
672
|
put?: never;
|
|
613
673
|
post?: never;
|
|
614
674
|
delete?: never;
|
|
@@ -617,7 +677,7 @@ interface paths {
|
|
|
617
677
|
patch?: never;
|
|
618
678
|
trace?: never;
|
|
619
679
|
};
|
|
620
|
-
|
|
680
|
+
'/v1/ops/publication/list': {
|
|
621
681
|
parameters: {
|
|
622
682
|
query?: never;
|
|
623
683
|
header?: never;
|
|
@@ -630,14 +690,14 @@ interface paths {
|
|
|
630
690
|
* /v1/ops/publication/list
|
|
631
691
|
* @description Call this endpoint to get a list of publication requests. For admins, it is a list of all publication requests that are `PENDING` for review (approve or reject). For users, it is a list of all publication requests created by a particular user. Refer to documentation to learn more about working with publications for [users](https://docs.dialx.ai/platform/collaboration-intro#publication) and [admins](https://docs.dialx.ai/platform/admin-panel/approvals-prompt-publications).
|
|
632
692
|
*/
|
|
633
|
-
post: operations[
|
|
693
|
+
post: operations['getPublications'];
|
|
634
694
|
delete?: never;
|
|
635
695
|
options?: never;
|
|
636
696
|
head?: never;
|
|
637
697
|
patch?: never;
|
|
638
698
|
trace?: never;
|
|
639
699
|
};
|
|
640
|
-
|
|
700
|
+
'/v1/ops/publication/get': {
|
|
641
701
|
parameters: {
|
|
642
702
|
query?: never;
|
|
643
703
|
header?: never;
|
|
@@ -650,14 +710,14 @@ interface paths {
|
|
|
650
710
|
* /v1/ops/publication/get
|
|
651
711
|
* @description Call this endpoint to get a specific publication request.
|
|
652
712
|
*/
|
|
653
|
-
post: operations[
|
|
713
|
+
post: operations['getPublication'];
|
|
654
714
|
delete?: never;
|
|
655
715
|
options?: never;
|
|
656
716
|
head?: never;
|
|
657
717
|
patch?: never;
|
|
658
718
|
trace?: never;
|
|
659
719
|
};
|
|
660
|
-
|
|
720
|
+
'/v1/ops/publication/create': {
|
|
661
721
|
parameters: {
|
|
662
722
|
query?: never;
|
|
663
723
|
header?: never;
|
|
@@ -670,14 +730,14 @@ interface paths {
|
|
|
670
730
|
* /v1/ops/publication/create
|
|
671
731
|
* @description Call this endpoint to create a publish or unpublish request.
|
|
672
732
|
*/
|
|
673
|
-
post: operations[
|
|
733
|
+
post: operations['createPublication'];
|
|
674
734
|
delete?: never;
|
|
675
735
|
options?: never;
|
|
676
736
|
head?: never;
|
|
677
737
|
patch?: never;
|
|
678
738
|
trace?: never;
|
|
679
739
|
};
|
|
680
|
-
|
|
740
|
+
'/v1/ops/publication/update': {
|
|
681
741
|
parameters: {
|
|
682
742
|
query?: never;
|
|
683
743
|
header?: never;
|
|
@@ -690,14 +750,14 @@ interface paths {
|
|
|
690
750
|
* /v1/ops/publication/update
|
|
691
751
|
* @description Call this endpoint to update a publish request. Available for admins.
|
|
692
752
|
*/
|
|
693
|
-
post: operations[
|
|
753
|
+
post: operations['updatePublication'];
|
|
694
754
|
delete?: never;
|
|
695
755
|
options?: never;
|
|
696
756
|
head?: never;
|
|
697
757
|
patch?: never;
|
|
698
758
|
trace?: never;
|
|
699
759
|
};
|
|
700
|
-
|
|
760
|
+
'/v1/ops/publication/delete': {
|
|
701
761
|
parameters: {
|
|
702
762
|
query?: never;
|
|
703
763
|
header?: never;
|
|
@@ -710,14 +770,14 @@ interface paths {
|
|
|
710
770
|
* /v1/ops/publication/delete
|
|
711
771
|
* @description Call this endpoint to delete the publication request. Only requests that are in the `PENDING` status can be deleted.
|
|
712
772
|
*/
|
|
713
|
-
post: operations[
|
|
773
|
+
post: operations['deletePublication'];
|
|
714
774
|
delete?: never;
|
|
715
775
|
options?: never;
|
|
716
776
|
head?: never;
|
|
717
777
|
patch?: never;
|
|
718
778
|
trace?: never;
|
|
719
779
|
};
|
|
720
|
-
|
|
780
|
+
'/v1/ops/publication/reject': {
|
|
721
781
|
parameters: {
|
|
722
782
|
query?: never;
|
|
723
783
|
header?: never;
|
|
@@ -730,14 +790,14 @@ interface paths {
|
|
|
730
790
|
* /v1/ops/publication/reject
|
|
731
791
|
* @description Admins only! <br> Call this endpoint to reject the publication request.
|
|
732
792
|
*/
|
|
733
|
-
post: operations[
|
|
793
|
+
post: operations['rejectPublication'];
|
|
734
794
|
delete?: never;
|
|
735
795
|
options?: never;
|
|
736
796
|
head?: never;
|
|
737
797
|
patch?: never;
|
|
738
798
|
trace?: never;
|
|
739
799
|
};
|
|
740
|
-
|
|
800
|
+
'/v1/ops/publication/approve': {
|
|
741
801
|
parameters: {
|
|
742
802
|
query?: never;
|
|
743
803
|
header?: never;
|
|
@@ -750,14 +810,14 @@ interface paths {
|
|
|
750
810
|
* /v1/ops/publication/approve
|
|
751
811
|
* @description Admins only! <br> Call this endpoint to approve the publication request.
|
|
752
812
|
*/
|
|
753
|
-
post: operations[
|
|
813
|
+
post: operations['approvePublication'];
|
|
754
814
|
delete?: never;
|
|
755
815
|
options?: never;
|
|
756
816
|
head?: never;
|
|
757
817
|
patch?: never;
|
|
758
818
|
trace?: never;
|
|
759
819
|
};
|
|
760
|
-
|
|
820
|
+
'/v1/ops/publication/rule/list': {
|
|
761
821
|
parameters: {
|
|
762
822
|
query?: never;
|
|
763
823
|
header?: never;
|
|
@@ -770,14 +830,14 @@ interface paths {
|
|
|
770
830
|
* /v1/ops/publication/rule/list
|
|
771
831
|
* @description Call this endpoint to get a list of rules for publications.
|
|
772
832
|
*/
|
|
773
|
-
post: operations[
|
|
833
|
+
post: operations['getPublicationRules'];
|
|
774
834
|
delete?: never;
|
|
775
835
|
options?: never;
|
|
776
836
|
head?: never;
|
|
777
837
|
patch?: never;
|
|
778
838
|
trace?: never;
|
|
779
839
|
};
|
|
780
|
-
|
|
840
|
+
'/v1/ops/resource/per-request-permissions/grant': {
|
|
781
841
|
parameters: {
|
|
782
842
|
query?: never;
|
|
783
843
|
header?: never;
|
|
@@ -794,14 +854,14 @@ interface paths {
|
|
|
794
854
|
*
|
|
795
855
|
* Refer to [Documentation](https://docs.dialx.ai/tutorials/developers/work-with-resources/sharing) for more details on how to share resources between deployments.
|
|
796
856
|
*/
|
|
797
|
-
post: operations[
|
|
857
|
+
post: operations['grantPerRequestPermissions'];
|
|
798
858
|
delete?: never;
|
|
799
859
|
options?: never;
|
|
800
860
|
head?: never;
|
|
801
861
|
patch?: never;
|
|
802
862
|
trace?: never;
|
|
803
863
|
};
|
|
804
|
-
|
|
864
|
+
'/v1/ops/resource/per-request-permissions/revoke': {
|
|
805
865
|
parameters: {
|
|
806
866
|
query?: never;
|
|
807
867
|
header?: never;
|
|
@@ -818,14 +878,14 @@ interface paths {
|
|
|
818
878
|
*
|
|
819
879
|
* Refer to [Documentation](https://docs.dialx.ai/tutorials/developers/work-with-resources/sharing) for more details on how to share resources between deployments.
|
|
820
880
|
*/
|
|
821
|
-
post: operations[
|
|
881
|
+
post: operations['revokePerRequestPermissions'];
|
|
822
882
|
delete?: never;
|
|
823
883
|
options?: never;
|
|
824
884
|
head?: never;
|
|
825
885
|
patch?: never;
|
|
826
886
|
trace?: never;
|
|
827
887
|
};
|
|
828
|
-
|
|
888
|
+
'/v1/ops/resource/per-request-permissions/list': {
|
|
829
889
|
parameters: {
|
|
830
890
|
query?: never;
|
|
831
891
|
header?: never;
|
|
@@ -842,14 +902,14 @@ interface paths {
|
|
|
842
902
|
*
|
|
843
903
|
* Refer to [Documentation](https://docs.dialx.ai/tutorials/developers/work-with-resources/sharing) for more details on how to share resources between deployments.
|
|
844
904
|
*/
|
|
845
|
-
post: operations[
|
|
905
|
+
post: operations['getPerRequestPermissions'];
|
|
846
906
|
delete?: never;
|
|
847
907
|
options?: never;
|
|
848
908
|
head?: never;
|
|
849
909
|
patch?: never;
|
|
850
910
|
trace?: never;
|
|
851
911
|
};
|
|
852
|
-
|
|
912
|
+
'/v1/ops/resource/share/create': {
|
|
853
913
|
parameters: {
|
|
854
914
|
query?: never;
|
|
855
915
|
header?: never;
|
|
@@ -862,14 +922,14 @@ interface paths {
|
|
|
862
922
|
* /v1/ops/resource/share/create
|
|
863
923
|
* @description Call this endpoint to share and re-share resources. Refer to [Documentation](https://docs.dialx.ai/tutorials/developers/work-with-resources/sharing) for more details on how to share resources.
|
|
864
924
|
*/
|
|
865
|
-
post: operations[
|
|
925
|
+
post: operations['shareResource'];
|
|
866
926
|
delete?: never;
|
|
867
927
|
options?: never;
|
|
868
928
|
head?: never;
|
|
869
929
|
patch?: never;
|
|
870
930
|
trace?: never;
|
|
871
931
|
};
|
|
872
|
-
|
|
932
|
+
'/v1/ops/resource/share/list': {
|
|
873
933
|
parameters: {
|
|
874
934
|
query?: never;
|
|
875
935
|
header?: never;
|
|
@@ -882,14 +942,14 @@ interface paths {
|
|
|
882
942
|
* /v1/ops/resource/share/list
|
|
883
943
|
* @description Call this endpoint to get the list of shared resources. Returns only resources that were accepted.
|
|
884
944
|
*/
|
|
885
|
-
post: operations[
|
|
945
|
+
post: operations['getSharedResources'];
|
|
886
946
|
delete?: never;
|
|
887
947
|
options?: never;
|
|
888
948
|
head?: never;
|
|
889
949
|
patch?: never;
|
|
890
950
|
trace?: never;
|
|
891
951
|
};
|
|
892
|
-
|
|
952
|
+
'/v1/ops/resource/share/revoke': {
|
|
893
953
|
parameters: {
|
|
894
954
|
query?: never;
|
|
895
955
|
header?: never;
|
|
@@ -902,14 +962,14 @@ interface paths {
|
|
|
902
962
|
* /v1/ops/resource/share/revoke
|
|
903
963
|
* @description Call this endpoint to revoke shared access from all users.
|
|
904
964
|
*/
|
|
905
|
-
post: operations[
|
|
965
|
+
post: operations['revokeSharedResources'];
|
|
906
966
|
delete?: never;
|
|
907
967
|
options?: never;
|
|
908
968
|
head?: never;
|
|
909
969
|
patch?: never;
|
|
910
970
|
trace?: never;
|
|
911
971
|
};
|
|
912
|
-
|
|
972
|
+
'/v1/ops/resource/share/discard': {
|
|
913
973
|
parameters: {
|
|
914
974
|
query?: never;
|
|
915
975
|
header?: never;
|
|
@@ -922,14 +982,14 @@ interface paths {
|
|
|
922
982
|
* /v1/ops/resource/share/discard
|
|
923
983
|
* @description Call this endpoint to discard the resource shared with you.
|
|
924
984
|
*/
|
|
925
|
-
post: operations[
|
|
985
|
+
post: operations['discardSharedResources'];
|
|
926
986
|
delete?: never;
|
|
927
987
|
options?: never;
|
|
928
988
|
head?: never;
|
|
929
989
|
patch?: never;
|
|
930
990
|
trace?: never;
|
|
931
991
|
};
|
|
932
|
-
|
|
992
|
+
'/v1/ops/resource/share/copy': {
|
|
933
993
|
parameters: {
|
|
934
994
|
query?: never;
|
|
935
995
|
header?: never;
|
|
@@ -942,14 +1002,14 @@ interface paths {
|
|
|
942
1002
|
* /v1/ops/resource/share/copy
|
|
943
1003
|
* @description Call this endpoint to share the *destination* resource with users who have access to the *source* resource. Note, user's permissions will be copied from a source to a destination.
|
|
944
1004
|
*/
|
|
945
|
-
post: operations[
|
|
1005
|
+
post: operations['copySharedResources'];
|
|
946
1006
|
delete?: never;
|
|
947
1007
|
options?: never;
|
|
948
1008
|
head?: never;
|
|
949
1009
|
patch?: never;
|
|
950
1010
|
trace?: never;
|
|
951
1011
|
};
|
|
952
|
-
|
|
1012
|
+
'/v1/invitations': {
|
|
953
1013
|
parameters: {
|
|
954
1014
|
query?: never;
|
|
955
1015
|
header?: never;
|
|
@@ -960,7 +1020,7 @@ interface paths {
|
|
|
960
1020
|
* /v1/invitations
|
|
961
1021
|
* @description Call this endpoint to get the list of your active invitations.
|
|
962
1022
|
*/
|
|
963
|
-
get: operations[
|
|
1023
|
+
get: operations['getInvitations'];
|
|
964
1024
|
put?: never;
|
|
965
1025
|
post?: never;
|
|
966
1026
|
delete?: never;
|
|
@@ -969,7 +1029,7 @@ interface paths {
|
|
|
969
1029
|
patch?: never;
|
|
970
1030
|
trace?: never;
|
|
971
1031
|
};
|
|
972
|
-
|
|
1032
|
+
'/v1/invitations/{invitation_id}': {
|
|
973
1033
|
parameters: {
|
|
974
1034
|
query?: never;
|
|
975
1035
|
header?: never;
|
|
@@ -980,20 +1040,20 @@ interface paths {
|
|
|
980
1040
|
* /v1/invitations/{invitation_id}
|
|
981
1041
|
* @description Call this endpoint to get the invitation details or accept the invitation.
|
|
982
1042
|
*/
|
|
983
|
-
get: operations[
|
|
1043
|
+
get: operations['getInvitation'];
|
|
984
1044
|
put?: never;
|
|
985
1045
|
post?: never;
|
|
986
1046
|
/**
|
|
987
1047
|
* /v1/invitations/{invitation_id}
|
|
988
1048
|
* @description Call this endpoint to revoke the invitation.
|
|
989
1049
|
*/
|
|
990
|
-
delete: operations[
|
|
1050
|
+
delete: operations['deleteInvitation'];
|
|
991
1051
|
options?: never;
|
|
992
1052
|
head?: never;
|
|
993
1053
|
patch?: never;
|
|
994
1054
|
trace?: never;
|
|
995
1055
|
};
|
|
996
|
-
|
|
1056
|
+
'/v1/ops/notification/list': {
|
|
997
1057
|
parameters: {
|
|
998
1058
|
query?: never;
|
|
999
1059
|
header?: never;
|
|
@@ -1006,14 +1066,14 @@ interface paths {
|
|
|
1006
1066
|
* /v1/ops/notification/list
|
|
1007
1067
|
* @description Call this endpoint to get a list of notifications. Refer to [Documentation](https://docs.dialx.ai/tutorials/developers/work-with-resources/notifications#notification-api) for more details on how to work with notifications.
|
|
1008
1068
|
*/
|
|
1009
|
-
post: operations[
|
|
1069
|
+
post: operations['getNotifications'];
|
|
1010
1070
|
delete?: never;
|
|
1011
1071
|
options?: never;
|
|
1012
1072
|
head?: never;
|
|
1013
1073
|
patch?: never;
|
|
1014
1074
|
trace?: never;
|
|
1015
1075
|
};
|
|
1016
|
-
|
|
1076
|
+
'/v1/ops/notification/delete': {
|
|
1017
1077
|
parameters: {
|
|
1018
1078
|
query?: never;
|
|
1019
1079
|
header?: never;
|
|
@@ -1026,14 +1086,14 @@ interface paths {
|
|
|
1026
1086
|
* /v1/ops/notification/delete
|
|
1027
1087
|
* @description Call this endpoint to delete one or more than one notification.
|
|
1028
1088
|
*/
|
|
1029
|
-
post: operations[
|
|
1089
|
+
post: operations['deleteNotifications'];
|
|
1030
1090
|
delete?: never;
|
|
1031
1091
|
options?: never;
|
|
1032
1092
|
head?: never;
|
|
1033
1093
|
patch?: never;
|
|
1034
1094
|
trace?: never;
|
|
1035
1095
|
};
|
|
1036
|
-
|
|
1096
|
+
'/v1/ops/resource/subscribe': {
|
|
1037
1097
|
parameters: {
|
|
1038
1098
|
query?: never;
|
|
1039
1099
|
header?: never;
|
|
@@ -1046,14 +1106,14 @@ interface paths {
|
|
|
1046
1106
|
* /v1/ops/resource/subscribe
|
|
1047
1107
|
* @description Use this endpoint to subscribe to resource updates. Refer to [Documentation](https://docs.dialx.ai/tutorials/developers/work-with-resources/notifications#subscribe-api) for more details on how to work with subscriptions.
|
|
1048
1108
|
*/
|
|
1049
|
-
post: operations[
|
|
1109
|
+
post: operations['subscribeToResources'];
|
|
1050
1110
|
delete?: never;
|
|
1051
1111
|
options?: never;
|
|
1052
1112
|
head?: never;
|
|
1053
1113
|
patch?: never;
|
|
1054
1114
|
trace?: never;
|
|
1055
1115
|
};
|
|
1056
|
-
|
|
1116
|
+
'/v1/ops/code_interpreter/open_session': {
|
|
1057
1117
|
parameters: {
|
|
1058
1118
|
query?: never;
|
|
1059
1119
|
header?: never;
|
|
@@ -1066,14 +1126,14 @@ interface paths {
|
|
|
1066
1126
|
* /v1/ops/code_interpreter/open_session
|
|
1067
1127
|
* @description Call this endpoint to open session for code interpreter application
|
|
1068
1128
|
*/
|
|
1069
|
-
post: operations[
|
|
1129
|
+
post: operations['openSession'];
|
|
1070
1130
|
delete?: never;
|
|
1071
1131
|
options?: never;
|
|
1072
1132
|
head?: never;
|
|
1073
1133
|
patch?: never;
|
|
1074
1134
|
trace?: never;
|
|
1075
1135
|
};
|
|
1076
|
-
|
|
1136
|
+
'/v1/ops/code_interpreter/close_session': {
|
|
1077
1137
|
parameters: {
|
|
1078
1138
|
query?: never;
|
|
1079
1139
|
header?: never;
|
|
@@ -1086,14 +1146,14 @@ interface paths {
|
|
|
1086
1146
|
* /v1/ops/code_interpreter/close_session
|
|
1087
1147
|
* @description Call this endpoint to close session for code interpreter application
|
|
1088
1148
|
*/
|
|
1089
|
-
post: operations[
|
|
1149
|
+
post: operations['closeSession'];
|
|
1090
1150
|
delete?: never;
|
|
1091
1151
|
options?: never;
|
|
1092
1152
|
head?: never;
|
|
1093
1153
|
patch?: never;
|
|
1094
1154
|
trace?: never;
|
|
1095
1155
|
};
|
|
1096
|
-
|
|
1156
|
+
'/v1/ops/code_interpreter/execute_code': {
|
|
1097
1157
|
parameters: {
|
|
1098
1158
|
query?: never;
|
|
1099
1159
|
header?: never;
|
|
@@ -1106,14 +1166,14 @@ interface paths {
|
|
|
1106
1166
|
* /v1/ops/code_interpreter/execute_code
|
|
1107
1167
|
* @description Call this endpoint to execute code by code interpreter application
|
|
1108
1168
|
*/
|
|
1109
|
-
post: operations[
|
|
1169
|
+
post: operations['executeCode'];
|
|
1110
1170
|
delete?: never;
|
|
1111
1171
|
options?: never;
|
|
1112
1172
|
head?: never;
|
|
1113
1173
|
patch?: never;
|
|
1114
1174
|
trace?: never;
|
|
1115
1175
|
};
|
|
1116
|
-
|
|
1176
|
+
'/v1/ops/code_interpreter/upload_file': {
|
|
1117
1177
|
parameters: {
|
|
1118
1178
|
query?: never;
|
|
1119
1179
|
header?: never;
|
|
@@ -1126,14 +1186,14 @@ interface paths {
|
|
|
1126
1186
|
* /v1/ops/code_interpreter/upload_file
|
|
1127
1187
|
* @description Call this endpoint to upload file to code interpreter container
|
|
1128
1188
|
*/
|
|
1129
|
-
post: operations[
|
|
1189
|
+
post: operations['uploadFileToCodeInterpreter'];
|
|
1130
1190
|
delete?: never;
|
|
1131
1191
|
options?: never;
|
|
1132
1192
|
head?: never;
|
|
1133
1193
|
patch?: never;
|
|
1134
1194
|
trace?: never;
|
|
1135
1195
|
};
|
|
1136
|
-
|
|
1196
|
+
'/v1/ops/code_interpreter/download_file': {
|
|
1137
1197
|
parameters: {
|
|
1138
1198
|
query?: never;
|
|
1139
1199
|
header?: never;
|
|
@@ -1146,14 +1206,14 @@ interface paths {
|
|
|
1146
1206
|
* /v1/ops/code_interpreter/download_file
|
|
1147
1207
|
* @description Call this endpoint to download file from code interpreter container
|
|
1148
1208
|
*/
|
|
1149
|
-
post: operations[
|
|
1209
|
+
post: operations['downloadFileFromCodeInterpreter'];
|
|
1150
1210
|
delete?: never;
|
|
1151
1211
|
options?: never;
|
|
1152
1212
|
head?: never;
|
|
1153
1213
|
patch?: never;
|
|
1154
1214
|
trace?: never;
|
|
1155
1215
|
};
|
|
1156
|
-
|
|
1216
|
+
'/v1/ops/code_interpreter/list_files': {
|
|
1157
1217
|
parameters: {
|
|
1158
1218
|
query?: never;
|
|
1159
1219
|
header?: never;
|
|
@@ -1166,14 +1226,14 @@ interface paths {
|
|
|
1166
1226
|
* /v1/ops/code_interpreter/list_files
|
|
1167
1227
|
* @description Call this endpoint to list files from code interpreter container
|
|
1168
1228
|
*/
|
|
1169
|
-
post: operations[
|
|
1229
|
+
post: operations['listFilesFromCodeInterpreter'];
|
|
1170
1230
|
delete?: never;
|
|
1171
1231
|
options?: never;
|
|
1172
1232
|
head?: never;
|
|
1173
1233
|
patch?: never;
|
|
1174
1234
|
trace?: never;
|
|
1175
1235
|
};
|
|
1176
|
-
|
|
1236
|
+
'/v1/ops/code_interpreter/transfer_input_file': {
|
|
1177
1237
|
parameters: {
|
|
1178
1238
|
query?: never;
|
|
1179
1239
|
header?: never;
|
|
@@ -1186,14 +1246,14 @@ interface paths {
|
|
|
1186
1246
|
* /v1/ops/code_interpreter/transfer_input_file
|
|
1187
1247
|
* @description Call this endpoint to transfer file from Core storage to code interpreter container
|
|
1188
1248
|
*/
|
|
1189
|
-
post: operations[
|
|
1249
|
+
post: operations['transferInputFile'];
|
|
1190
1250
|
delete?: never;
|
|
1191
1251
|
options?: never;
|
|
1192
1252
|
head?: never;
|
|
1193
1253
|
patch?: never;
|
|
1194
1254
|
trace?: never;
|
|
1195
1255
|
};
|
|
1196
|
-
|
|
1256
|
+
'/v1/ops/code_interpreter/transfer_output_file': {
|
|
1197
1257
|
parameters: {
|
|
1198
1258
|
query?: never;
|
|
1199
1259
|
header?: never;
|
|
@@ -1206,14 +1266,14 @@ interface paths {
|
|
|
1206
1266
|
* /v1/ops/code_interpreter/transfer_output_file
|
|
1207
1267
|
* @description Call this endpoint to transfer file from code interpreter container to Core storage
|
|
1208
1268
|
*/
|
|
1209
|
-
post: operations[
|
|
1269
|
+
post: operations['transferOutputFile'];
|
|
1210
1270
|
delete?: never;
|
|
1211
1271
|
options?: never;
|
|
1212
1272
|
head?: never;
|
|
1213
1273
|
patch?: never;
|
|
1214
1274
|
trace?: never;
|
|
1215
1275
|
};
|
|
1216
|
-
|
|
1276
|
+
'/v1/ops/code_interpreter/get_session': {
|
|
1217
1277
|
parameters: {
|
|
1218
1278
|
query?: never;
|
|
1219
1279
|
header?: never;
|
|
@@ -1226,14 +1286,34 @@ interface paths {
|
|
|
1226
1286
|
* /v1/ops/code_interpreter/get_session
|
|
1227
1287
|
* @description Call this endpoint to get a session description. Note, this API does not reset TTL for a session.
|
|
1228
1288
|
*/
|
|
1229
|
-
post: operations[
|
|
1289
|
+
post: operations['getSession'];
|
|
1290
|
+
delete?: never;
|
|
1291
|
+
options?: never;
|
|
1292
|
+
head?: never;
|
|
1293
|
+
patch?: never;
|
|
1294
|
+
trace?: never;
|
|
1295
|
+
};
|
|
1296
|
+
'/v1/deployments': {
|
|
1297
|
+
parameters: {
|
|
1298
|
+
query?: never;
|
|
1299
|
+
header?: never;
|
|
1300
|
+
path?: never;
|
|
1301
|
+
cookie?: never;
|
|
1302
|
+
};
|
|
1303
|
+
/**
|
|
1304
|
+
* /v1/deployments
|
|
1305
|
+
* @description Call this endpoint to get basic details about the available deployments of all types (AI models, applications, toolsets) filtered by the interface type.
|
|
1306
|
+
*/
|
|
1307
|
+
get: operations['getDeploymentsByInterfaceType'];
|
|
1308
|
+
put?: never;
|
|
1309
|
+
post?: never;
|
|
1230
1310
|
delete?: never;
|
|
1231
1311
|
options?: never;
|
|
1232
1312
|
head?: never;
|
|
1233
1313
|
patch?: never;
|
|
1234
1314
|
trace?: never;
|
|
1235
1315
|
};
|
|
1236
|
-
|
|
1316
|
+
'/openai/deployments': {
|
|
1237
1317
|
parameters: {
|
|
1238
1318
|
query?: never;
|
|
1239
1319
|
header?: never;
|
|
@@ -1245,7 +1325,7 @@ interface paths {
|
|
|
1245
1325
|
* @description Call this endpoint to get basic details about the available deployments.
|
|
1246
1326
|
* The response contains model objects (same as `/openai/models`).
|
|
1247
1327
|
*/
|
|
1248
|
-
get: operations[
|
|
1328
|
+
get: operations['getDeployments'];
|
|
1249
1329
|
put?: never;
|
|
1250
1330
|
post?: never;
|
|
1251
1331
|
delete?: never;
|
|
@@ -1254,7 +1334,7 @@ interface paths {
|
|
|
1254
1334
|
patch?: never;
|
|
1255
1335
|
trace?: never;
|
|
1256
1336
|
};
|
|
1257
|
-
|
|
1337
|
+
'/openai/deployments/{deployment_name}': {
|
|
1258
1338
|
parameters: {
|
|
1259
1339
|
query?: never;
|
|
1260
1340
|
header?: never;
|
|
@@ -1265,7 +1345,7 @@ interface paths {
|
|
|
1265
1345
|
* /openai/deployments/{deployment_name}
|
|
1266
1346
|
* @description Call this endpoint to get information about a model by its deployment name.
|
|
1267
1347
|
*/
|
|
1268
|
-
get: operations[
|
|
1348
|
+
get: operations['getDeployment'];
|
|
1269
1349
|
put?: never;
|
|
1270
1350
|
post?: never;
|
|
1271
1351
|
delete?: never;
|
|
@@ -1274,7 +1354,7 @@ interface paths {
|
|
|
1274
1354
|
patch?: never;
|
|
1275
1355
|
trace?: never;
|
|
1276
1356
|
};
|
|
1277
|
-
|
|
1357
|
+
'/openai/models': {
|
|
1278
1358
|
parameters: {
|
|
1279
1359
|
query?: never;
|
|
1280
1360
|
header?: never;
|
|
@@ -1285,7 +1365,7 @@ interface paths {
|
|
|
1285
1365
|
* /openai/models
|
|
1286
1366
|
* @description Call this endpoint to get extended details about the available models.
|
|
1287
1367
|
*/
|
|
1288
|
-
get: operations[
|
|
1368
|
+
get: operations['getModels'];
|
|
1289
1369
|
put?: never;
|
|
1290
1370
|
post?: never;
|
|
1291
1371
|
delete?: never;
|
|
@@ -1294,7 +1374,7 @@ interface paths {
|
|
|
1294
1374
|
patch?: never;
|
|
1295
1375
|
trace?: never;
|
|
1296
1376
|
};
|
|
1297
|
-
|
|
1377
|
+
'/openai/models/{model_name}': {
|
|
1298
1378
|
parameters: {
|
|
1299
1379
|
query?: never;
|
|
1300
1380
|
header?: never;
|
|
@@ -1305,7 +1385,7 @@ interface paths {
|
|
|
1305
1385
|
* /openai/models/{model_name}
|
|
1306
1386
|
* @description Call this endpoint to get an extended information about a model by its name.
|
|
1307
1387
|
*/
|
|
1308
|
-
get: operations[
|
|
1388
|
+
get: operations['getModel'];
|
|
1309
1389
|
put?: never;
|
|
1310
1390
|
post?: never;
|
|
1311
1391
|
delete?: never;
|
|
@@ -1314,7 +1394,7 @@ interface paths {
|
|
|
1314
1394
|
patch?: never;
|
|
1315
1395
|
trace?: never;
|
|
1316
1396
|
};
|
|
1317
|
-
|
|
1397
|
+
'/openai/applications': {
|
|
1318
1398
|
parameters: {
|
|
1319
1399
|
query?: never;
|
|
1320
1400
|
header?: never;
|
|
@@ -1325,7 +1405,7 @@ interface paths {
|
|
|
1325
1405
|
* /openai/applications
|
|
1326
1406
|
* @description Call this endpoint to get extended details about the available Applications.
|
|
1327
1407
|
*/
|
|
1328
|
-
get: operations[
|
|
1408
|
+
get: operations['getApplications'];
|
|
1329
1409
|
put?: never;
|
|
1330
1410
|
post?: never;
|
|
1331
1411
|
delete?: never;
|
|
@@ -1334,7 +1414,7 @@ interface paths {
|
|
|
1334
1414
|
patch?: never;
|
|
1335
1415
|
trace?: never;
|
|
1336
1416
|
};
|
|
1337
|
-
|
|
1417
|
+
'/openai/applications/{application_name}': {
|
|
1338
1418
|
parameters: {
|
|
1339
1419
|
query?: never;
|
|
1340
1420
|
header?: never;
|
|
@@ -1345,7 +1425,7 @@ interface paths {
|
|
|
1345
1425
|
* /openai/applications/{application_name}
|
|
1346
1426
|
* @description Call this endpoint to get extended information about an Application by its name.
|
|
1347
1427
|
*/
|
|
1348
|
-
get: operations[
|
|
1428
|
+
get: operations['getApplication'];
|
|
1349
1429
|
put?: never;
|
|
1350
1430
|
post?: never;
|
|
1351
1431
|
delete?: never;
|
|
@@ -1354,7 +1434,7 @@ interface paths {
|
|
|
1354
1434
|
patch?: never;
|
|
1355
1435
|
trace?: never;
|
|
1356
1436
|
};
|
|
1357
|
-
|
|
1437
|
+
'/openai/toolsets': {
|
|
1358
1438
|
parameters: {
|
|
1359
1439
|
query?: never;
|
|
1360
1440
|
header?: never;
|
|
@@ -1365,7 +1445,7 @@ interface paths {
|
|
|
1365
1445
|
* /openai/toolsets
|
|
1366
1446
|
* @description Call this endpoint to get extended details about the available toolsets.
|
|
1367
1447
|
*/
|
|
1368
|
-
get: operations[
|
|
1448
|
+
get: operations['getToolSets'];
|
|
1369
1449
|
put?: never;
|
|
1370
1450
|
post?: never;
|
|
1371
1451
|
delete?: never;
|
|
@@ -1374,7 +1454,7 @@ interface paths {
|
|
|
1374
1454
|
patch?: never;
|
|
1375
1455
|
trace?: never;
|
|
1376
1456
|
};
|
|
1377
|
-
|
|
1457
|
+
'/openai/toolsets/{toolset_name}': {
|
|
1378
1458
|
parameters: {
|
|
1379
1459
|
query?: never;
|
|
1380
1460
|
header?: never;
|
|
@@ -1385,7 +1465,7 @@ interface paths {
|
|
|
1385
1465
|
* /openai/toolsets/{toolset_name}
|
|
1386
1466
|
* @description Call this endpoint to get an extended information about a specific toolset by name
|
|
1387
1467
|
*/
|
|
1388
|
-
get: operations[
|
|
1468
|
+
get: operations['getToolset'];
|
|
1389
1469
|
put?: never;
|
|
1390
1470
|
post?: never;
|
|
1391
1471
|
delete?: never;
|
|
@@ -1394,7 +1474,7 @@ interface paths {
|
|
|
1394
1474
|
patch?: never;
|
|
1395
1475
|
trace?: never;
|
|
1396
1476
|
};
|
|
1397
|
-
|
|
1477
|
+
'/v1/deployments/{deployment_name}/limits': {
|
|
1398
1478
|
parameters: {
|
|
1399
1479
|
query?: never;
|
|
1400
1480
|
header?: never;
|
|
@@ -1405,7 +1485,7 @@ interface paths {
|
|
|
1405
1485
|
* /v1/deployments/{deployment_name}/limits
|
|
1406
1486
|
* @description Call this endpoint to get information about spent limits for a given deployment.
|
|
1407
1487
|
*/
|
|
1408
|
-
get: operations[
|
|
1488
|
+
get: operations['getDeploymentLimits'];
|
|
1409
1489
|
put?: never;
|
|
1410
1490
|
post?: never;
|
|
1411
1491
|
delete?: never;
|
|
@@ -1414,7 +1494,7 @@ interface paths {
|
|
|
1414
1494
|
patch?: never;
|
|
1415
1495
|
trace?: never;
|
|
1416
1496
|
};
|
|
1417
|
-
|
|
1497
|
+
'/v1/ops/config/reload': {
|
|
1418
1498
|
parameters: {
|
|
1419
1499
|
query?: never;
|
|
1420
1500
|
header?: never;
|
|
@@ -1429,14 +1509,14 @@ interface paths {
|
|
|
1429
1509
|
*
|
|
1430
1510
|
* <b>Allowed for admin users only</b>!
|
|
1431
1511
|
*/
|
|
1432
|
-
post: operations[
|
|
1512
|
+
post: operations['reloadConfig'];
|
|
1433
1513
|
delete?: never;
|
|
1434
1514
|
options?: never;
|
|
1435
1515
|
head?: never;
|
|
1436
1516
|
patch?: never;
|
|
1437
1517
|
trace?: never;
|
|
1438
1518
|
};
|
|
1439
|
-
|
|
1519
|
+
'/v1/consent/{deployment_id}': {
|
|
1440
1520
|
parameters: {
|
|
1441
1521
|
query?: never;
|
|
1442
1522
|
header?: never;
|
|
@@ -1447,13 +1527,93 @@ interface paths {
|
|
|
1447
1527
|
* /v1/consent/{deployment_id}
|
|
1448
1528
|
* @description Call this endpoint to get a user's consent for the deployment id. Refer to [DIAL documentation](https://docs.dialx.ai/tutorials/developers/apps-development/auth-matrix#dial-api) to learn more about consent forms and Auth Matrix.
|
|
1449
1529
|
*/
|
|
1450
|
-
get: operations[
|
|
1530
|
+
get: operations['requestUserConsent'];
|
|
1451
1531
|
put?: never;
|
|
1452
1532
|
/**
|
|
1453
1533
|
* /v1/consent/{deployment_id}
|
|
1454
1534
|
* @description Call this endpoint to accept user's consent for the deployment id.
|
|
1455
1535
|
*/
|
|
1456
|
-
post: operations[
|
|
1536
|
+
post: operations['acceptUserConsent'];
|
|
1537
|
+
delete?: never;
|
|
1538
|
+
options?: never;
|
|
1539
|
+
head?: never;
|
|
1540
|
+
patch?: never;
|
|
1541
|
+
trace?: never;
|
|
1542
|
+
};
|
|
1543
|
+
'/v1/ops/client-channel/subscribe': {
|
|
1544
|
+
parameters: {
|
|
1545
|
+
query?: never;
|
|
1546
|
+
header?: never;
|
|
1547
|
+
path?: never;
|
|
1548
|
+
cookie?: never;
|
|
1549
|
+
};
|
|
1550
|
+
get?: never;
|
|
1551
|
+
put?: never;
|
|
1552
|
+
/**
|
|
1553
|
+
* /v1/ops/client-channel/subscribe
|
|
1554
|
+
* @description **Note**: This endpoint is in PREVIEW - it can be removed or modified in nearest future. Call this endpoint to get subscription on events from client channel.
|
|
1555
|
+
*/
|
|
1556
|
+
post: operations['subscribeOnClientChannel'];
|
|
1557
|
+
delete?: never;
|
|
1558
|
+
options?: never;
|
|
1559
|
+
head?: never;
|
|
1560
|
+
patch?: never;
|
|
1561
|
+
trace?: never;
|
|
1562
|
+
};
|
|
1563
|
+
'/v1/ops/client-channel/unsubscribe': {
|
|
1564
|
+
parameters: {
|
|
1565
|
+
query?: never;
|
|
1566
|
+
header?: never;
|
|
1567
|
+
path?: never;
|
|
1568
|
+
cookie?: never;
|
|
1569
|
+
};
|
|
1570
|
+
get?: never;
|
|
1571
|
+
put?: never;
|
|
1572
|
+
/**
|
|
1573
|
+
* /v1/ops/client-channel/unsubscribe
|
|
1574
|
+
* @description **Note**: This endpoint is in PREVIEW - it can be removed or modified in nearest future. Call this endpoint to remove subscription on events from client channel.
|
|
1575
|
+
*/
|
|
1576
|
+
post: operations['unsubscribeOnClientChannel'];
|
|
1577
|
+
delete?: never;
|
|
1578
|
+
options?: never;
|
|
1579
|
+
head?: never;
|
|
1580
|
+
patch?: never;
|
|
1581
|
+
trace?: never;
|
|
1582
|
+
};
|
|
1583
|
+
'/v1/ops/client-channel/report': {
|
|
1584
|
+
parameters: {
|
|
1585
|
+
query?: never;
|
|
1586
|
+
header?: never;
|
|
1587
|
+
path?: never;
|
|
1588
|
+
cookie?: never;
|
|
1589
|
+
};
|
|
1590
|
+
get?: never;
|
|
1591
|
+
put?: never;
|
|
1592
|
+
/**
|
|
1593
|
+
* /v1/ops/client-channel/report
|
|
1594
|
+
* @description **Note**: This endpoint is in PREVIEW - it can be removed or modified in nearest future. Call this endpoint to report RPC response to client channel.
|
|
1595
|
+
*/
|
|
1596
|
+
post: operations['reportResponseToClientChannel'];
|
|
1597
|
+
delete?: never;
|
|
1598
|
+
options?: never;
|
|
1599
|
+
head?: never;
|
|
1600
|
+
patch?: never;
|
|
1601
|
+
trace?: never;
|
|
1602
|
+
};
|
|
1603
|
+
'/v1/ops/client-channel/interact': {
|
|
1604
|
+
parameters: {
|
|
1605
|
+
query?: never;
|
|
1606
|
+
header?: never;
|
|
1607
|
+
path?: never;
|
|
1608
|
+
cookie?: never;
|
|
1609
|
+
};
|
|
1610
|
+
get?: never;
|
|
1611
|
+
put?: never;
|
|
1612
|
+
/**
|
|
1613
|
+
* /v1/ops/client-channel/interact
|
|
1614
|
+
* @description **Note**: This endpoint is in PREVIEW - it can be removed or modified in nearest future. Call this endpoint to send RPC request to client channel and wait for RPC response.
|
|
1615
|
+
*/
|
|
1616
|
+
post: operations['interactWithClientChannel'];
|
|
1457
1617
|
delete?: never;
|
|
1458
1618
|
options?: never;
|
|
1459
1619
|
head?: never;
|
|
@@ -1465,13 +1625,13 @@ interface components {
|
|
|
1465
1625
|
schemas: {
|
|
1466
1626
|
/** @description Response for reviewing user consent status. */
|
|
1467
1627
|
ReviewConsentResponse: {
|
|
1468
|
-
consent?: components[
|
|
1628
|
+
consent?: components['schemas']['Consent'];
|
|
1469
1629
|
/** @description Whether the user has already accepted the consent. */
|
|
1470
1630
|
accepted?: boolean;
|
|
1471
1631
|
};
|
|
1472
1632
|
/** @description Request body for accepting user consent. */
|
|
1473
1633
|
AcceptConsentRequest: {
|
|
1474
|
-
consent?: components[
|
|
1634
|
+
consent?: components['schemas']['Consent'];
|
|
1475
1635
|
};
|
|
1476
1636
|
/** @description User consent for deployments. Keys are deployment IDs. */
|
|
1477
1637
|
Consent: {
|
|
@@ -1487,12 +1647,12 @@ interface components {
|
|
|
1487
1647
|
* @description The type of the tool. Currently, only `function` is supported.
|
|
1488
1648
|
* @enum {string}
|
|
1489
1649
|
*/
|
|
1490
|
-
type:
|
|
1491
|
-
function: components[
|
|
1492
|
-
custom_fields?: components[
|
|
1650
|
+
type: 'function';
|
|
1651
|
+
function: components['schemas']['FunctionObject'];
|
|
1652
|
+
custom_fields?: components['schemas']['ToolCustomFields'];
|
|
1493
1653
|
};
|
|
1494
1654
|
ToolCustomFields: {
|
|
1495
|
-
cache_breakpoint?: components[
|
|
1655
|
+
cache_breakpoint?: components['schemas']['CacheBreakpoint'];
|
|
1496
1656
|
};
|
|
1497
1657
|
/** @description A manual cache breakpoint. The part of the chat completion request up to this breakpoint will be cached by the deployment. Follow-up requests sharing the same prefix have a chance of hitting the cache and reusing the input tokens associated with this prefix. The field only makes sense for the deployments that support [prompt caching](https://docs.dialx.ai/tutorials/developers/prompt-caching). */
|
|
1498
1658
|
CacheBreakpoint: {
|
|
@@ -1507,7 +1667,7 @@ interface components {
|
|
|
1507
1667
|
description?: string;
|
|
1508
1668
|
/** @description The name of the `function` to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. */
|
|
1509
1669
|
name: string;
|
|
1510
|
-
parameters?: components[
|
|
1670
|
+
parameters?: components['schemas']['FunctionParameters'];
|
|
1511
1671
|
/**
|
|
1512
1672
|
* @description Whether to enable strict schema adherence when generating the `function` call. If set to `true`, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling).
|
|
1513
1673
|
* @default false
|
|
@@ -1519,9 +1679,7 @@ interface components {
|
|
|
1519
1679
|
*
|
|
1520
1680
|
* Omitting `parameters` defines a `function` with an empty parameter list.
|
|
1521
1681
|
*/
|
|
1522
|
-
FunctionParameters:
|
|
1523
|
-
[key: string]: unknown;
|
|
1524
|
-
};
|
|
1682
|
+
FunctionParameters: Record<string, never>;
|
|
1525
1683
|
/**
|
|
1526
1684
|
* @description Controls which (if any) tool is called by the model.
|
|
1527
1685
|
*
|
|
@@ -1535,14 +1693,14 @@ interface components {
|
|
|
1535
1693
|
* `none` is the default when no `tools` are present.
|
|
1536
1694
|
* `auto` is the default if `tools` are present.
|
|
1537
1695
|
*/
|
|
1538
|
-
ChatCompletionToolChoiceOption: (
|
|
1696
|
+
ChatCompletionToolChoiceOption: ('none' | 'auto' | 'required') | components['schemas']['ChatCompletionNamedToolChoice'];
|
|
1539
1697
|
/** @description Specifies a `tool` the model should use. Use to force the model to call a specific `function`. */
|
|
1540
1698
|
ChatCompletionNamedToolChoice: {
|
|
1541
1699
|
/**
|
|
1542
1700
|
* @description The type of the `tool`. Currently, only `function` is supported.
|
|
1543
1701
|
* @enum {string}
|
|
1544
1702
|
*/
|
|
1545
|
-
type:
|
|
1703
|
+
type: 'function';
|
|
1546
1704
|
function: {
|
|
1547
1705
|
/** @description The name of the `function` to call. */
|
|
1548
1706
|
name: string;
|
|
@@ -1554,7 +1712,7 @@ interface components {
|
|
|
1554
1712
|
*/
|
|
1555
1713
|
ParallelToolCalls: boolean;
|
|
1556
1714
|
/** @description The `tool` calls generated by the model, such as `function` calls. */
|
|
1557
|
-
ChatCompletionMessageToolCalls: components[
|
|
1715
|
+
ChatCompletionMessageToolCalls: components['schemas']['ChatCompletionMessageToolCall'][];
|
|
1558
1716
|
/** @description Deprecated and replaced by `tool_calls`. The name and arguments of a `function` that should be called, as generated by the model. */
|
|
1559
1717
|
ChatCompletionFunctionCall: {
|
|
1560
1718
|
/** @description The name of the `function` to call. */
|
|
@@ -1565,7 +1723,7 @@ interface components {
|
|
|
1565
1723
|
ChatCompletionMessageToolCall: {
|
|
1566
1724
|
/** @description The ID of the `tool` call. */
|
|
1567
1725
|
id: string;
|
|
1568
|
-
type: components[
|
|
1726
|
+
type: components['schemas']['ToolCallType'];
|
|
1569
1727
|
/** @description The `function` that the model called. */
|
|
1570
1728
|
function: {
|
|
1571
1729
|
/** @description The name of the `function` to call. */
|
|
@@ -1578,11 +1736,13 @@ interface components {
|
|
|
1578
1736
|
* @description The type of the `tool` call, in this case `function`.
|
|
1579
1737
|
* @enum {string}
|
|
1580
1738
|
*/
|
|
1581
|
-
ToolCallType:
|
|
1739
|
+
ToolCallType: 'function';
|
|
1582
1740
|
/** @description The features supported by a deployment. */
|
|
1583
1741
|
DeploymentFeatures: {
|
|
1584
1742
|
/** @description Does the deployment support endpoint for rating a request: `POST /v1/{deployment_name}/rate`? */
|
|
1585
1743
|
rate: boolean;
|
|
1744
|
+
/** @description Does the deployment support endpoint for MCP (Multi-Channel Processing) requests: `GET /v1/deployments/{deployment_name}/mcp`? */
|
|
1745
|
+
mcp: boolean;
|
|
1586
1746
|
/** @description Does the deployment support endpoint for tokenization: `POST /v1/{deployment_name}/tokenize`? */
|
|
1587
1747
|
tokenize: boolean;
|
|
1588
1748
|
/** @description Does the deployment support endpoint for prompt truncation: `POST /v1/{deployment_name}/truncate_prompt`? */
|
|
@@ -1713,7 +1873,7 @@ interface components {
|
|
|
1713
1873
|
DeploymentBase: {
|
|
1714
1874
|
/** @description The unique identifier of the deployment. */
|
|
1715
1875
|
id?: string;
|
|
1716
|
-
/** @description The display name of the deployment. */
|
|
1876
|
+
/** @description The display name of the deployment. Returned only with the response from `/v1/deployments` endpoint. */
|
|
1717
1877
|
display_name?: string;
|
|
1718
1878
|
/** @description The display version of the deployment. */
|
|
1719
1879
|
display_version?: string;
|
|
@@ -1735,16 +1895,16 @@ interface components {
|
|
|
1735
1895
|
description_keywords?: string[];
|
|
1736
1896
|
/** @description The maximum number of retry attempts to route a single user's request to the deployment's endpoint. */
|
|
1737
1897
|
max_retry_attempts?: number;
|
|
1738
|
-
/** @description
|
|
1898
|
+
/** @description Interface types supported by the deployment. Returned only with the response from `/v1/deployments` endpoint. */
|
|
1739
1899
|
interfaces?: string[];
|
|
1740
1900
|
};
|
|
1741
1901
|
DeploymentWithFeatures: {
|
|
1742
|
-
features?: components[
|
|
1743
|
-
input_attachment_types?: components[
|
|
1744
|
-
max_input_attachments?: components[
|
|
1745
|
-
defaults?: components[
|
|
1902
|
+
features?: components['schemas']['DeploymentFeatures'];
|
|
1903
|
+
input_attachment_types?: components['schemas']['DeploymentInputAttachmentTypes'];
|
|
1904
|
+
max_input_attachments?: components['schemas']['DeploymentMaxInputAttachments'];
|
|
1905
|
+
defaults?: components['schemas']['DeploymentDefaultParameters'];
|
|
1746
1906
|
};
|
|
1747
|
-
Deployment: components[
|
|
1907
|
+
Deployment: components['schemas']['DeploymentBase'] & {
|
|
1748
1908
|
/** @description The deployment name. */
|
|
1749
1909
|
model?: string;
|
|
1750
1910
|
/** @description The object type. Always is `deployment`. */
|
|
@@ -1754,25 +1914,25 @@ interface components {
|
|
|
1754
1914
|
/** @description The scale type. Only the `standard` type is currently supported. */
|
|
1755
1915
|
scale_type?: string;
|
|
1756
1916
|
};
|
|
1757
|
-
} & components[
|
|
1758
|
-
|
|
1917
|
+
} & components['schemas']['DeploymentWithFeatures'];
|
|
1918
|
+
ModelOpenAi: components['schemas']['DeploymentBase'] & {
|
|
1759
1919
|
/** @description The model name. Same as the `id` field. */
|
|
1760
1920
|
model?: string;
|
|
1761
1921
|
/** @description The object type. Always is `model`. */
|
|
1762
1922
|
object?: string;
|
|
1763
1923
|
/** @description Lifecycle status. Always is `generally-available`. */
|
|
1764
1924
|
lifecycle_status?: string;
|
|
1765
|
-
capabilities?: components[
|
|
1925
|
+
capabilities?: components['schemas']['ModelCapabilities'];
|
|
1766
1926
|
/**
|
|
1767
1927
|
* @description This parameter specifies the exact model whose tokenization algorithm matches the one used by the given model. Typically, this is the name of the first model released in a series that shares the same tokenization algorithm _(e.g., `gpt-3.5-turbo-0301`, `gpt-4-0314`, `gpt-4-1106-vision-preview`)_.
|
|
1768
1928
|
* <br><br>
|
|
1769
1929
|
* This parameter is useful for DIAL clients that implement tokenization algorithms on their side, rather than using the `/tokenize` endpoint provided by the model.
|
|
1770
1930
|
*/
|
|
1771
1931
|
tokenizer_model?: string;
|
|
1772
|
-
limits?: components[
|
|
1773
|
-
pricing?: components[
|
|
1774
|
-
} & components[
|
|
1775
|
-
|
|
1932
|
+
limits?: components['schemas']['ModelLimits'];
|
|
1933
|
+
pricing?: components['schemas']['ModelPricing'];
|
|
1934
|
+
} & components['schemas']['DeploymentWithFeatures'];
|
|
1935
|
+
ApplicationOpenAi: components['schemas']['DeploymentBase'] & {
|
|
1776
1936
|
/** @description The application name. */
|
|
1777
1937
|
application?: string;
|
|
1778
1938
|
/** @description The URL of the custom app UI. */
|
|
@@ -1782,39 +1942,37 @@ interface components {
|
|
|
1782
1942
|
/** @description The object type. Always is `application`. */
|
|
1783
1943
|
object?: string;
|
|
1784
1944
|
/** @description Custom application properties. */
|
|
1785
|
-
application_properties?:
|
|
1786
|
-
[key: string]: unknown;
|
|
1787
|
-
};
|
|
1945
|
+
application_properties?: Record<string, never>;
|
|
1788
1946
|
/**
|
|
1789
1947
|
* Format: uri
|
|
1790
1948
|
* @description The URI of the application type schema.
|
|
1791
1949
|
*/
|
|
1792
1950
|
application_type_schema_id?: string;
|
|
1793
|
-
function?: components[
|
|
1951
|
+
function?: components['schemas']['ApplicationFunction'];
|
|
1794
1952
|
/** @description Custom routes for the application. */
|
|
1795
1953
|
routes?: {
|
|
1796
1954
|
[key: string]: Record<string, never>;
|
|
1797
1955
|
};
|
|
1798
1956
|
/** @description Indicates whether the application is invalid (e.g., missing required properties or schema violations). Only applicable for schema-rich applications. Null when the application is valid. */
|
|
1799
1957
|
readonly invalid?: boolean;
|
|
1800
|
-
} & components[
|
|
1958
|
+
} & components['schemas']['DeploymentWithFeatures'];
|
|
1801
1959
|
/**
|
|
1802
1960
|
* @deprecated
|
|
1803
1961
|
* @description Deprecated: Assistant type has been removed from the codebase.
|
|
1804
1962
|
*/
|
|
1805
|
-
Assistant: components[
|
|
1963
|
+
Assistant: components['schemas']['DeploymentBase'] & {
|
|
1806
1964
|
/** @description The assistant name. */
|
|
1807
1965
|
assistant?: string;
|
|
1808
1966
|
/** @description The object type. Always is `assistant`. */
|
|
1809
1967
|
object?: string;
|
|
1810
1968
|
/** @description The array of addons enabled by default in the assistant. */
|
|
1811
1969
|
addons?: string[];
|
|
1812
|
-
} & components[
|
|
1970
|
+
} & components['schemas']['DeploymentWithFeatures'];
|
|
1813
1971
|
/**
|
|
1814
1972
|
* @deprecated
|
|
1815
1973
|
* @description Deprecated: Addon type has been removed from the codebase.
|
|
1816
1974
|
*/
|
|
1817
|
-
Addon: components[
|
|
1975
|
+
Addon: components['schemas']['DeploymentBase'] & {
|
|
1818
1976
|
/** @description The addon name. */
|
|
1819
1977
|
addon?: string;
|
|
1820
1978
|
/** @description The object type. Always is `addon`. */
|
|
@@ -1836,7 +1994,7 @@ interface components {
|
|
|
1836
1994
|
* @description The current deployment status of the function.
|
|
1837
1995
|
* @enum {string}
|
|
1838
1996
|
*/
|
|
1839
|
-
status?:
|
|
1997
|
+
status?: 'DEPLOYING' | 'UNDEPLOYING' | 'DEPLOYED' | 'UNDEPLOYED' | 'FAILED';
|
|
1840
1998
|
/** @description Error message if the function deployment failed. */
|
|
1841
1999
|
error?: string;
|
|
1842
2000
|
/** @description The mapping configuration for the function. */
|
|
@@ -1852,7 +2010,7 @@ interface components {
|
|
|
1852
2010
|
* @description Type of authentication.
|
|
1853
2011
|
* @enum {string}
|
|
1854
2012
|
*/
|
|
1855
|
-
authentication_type:
|
|
2013
|
+
authentication_type: 'OAUTH' | 'API_KEY' | 'NONE';
|
|
1856
2014
|
/** @description (OAUTH only) Client ID for OAuth flows. */
|
|
1857
2015
|
client_id?: string;
|
|
1858
2016
|
/** @description (OAUTH only) Client secret for OAuth flows. */
|
|
@@ -1873,17 +2031,17 @@ interface components {
|
|
|
1873
2031
|
* @description Global credentials status.
|
|
1874
2032
|
* @enum {string}
|
|
1875
2033
|
*/
|
|
1876
|
-
readonly global_auth_status?:
|
|
2034
|
+
readonly global_auth_status?: 'SIGNED_IN' | 'SIGNED_OUT';
|
|
1877
2035
|
/**
|
|
1878
2036
|
* @description Application-level credentials status.
|
|
1879
2037
|
* @enum {string}
|
|
1880
2038
|
*/
|
|
1881
|
-
readonly app_level_auth_status?:
|
|
2039
|
+
readonly app_level_auth_status?: 'SIGNED_IN' | 'SIGNED_OUT';
|
|
1882
2040
|
/**
|
|
1883
2041
|
* @description User-level credentials status.
|
|
1884
2042
|
* @enum {string}
|
|
1885
2043
|
*/
|
|
1886
|
-
readonly user_level_auth_status?:
|
|
2044
|
+
readonly user_level_auth_status?: 'SIGNED_IN' | 'SIGNED_OUT';
|
|
1887
2045
|
/** @description (API_KEY only) Header name for API key. */
|
|
1888
2046
|
api_key_header?: string;
|
|
1889
2047
|
};
|
|
@@ -1892,6 +2050,8 @@ interface components {
|
|
|
1892
2050
|
id?: string;
|
|
1893
2051
|
/** @description DIAL toolset name. */
|
|
1894
2052
|
toolset?: string;
|
|
2053
|
+
/** @description Interfaces supported by the toolset. Default value `mcp`. Returned only with the response from `/v1/deployments` endpoint. */
|
|
2054
|
+
interfaces?: string;
|
|
1895
2055
|
/** @description The path for the location of the icon applied to the toolset on UI. */
|
|
1896
2056
|
icon_url?: string;
|
|
1897
2057
|
/** @description A brief description of the toolset. */
|
|
@@ -1920,9 +2080,9 @@ interface components {
|
|
|
1920
2080
|
transport?: string;
|
|
1921
2081
|
/** @description A list of available tools in the MCP server. */
|
|
1922
2082
|
allowed_tools?: unknown[];
|
|
1923
|
-
auth_settings?: components[
|
|
1924
|
-
} & components[
|
|
1925
|
-
ToolSet: components[
|
|
2083
|
+
auth_settings?: components['schemas']['ResourceAuthSettings'];
|
|
2084
|
+
} & components['schemas']['DeploymentWithFeatures'];
|
|
2085
|
+
ToolSet: components['schemas']['DeploymentBase'] & {
|
|
1926
2086
|
/** @description The toolset name. */
|
|
1927
2087
|
toolset?: string;
|
|
1928
2088
|
/** @description The transport supported by the MCP server. Available options are `HTTP` or `SSE`. */
|
|
@@ -1931,7 +2091,7 @@ interface components {
|
|
|
1931
2091
|
allowed_tools?: string[];
|
|
1932
2092
|
/** @description The object type. Always is `toolset`. */
|
|
1933
2093
|
object?: string;
|
|
1934
|
-
} & components[
|
|
2094
|
+
} & components['schemas']['DeploymentWithFeatures'];
|
|
1935
2095
|
Toolset: {
|
|
1936
2096
|
/** @description DIAL Toolset's name. */
|
|
1937
2097
|
name?: string;
|
|
@@ -1965,8 +2125,8 @@ interface components {
|
|
|
1965
2125
|
transport?: string;
|
|
1966
2126
|
/** @description A list of allowed tools supported by the MCP server. */
|
|
1967
2127
|
allowed_tools?: unknown[];
|
|
1968
|
-
auth_settings?: components[
|
|
1969
|
-
} & components[
|
|
2128
|
+
auth_settings?: components['schemas']['ResourceAuthSettings'];
|
|
2129
|
+
} & components['schemas']['DeploymentWithFeatures'];
|
|
1970
2130
|
/** @description The capabilities of the model. */
|
|
1971
2131
|
ModelCapabilities: {
|
|
1972
2132
|
/** @description The scale types of the model. Defaults to `["standard"]`. */
|
|
@@ -2002,7 +2162,7 @@ interface components {
|
|
|
2002
2162
|
* @description The pricing units.
|
|
2003
2163
|
* @enum {string}
|
|
2004
2164
|
*/
|
|
2005
|
-
unit:
|
|
2165
|
+
unit: 'token' | 'char_without_whitespace';
|
|
2006
2166
|
/** @description The per-unit price for the completion request. */
|
|
2007
2167
|
prompt: string;
|
|
2008
2168
|
/**
|
|
@@ -2023,7 +2183,7 @@ interface components {
|
|
|
2023
2183
|
* **Note:** representation of strings as an array of token ids may not be supported by certain models.
|
|
2024
2184
|
*/
|
|
2025
2185
|
input: string | string[] | number[] | number[][];
|
|
2026
|
-
custom_input?: components[
|
|
2186
|
+
custom_input?: components['schemas']['EmbeddingsCustomInput'];
|
|
2027
2187
|
/** @description A unique identifier representing the end-user. */
|
|
2028
2188
|
user?: string;
|
|
2029
2189
|
/**
|
|
@@ -2032,7 +2192,7 @@ interface components {
|
|
|
2032
2192
|
* @example base64
|
|
2033
2193
|
* @enum {string}
|
|
2034
2194
|
*/
|
|
2035
|
-
encoding_format:
|
|
2195
|
+
encoding_format: 'float' | 'base64';
|
|
2036
2196
|
/**
|
|
2037
2197
|
* @description The number of dimensions the resulting output embeddings should have.
|
|
2038
2198
|
*
|
|
@@ -2040,7 +2200,7 @@ interface components {
|
|
|
2040
2200
|
* @example 512
|
|
2041
2201
|
*/
|
|
2042
2202
|
dimensions?: number;
|
|
2043
|
-
custom_fields?: components[
|
|
2203
|
+
custom_fields?: components['schemas']['EmbeddingsCustomFields'];
|
|
2044
2204
|
};
|
|
2045
2205
|
EmbeddingResponse: {
|
|
2046
2206
|
/** @description Object type. Always is `list`. */
|
|
@@ -2070,7 +2230,7 @@ interface components {
|
|
|
2070
2230
|
description?: string;
|
|
2071
2231
|
/** @description The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. */
|
|
2072
2232
|
name: string;
|
|
2073
|
-
parameters?: components[
|
|
2233
|
+
parameters?: components['schemas']['FunctionParameters'];
|
|
2074
2234
|
};
|
|
2075
2235
|
/** @description Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. */
|
|
2076
2236
|
ChatCompletionFunctionCallOption: {
|
|
@@ -2088,7 +2248,7 @@ interface components {
|
|
|
2088
2248
|
*/
|
|
2089
2249
|
url?: string;
|
|
2090
2250
|
};
|
|
2091
|
-
ChatCompletionRequestMessage: components[
|
|
2251
|
+
ChatCompletionRequestMessage: components['schemas']['ChatCompletionRequestDeveloperMessage'] | components['schemas']['ChatCompletionRequestSystemMessage'] | components['schemas']['ChatCompletionRequestUserMessage'] | components['schemas']['ChatCompletionRequestAssistantMessage'] | components['schemas']['ChatCompletionRequestToolMessage'] | components['schemas']['ChatCompletionRequestFunctionMessage'];
|
|
2092
2252
|
/**
|
|
2093
2253
|
* Developer message
|
|
2094
2254
|
* @description Developer-provided instructions that the model should follow, regardless of
|
|
@@ -2097,59 +2257,59 @@ interface components {
|
|
|
2097
2257
|
*/
|
|
2098
2258
|
ChatCompletionRequestDeveloperMessage: {
|
|
2099
2259
|
/** @description The contents of the developer message. */
|
|
2100
|
-
content: string | components[
|
|
2101
|
-
custom_fields?: components[
|
|
2260
|
+
content: string | components['schemas']['ChatCompletionRequestDeveloperMessageContentPart'][];
|
|
2261
|
+
custom_fields?: components['schemas']['ChatCompletionRequestCustomFields'];
|
|
2102
2262
|
/**
|
|
2103
2263
|
* @description The role of the messages author, in this case `developer`.
|
|
2104
2264
|
* @enum {string}
|
|
2105
2265
|
*/
|
|
2106
|
-
role:
|
|
2266
|
+
role: 'developer';
|
|
2107
2267
|
/** @description An optional name for the participant. Provides the model information to differentiate between participants of the same role. */
|
|
2108
2268
|
name?: string;
|
|
2109
2269
|
};
|
|
2110
2270
|
/** System message */
|
|
2111
2271
|
ChatCompletionRequestSystemMessage: {
|
|
2112
2272
|
/** @description The contents of the system message. */
|
|
2113
|
-
content: string | components[
|
|
2114
|
-
custom_fields?: components[
|
|
2273
|
+
content: string | components['schemas']['ChatCompletionRequestSystemMessageContentPart'][];
|
|
2274
|
+
custom_fields?: components['schemas']['ChatCompletionRequestCustomFields'];
|
|
2115
2275
|
/**
|
|
2116
2276
|
* @description The role of the messages author, in this case `system`.
|
|
2117
2277
|
* @enum {string}
|
|
2118
2278
|
*/
|
|
2119
|
-
role:
|
|
2279
|
+
role: 'system';
|
|
2120
2280
|
/** @description An optional name for the participant. Provides the model information to differentiate between participants of the same role. */
|
|
2121
2281
|
name?: string;
|
|
2122
2282
|
};
|
|
2123
2283
|
/** User message */
|
|
2124
2284
|
ChatCompletionRequestUserMessage: {
|
|
2125
2285
|
/** @description The contents of the user message. */
|
|
2126
|
-
content: string | components[
|
|
2127
|
-
custom_content?: components[
|
|
2128
|
-
custom_fields?: components[
|
|
2286
|
+
content: string | components['schemas']['ChatCompletionRequestUserMessageContentPart'][];
|
|
2287
|
+
custom_content?: components['schemas']['ChatCompletionRequestUserMessageCustomContent'];
|
|
2288
|
+
custom_fields?: components['schemas']['ChatCompletionRequestCustomFields'];
|
|
2129
2289
|
/**
|
|
2130
2290
|
* @description The role of the messages author, in this case `user`.
|
|
2131
2291
|
* @enum {string}
|
|
2132
2292
|
*/
|
|
2133
|
-
role:
|
|
2293
|
+
role: 'user';
|
|
2134
2294
|
/** @description An optional name for the participant. Provides the model information to differentiate between participants of the same role. */
|
|
2135
2295
|
name?: string;
|
|
2136
2296
|
};
|
|
2137
2297
|
/** Assistant message */
|
|
2138
2298
|
ChatCompletionRequestAssistantMessage: {
|
|
2139
2299
|
/** @description The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified. */
|
|
2140
|
-
content?: (string & (string | components[
|
|
2141
|
-
custom_content?: components[
|
|
2142
|
-
custom_fields?: components[
|
|
2300
|
+
content?: (string & (string | components['schemas']['ChatCompletionRequestAssistantMessageContentPart'][])) | null;
|
|
2301
|
+
custom_content?: components['schemas']['ChatCompletionRequestAssistantMessageCustomContent'];
|
|
2302
|
+
custom_fields?: components['schemas']['ChatCompletionRequestCustomFields'];
|
|
2143
2303
|
/** @description The refusal message by the assistant. */
|
|
2144
2304
|
refusal?: string | null;
|
|
2145
2305
|
/**
|
|
2146
2306
|
* @description The role of the messages author, in this case `assistant`.
|
|
2147
2307
|
* @enum {string}
|
|
2148
2308
|
*/
|
|
2149
|
-
role:
|
|
2309
|
+
role: 'assistant';
|
|
2150
2310
|
/** @description An optional name for the participant. Provides the model information to differentiate between participants of the same role. */
|
|
2151
2311
|
name?: string;
|
|
2152
|
-
tool_calls?: components[
|
|
2312
|
+
tool_calls?: components['schemas']['ChatCompletionMessageToolCalls'];
|
|
2153
2313
|
/**
|
|
2154
2314
|
* @deprecated
|
|
2155
2315
|
* @description Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
|
|
@@ -2167,10 +2327,10 @@ interface components {
|
|
|
2167
2327
|
* @description The role of the messages author, in this case `tool`.
|
|
2168
2328
|
* @enum {string}
|
|
2169
2329
|
*/
|
|
2170
|
-
role:
|
|
2330
|
+
role: 'tool';
|
|
2171
2331
|
/** @description The contents of the tool message. */
|
|
2172
|
-
content: string | components[
|
|
2173
|
-
custom_fields?: components[
|
|
2332
|
+
content: string | components['schemas']['ChatCompletionRequestToolMessageContentPart'][];
|
|
2333
|
+
custom_fields?: components['schemas']['ChatCompletionRequestCustomFields'];
|
|
2174
2334
|
/** @description Tool call that this message is responding to. */
|
|
2175
2335
|
tool_call_id: string;
|
|
2176
2336
|
};
|
|
@@ -2183,25 +2343,25 @@ interface components {
|
|
|
2183
2343
|
* @description The role of the messages author, in this case `function`.
|
|
2184
2344
|
* @enum {string}
|
|
2185
2345
|
*/
|
|
2186
|
-
role:
|
|
2346
|
+
role: 'function';
|
|
2187
2347
|
/** @description The contents of the function message. */
|
|
2188
2348
|
content: string | null;
|
|
2189
|
-
custom_fields?: components[
|
|
2349
|
+
custom_fields?: components['schemas']['ChatCompletionRequestCustomFields'];
|
|
2190
2350
|
/** @description The name of the function to call. */
|
|
2191
2351
|
name: string;
|
|
2192
2352
|
};
|
|
2193
|
-
ChatCompletionRequestDeveloperMessageContentPart: components[
|
|
2194
|
-
ChatCompletionRequestSystemMessageContentPart: components[
|
|
2195
|
-
ChatCompletionRequestUserMessageContentPart: components[
|
|
2196
|
-
ChatCompletionRequestAssistantMessageContentPart: components[
|
|
2197
|
-
ChatCompletionRequestToolMessageContentPart: components[
|
|
2353
|
+
ChatCompletionRequestDeveloperMessageContentPart: components['schemas']['ChatCompletionRequestMessageContentPartText'];
|
|
2354
|
+
ChatCompletionRequestSystemMessageContentPart: components['schemas']['ChatCompletionRequestMessageContentPartText'];
|
|
2355
|
+
ChatCompletionRequestUserMessageContentPart: components['schemas']['ChatCompletionRequestMessageContentPartText'] | components['schemas']['ChatCompletionRequestMessageContentPartImage'];
|
|
2356
|
+
ChatCompletionRequestAssistantMessageContentPart: components['schemas']['ChatCompletionRequestMessageContentPartText'] | components['schemas']['ChatCompletionRequestMessageContentPartRefusal'];
|
|
2357
|
+
ChatCompletionRequestToolMessageContentPart: components['schemas']['ChatCompletionRequestMessageContentPartText'];
|
|
2198
2358
|
/** Text content part */
|
|
2199
2359
|
ChatCompletionRequestMessageContentPartText: {
|
|
2200
2360
|
/**
|
|
2201
2361
|
* @description The type of the content part.
|
|
2202
2362
|
* @enum {string}
|
|
2203
2363
|
*/
|
|
2204
|
-
type:
|
|
2364
|
+
type: 'text';
|
|
2205
2365
|
/** @description The text content. */
|
|
2206
2366
|
text: string;
|
|
2207
2367
|
};
|
|
@@ -2211,7 +2371,7 @@ interface components {
|
|
|
2211
2371
|
* @description The type of the content part.
|
|
2212
2372
|
* @enum {string}
|
|
2213
2373
|
*/
|
|
2214
|
-
type:
|
|
2374
|
+
type: 'image_url';
|
|
2215
2375
|
image_url: {
|
|
2216
2376
|
/**
|
|
2217
2377
|
* Format: uri
|
|
@@ -2223,7 +2383,7 @@ interface components {
|
|
|
2223
2383
|
* @default auto
|
|
2224
2384
|
* @enum {string}
|
|
2225
2385
|
*/
|
|
2226
|
-
detail:
|
|
2386
|
+
detail: 'auto' | 'low' | 'high';
|
|
2227
2387
|
};
|
|
2228
2388
|
};
|
|
2229
2389
|
/** Refusal content part */
|
|
@@ -2232,7 +2392,7 @@ interface components {
|
|
|
2232
2392
|
* @description The type of the content part.
|
|
2233
2393
|
* @enum {string}
|
|
2234
2394
|
*/
|
|
2235
|
-
type:
|
|
2395
|
+
type: 'refusal';
|
|
2236
2396
|
/** @description The refusal message generated by the model. */
|
|
2237
2397
|
refusal: string;
|
|
2238
2398
|
};
|
|
@@ -2242,15 +2402,15 @@ interface components {
|
|
|
2242
2402
|
* @description The role of the author of the response message.
|
|
2243
2403
|
* @enum {string}
|
|
2244
2404
|
*/
|
|
2245
|
-
role:
|
|
2405
|
+
role: 'assistant';
|
|
2246
2406
|
/** @description The refusal message generated by the model. */
|
|
2247
2407
|
refusal: string | null;
|
|
2248
2408
|
/** @description The contents of the message. `content` is set for all messages except messages with tool calls, function calls and refusals. */
|
|
2249
2409
|
content: string | null;
|
|
2250
|
-
custom_content?: components[
|
|
2410
|
+
custom_content?: components['schemas']['ChatCompletionResponseCustomContent'];
|
|
2251
2411
|
/** @description The tool calls generated by the model, such as function calls. */
|
|
2252
|
-
tool_calls?: components[
|
|
2253
|
-
function_call?: components[
|
|
2412
|
+
tool_calls?: components['schemas']['ChatCompletionMessageToolCall'][];
|
|
2413
|
+
function_call?: components['schemas']['ChatCompletionFunctionCall'];
|
|
2254
2414
|
};
|
|
2255
2415
|
/** @description A chat completion delta generated by streamed model responses. */
|
|
2256
2416
|
ChatCompletionStreamResponseDelta: {
|
|
@@ -2258,12 +2418,12 @@ interface components {
|
|
|
2258
2418
|
* @description The role of the author of this message.
|
|
2259
2419
|
* @enum {string}
|
|
2260
2420
|
*/
|
|
2261
|
-
role?:
|
|
2421
|
+
role?: 'assistant';
|
|
2262
2422
|
/** @description The refusal message generated by the model. */
|
|
2263
2423
|
refusal?: string | null;
|
|
2264
2424
|
/** @description The contents of the chunk message. */
|
|
2265
2425
|
content?: string | null;
|
|
2266
|
-
custom_content?: components[
|
|
2426
|
+
custom_content?: components['schemas']['ChatCompletionResponseCustomContent'];
|
|
2267
2427
|
/**
|
|
2268
2428
|
* @deprecated
|
|
2269
2429
|
* @description Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
|
|
@@ -2274,7 +2434,7 @@ interface components {
|
|
|
2274
2434
|
/** @description The name of the function to call. */
|
|
2275
2435
|
name?: string;
|
|
2276
2436
|
};
|
|
2277
|
-
tool_calls?: components[
|
|
2437
|
+
tool_calls?: components['schemas']['ChatCompletionMessageToolCallChunk'][];
|
|
2278
2438
|
};
|
|
2279
2439
|
ChatCompletionMessageToolCallChunk: {
|
|
2280
2440
|
index: number;
|
|
@@ -2284,7 +2444,7 @@ interface components {
|
|
|
2284
2444
|
* @description The type of the tool. Currently, only `function` is supported.
|
|
2285
2445
|
* @enum {string}
|
|
2286
2446
|
*/
|
|
2287
|
-
type?:
|
|
2447
|
+
type?: 'function';
|
|
2288
2448
|
function?: {
|
|
2289
2449
|
/** @description The name of the function to call. */
|
|
2290
2450
|
name?: string;
|
|
@@ -2295,38 +2455,32 @@ interface components {
|
|
|
2295
2455
|
/** @description The custom content of the assistant message. */
|
|
2296
2456
|
ChatCompletionRequestAssistantMessageCustomContent: {
|
|
2297
2457
|
/** @description The internal state of the Assistant. This field can have an arbitrary set of fields with an arbitrary structure. */
|
|
2298
|
-
state?:
|
|
2299
|
-
[key: string]: unknown;
|
|
2300
|
-
};
|
|
2458
|
+
state?: Record<string, never>;
|
|
2301
2459
|
/** @description List of attachments used to supply an additional output from the model. */
|
|
2302
|
-
attachments?: components[
|
|
2460
|
+
attachments?: components['schemas']['RequestAttachment'][];
|
|
2303
2461
|
/**
|
|
2304
2462
|
* @description The JSON schema describing a form that the assistant prompts the user to fill in.
|
|
2305
2463
|
* Given this schema, the user is expected to provide a JSON value in the next message in the `custom_content.form_value` field.
|
|
2306
2464
|
*/
|
|
2307
|
-
form_schema?:
|
|
2308
|
-
[key: string]: unknown;
|
|
2309
|
-
};
|
|
2465
|
+
form_schema?: Record<string, never>;
|
|
2310
2466
|
};
|
|
2311
2467
|
/** @description The custom content of the user message. */
|
|
2312
2468
|
ChatCompletionRequestUserMessageCustomContent: {
|
|
2313
2469
|
/** @description List of attachments used to supply an additional input for the model. */
|
|
2314
|
-
attachments?: components[
|
|
2470
|
+
attachments?: components['schemas']['RequestAttachment'][];
|
|
2315
2471
|
/** @description The JSON value corresponding to the JSON schema sent by the assistant in the previous message in the `custom_content.form_schema` field. */
|
|
2316
|
-
form_value?:
|
|
2317
|
-
[key: string]: unknown;
|
|
2318
|
-
};
|
|
2472
|
+
form_value?: Record<string, never>;
|
|
2319
2473
|
};
|
|
2320
2474
|
/** @description DIAL-specific extensions of the Chat Completions message. */
|
|
2321
2475
|
ChatCompletionRequestCustomFields: {
|
|
2322
|
-
cache_breakpoint?: components[
|
|
2476
|
+
cache_breakpoint?: components['schemas']['CacheBreakpoint'];
|
|
2323
2477
|
};
|
|
2324
2478
|
/** @description The custom embedding inputs that represent multi-modal inputs (e.g. images and video) along with compound inputs (e.g. a title for an image and the image itself). */
|
|
2325
|
-
EmbeddingsCustomInput: components[
|
|
2479
|
+
EmbeddingsCustomInput: components['schemas']['EmbeddingsCustomInputElement'][];
|
|
2326
2480
|
/** @description A particular embedding input which embeddings model translates to an embedding vector. */
|
|
2327
|
-
EmbeddingsCustomInputElement: string | components[
|
|
2481
|
+
EmbeddingsCustomInputElement: string | components['schemas']['RequestAttachment'] | components['schemas']['EmbeddingsCustomInputCompoundElement'];
|
|
2328
2482
|
/** @description An embedding input composed of multiple strings and attachments. */
|
|
2329
|
-
EmbeddingsCustomInputCompoundElement: (string | components[
|
|
2483
|
+
EmbeddingsCustomInputCompoundElement: (string | components['schemas']['RequestAttachment'])[];
|
|
2330
2484
|
/** @description Additional parameters for an embedding model. */
|
|
2331
2485
|
EmbeddingsCustomFields: {
|
|
2332
2486
|
/**
|
|
@@ -2349,31 +2503,29 @@ interface components {
|
|
|
2349
2503
|
* @description The type of response format being defined: `text`
|
|
2350
2504
|
* @enum {string}
|
|
2351
2505
|
*/
|
|
2352
|
-
type:
|
|
2506
|
+
type: 'text';
|
|
2353
2507
|
};
|
|
2354
2508
|
ResponseFormatJsonObject: {
|
|
2355
2509
|
/**
|
|
2356
2510
|
* @description The type of response format being defined: `json_object`
|
|
2357
2511
|
* @enum {string}
|
|
2358
2512
|
*/
|
|
2359
|
-
type:
|
|
2513
|
+
type: 'json_object';
|
|
2360
2514
|
};
|
|
2361
2515
|
/** @description The schema for the response format, described as a JSON Schema object. */
|
|
2362
|
-
ResponseFormatJsonSchemaSchema:
|
|
2363
|
-
[key: string]: unknown;
|
|
2364
|
-
};
|
|
2516
|
+
ResponseFormatJsonSchemaSchema: Record<string, never>;
|
|
2365
2517
|
ResponseFormatJsonSchema: {
|
|
2366
2518
|
/**
|
|
2367
2519
|
* @description The type of response format being defined: `json_schema`
|
|
2368
2520
|
* @enum {string}
|
|
2369
2521
|
*/
|
|
2370
|
-
type:
|
|
2522
|
+
type: 'json_schema';
|
|
2371
2523
|
json_schema: {
|
|
2372
2524
|
/** @description A description of what the response format is for, used by the model to determine how to respond in the format. */
|
|
2373
2525
|
description?: string;
|
|
2374
2526
|
/** @description The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. */
|
|
2375
2527
|
name: string;
|
|
2376
|
-
schema: components[
|
|
2528
|
+
schema: components['schemas']['ResponseFormatJsonSchemaSchema'];
|
|
2377
2529
|
/**
|
|
2378
2530
|
* @description Whether to enable strict schema adherence when generating the output. If set to `true`, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`.
|
|
2379
2531
|
* @default false
|
|
@@ -2400,20 +2552,16 @@ interface components {
|
|
|
2400
2552
|
* "task": 1
|
|
2401
2553
|
* }
|
|
2402
2554
|
*/
|
|
2403
|
-
configuration?:
|
|
2404
|
-
[key: string]: unknown;
|
|
2405
|
-
};
|
|
2555
|
+
configuration?: Record<string, never>;
|
|
2406
2556
|
};
|
|
2407
2557
|
/** @description The custom content of a message. */
|
|
2408
2558
|
ChatCompletionResponseCustomContent: {
|
|
2409
2559
|
/** @description List of attachments. */
|
|
2410
|
-
attachments?: components[
|
|
2560
|
+
attachments?: components['schemas']['ChatCompletionResponseAttachment'][];
|
|
2411
2561
|
/** @description The intermediate stages that the Assistant went through to generate the response. */
|
|
2412
|
-
readonly stages?: components[
|
|
2562
|
+
readonly stages?: components['schemas']['ChatCompletionResponseStage'][];
|
|
2413
2563
|
/** @description The internal state of the Assistant. This field can have an arbitrary set of fields with an arbitrary structure. In case of a streaming, the state is published fully in one chunk. */
|
|
2414
|
-
state?:
|
|
2415
|
-
[key: string]: unknown;
|
|
2416
|
-
};
|
|
2564
|
+
state?: Record<string, never>;
|
|
2417
2565
|
};
|
|
2418
2566
|
RequestAttachment: {
|
|
2419
2567
|
/**
|
|
@@ -2491,7 +2639,7 @@ interface components {
|
|
|
2491
2639
|
/** @description The contents of the stage. */
|
|
2492
2640
|
content?: string;
|
|
2493
2641
|
/** @description List of attachments to the stage. */
|
|
2494
|
-
attachments?: components[
|
|
2642
|
+
attachments?: components['schemas']['ChatCompletionResponseAttachment'][];
|
|
2495
2643
|
/**
|
|
2496
2644
|
* @description The execution status of the stage. Available status values:
|
|
2497
2645
|
*
|
|
@@ -2514,7 +2662,7 @@ interface components {
|
|
|
2514
2662
|
choices?: {
|
|
2515
2663
|
/** @description The index of the choice from `0` to `n - 1`. */
|
|
2516
2664
|
index: number;
|
|
2517
|
-
message: components[
|
|
2665
|
+
message: components['schemas']['ChatCompletionResponseMessage'];
|
|
2518
2666
|
/**
|
|
2519
2667
|
* @description The reason indicating the completion of the choice generation process. The possible reasons:
|
|
2520
2668
|
*
|
|
@@ -2535,7 +2683,7 @@ interface components {
|
|
|
2535
2683
|
/** @description The sum of prompt and completion tokens. */
|
|
2536
2684
|
total_tokens?: number;
|
|
2537
2685
|
};
|
|
2538
|
-
statistics?: components[
|
|
2686
|
+
statistics?: components['schemas']['ChatCompletionResponseStatistics'];
|
|
2539
2687
|
/** @description Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. */
|
|
2540
2688
|
system_fingerprint?: string;
|
|
2541
2689
|
};
|
|
@@ -2552,7 +2700,7 @@ interface components {
|
|
|
2552
2700
|
* @description The type of action to performed. Use `ADD` to create a publish request. Use `DELETE` to create an unpublish request.
|
|
2553
2701
|
* @enum {string}
|
|
2554
2702
|
*/
|
|
2555
|
-
action?:
|
|
2703
|
+
action?: 'ADD' | 'DELETE' | 'ADD_IF_ABSENT';
|
|
2556
2704
|
/** @description The path to the source of the publication. */
|
|
2557
2705
|
sourceUrl?: string;
|
|
2558
2706
|
/** @description The path to the destination of the publication. */
|
|
@@ -2568,7 +2716,7 @@ interface components {
|
|
|
2568
2716
|
* @description The function.
|
|
2569
2717
|
* @enum {string}
|
|
2570
2718
|
*/
|
|
2571
|
-
function?:
|
|
2719
|
+
function?: 'EQUAL' | 'CONTAIN' | 'REGEX';
|
|
2572
2720
|
/** @description Claim value(s) for authorization using JWT. For authorization with API keys - the roles assigned to API key. */
|
|
2573
2721
|
targets?: string[];
|
|
2574
2722
|
}[];
|
|
@@ -2588,7 +2736,7 @@ interface components {
|
|
|
2588
2736
|
* @description A type of action to performed. Use `ADD` to create a publish request. Use `DELETE` to create an unpublish request.
|
|
2589
2737
|
* @enum {string}
|
|
2590
2738
|
*/
|
|
2591
|
-
action?:
|
|
2739
|
+
action?: 'ADD' | 'DELETE' | 'ADD_IF_ABSENT';
|
|
2592
2740
|
/** @description The path to the source of the publication. */
|
|
2593
2741
|
sourceUrl?: string;
|
|
2594
2742
|
/** @description The path to the destination of the publication. */
|
|
@@ -2604,7 +2752,7 @@ interface components {
|
|
|
2604
2752
|
* @description The function.
|
|
2605
2753
|
* @enum {string}
|
|
2606
2754
|
*/
|
|
2607
|
-
function?:
|
|
2755
|
+
function?: 'EQUAL' | 'CONTAIN' | 'REGEX';
|
|
2608
2756
|
/** @description Claim value(s) for authorization using JWT. For authorization with API keys - the roles assigned to API key. */
|
|
2609
2757
|
targets?: string[];
|
|
2610
2758
|
}[];
|
|
@@ -2629,9 +2777,9 @@ interface components {
|
|
|
2629
2777
|
* @description Publication status.
|
|
2630
2778
|
* @enum {string}
|
|
2631
2779
|
*/
|
|
2632
|
-
status?:
|
|
2780
|
+
status?: 'PENDING' | 'APPROVED' | 'REJECTED';
|
|
2633
2781
|
/** @description The type of resource. */
|
|
2634
|
-
resourceTypes?: (
|
|
2782
|
+
resourceTypes?: ('FILE' | 'PROMPT' | 'CONVERSATION' | 'APPLICATION')[];
|
|
2635
2783
|
}[];
|
|
2636
2784
|
};
|
|
2637
2785
|
/** @description Notifications */
|
|
@@ -2668,14 +2816,14 @@ interface components {
|
|
|
2668
2816
|
* @description Publication status.
|
|
2669
2817
|
* @enum {string}
|
|
2670
2818
|
*/
|
|
2671
|
-
status?:
|
|
2819
|
+
status?: 'PENDING' | 'APPROVED' | 'REJECTED';
|
|
2672
2820
|
/** @description List of resources to be published. */
|
|
2673
2821
|
resources?: {
|
|
2674
2822
|
/**
|
|
2675
2823
|
* @description The type of action to be performed.
|
|
2676
2824
|
* @enum {string}
|
|
2677
2825
|
*/
|
|
2678
|
-
action?:
|
|
2826
|
+
action?: 'ADD' | 'DELETE' | 'ADD_IF_ABSENT';
|
|
2679
2827
|
/** @description The location of the source for the publication resource. */
|
|
2680
2828
|
sourceUrl?: string;
|
|
2681
2829
|
/** @description The path to the destination for the publication. */
|
|
@@ -2684,7 +2832,7 @@ interface components {
|
|
|
2684
2832
|
reviewUrl?: string;
|
|
2685
2833
|
}[];
|
|
2686
2834
|
/** @description The type of resource. */
|
|
2687
|
-
resourceTypes?: (
|
|
2835
|
+
resourceTypes?: ('FILE' | 'PROMPT' | 'CONVERSATION' | 'APPLICATION')[];
|
|
2688
2836
|
/** @description List of rules to restrict access to the published resource. */
|
|
2689
2837
|
rules?: {
|
|
2690
2838
|
/** @description Claim for authorization using JWT. For authorization with API keys the source is `roles`. */
|
|
@@ -2695,7 +2843,7 @@ interface components {
|
|
|
2695
2843
|
* @description The function for the rule.
|
|
2696
2844
|
* @enum {string}
|
|
2697
2845
|
*/
|
|
2698
|
-
function?:
|
|
2846
|
+
function?: 'EQUAL' | 'CONTAIN' | 'REGEX';
|
|
2699
2847
|
}[];
|
|
2700
2848
|
};
|
|
2701
2849
|
/** @description Publications */
|
|
@@ -2716,14 +2864,14 @@ interface components {
|
|
|
2716
2864
|
* @description Publication status.
|
|
2717
2865
|
* @enum {string}
|
|
2718
2866
|
*/
|
|
2719
|
-
status?:
|
|
2867
|
+
status?: 'PENDING' | 'APPROVED' | 'REJECTED';
|
|
2720
2868
|
/** @description List of resources to be published. */
|
|
2721
2869
|
resources?: {
|
|
2722
2870
|
/**
|
|
2723
2871
|
* @description The type of action to be performed.
|
|
2724
2872
|
* @enum {string}
|
|
2725
2873
|
*/
|
|
2726
|
-
action?:
|
|
2874
|
+
action?: 'ADD' | 'DELETE' | 'ADD_IF_ABSENT';
|
|
2727
2875
|
/** @description The location of the source for the publication resource. */
|
|
2728
2876
|
sourceUrl?: string;
|
|
2729
2877
|
/** @description The path to the destination for the publication. */
|
|
@@ -2732,7 +2880,7 @@ interface components {
|
|
|
2732
2880
|
reviewUrl?: string;
|
|
2733
2881
|
}[];
|
|
2734
2882
|
/** @description The type of resource. */
|
|
2735
|
-
resourceTypes?: (
|
|
2883
|
+
resourceTypes?: ('FILE' | 'PROMPT' | 'CONVERSATION' | 'APPLICATION')[];
|
|
2736
2884
|
/** @description List of rules to restrict access to the published resource. */
|
|
2737
2885
|
rules?: {
|
|
2738
2886
|
/** @description Claim for authorization using JWT. For authorization with API keys the source is `roles`. */
|
|
@@ -2743,7 +2891,7 @@ interface components {
|
|
|
2743
2891
|
* @description The function for the rule.
|
|
2744
2892
|
* @enum {string}
|
|
2745
2893
|
*/
|
|
2746
|
-
function?:
|
|
2894
|
+
function?: 'EQUAL' | 'CONTAIN' | 'REGEX';
|
|
2747
2895
|
}[];
|
|
2748
2896
|
};
|
|
2749
2897
|
/** @description Publication rules */
|
|
@@ -2762,7 +2910,7 @@ interface components {
|
|
|
2762
2910
|
* @description The function.
|
|
2763
2911
|
* @enum {string}
|
|
2764
2912
|
*/
|
|
2765
|
-
function?:
|
|
2913
|
+
function?: 'EQUAL' | 'CONTAIN' | 'REGEX';
|
|
2766
2914
|
}[];
|
|
2767
2915
|
} & {
|
|
2768
2916
|
[key: string]: unknown;
|
|
@@ -2805,7 +2953,7 @@ interface components {
|
|
|
2805
2953
|
* @description The object type, which is always `chat.completion.chunk`.
|
|
2806
2954
|
* @enum {string}
|
|
2807
2955
|
*/
|
|
2808
|
-
object:
|
|
2956
|
+
object: 'chat.completion.chunk';
|
|
2809
2957
|
/** @description The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp. */
|
|
2810
2958
|
created: number;
|
|
2811
2959
|
/** @description The model name that generated the response. May not be the same as the deployment name. */
|
|
@@ -2819,7 +2967,7 @@ interface components {
|
|
|
2819
2967
|
choices: {
|
|
2820
2968
|
/** @description The index of the choice from 0 to _n - 1_ */
|
|
2821
2969
|
index: number;
|
|
2822
|
-
delta: components[
|
|
2970
|
+
delta: components['schemas']['ChatCompletionStreamResponseDelta'];
|
|
2823
2971
|
/**
|
|
2824
2972
|
* @description The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,
|
|
2825
2973
|
*
|
|
@@ -2840,7 +2988,7 @@ interface components {
|
|
|
2840
2988
|
/** @description The sum of prompt and completion tokens. */
|
|
2841
2989
|
total_tokens: number;
|
|
2842
2990
|
};
|
|
2843
|
-
statistics?: components[
|
|
2991
|
+
statistics?: components['schemas']['ChatCompletionResponseStatistics'];
|
|
2844
2992
|
};
|
|
2845
2993
|
Error: {
|
|
2846
2994
|
type?: string | null;
|
|
@@ -2867,7 +3015,7 @@ interface components {
|
|
|
2867
3015
|
/** @description Application logs */
|
|
2868
3016
|
ApplicationLogs: {
|
|
2869
3017
|
/** @description log records */
|
|
2870
|
-
logs?: components[
|
|
3018
|
+
logs?: components['schemas']['ApplicationLog'][];
|
|
2871
3019
|
};
|
|
2872
3020
|
ApplicationLog: {
|
|
2873
3021
|
/** @description machine instance ID */
|
|
@@ -2905,6 +3053,54 @@ interface components {
|
|
|
2905
3053
|
/** @description Prompt body */
|
|
2906
3054
|
content: string;
|
|
2907
3055
|
};
|
|
3056
|
+
JsonRpcRequest: {
|
|
3057
|
+
/**
|
|
3058
|
+
* @description JSON-RPC protocol version
|
|
3059
|
+
* @enum {string}
|
|
3060
|
+
*/
|
|
3061
|
+
jsonrpc: '2.0';
|
|
3062
|
+
/** @description Name of the method to be invoked. */
|
|
3063
|
+
method: string;
|
|
3064
|
+
/** @description Parameter values for the RPC call. Can be: `array` (by-position parameters) OR `object` (by-name parameters). */
|
|
3065
|
+
params?: unknown[] | Record<string, never>;
|
|
3066
|
+
/**
|
|
3067
|
+
* @description Identifier established by the client. Must be included in the
|
|
3068
|
+
* response if present. If omitted, it's a notification.
|
|
3069
|
+
*/
|
|
3070
|
+
id?: string | number;
|
|
3071
|
+
};
|
|
3072
|
+
JsonRpcResponse: {
|
|
3073
|
+
/**
|
|
3074
|
+
* @description JSON-RPC protocol version
|
|
3075
|
+
* @enum {string}
|
|
3076
|
+
*/
|
|
3077
|
+
jsonrpc: '2.0';
|
|
3078
|
+
/**
|
|
3079
|
+
* @description The successful result of the RPC call. Must not be included
|
|
3080
|
+
* if `error` is present.
|
|
3081
|
+
*/
|
|
3082
|
+
result?: unknown;
|
|
3083
|
+
/**
|
|
3084
|
+
* @description Error object in case of failure. Must not be included
|
|
3085
|
+
* if `result` is present.
|
|
3086
|
+
*/
|
|
3087
|
+
error?: {
|
|
3088
|
+
/** @description Error code. */
|
|
3089
|
+
code: number;
|
|
3090
|
+
/** @description Error message. */
|
|
3091
|
+
message: string;
|
|
3092
|
+
/** @description Additional error information */
|
|
3093
|
+
data?: unknown;
|
|
3094
|
+
};
|
|
3095
|
+
/**
|
|
3096
|
+
* @description Same `id` as in the request. `Null` for certain errors where the
|
|
3097
|
+
* request `id` cannot be determined.
|
|
3098
|
+
*/
|
|
3099
|
+
id?: string | number;
|
|
3100
|
+
};
|
|
3101
|
+
Deployments: {
|
|
3102
|
+
deployments?: (components['schemas']['ModelOpenAi'] | components['schemas']['ApplicationOpenAi'] | components['schemas']['ToolsetOpenAi'])[];
|
|
3103
|
+
};
|
|
2908
3104
|
};
|
|
2909
3105
|
responses: never;
|
|
2910
3106
|
parameters: never;
|
|
@@ -2920,10 +3116,10 @@ interface operations {
|
|
|
2920
3116
|
* @description The API version to use for this request. Follows the `YYYY-MM-DD[-preview]` format.
|
|
2921
3117
|
* @example 2024-10-21
|
|
2922
3118
|
*/
|
|
2923
|
-
|
|
3119
|
+
'api-version': string;
|
|
2924
3120
|
};
|
|
2925
3121
|
header?: {
|
|
2926
|
-
|
|
3122
|
+
'X-CACHE-POLICY'?: 'availability-priority' | 'cache-priority';
|
|
2927
3123
|
};
|
|
2928
3124
|
path: {
|
|
2929
3125
|
/** @description The name of the deployment. */
|
|
@@ -2933,18 +3129,18 @@ interface operations {
|
|
|
2933
3129
|
};
|
|
2934
3130
|
requestBody: {
|
|
2935
3131
|
content: {
|
|
2936
|
-
|
|
3132
|
+
'application/json': {
|
|
2937
3133
|
/** @description The name of the model to use. */
|
|
2938
3134
|
model?: string;
|
|
2939
3135
|
/** @description A list of messages comprising the conversation so far. */
|
|
2940
|
-
messages: components[
|
|
3136
|
+
messages: components['schemas']['ChatCompletionRequestMessage'][];
|
|
2941
3137
|
/**
|
|
2942
3138
|
* @deprecated
|
|
2943
3139
|
* @description Deprecated in favor of `tools`.
|
|
2944
3140
|
*
|
|
2945
3141
|
* A list of functions the model may generate JSON inputs for.
|
|
2946
3142
|
*/
|
|
2947
|
-
functions?: components[
|
|
3143
|
+
functions?: components['schemas']['ChatCompletionFunction'][];
|
|
2948
3144
|
/**
|
|
2949
3145
|
* @deprecated
|
|
2950
3146
|
* @description Deprecated in favor of `tool_choice`.
|
|
@@ -2959,15 +3155,15 @@ interface operations {
|
|
|
2959
3155
|
*
|
|
2960
3156
|
* `none` is the default when no functions are present. `auto` is the default if functions are present.
|
|
2961
3157
|
*/
|
|
2962
|
-
function_call?: (
|
|
3158
|
+
function_call?: ('none' | 'auto') | components['schemas']['ChatCompletionFunctionCallOption'];
|
|
2963
3159
|
/** @description A list of tools the model may call. Currently, only `functions` are supported as a tool. Use this to provide a list of `functions` the model may generate JSON inputs for. A max of 128 functions are supported. */
|
|
2964
|
-
tools?: components[
|
|
2965
|
-
tool_choice?: components[
|
|
3160
|
+
tools?: components['schemas']['ChatCompletionTool'][];
|
|
3161
|
+
tool_choice?: components['schemas']['ChatCompletionToolChoiceOption'];
|
|
2966
3162
|
/**
|
|
2967
3163
|
* @deprecated
|
|
2968
3164
|
* @description A list of Addons the Assistant can use.
|
|
2969
3165
|
*/
|
|
2970
|
-
addons?: components[
|
|
3166
|
+
addons?: components['schemas']['ChatCompletionAddon'][];
|
|
2971
3167
|
/**
|
|
2972
3168
|
* @description If set, partial message deltas will be sent. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
|
|
2973
3169
|
* @default false
|
|
@@ -2989,7 +3185,7 @@ interface operations {
|
|
|
2989
3185
|
* @example 1
|
|
2990
3186
|
*/
|
|
2991
3187
|
n?: number | null;
|
|
2992
|
-
parallel_tool_calls?: components[
|
|
3188
|
+
parallel_tool_calls?: components['schemas']['ParallelToolCalls'];
|
|
2993
3189
|
/** @description Up to 4 sequences where the Assistant will stop generating further tokens. */
|
|
2994
3190
|
stop?: (string | null) | string[];
|
|
2995
3191
|
/**
|
|
@@ -3028,9 +3224,7 @@ interface operations {
|
|
|
3028
3224
|
* Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from `-100` to `100`. Mathematically, the bias is added to the `logits` generated by the model prior to sampling. The exact effect will vary per model, but values between `-1` and `1` should decrease or increase the likelihood of a selection; values like `-100` or `100` should result in a ban or exclusive selection of the relevant token.
|
|
3029
3225
|
* @default null
|
|
3030
3226
|
*/
|
|
3031
|
-
logit_bias?:
|
|
3032
|
-
[key: string]: unknown;
|
|
3033
|
-
};
|
|
3227
|
+
logit_bias?: Record<string, never>;
|
|
3034
3228
|
/**
|
|
3035
3229
|
* @description This feature is in **Beta**.
|
|
3036
3230
|
*
|
|
@@ -3051,8 +3245,8 @@ interface operations {
|
|
|
3051
3245
|
*
|
|
3052
3246
|
* **Note:** JSON mode is not supported by all models.
|
|
3053
3247
|
*/
|
|
3054
|
-
response_format?: components[
|
|
3055
|
-
custom_fields?: components[
|
|
3248
|
+
response_format?: components['schemas']['ResponseFormatText'] | components['schemas']['ResponseFormatJsonObject'] | components['schemas']['ResponseFormatJsonSchema'];
|
|
3249
|
+
custom_fields?: components['schemas']['ChatCompletionsCustomFields'];
|
|
3056
3250
|
};
|
|
3057
3251
|
};
|
|
3058
3252
|
};
|
|
@@ -3063,8 +3257,8 @@ interface operations {
|
|
|
3063
3257
|
[name: string]: unknown;
|
|
3064
3258
|
};
|
|
3065
3259
|
content: {
|
|
3066
|
-
|
|
3067
|
-
|
|
3260
|
+
'application/json': components['schemas']['CreateChatCompletionResponse'];
|
|
3261
|
+
'text/event-stream': components['schemas']['CreateChatCompletionStreamResponse'][];
|
|
3068
3262
|
};
|
|
3069
3263
|
};
|
|
3070
3264
|
/** @description Invalid Authentication */
|
|
@@ -3073,8 +3267,8 @@ interface operations {
|
|
|
3073
3267
|
[name: string]: unknown;
|
|
3074
3268
|
};
|
|
3075
3269
|
content: {
|
|
3076
|
-
|
|
3077
|
-
error?: components[
|
|
3270
|
+
'application/json': {
|
|
3271
|
+
error?: components['schemas']['Error'];
|
|
3078
3272
|
};
|
|
3079
3273
|
};
|
|
3080
3274
|
};
|
|
@@ -3090,8 +3284,8 @@ interface operations {
|
|
|
3090
3284
|
[name: string]: unknown;
|
|
3091
3285
|
};
|
|
3092
3286
|
content: {
|
|
3093
|
-
|
|
3094
|
-
error?: components[
|
|
3287
|
+
'application/json': {
|
|
3288
|
+
error?: components['schemas']['Error'];
|
|
3095
3289
|
};
|
|
3096
3290
|
};
|
|
3097
3291
|
};
|
|
@@ -3101,8 +3295,8 @@ interface operations {
|
|
|
3101
3295
|
[name: string]: unknown;
|
|
3102
3296
|
};
|
|
3103
3297
|
content: {
|
|
3104
|
-
|
|
3105
|
-
error?: components[
|
|
3298
|
+
'application/json': {
|
|
3299
|
+
error?: components['schemas']['Error'];
|
|
3106
3300
|
};
|
|
3107
3301
|
};
|
|
3108
3302
|
};
|
|
@@ -3112,8 +3306,19 @@ interface operations {
|
|
|
3112
3306
|
[name: string]: unknown;
|
|
3113
3307
|
};
|
|
3114
3308
|
content: {
|
|
3115
|
-
|
|
3116
|
-
error?: components[
|
|
3309
|
+
'application/json': {
|
|
3310
|
+
error?: components['schemas']['Error'];
|
|
3311
|
+
};
|
|
3312
|
+
};
|
|
3313
|
+
};
|
|
3314
|
+
/** @description Failed to connect to upstream server. */
|
|
3315
|
+
502: {
|
|
3316
|
+
headers: {
|
|
3317
|
+
[name: string]: unknown;
|
|
3318
|
+
};
|
|
3319
|
+
content: {
|
|
3320
|
+
'application/json': {
|
|
3321
|
+
error?: components['schemas']['Error'];
|
|
3117
3322
|
};
|
|
3118
3323
|
};
|
|
3119
3324
|
};
|
|
@@ -3123,8 +3328,8 @@ interface operations {
|
|
|
3123
3328
|
[name: string]: unknown;
|
|
3124
3329
|
};
|
|
3125
3330
|
content: {
|
|
3126
|
-
|
|
3127
|
-
error?: components[
|
|
3331
|
+
'application/json': {
|
|
3332
|
+
error?: components['schemas']['Error'];
|
|
3128
3333
|
};
|
|
3129
3334
|
};
|
|
3130
3335
|
};
|
|
@@ -3148,9 +3353,7 @@ interface operations {
|
|
|
3148
3353
|
[name: string]: unknown;
|
|
3149
3354
|
};
|
|
3150
3355
|
content: {
|
|
3151
|
-
|
|
3152
|
-
[key: string]: unknown;
|
|
3153
|
-
};
|
|
3356
|
+
'application/json': Record<string, never>;
|
|
3154
3357
|
};
|
|
3155
3358
|
};
|
|
3156
3359
|
/** @description Invalid Authentication */
|
|
@@ -3169,7 +3372,7 @@ interface operations {
|
|
|
3169
3372
|
* @description The API version to use for this request. Follows the `YYYY-MM-DD[-preview]` format.
|
|
3170
3373
|
* @example 2023-12-01-preview
|
|
3171
3374
|
*/
|
|
3172
|
-
|
|
3375
|
+
'api-version': string;
|
|
3173
3376
|
};
|
|
3174
3377
|
header?: never;
|
|
3175
3378
|
path: {
|
|
@@ -3180,7 +3383,7 @@ interface operations {
|
|
|
3180
3383
|
};
|
|
3181
3384
|
requestBody: {
|
|
3182
3385
|
content: {
|
|
3183
|
-
|
|
3386
|
+
'application/json': components['schemas']['EmbeddingRequest'];
|
|
3184
3387
|
};
|
|
3185
3388
|
};
|
|
3186
3389
|
responses: {
|
|
@@ -3190,7 +3393,7 @@ interface operations {
|
|
|
3190
3393
|
[name: string]: unknown;
|
|
3191
3394
|
};
|
|
3192
3395
|
content: {
|
|
3193
|
-
|
|
3396
|
+
'application/json': components['schemas']['EmbeddingResponse'];
|
|
3194
3397
|
};
|
|
3195
3398
|
};
|
|
3196
3399
|
/** @description Invalid Authentication */
|
|
@@ -3199,8 +3402,8 @@ interface operations {
|
|
|
3199
3402
|
[name: string]: unknown;
|
|
3200
3403
|
};
|
|
3201
3404
|
content: {
|
|
3202
|
-
|
|
3203
|
-
error?: components[
|
|
3405
|
+
'application/json': {
|
|
3406
|
+
error?: components['schemas']['Error'];
|
|
3204
3407
|
};
|
|
3205
3408
|
};
|
|
3206
3409
|
};
|
|
@@ -3216,8 +3419,8 @@ interface operations {
|
|
|
3216
3419
|
[name: string]: unknown;
|
|
3217
3420
|
};
|
|
3218
3421
|
content: {
|
|
3219
|
-
|
|
3220
|
-
error?: components[
|
|
3422
|
+
'application/json': {
|
|
3423
|
+
error?: components['schemas']['Error'];
|
|
3221
3424
|
};
|
|
3222
3425
|
};
|
|
3223
3426
|
};
|
|
@@ -3227,8 +3430,8 @@ interface operations {
|
|
|
3227
3430
|
[name: string]: unknown;
|
|
3228
3431
|
};
|
|
3229
3432
|
content: {
|
|
3230
|
-
|
|
3231
|
-
error?: components[
|
|
3433
|
+
'application/json': {
|
|
3434
|
+
error?: components['schemas']['Error'];
|
|
3232
3435
|
};
|
|
3233
3436
|
};
|
|
3234
3437
|
};
|
|
@@ -3238,8 +3441,8 @@ interface operations {
|
|
|
3238
3441
|
[name: string]: unknown;
|
|
3239
3442
|
};
|
|
3240
3443
|
content: {
|
|
3241
|
-
|
|
3242
|
-
error?: components[
|
|
3444
|
+
'application/json': {
|
|
3445
|
+
error?: components['schemas']['Error'];
|
|
3243
3446
|
};
|
|
3244
3447
|
};
|
|
3245
3448
|
};
|
|
@@ -3249,8 +3452,8 @@ interface operations {
|
|
|
3249
3452
|
[name: string]: unknown;
|
|
3250
3453
|
};
|
|
3251
3454
|
content: {
|
|
3252
|
-
|
|
3253
|
-
error?: components[
|
|
3455
|
+
'application/json': {
|
|
3456
|
+
error?: components['schemas']['Error'];
|
|
3254
3457
|
};
|
|
3255
3458
|
};
|
|
3256
3459
|
};
|
|
@@ -3268,7 +3471,7 @@ interface operations {
|
|
|
3268
3471
|
};
|
|
3269
3472
|
requestBody: {
|
|
3270
3473
|
content: {
|
|
3271
|
-
|
|
3474
|
+
'application/json': {
|
|
3272
3475
|
/** @description True if you like the message and false otherwise */
|
|
3273
3476
|
rate?: boolean;
|
|
3274
3477
|
/** @description Id received in the target chat completion response */
|
|
@@ -3308,7 +3511,7 @@ interface operations {
|
|
|
3308
3511
|
[name: string]: unknown;
|
|
3309
3512
|
};
|
|
3310
3513
|
content: {
|
|
3311
|
-
|
|
3514
|
+
'application/json': components['schemas']['userinfo'];
|
|
3312
3515
|
};
|
|
3313
3516
|
};
|
|
3314
3517
|
/** @description Invalid Authentication */
|
|
@@ -3339,7 +3542,7 @@ interface operations {
|
|
|
3339
3542
|
};
|
|
3340
3543
|
requestBody: {
|
|
3341
3544
|
content: {
|
|
3342
|
-
|
|
3545
|
+
'application/json': string;
|
|
3343
3546
|
};
|
|
3344
3547
|
};
|
|
3345
3548
|
responses: {
|
|
@@ -3349,7 +3552,48 @@ interface operations {
|
|
|
3349
3552
|
[name: string]: unknown;
|
|
3350
3553
|
};
|
|
3351
3554
|
content: {
|
|
3352
|
-
|
|
3555
|
+
'application/json': Record<string, never>;
|
|
3556
|
+
};
|
|
3557
|
+
};
|
|
3558
|
+
/** @description Invalid Authentication */
|
|
3559
|
+
400: {
|
|
3560
|
+
headers: {
|
|
3561
|
+
[name: string]: unknown;
|
|
3562
|
+
};
|
|
3563
|
+
content?: never;
|
|
3564
|
+
};
|
|
3565
|
+
/** @description Unauthorized */
|
|
3566
|
+
401: {
|
|
3567
|
+
headers: {
|
|
3568
|
+
[name: string]: unknown;
|
|
3569
|
+
};
|
|
3570
|
+
content?: never;
|
|
3571
|
+
};
|
|
3572
|
+
};
|
|
3573
|
+
};
|
|
3574
|
+
callMcp: {
|
|
3575
|
+
parameters: {
|
|
3576
|
+
query?: never;
|
|
3577
|
+
header?: never;
|
|
3578
|
+
path: {
|
|
3579
|
+
/** @description The ID of the deployment. */
|
|
3580
|
+
deployment_id: string;
|
|
3581
|
+
};
|
|
3582
|
+
cookie?: never;
|
|
3583
|
+
};
|
|
3584
|
+
requestBody: {
|
|
3585
|
+
content: {
|
|
3586
|
+
'application/json': string;
|
|
3587
|
+
};
|
|
3588
|
+
};
|
|
3589
|
+
responses: {
|
|
3590
|
+
/** @description Success */
|
|
3591
|
+
200: {
|
|
3592
|
+
headers: {
|
|
3593
|
+
[name: string]: unknown;
|
|
3594
|
+
};
|
|
3595
|
+
content: {
|
|
3596
|
+
'application/json': Record<string, never>;
|
|
3353
3597
|
};
|
|
3354
3598
|
};
|
|
3355
3599
|
/** @description Invalid Authentication */
|
|
@@ -3377,7 +3621,7 @@ interface operations {
|
|
|
3377
3621
|
};
|
|
3378
3622
|
requestBody: {
|
|
3379
3623
|
content: {
|
|
3380
|
-
|
|
3624
|
+
'application/json': {
|
|
3381
3625
|
/** @description The application URL. */
|
|
3382
3626
|
url?: string;
|
|
3383
3627
|
};
|
|
@@ -3390,7 +3634,7 @@ interface operations {
|
|
|
3390
3634
|
[name: string]: unknown;
|
|
3391
3635
|
};
|
|
3392
3636
|
content: {
|
|
3393
|
-
|
|
3637
|
+
'application/json': components['schemas']['ApplicationOpenAi'];
|
|
3394
3638
|
};
|
|
3395
3639
|
};
|
|
3396
3640
|
/** @description Bad request */
|
|
@@ -3432,7 +3676,7 @@ interface operations {
|
|
|
3432
3676
|
};
|
|
3433
3677
|
requestBody: {
|
|
3434
3678
|
content: {
|
|
3435
|
-
|
|
3679
|
+
'application/json': {
|
|
3436
3680
|
/** @description The application URL. */
|
|
3437
3681
|
url?: string;
|
|
3438
3682
|
};
|
|
@@ -3445,7 +3689,7 @@ interface operations {
|
|
|
3445
3689
|
[name: string]: unknown;
|
|
3446
3690
|
};
|
|
3447
3691
|
content: {
|
|
3448
|
-
|
|
3692
|
+
'application/json': components['schemas']['ApplicationOpenAi'];
|
|
3449
3693
|
};
|
|
3450
3694
|
};
|
|
3451
3695
|
/** @description Bad request */
|
|
@@ -3487,7 +3731,7 @@ interface operations {
|
|
|
3487
3731
|
};
|
|
3488
3732
|
requestBody: {
|
|
3489
3733
|
content: {
|
|
3490
|
-
|
|
3734
|
+
'application/json': {
|
|
3491
3735
|
/** @description The application URL. */
|
|
3492
3736
|
url?: string;
|
|
3493
3737
|
};
|
|
@@ -3500,7 +3744,7 @@ interface operations {
|
|
|
3500
3744
|
[name: string]: unknown;
|
|
3501
3745
|
};
|
|
3502
3746
|
content: {
|
|
3503
|
-
|
|
3747
|
+
'application/json': components['schemas']['ApplicationOpenAi'];
|
|
3504
3748
|
};
|
|
3505
3749
|
};
|
|
3506
3750
|
/** @description Bad request */
|
|
@@ -3542,7 +3786,7 @@ interface operations {
|
|
|
3542
3786
|
};
|
|
3543
3787
|
requestBody: {
|
|
3544
3788
|
content: {
|
|
3545
|
-
|
|
3789
|
+
'application/json': {
|
|
3546
3790
|
/** @description The application URL. */
|
|
3547
3791
|
url?: string;
|
|
3548
3792
|
};
|
|
@@ -3555,7 +3799,7 @@ interface operations {
|
|
|
3555
3799
|
[name: string]: unknown;
|
|
3556
3800
|
};
|
|
3557
3801
|
content: {
|
|
3558
|
-
|
|
3802
|
+
'application/json': components['schemas']['ApplicationLogs'];
|
|
3559
3803
|
};
|
|
3560
3804
|
};
|
|
3561
3805
|
/** @description Bad request */
|
|
@@ -3603,17 +3847,17 @@ interface operations {
|
|
|
3603
3847
|
[name: string]: unknown;
|
|
3604
3848
|
};
|
|
3605
3849
|
content: {
|
|
3606
|
-
|
|
3850
|
+
'application/json': {
|
|
3607
3851
|
/** @description Unique identifier for the application schema. */
|
|
3608
3852
|
$id?: string;
|
|
3609
3853
|
/** @description Name of the application type displayed on the UI. */
|
|
3610
|
-
|
|
3854
|
+
'dial:applicationTypeDisplayName'?: string;
|
|
3611
3855
|
/** @description URL for the UI of the application type. */
|
|
3612
|
-
|
|
3856
|
+
'dial:applicationTypeViewerUrl'?: string;
|
|
3613
3857
|
/** @description URL for the application builder used by the app type. */
|
|
3614
|
-
|
|
3858
|
+
'dial:applicationTypeEditorUrl'?: string;
|
|
3615
3859
|
/** @description URL to retrieve JSON schema of the application. */
|
|
3616
|
-
|
|
3860
|
+
'dial:applicationTypeSchemaEndpoint'?: string;
|
|
3617
3861
|
}[];
|
|
3618
3862
|
};
|
|
3619
3863
|
};
|
|
@@ -3648,7 +3892,7 @@ interface operations {
|
|
|
3648
3892
|
[name: string]: unknown;
|
|
3649
3893
|
};
|
|
3650
3894
|
content: {
|
|
3651
|
-
|
|
3895
|
+
'application/json': Record<string, never>;
|
|
3652
3896
|
};
|
|
3653
3897
|
};
|
|
3654
3898
|
/** @description Invalid Authentication */
|
|
@@ -3685,7 +3929,7 @@ interface operations {
|
|
|
3685
3929
|
[name: string]: unknown;
|
|
3686
3930
|
};
|
|
3687
3931
|
content: {
|
|
3688
|
-
|
|
3932
|
+
'application/json': Record<string, never>;
|
|
3689
3933
|
};
|
|
3690
3934
|
};
|
|
3691
3935
|
/** @description Bad request */
|
|
@@ -3731,7 +3975,7 @@ interface operations {
|
|
|
3731
3975
|
[name: string]: unknown;
|
|
3732
3976
|
};
|
|
3733
3977
|
content: {
|
|
3734
|
-
|
|
3978
|
+
'application/json': string;
|
|
3735
3979
|
};
|
|
3736
3980
|
};
|
|
3737
3981
|
/** @description Invalid Authentication */
|
|
@@ -3752,12 +3996,12 @@ interface operations {
|
|
|
3752
3996
|
* If the application does not exist, this header is ignored.
|
|
3753
3997
|
* If this header is not provided or the value is "*", any existing application at the specified path will be overwritten.
|
|
3754
3998
|
*/
|
|
3755
|
-
|
|
3999
|
+
'If-Match'?: string;
|
|
3756
4000
|
/**
|
|
3757
4001
|
* @description The entity tag (ETag) used to ensure that the application is only uploaded if it does not already exist.
|
|
3758
4002
|
* The only supported value is "*".
|
|
3759
4003
|
*/
|
|
3760
|
-
|
|
4004
|
+
'If-None-Match'?: string;
|
|
3761
4005
|
};
|
|
3762
4006
|
path: {
|
|
3763
4007
|
/** @description The target bucket. */
|
|
@@ -3769,7 +4013,7 @@ interface operations {
|
|
|
3769
4013
|
};
|
|
3770
4014
|
requestBody: {
|
|
3771
4015
|
content: {
|
|
3772
|
-
|
|
4016
|
+
'application/json': string;
|
|
3773
4017
|
};
|
|
3774
4018
|
};
|
|
3775
4019
|
responses: {
|
|
@@ -3779,7 +4023,7 @@ interface operations {
|
|
|
3779
4023
|
[name: string]: unknown;
|
|
3780
4024
|
};
|
|
3781
4025
|
content: {
|
|
3782
|
-
|
|
4026
|
+
'application/json': {
|
|
3783
4027
|
name?: string;
|
|
3784
4028
|
author?: string;
|
|
3785
4029
|
parentPath?: string;
|
|
@@ -3813,7 +4057,7 @@ interface operations {
|
|
|
3813
4057
|
query?: never;
|
|
3814
4058
|
header?: {
|
|
3815
4059
|
/** @description The entity tag (ETag) of the application. This is used for conditional requests to ensure that the application is only deleted if it matches the specified ETag. */
|
|
3816
|
-
|
|
4060
|
+
'If-Match'?: string;
|
|
3817
4061
|
};
|
|
3818
4062
|
path: {
|
|
3819
4063
|
/** @description The target bucket. */
|
|
@@ -3881,7 +4125,7 @@ interface operations {
|
|
|
3881
4125
|
[name: string]: unknown;
|
|
3882
4126
|
};
|
|
3883
4127
|
content: {
|
|
3884
|
-
|
|
4128
|
+
'application/json': {
|
|
3885
4129
|
name?: string;
|
|
3886
4130
|
/** @description This field is not available for folders. */
|
|
3887
4131
|
author?: string;
|
|
@@ -3896,7 +4140,7 @@ interface operations {
|
|
|
3896
4140
|
/** @description The creation time is not supported by all storage providers. */
|
|
3897
4141
|
createdAt?: number;
|
|
3898
4142
|
updatedAt?: number;
|
|
3899
|
-
permissions?: (
|
|
4143
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
3900
4144
|
items?: {
|
|
3901
4145
|
name?: string;
|
|
3902
4146
|
parentPath?: string;
|
|
@@ -3906,7 +4150,7 @@ interface operations {
|
|
|
3906
4150
|
resourceType?: string;
|
|
3907
4151
|
createdAt?: number;
|
|
3908
4152
|
updatedAt?: number;
|
|
3909
|
-
permissions?: (
|
|
4153
|
+
permissions?: ('READ' | 'WRITE')[];
|
|
3910
4154
|
}[];
|
|
3911
4155
|
/** @description An optional field that can be used to request next items if present. */
|
|
3912
4156
|
nextToken?: string;
|
|
@@ -3937,7 +4181,7 @@ interface operations {
|
|
|
3937
4181
|
[name: string]: unknown;
|
|
3938
4182
|
};
|
|
3939
4183
|
content: {
|
|
3940
|
-
|
|
4184
|
+
'application/json': {
|
|
3941
4185
|
bucket: string;
|
|
3942
4186
|
/** @description Bucket of the root user, allowing to manage user files in the assistant folder. Exists only for requests made using temporary api-key that were generated for the request to the dial assistants. */
|
|
3943
4187
|
appdata?: string;
|
|
@@ -3973,7 +4217,7 @@ interface operations {
|
|
|
3973
4217
|
[name: string]: unknown;
|
|
3974
4218
|
};
|
|
3975
4219
|
content: {
|
|
3976
|
-
|
|
4220
|
+
'application/octet-stream': string;
|
|
3977
4221
|
};
|
|
3978
4222
|
};
|
|
3979
4223
|
/** @description Invalid Authentication */
|
|
@@ -3991,15 +4235,15 @@ interface operations {
|
|
|
3991
4235
|
header?: {
|
|
3992
4236
|
/**
|
|
3993
4237
|
* @description The entity tag (ETag) of the file. This is used for conditional requests to ensure that the file is only uploaded if it matches the specified ETag.
|
|
3994
|
-
* If the file does not exist, this header is
|
|
4238
|
+
* If the file does not exist, and this header is provided, the request returns 412 Precondition Failed response.
|
|
3995
4239
|
* If this header is not provided or the value is "*", any existing file at the specified path will be overwritten.
|
|
3996
4240
|
*/
|
|
3997
|
-
|
|
4241
|
+
'If-Match'?: string;
|
|
3998
4242
|
/**
|
|
3999
4243
|
* @description The entity tag (ETag) used to ensure that the file is only uploaded if it does not already exist.
|
|
4000
4244
|
* The only supported value is "*".
|
|
4001
4245
|
*/
|
|
4002
|
-
|
|
4246
|
+
'If-None-Match'?: string;
|
|
4003
4247
|
};
|
|
4004
4248
|
path: {
|
|
4005
4249
|
/** @description The target bucket. */
|
|
@@ -4011,7 +4255,7 @@ interface operations {
|
|
|
4011
4255
|
};
|
|
4012
4256
|
requestBody: {
|
|
4013
4257
|
content: {
|
|
4014
|
-
|
|
4258
|
+
'multipart/form-data': {
|
|
4015
4259
|
/**
|
|
4016
4260
|
* Format: binary
|
|
4017
4261
|
* @description A part of multipart/form-data request
|
|
@@ -4027,7 +4271,7 @@ interface operations {
|
|
|
4027
4271
|
[name: string]: unknown;
|
|
4028
4272
|
};
|
|
4029
4273
|
content: {
|
|
4030
|
-
|
|
4274
|
+
'application/json': {
|
|
4031
4275
|
name?: string;
|
|
4032
4276
|
parentPath?: string;
|
|
4033
4277
|
bucket?: string;
|
|
@@ -4060,7 +4304,7 @@ interface operations {
|
|
|
4060
4304
|
query?: never;
|
|
4061
4305
|
header?: {
|
|
4062
4306
|
/** @description The entity tag (ETag) of the file. This is used for conditional requests to ensure that the file is only deleted if it matches the specified ETag. */
|
|
4063
|
-
|
|
4307
|
+
'If-Match'?: string;
|
|
4064
4308
|
};
|
|
4065
4309
|
path: {
|
|
4066
4310
|
/** @description The target bucket. */
|
|
@@ -4128,7 +4372,7 @@ interface operations {
|
|
|
4128
4372
|
[name: string]: unknown;
|
|
4129
4373
|
};
|
|
4130
4374
|
content: {
|
|
4131
|
-
|
|
4375
|
+
'application/json': {
|
|
4132
4376
|
name?: string;
|
|
4133
4377
|
/** @description This field is not available for folders. */
|
|
4134
4378
|
author?: string;
|
|
@@ -4144,7 +4388,7 @@ interface operations {
|
|
|
4144
4388
|
updatedAt?: number;
|
|
4145
4389
|
contentLength?: number;
|
|
4146
4390
|
contentType?: string;
|
|
4147
|
-
permissions?: (
|
|
4391
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
4148
4392
|
/** @description This field is only available for folders. */
|
|
4149
4393
|
items?: {
|
|
4150
4394
|
name?: string;
|
|
@@ -4157,7 +4401,7 @@ interface operations {
|
|
|
4157
4401
|
updatedAt?: number;
|
|
4158
4402
|
contentLength?: number;
|
|
4159
4403
|
contentType?: string;
|
|
4160
|
-
permissions?: (
|
|
4404
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
4161
4405
|
}[];
|
|
4162
4406
|
};
|
|
4163
4407
|
};
|
|
@@ -4180,7 +4424,7 @@ interface operations {
|
|
|
4180
4424
|
};
|
|
4181
4425
|
requestBody: {
|
|
4182
4426
|
content: {
|
|
4183
|
-
|
|
4427
|
+
'application/json': {
|
|
4184
4428
|
/** @description Source URL. Must belong to the user. */
|
|
4185
4429
|
sourceUrl?: string;
|
|
4186
4430
|
/** @description Destination URL. Must belong to the user and be of the same type as the source URL. */
|
|
@@ -4223,7 +4467,7 @@ interface operations {
|
|
|
4223
4467
|
};
|
|
4224
4468
|
requestBody: {
|
|
4225
4469
|
content: {
|
|
4226
|
-
|
|
4470
|
+
'application/json': {
|
|
4227
4471
|
/** @description Source URL. Must belong to the user. */
|
|
4228
4472
|
sourceUrl?: string;
|
|
4229
4473
|
/** @description Destination URL. Must belong to the user and be of the same type as the source URL. */
|
|
@@ -4277,7 +4521,7 @@ interface operations {
|
|
|
4277
4521
|
[name: string]: unknown;
|
|
4278
4522
|
};
|
|
4279
4523
|
content: {
|
|
4280
|
-
|
|
4524
|
+
'application/json': string;
|
|
4281
4525
|
};
|
|
4282
4526
|
};
|
|
4283
4527
|
/** @description Invalid Authentication */
|
|
@@ -4298,12 +4542,12 @@ interface operations {
|
|
|
4298
4542
|
* If the conversation does not exist, this header is ignored.
|
|
4299
4543
|
* If this header is not provided or the value is "*", any existing conversation at the specified path will be overwritten.
|
|
4300
4544
|
*/
|
|
4301
|
-
|
|
4545
|
+
'If-Match'?: string;
|
|
4302
4546
|
/**
|
|
4303
4547
|
* @description The entity tag (ETag) used to ensure that the conversation is only uploaded if it does not already exist.
|
|
4304
4548
|
* The only supported value is "*".
|
|
4305
4549
|
*/
|
|
4306
|
-
|
|
4550
|
+
'If-None-Match'?: string;
|
|
4307
4551
|
};
|
|
4308
4552
|
path: {
|
|
4309
4553
|
/** @description The target bucket. */
|
|
@@ -4315,7 +4559,7 @@ interface operations {
|
|
|
4315
4559
|
};
|
|
4316
4560
|
requestBody: {
|
|
4317
4561
|
content: {
|
|
4318
|
-
|
|
4562
|
+
'application/json': string;
|
|
4319
4563
|
};
|
|
4320
4564
|
};
|
|
4321
4565
|
responses: {
|
|
@@ -4325,7 +4569,7 @@ interface operations {
|
|
|
4325
4569
|
[name: string]: unknown;
|
|
4326
4570
|
};
|
|
4327
4571
|
content: {
|
|
4328
|
-
|
|
4572
|
+
'application/json': {
|
|
4329
4573
|
name?: string;
|
|
4330
4574
|
parentPath?: string;
|
|
4331
4575
|
bucket?: string;
|
|
@@ -4358,7 +4602,7 @@ interface operations {
|
|
|
4358
4602
|
query?: never;
|
|
4359
4603
|
header?: {
|
|
4360
4604
|
/** @description The entity tag (ETag) of the conversation. This is used for conditional requests to ensure that the conversation is only deleted if it matches the specified ETag. */
|
|
4361
|
-
|
|
4605
|
+
'If-Match'?: string;
|
|
4362
4606
|
};
|
|
4363
4607
|
path: {
|
|
4364
4608
|
/** @description The target bucket. */
|
|
@@ -4426,7 +4670,7 @@ interface operations {
|
|
|
4426
4670
|
[name: string]: unknown;
|
|
4427
4671
|
};
|
|
4428
4672
|
content: {
|
|
4429
|
-
|
|
4673
|
+
'application/json': {
|
|
4430
4674
|
name?: string;
|
|
4431
4675
|
/** @description This field is not available for folders. */
|
|
4432
4676
|
author?: string;
|
|
@@ -4440,7 +4684,7 @@ interface operations {
|
|
|
4440
4684
|
/** @description The creation time is not supported by all storage providers. */
|
|
4441
4685
|
createdAt?: number;
|
|
4442
4686
|
updatedAt?: number;
|
|
4443
|
-
permissions?: (
|
|
4687
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
4444
4688
|
items?: {
|
|
4445
4689
|
name?: string;
|
|
4446
4690
|
parentPath?: string;
|
|
@@ -4450,7 +4694,7 @@ interface operations {
|
|
|
4450
4694
|
resourceType?: string;
|
|
4451
4695
|
createdAt?: number;
|
|
4452
4696
|
updatedAt?: number;
|
|
4453
|
-
permissions?: (
|
|
4697
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
4454
4698
|
}[];
|
|
4455
4699
|
/** @description An optional field that can be used to request next items if present. */
|
|
4456
4700
|
nextToken?: string;
|
|
@@ -4486,7 +4730,7 @@ interface operations {
|
|
|
4486
4730
|
[name: string]: unknown;
|
|
4487
4731
|
};
|
|
4488
4732
|
content: {
|
|
4489
|
-
|
|
4733
|
+
'application/json': {
|
|
4490
4734
|
/** @description Prompt unique identifier */
|
|
4491
4735
|
id?: string;
|
|
4492
4736
|
/** @description Path to the folder where prompt located according to the user's root */
|
|
@@ -4516,12 +4760,12 @@ interface operations {
|
|
|
4516
4760
|
* If the prompt does not exist, this header is ignored.
|
|
4517
4761
|
* If this header is not provided or the value is "*", any existing prompt at the specified path will be overwritten.
|
|
4518
4762
|
*/
|
|
4519
|
-
|
|
4763
|
+
'If-Match'?: string;
|
|
4520
4764
|
/**
|
|
4521
4765
|
* @description The entity tag (ETag) used to ensure that the prompt is only uploaded if it does not already exist.
|
|
4522
4766
|
* The only supported value is "*".
|
|
4523
4767
|
*/
|
|
4524
|
-
|
|
4768
|
+
'If-None-Match'?: string;
|
|
4525
4769
|
};
|
|
4526
4770
|
path: {
|
|
4527
4771
|
/** @description The target bucket. */
|
|
@@ -4533,7 +4777,7 @@ interface operations {
|
|
|
4533
4777
|
};
|
|
4534
4778
|
requestBody: {
|
|
4535
4779
|
content: {
|
|
4536
|
-
|
|
4780
|
+
'application/json': components['schemas']['PromptRequest'];
|
|
4537
4781
|
};
|
|
4538
4782
|
};
|
|
4539
4783
|
responses: {
|
|
@@ -4543,7 +4787,7 @@ interface operations {
|
|
|
4543
4787
|
[name: string]: unknown;
|
|
4544
4788
|
};
|
|
4545
4789
|
content: {
|
|
4546
|
-
|
|
4790
|
+
'application/json': {
|
|
4547
4791
|
/** @description Resource name provided in the prompt path */
|
|
4548
4792
|
name?: string;
|
|
4549
4793
|
/** @description Relative path to the resource starting with the bucket identifier */
|
|
@@ -4556,7 +4800,7 @@ interface operations {
|
|
|
4556
4800
|
* @description A node type
|
|
4557
4801
|
* @enum {string}
|
|
4558
4802
|
*/
|
|
4559
|
-
nodeType?:
|
|
4803
|
+
nodeType?: 'ITEM' | 'FOLDER';
|
|
4560
4804
|
/** @description A resource type */
|
|
4561
4805
|
resourceType?: string;
|
|
4562
4806
|
/** @description This field is not available for folders. */
|
|
@@ -4564,7 +4808,7 @@ interface operations {
|
|
|
4564
4808
|
/** @description The creation time is not supported by all storage providers. */
|
|
4565
4809
|
createdAt?: number;
|
|
4566
4810
|
updatedAt?: number;
|
|
4567
|
-
permissions?: (
|
|
4811
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
4568
4812
|
};
|
|
4569
4813
|
};
|
|
4570
4814
|
};
|
|
@@ -4589,7 +4833,7 @@ interface operations {
|
|
|
4589
4833
|
query?: never;
|
|
4590
4834
|
header?: {
|
|
4591
4835
|
/** @description The entity tag (ETag) of the prompt. This is used for conditional requests to ensure that the prompt is only deleted if it matches the specified ETag. */
|
|
4592
|
-
|
|
4836
|
+
'If-Match'?: string;
|
|
4593
4837
|
};
|
|
4594
4838
|
path: {
|
|
4595
4839
|
/** @description The target bucket. */
|
|
@@ -4657,7 +4901,7 @@ interface operations {
|
|
|
4657
4901
|
[name: string]: unknown;
|
|
4658
4902
|
};
|
|
4659
4903
|
content: {
|
|
4660
|
-
|
|
4904
|
+
'application/json': {
|
|
4661
4905
|
name?: string;
|
|
4662
4906
|
author?: string;
|
|
4663
4907
|
parentPath?: string;
|
|
@@ -4714,7 +4958,7 @@ interface operations {
|
|
|
4714
4958
|
[name: string]: unknown;
|
|
4715
4959
|
};
|
|
4716
4960
|
content: {
|
|
4717
|
-
|
|
4961
|
+
'application/json': components['schemas']['Toolset'];
|
|
4718
4962
|
};
|
|
4719
4963
|
};
|
|
4720
4964
|
/** @description Invalid Authentication */
|
|
@@ -4723,8 +4967,8 @@ interface operations {
|
|
|
4723
4967
|
[name: string]: unknown;
|
|
4724
4968
|
};
|
|
4725
4969
|
content: {
|
|
4726
|
-
|
|
4727
|
-
error?: components[
|
|
4970
|
+
'application/json': {
|
|
4971
|
+
error?: components['schemas']['Error'];
|
|
4728
4972
|
};
|
|
4729
4973
|
};
|
|
4730
4974
|
};
|
|
@@ -4739,12 +4983,12 @@ interface operations {
|
|
|
4739
4983
|
* If the toolset does not exist, this header is ignored.
|
|
4740
4984
|
* If this header is not provided or the value is "*", any existing toolset at the specified path will be overwritten.
|
|
4741
4985
|
*/
|
|
4742
|
-
|
|
4986
|
+
'If-Match'?: string;
|
|
4743
4987
|
/**
|
|
4744
4988
|
* @description The entity tag (ETag) used to ensure that the toolset is only uploaded if it does not already exist.
|
|
4745
4989
|
* The only supported value is "*".
|
|
4746
4990
|
*/
|
|
4747
|
-
|
|
4991
|
+
'If-None-Match'?: string;
|
|
4748
4992
|
};
|
|
4749
4993
|
path: {
|
|
4750
4994
|
/** @description The target bucket. */
|
|
@@ -4756,7 +5000,7 @@ interface operations {
|
|
|
4756
5000
|
};
|
|
4757
5001
|
requestBody: {
|
|
4758
5002
|
content: {
|
|
4759
|
-
|
|
5003
|
+
'application/json': components['schemas']['Toolset'];
|
|
4760
5004
|
};
|
|
4761
5005
|
};
|
|
4762
5006
|
responses: {
|
|
@@ -4766,7 +5010,7 @@ interface operations {
|
|
|
4766
5010
|
[name: string]: unknown;
|
|
4767
5011
|
};
|
|
4768
5012
|
content: {
|
|
4769
|
-
|
|
5013
|
+
'application/json': {
|
|
4770
5014
|
name?: string;
|
|
4771
5015
|
author?: string;
|
|
4772
5016
|
parentPath?: string;
|
|
@@ -4786,8 +5030,8 @@ interface operations {
|
|
|
4786
5030
|
[name: string]: unknown;
|
|
4787
5031
|
};
|
|
4788
5032
|
content: {
|
|
4789
|
-
|
|
4790
|
-
error?: components[
|
|
5033
|
+
'application/json': {
|
|
5034
|
+
error?: components['schemas']['Error'];
|
|
4791
5035
|
};
|
|
4792
5036
|
};
|
|
4793
5037
|
};
|
|
@@ -4798,7 +5042,7 @@ interface operations {
|
|
|
4798
5042
|
query?: never;
|
|
4799
5043
|
header?: {
|
|
4800
5044
|
/** @description The entity tag (ETag) of the toolset. This is used for conditional requests to ensure that the toolset is only deleted if it matches the specified ETag. */
|
|
4801
|
-
|
|
5045
|
+
'If-Match'?: string;
|
|
4802
5046
|
};
|
|
4803
5047
|
path: {
|
|
4804
5048
|
/** @description The target bucket. */
|
|
@@ -4833,6 +5077,101 @@ interface operations {
|
|
|
4833
5077
|
};
|
|
4834
5078
|
};
|
|
4835
5079
|
};
|
|
5080
|
+
getAllToolSetTools: {
|
|
5081
|
+
parameters: {
|
|
5082
|
+
query?: never;
|
|
5083
|
+
header?: never;
|
|
5084
|
+
path: {
|
|
5085
|
+
/** @description The target toolset ID. The parameter specifies the unique identifier of the toolset. */
|
|
5086
|
+
toolset_id: string;
|
|
5087
|
+
};
|
|
5088
|
+
cookie?: never;
|
|
5089
|
+
};
|
|
5090
|
+
requestBody?: never;
|
|
5091
|
+
responses: {
|
|
5092
|
+
/** @description Success */
|
|
5093
|
+
200: {
|
|
5094
|
+
headers: {
|
|
5095
|
+
[name: string]: unknown;
|
|
5096
|
+
};
|
|
5097
|
+
content: {
|
|
5098
|
+
'application/json': {
|
|
5099
|
+
id?: string;
|
|
5100
|
+
result?: {
|
|
5101
|
+
tools?: {
|
|
5102
|
+
name?: string;
|
|
5103
|
+
title?: string;
|
|
5104
|
+
}[];
|
|
5105
|
+
};
|
|
5106
|
+
};
|
|
5107
|
+
};
|
|
5108
|
+
};
|
|
5109
|
+
/** @description Forbidden */
|
|
5110
|
+
403: {
|
|
5111
|
+
headers: {
|
|
5112
|
+
[name: string]: unknown;
|
|
5113
|
+
};
|
|
5114
|
+
content: {
|
|
5115
|
+
'application/json': {
|
|
5116
|
+
error?: components['schemas']['Error'];
|
|
5117
|
+
};
|
|
5118
|
+
};
|
|
5119
|
+
};
|
|
5120
|
+
};
|
|
5121
|
+
};
|
|
5122
|
+
getAllToolSetAllowedTools: {
|
|
5123
|
+
parameters: {
|
|
5124
|
+
query?: never;
|
|
5125
|
+
header?: never;
|
|
5126
|
+
path: {
|
|
5127
|
+
/** @description The target toolset ID. The parameter specifies the unique identifier of the toolset. */
|
|
5128
|
+
toolset_id: string;
|
|
5129
|
+
};
|
|
5130
|
+
cookie?: never;
|
|
5131
|
+
};
|
|
5132
|
+
requestBody?: never;
|
|
5133
|
+
responses: {
|
|
5134
|
+
/** @description Success */
|
|
5135
|
+
200: {
|
|
5136
|
+
headers: {
|
|
5137
|
+
[name: string]: unknown;
|
|
5138
|
+
};
|
|
5139
|
+
content: {
|
|
5140
|
+
'application/json': {
|
|
5141
|
+
id?: string;
|
|
5142
|
+
result?: {
|
|
5143
|
+
tools?: {
|
|
5144
|
+
name?: string;
|
|
5145
|
+
title?: string;
|
|
5146
|
+
}[];
|
|
5147
|
+
};
|
|
5148
|
+
};
|
|
5149
|
+
};
|
|
5150
|
+
};
|
|
5151
|
+
/** @description Bad request */
|
|
5152
|
+
400: {
|
|
5153
|
+
headers: {
|
|
5154
|
+
[name: string]: unknown;
|
|
5155
|
+
};
|
|
5156
|
+
content: {
|
|
5157
|
+
'application/json': {
|
|
5158
|
+
error?: components['schemas']['Error'];
|
|
5159
|
+
};
|
|
5160
|
+
};
|
|
5161
|
+
};
|
|
5162
|
+
/** @description Invalid Authentication */
|
|
5163
|
+
401: {
|
|
5164
|
+
headers: {
|
|
5165
|
+
[name: string]: unknown;
|
|
5166
|
+
};
|
|
5167
|
+
content: {
|
|
5168
|
+
'application/json': {
|
|
5169
|
+
error?: components['schemas']['Error'];
|
|
5170
|
+
};
|
|
5171
|
+
};
|
|
5172
|
+
};
|
|
5173
|
+
};
|
|
5174
|
+
};
|
|
4836
5175
|
toolsetSignin: {
|
|
4837
5176
|
parameters: {
|
|
4838
5177
|
query?: never;
|
|
@@ -4842,19 +5181,19 @@ interface operations {
|
|
|
4842
5181
|
};
|
|
4843
5182
|
requestBody: {
|
|
4844
5183
|
content: {
|
|
4845
|
-
|
|
5184
|
+
'application/json': {
|
|
4846
5185
|
/** @description The Toolset URL (e.g., toolsets/{bucket}/{path}). */
|
|
4847
5186
|
url: string;
|
|
4848
5187
|
/**
|
|
4849
5188
|
* @description The scope of credentials for the Toolset.
|
|
4850
5189
|
* @enum {string}
|
|
4851
5190
|
*/
|
|
4852
|
-
credentials_level:
|
|
5191
|
+
credentials_level: 'GLOBAL' | 'APP' | 'USER';
|
|
4853
5192
|
/**
|
|
4854
5193
|
* @description The authentication method.
|
|
4855
5194
|
* @enum {string}
|
|
4856
5195
|
*/
|
|
4857
|
-
authentication_type:
|
|
5196
|
+
authentication_type: 'OAUTH' | 'API_KEY';
|
|
4858
5197
|
/** @description The authorization code (OAUTH only). */
|
|
4859
5198
|
code?: string;
|
|
4860
5199
|
/** @description The API key value (API_KEY only). */
|
|
@@ -4869,7 +5208,7 @@ interface operations {
|
|
|
4869
5208
|
[name: string]: unknown;
|
|
4870
5209
|
};
|
|
4871
5210
|
content: {
|
|
4872
|
-
|
|
5211
|
+
'application/json': {
|
|
4873
5212
|
/** @description Signin status. */
|
|
4874
5213
|
status?: string;
|
|
4875
5214
|
};
|
|
@@ -4914,19 +5253,19 @@ interface operations {
|
|
|
4914
5253
|
};
|
|
4915
5254
|
requestBody: {
|
|
4916
5255
|
content: {
|
|
4917
|
-
|
|
5256
|
+
'application/json': {
|
|
4918
5257
|
/** @description The Toolset URL (e.g., toolsets/{bucket}/{path}). */
|
|
4919
5258
|
url: string;
|
|
4920
5259
|
/**
|
|
4921
5260
|
* @description The scope of credentials for the Toolset.
|
|
4922
5261
|
* @enum {string}
|
|
4923
5262
|
*/
|
|
4924
|
-
credentials_level:
|
|
5263
|
+
credentials_level: 'GLOBAL' | 'APP' | 'USER';
|
|
4925
5264
|
/**
|
|
4926
5265
|
* @description The authentication method.
|
|
4927
5266
|
* @enum {string}
|
|
4928
5267
|
*/
|
|
4929
|
-
authentication_type:
|
|
5268
|
+
authentication_type: 'OAUTH' | 'API_KEY';
|
|
4930
5269
|
};
|
|
4931
5270
|
};
|
|
4932
5271
|
};
|
|
@@ -4937,7 +5276,7 @@ interface operations {
|
|
|
4937
5276
|
[name: string]: unknown;
|
|
4938
5277
|
};
|
|
4939
5278
|
content: {
|
|
4940
|
-
|
|
5279
|
+
'application/json': {
|
|
4941
5280
|
/** @description Signout status. */
|
|
4942
5281
|
status?: string;
|
|
4943
5282
|
};
|
|
@@ -5006,7 +5345,7 @@ interface operations {
|
|
|
5006
5345
|
[name: string]: unknown;
|
|
5007
5346
|
};
|
|
5008
5347
|
content: {
|
|
5009
|
-
|
|
5348
|
+
'application/json': {
|
|
5010
5349
|
name?: string;
|
|
5011
5350
|
author?: string;
|
|
5012
5351
|
parentPath?: string;
|
|
@@ -5052,7 +5391,7 @@ interface operations {
|
|
|
5052
5391
|
};
|
|
5053
5392
|
requestBody: {
|
|
5054
5393
|
content: {
|
|
5055
|
-
|
|
5394
|
+
'application/json': {
|
|
5056
5395
|
/** @description The publication URL. For admins it is `publications/public/`. For users it is `publications/user_bucket/`. */
|
|
5057
5396
|
url?: string;
|
|
5058
5397
|
};
|
|
@@ -5065,7 +5404,7 @@ interface operations {
|
|
|
5065
5404
|
[name: string]: unknown;
|
|
5066
5405
|
};
|
|
5067
5406
|
content: {
|
|
5068
|
-
|
|
5407
|
+
'application/json': components['schemas']['PublicationResponse'];
|
|
5069
5408
|
};
|
|
5070
5409
|
};
|
|
5071
5410
|
/** @description Bad request */
|
|
@@ -5107,7 +5446,7 @@ interface operations {
|
|
|
5107
5446
|
};
|
|
5108
5447
|
requestBody: {
|
|
5109
5448
|
content: {
|
|
5110
|
-
|
|
5449
|
+
'application/json': {
|
|
5111
5450
|
/** @description The publication request. Template is `publications/bucketId/requestId`. */
|
|
5112
5451
|
url?: string;
|
|
5113
5452
|
};
|
|
@@ -5120,7 +5459,7 @@ interface operations {
|
|
|
5120
5459
|
[name: string]: unknown;
|
|
5121
5460
|
};
|
|
5122
5461
|
content: {
|
|
5123
|
-
|
|
5462
|
+
'application/json': components['schemas']['GetPublicationResponseObject'];
|
|
5124
5463
|
};
|
|
5125
5464
|
};
|
|
5126
5465
|
/** @description Bad request */
|
|
@@ -5162,7 +5501,7 @@ interface operations {
|
|
|
5162
5501
|
};
|
|
5163
5502
|
requestBody?: {
|
|
5164
5503
|
content: {
|
|
5165
|
-
|
|
5504
|
+
'application/json': components['schemas']['PublicationRequest'];
|
|
5166
5505
|
};
|
|
5167
5506
|
};
|
|
5168
5507
|
responses: {
|
|
@@ -5172,7 +5511,7 @@ interface operations {
|
|
|
5172
5511
|
[name: string]: unknown;
|
|
5173
5512
|
};
|
|
5174
5513
|
content: {
|
|
5175
|
-
|
|
5514
|
+
'application/json': components['schemas']['PublicationResponseObject'];
|
|
5176
5515
|
};
|
|
5177
5516
|
};
|
|
5178
5517
|
/** @description Bad request */
|
|
@@ -5214,7 +5553,7 @@ interface operations {
|
|
|
5214
5553
|
};
|
|
5215
5554
|
requestBody?: {
|
|
5216
5555
|
content: {
|
|
5217
|
-
|
|
5556
|
+
'application/json': components['schemas']['UpdatePublicationRequest'];
|
|
5218
5557
|
};
|
|
5219
5558
|
};
|
|
5220
5559
|
responses: {
|
|
@@ -5224,7 +5563,7 @@ interface operations {
|
|
|
5224
5563
|
[name: string]: unknown;
|
|
5225
5564
|
};
|
|
5226
5565
|
content: {
|
|
5227
|
-
|
|
5566
|
+
'application/json': components['schemas']['PublicationResponseObject'];
|
|
5228
5567
|
};
|
|
5229
5568
|
};
|
|
5230
5569
|
/** @description Bad request */
|
|
@@ -5266,7 +5605,7 @@ interface operations {
|
|
|
5266
5605
|
};
|
|
5267
5606
|
requestBody: {
|
|
5268
5607
|
content: {
|
|
5269
|
-
|
|
5608
|
+
'application/json': {
|
|
5270
5609
|
/** @description The publication URL. Template is `publications/bucketId/requestId`. */
|
|
5271
5610
|
url?: string;
|
|
5272
5611
|
};
|
|
@@ -5319,7 +5658,7 @@ interface operations {
|
|
|
5319
5658
|
};
|
|
5320
5659
|
requestBody: {
|
|
5321
5660
|
content: {
|
|
5322
|
-
|
|
5661
|
+
'application/json': {
|
|
5323
5662
|
/** @description The publication URL. Template is `publications/bucketId/requestId`. */
|
|
5324
5663
|
url?: string;
|
|
5325
5664
|
/** @description Rejection comment. */
|
|
@@ -5334,7 +5673,7 @@ interface operations {
|
|
|
5334
5673
|
[name: string]: unknown;
|
|
5335
5674
|
};
|
|
5336
5675
|
content: {
|
|
5337
|
-
|
|
5676
|
+
'application/json': components['schemas']['PublicationResponseObject'];
|
|
5338
5677
|
};
|
|
5339
5678
|
};
|
|
5340
5679
|
/** @description Bad request */
|
|
@@ -5376,7 +5715,7 @@ interface operations {
|
|
|
5376
5715
|
};
|
|
5377
5716
|
requestBody: {
|
|
5378
5717
|
content: {
|
|
5379
|
-
|
|
5718
|
+
'application/json': {
|
|
5380
5719
|
/** @description The publication URL. Template is `publications/bucketId/requestId`. */
|
|
5381
5720
|
url?: string;
|
|
5382
5721
|
};
|
|
@@ -5389,7 +5728,7 @@ interface operations {
|
|
|
5389
5728
|
[name: string]: unknown;
|
|
5390
5729
|
};
|
|
5391
5730
|
content: {
|
|
5392
|
-
|
|
5731
|
+
'application/json': components['schemas']['PublicationResponseObject'];
|
|
5393
5732
|
};
|
|
5394
5733
|
};
|
|
5395
5734
|
/** @description Bad request */
|
|
@@ -5431,7 +5770,7 @@ interface operations {
|
|
|
5431
5770
|
};
|
|
5432
5771
|
requestBody: {
|
|
5433
5772
|
content: {
|
|
5434
|
-
|
|
5773
|
+
'application/json': {
|
|
5435
5774
|
/** @description Publication public folder URL. Template is `public/folderName` */
|
|
5436
5775
|
url?: string;
|
|
5437
5776
|
};
|
|
@@ -5444,7 +5783,7 @@ interface operations {
|
|
|
5444
5783
|
[name: string]: unknown;
|
|
5445
5784
|
};
|
|
5446
5785
|
content: {
|
|
5447
|
-
|
|
5786
|
+
'application/json': components['schemas']['PublicationRules'];
|
|
5448
5787
|
};
|
|
5449
5788
|
};
|
|
5450
5789
|
/** @description Bad request */
|
|
@@ -5486,13 +5825,13 @@ interface operations {
|
|
|
5486
5825
|
};
|
|
5487
5826
|
requestBody: {
|
|
5488
5827
|
content: {
|
|
5489
|
-
|
|
5828
|
+
'application/json': {
|
|
5490
5829
|
/** @description An array of resources to share. */
|
|
5491
5830
|
resources?: {
|
|
5492
5831
|
/** @description A relative url of the resource to share. */
|
|
5493
5832
|
url?: string;
|
|
5494
5833
|
/** @description Lists the permissions you grant for the resource. */
|
|
5495
|
-
permissions?: (
|
|
5834
|
+
permissions?: ('READ' | 'WRITE')[];
|
|
5496
5835
|
}[];
|
|
5497
5836
|
/** @description The ID of the receiving DIAL deployment (application or toolset). */
|
|
5498
5837
|
receiver?: string;
|
|
@@ -5525,13 +5864,13 @@ interface operations {
|
|
|
5525
5864
|
};
|
|
5526
5865
|
requestBody: {
|
|
5527
5866
|
content: {
|
|
5528
|
-
|
|
5867
|
+
'application/json': {
|
|
5529
5868
|
/** @description An array of resources to share. */
|
|
5530
5869
|
resources?: {
|
|
5531
5870
|
/** @description A relative url of the resource to share. */
|
|
5532
5871
|
url?: string;
|
|
5533
5872
|
/** @description Lists the permissions you grant for the resource. */
|
|
5534
|
-
permissions?: (
|
|
5873
|
+
permissions?: ('READ' | 'WRITE')[];
|
|
5535
5874
|
}[];
|
|
5536
5875
|
/** @description The ID of the receiving DIAL deployment (application or toolset). */
|
|
5537
5876
|
receiver?: string;
|
|
@@ -5564,14 +5903,14 @@ interface operations {
|
|
|
5564
5903
|
};
|
|
5565
5904
|
requestBody: {
|
|
5566
5905
|
content: {
|
|
5567
|
-
|
|
5906
|
+
'application/json': {
|
|
5568
5907
|
/**
|
|
5569
5908
|
* @description Currently, supported the next options:
|
|
5570
5909
|
* - `me`: returns shared resources with you.
|
|
5571
5910
|
* - `others`: returns resources that you have shared with others
|
|
5572
5911
|
* @enum {string}
|
|
5573
5912
|
*/
|
|
5574
|
-
with?:
|
|
5913
|
+
with?: 'me' | 'others';
|
|
5575
5914
|
};
|
|
5576
5915
|
};
|
|
5577
5916
|
};
|
|
@@ -5582,20 +5921,20 @@ interface operations {
|
|
|
5582
5921
|
[name: string]: unknown;
|
|
5583
5922
|
};
|
|
5584
5923
|
content: {
|
|
5585
|
-
|
|
5924
|
+
'application/json': {
|
|
5586
5925
|
resources?: {
|
|
5587
5926
|
url?: string;
|
|
5588
5927
|
/**
|
|
5589
5928
|
* @description Lists the permissions you have on the resource if `with` is set to "me".
|
|
5590
5929
|
* Lists the permissions you have granted to others if `with` is set to "others".
|
|
5591
5930
|
*/
|
|
5592
|
-
permissions?: (
|
|
5931
|
+
permissions?: ('READ' | 'WRITE')[];
|
|
5593
5932
|
}[];
|
|
5594
5933
|
receivers?: {
|
|
5595
5934
|
receiver?: string;
|
|
5596
5935
|
resources?: {
|
|
5597
5936
|
url?: string;
|
|
5598
|
-
permissions?: (
|
|
5937
|
+
permissions?: ('READ' | 'WRITE')[];
|
|
5599
5938
|
}[];
|
|
5600
5939
|
}[];
|
|
5601
5940
|
};
|
|
@@ -5619,13 +5958,13 @@ interface operations {
|
|
|
5619
5958
|
};
|
|
5620
5959
|
requestBody: {
|
|
5621
5960
|
content: {
|
|
5622
|
-
|
|
5961
|
+
'application/json': {
|
|
5623
5962
|
/** @description An array of resources to share. */
|
|
5624
5963
|
resources?: {
|
|
5625
5964
|
/** @description A relative url of the resource to share. */
|
|
5626
5965
|
url?: string;
|
|
5627
5966
|
/** @description Lists the permissions you have on the resource. */
|
|
5628
|
-
permissions?: (
|
|
5967
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
5629
5968
|
/**
|
|
5630
5969
|
* @description Indicates whether global resource credentials should be shared with user.
|
|
5631
5970
|
* @default false
|
|
@@ -5646,7 +5985,7 @@ interface operations {
|
|
|
5646
5985
|
[name: string]: unknown;
|
|
5647
5986
|
};
|
|
5648
5987
|
content: {
|
|
5649
|
-
|
|
5988
|
+
'application/json': {
|
|
5650
5989
|
invitationLink?: string;
|
|
5651
5990
|
};
|
|
5652
5991
|
};
|
|
@@ -5669,15 +6008,15 @@ interface operations {
|
|
|
5669
6008
|
};
|
|
5670
6009
|
requestBody: {
|
|
5671
6010
|
content: {
|
|
5672
|
-
|
|
5673
|
-
resourceTypes?: (
|
|
6011
|
+
'application/json': {
|
|
6012
|
+
resourceTypes?: ('FILE' | 'PROMPT' | 'CONVERSATION' | 'APPLICATION' | 'TOOL_SET')[];
|
|
5674
6013
|
/**
|
|
5675
6014
|
* @description Currently, supported the next options:
|
|
5676
6015
|
* - `me`: returns shared resources with you.
|
|
5677
6016
|
* - `others`: returns resources that you have shared with others
|
|
5678
6017
|
* @enum {string}
|
|
5679
6018
|
*/
|
|
5680
|
-
with?:
|
|
6019
|
+
with?: 'me' | 'others';
|
|
5681
6020
|
/**
|
|
5682
6021
|
* @description If true, includes additional user information such as resource owner display name, users who have shared the resource with you, and users with whom you have shared the resource.
|
|
5683
6022
|
* @default false
|
|
@@ -5693,7 +6032,7 @@ interface operations {
|
|
|
5693
6032
|
[name: string]: unknown;
|
|
5694
6033
|
};
|
|
5695
6034
|
content: {
|
|
5696
|
-
|
|
6035
|
+
'application/json': {
|
|
5697
6036
|
resources?: {
|
|
5698
6037
|
nodeType?: string;
|
|
5699
6038
|
resourceType?: string;
|
|
@@ -5705,7 +6044,7 @@ interface operations {
|
|
|
5705
6044
|
* @description Lists the permissions you have on the resource if `with` is set to "me".
|
|
5706
6045
|
* Lists the permissions you have granted to others if `with` is set to "others".
|
|
5707
6046
|
*/
|
|
5708
|
-
permissions?: (
|
|
6047
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
5709
6048
|
/** @description Resource owner display name (a configurable claim from JWT or a project name for API keys). The field is populated if `with` is set to "me" and `includeUserInfo` is true. */
|
|
5710
6049
|
author?: string;
|
|
5711
6050
|
/** @description A list of users who have shared the resource with you. The field is populated if `with` is set to "me" and `includeUserInfo` is true. */
|
|
@@ -5715,14 +6054,14 @@ interface operations {
|
|
|
5715
6054
|
/** @description The timestamp when the shared resource has been accepted. */
|
|
5716
6055
|
acceptedAt?: number;
|
|
5717
6056
|
/** @description A list of permissions granted by the user. */
|
|
5718
|
-
permissions?: (
|
|
6057
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
5719
6058
|
}[];
|
|
5720
6059
|
/** @description A list of users with whom you have shared the resource. The field is populated if `with` is set to "others" and `includeUserInfo` is true. */
|
|
5721
6060
|
sharedWith?: {
|
|
5722
6061
|
/** @description User display name (a configurable claim from JWT or a project name for API keys). */
|
|
5723
6062
|
user?: string;
|
|
5724
6063
|
/** @description A list of permissions granted to the user. */
|
|
5725
|
-
permissions?: (
|
|
6064
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
5726
6065
|
}[];
|
|
5727
6066
|
/**
|
|
5728
6067
|
* @description Indicates whether global resource credentials were shared with user.
|
|
@@ -5751,7 +6090,7 @@ interface operations {
|
|
|
5751
6090
|
};
|
|
5752
6091
|
requestBody: {
|
|
5753
6092
|
content: {
|
|
5754
|
-
|
|
6093
|
+
'application/json': {
|
|
5755
6094
|
/** @description An array of resources to revoke. */
|
|
5756
6095
|
resources?: {
|
|
5757
6096
|
/** @description A relative url of the resource to revoke. */
|
|
@@ -5786,7 +6125,7 @@ interface operations {
|
|
|
5786
6125
|
};
|
|
5787
6126
|
requestBody: {
|
|
5788
6127
|
content: {
|
|
5789
|
-
|
|
6128
|
+
'application/json': {
|
|
5790
6129
|
/** @description An array of resources to discard. */
|
|
5791
6130
|
resources?: {
|
|
5792
6131
|
/** @description A relative url of the resource to discard. */
|
|
@@ -5821,7 +6160,7 @@ interface operations {
|
|
|
5821
6160
|
};
|
|
5822
6161
|
requestBody: {
|
|
5823
6162
|
content: {
|
|
5824
|
-
|
|
6163
|
+
'application/json': {
|
|
5825
6164
|
/** @description The relative URL of the original resource where user's permissions will be copied from. */
|
|
5826
6165
|
sourceUrl?: string;
|
|
5827
6166
|
/** @description The relative URL of the original resource where user's permissions will be copied to. */
|
|
@@ -5861,7 +6200,7 @@ interface operations {
|
|
|
5861
6200
|
[name: string]: unknown;
|
|
5862
6201
|
};
|
|
5863
6202
|
content: {
|
|
5864
|
-
|
|
6203
|
+
'application/json': {
|
|
5865
6204
|
invitations?: {
|
|
5866
6205
|
id?: string;
|
|
5867
6206
|
author?: string;
|
|
@@ -5871,7 +6210,7 @@ interface operations {
|
|
|
5871
6210
|
/** @description Resource owner display name (a configurable claim from JWT or a project name for API keys). */
|
|
5872
6211
|
author?: string;
|
|
5873
6212
|
/** @description Lists of permissions to be granted. */
|
|
5874
|
-
permissions?: (
|
|
6213
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
5875
6214
|
/**
|
|
5876
6215
|
* @description Indicates whether global resource credentials was shared with user.
|
|
5877
6216
|
* @default false
|
|
@@ -5913,7 +6252,7 @@ interface operations {
|
|
|
5913
6252
|
[name: string]: unknown;
|
|
5914
6253
|
};
|
|
5915
6254
|
content: {
|
|
5916
|
-
|
|
6255
|
+
'application/json': {
|
|
5917
6256
|
id?: string;
|
|
5918
6257
|
author?: string;
|
|
5919
6258
|
/** @description An array of shared resources. */
|
|
@@ -5921,7 +6260,7 @@ interface operations {
|
|
|
5921
6260
|
/** @description A relative url of the shared resource. */
|
|
5922
6261
|
url?: string;
|
|
5923
6262
|
/** @description Lists the permissions you have on the resource. */
|
|
5924
|
-
permissions?: (
|
|
6263
|
+
permissions?: ('READ' | 'WRITE' | 'SHARE')[];
|
|
5925
6264
|
/**
|
|
5926
6265
|
* @description Indicates whether global resource credentials was shared with user.
|
|
5927
6266
|
* @default false
|
|
@@ -5984,7 +6323,7 @@ interface operations {
|
|
|
5984
6323
|
[name: string]: unknown;
|
|
5985
6324
|
};
|
|
5986
6325
|
content: {
|
|
5987
|
-
|
|
6326
|
+
'application/json': components['schemas']['NotificationsResponse'];
|
|
5988
6327
|
};
|
|
5989
6328
|
};
|
|
5990
6329
|
/** @description Bad request */
|
|
@@ -6026,7 +6365,7 @@ interface operations {
|
|
|
6026
6365
|
};
|
|
6027
6366
|
requestBody: {
|
|
6028
6367
|
content: {
|
|
6029
|
-
|
|
6368
|
+
'application/json': {
|
|
6030
6369
|
/** @description Notification identifiers. */
|
|
6031
6370
|
ids?: string[];
|
|
6032
6371
|
};
|
|
@@ -6079,7 +6418,7 @@ interface operations {
|
|
|
6079
6418
|
};
|
|
6080
6419
|
requestBody: {
|
|
6081
6420
|
content: {
|
|
6082
|
-
|
|
6421
|
+
'application/json': {
|
|
6083
6422
|
/** @description An array of resources to subscribe to. */
|
|
6084
6423
|
resources?: {
|
|
6085
6424
|
/** @description A relative url of the resource to subscribe to. */
|
|
@@ -6095,10 +6434,10 @@ interface operations {
|
|
|
6095
6434
|
[name: string]: unknown;
|
|
6096
6435
|
};
|
|
6097
6436
|
content: {
|
|
6098
|
-
|
|
6437
|
+
'text/event-stream': {
|
|
6099
6438
|
url?: string;
|
|
6100
6439
|
/** @enum {string} */
|
|
6101
|
-
action?:
|
|
6440
|
+
action?: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
6102
6441
|
timestamp?: number;
|
|
6103
6442
|
}[];
|
|
6104
6443
|
};
|
|
@@ -6135,7 +6474,7 @@ interface operations {
|
|
|
6135
6474
|
};
|
|
6136
6475
|
requestBody: {
|
|
6137
6476
|
content: {
|
|
6138
|
-
|
|
6477
|
+
'application/json': {
|
|
6139
6478
|
/** @description session id. */
|
|
6140
6479
|
sessionId?: string;
|
|
6141
6480
|
};
|
|
@@ -6148,7 +6487,7 @@ interface operations {
|
|
|
6148
6487
|
[name: string]: unknown;
|
|
6149
6488
|
};
|
|
6150
6489
|
content: {
|
|
6151
|
-
|
|
6490
|
+
'application/json': {
|
|
6152
6491
|
sessionId?: string;
|
|
6153
6492
|
};
|
|
6154
6493
|
};
|
|
@@ -6192,7 +6531,7 @@ interface operations {
|
|
|
6192
6531
|
};
|
|
6193
6532
|
requestBody: {
|
|
6194
6533
|
content: {
|
|
6195
|
-
|
|
6534
|
+
'application/json': {
|
|
6196
6535
|
/** @description session id. */
|
|
6197
6536
|
sessionId?: string;
|
|
6198
6537
|
};
|
|
@@ -6205,7 +6544,7 @@ interface operations {
|
|
|
6205
6544
|
[name: string]: unknown;
|
|
6206
6545
|
};
|
|
6207
6546
|
content: {
|
|
6208
|
-
|
|
6547
|
+
'application/json': {
|
|
6209
6548
|
sessionId?: string;
|
|
6210
6549
|
};
|
|
6211
6550
|
};
|
|
@@ -6249,13 +6588,13 @@ interface operations {
|
|
|
6249
6588
|
};
|
|
6250
6589
|
requestBody: {
|
|
6251
6590
|
content: {
|
|
6252
|
-
|
|
6591
|
+
'application/json': {
|
|
6253
6592
|
/** @description session id. */
|
|
6254
6593
|
sessionId?: string;
|
|
6255
6594
|
/** @description code to be executed */
|
|
6256
6595
|
code?: string;
|
|
6257
|
-
inputFiles?: components[
|
|
6258
|
-
outputFiles?: components[
|
|
6596
|
+
inputFiles?: components['schemas']['CodeInterpreterRequestFile'];
|
|
6597
|
+
outputFiles?: components['schemas']['CodeInterpreterRequestFile'];
|
|
6259
6598
|
};
|
|
6260
6599
|
};
|
|
6261
6600
|
};
|
|
@@ -6266,7 +6605,7 @@ interface operations {
|
|
|
6266
6605
|
[name: string]: unknown;
|
|
6267
6606
|
};
|
|
6268
6607
|
content: {
|
|
6269
|
-
|
|
6608
|
+
'application/json': {
|
|
6270
6609
|
status?: string;
|
|
6271
6610
|
stdout?: string;
|
|
6272
6611
|
stderr?: string;
|
|
@@ -6314,7 +6653,7 @@ interface operations {
|
|
|
6314
6653
|
};
|
|
6315
6654
|
requestBody: {
|
|
6316
6655
|
content: {
|
|
6317
|
-
|
|
6656
|
+
'multipart/form-data': {
|
|
6318
6657
|
/**
|
|
6319
6658
|
* Format: binary
|
|
6320
6659
|
* @description A part of multipart/form-data request
|
|
@@ -6330,7 +6669,7 @@ interface operations {
|
|
|
6330
6669
|
[name: string]: unknown;
|
|
6331
6670
|
};
|
|
6332
6671
|
content: {
|
|
6333
|
-
|
|
6672
|
+
'application/json': components['schemas']['CodeInterpreterFile'];
|
|
6334
6673
|
};
|
|
6335
6674
|
};
|
|
6336
6675
|
/** @description Bad request */
|
|
@@ -6372,7 +6711,7 @@ interface operations {
|
|
|
6372
6711
|
};
|
|
6373
6712
|
requestBody: {
|
|
6374
6713
|
content: {
|
|
6375
|
-
|
|
6714
|
+
'application/json': components['schemas']['CodeInterpreterFile'];
|
|
6376
6715
|
};
|
|
6377
6716
|
};
|
|
6378
6717
|
responses: {
|
|
@@ -6382,7 +6721,7 @@ interface operations {
|
|
|
6382
6721
|
[name: string]: unknown;
|
|
6383
6722
|
};
|
|
6384
6723
|
content: {
|
|
6385
|
-
|
|
6724
|
+
'application/octet-stream': string;
|
|
6386
6725
|
};
|
|
6387
6726
|
};
|
|
6388
6727
|
/** @description Bad request */
|
|
@@ -6424,7 +6763,7 @@ interface operations {
|
|
|
6424
6763
|
};
|
|
6425
6764
|
requestBody: {
|
|
6426
6765
|
content: {
|
|
6427
|
-
|
|
6766
|
+
'application/json': {
|
|
6428
6767
|
sessionId?: string;
|
|
6429
6768
|
};
|
|
6430
6769
|
};
|
|
@@ -6436,8 +6775,8 @@ interface operations {
|
|
|
6436
6775
|
[name: string]: unknown;
|
|
6437
6776
|
};
|
|
6438
6777
|
content: {
|
|
6439
|
-
|
|
6440
|
-
files?: components[
|
|
6778
|
+
'application/json': {
|
|
6779
|
+
files?: components['schemas']['CodeInterpreterFile'][];
|
|
6441
6780
|
};
|
|
6442
6781
|
};
|
|
6443
6782
|
};
|
|
@@ -6480,7 +6819,7 @@ interface operations {
|
|
|
6480
6819
|
};
|
|
6481
6820
|
requestBody: {
|
|
6482
6821
|
content: {
|
|
6483
|
-
|
|
6822
|
+
'application/json': components['schemas']['CodeInterpreterRequestFile'];
|
|
6484
6823
|
};
|
|
6485
6824
|
};
|
|
6486
6825
|
responses: {
|
|
@@ -6490,7 +6829,7 @@ interface operations {
|
|
|
6490
6829
|
[name: string]: unknown;
|
|
6491
6830
|
};
|
|
6492
6831
|
content: {
|
|
6493
|
-
|
|
6832
|
+
'application/json': components['schemas']['CodeInterpreterFile'];
|
|
6494
6833
|
};
|
|
6495
6834
|
};
|
|
6496
6835
|
/** @description Bad request */
|
|
@@ -6532,7 +6871,7 @@ interface operations {
|
|
|
6532
6871
|
};
|
|
6533
6872
|
requestBody: {
|
|
6534
6873
|
content: {
|
|
6535
|
-
|
|
6874
|
+
'application/json': components['schemas']['CodeInterpreterRequestFile'];
|
|
6536
6875
|
};
|
|
6537
6876
|
};
|
|
6538
6877
|
responses: {
|
|
@@ -6542,7 +6881,7 @@ interface operations {
|
|
|
6542
6881
|
[name: string]: unknown;
|
|
6543
6882
|
};
|
|
6544
6883
|
content: {
|
|
6545
|
-
|
|
6884
|
+
'application/json': {
|
|
6546
6885
|
name?: string;
|
|
6547
6886
|
parentPath?: string;
|
|
6548
6887
|
bucket?: string;
|
|
@@ -6554,7 +6893,7 @@ interface operations {
|
|
|
6554
6893
|
updatedAt?: number;
|
|
6555
6894
|
contentLength?: number;
|
|
6556
6895
|
contentType?: string;
|
|
6557
|
-
permissions?: (
|
|
6896
|
+
permissions?: ('READ' | 'WRITE')[];
|
|
6558
6897
|
};
|
|
6559
6898
|
};
|
|
6560
6899
|
};
|
|
@@ -6597,7 +6936,7 @@ interface operations {
|
|
|
6597
6936
|
};
|
|
6598
6937
|
requestBody: {
|
|
6599
6938
|
content: {
|
|
6600
|
-
|
|
6939
|
+
'application/json': {
|
|
6601
6940
|
/** @description session id. */
|
|
6602
6941
|
sessionId?: string;
|
|
6603
6942
|
};
|
|
@@ -6610,7 +6949,7 @@ interface operations {
|
|
|
6610
6949
|
[name: string]: unknown;
|
|
6611
6950
|
};
|
|
6612
6951
|
content: {
|
|
6613
|
-
|
|
6952
|
+
'application/json': components['schemas']['GetSession'];
|
|
6614
6953
|
};
|
|
6615
6954
|
};
|
|
6616
6955
|
/** @description Bad request */
|
|
@@ -6650,6 +6989,40 @@ interface operations {
|
|
|
6650
6989
|
};
|
|
6651
6990
|
};
|
|
6652
6991
|
};
|
|
6992
|
+
getDeploymentsByInterfaceType: {
|
|
6993
|
+
parameters: {
|
|
6994
|
+
query?: {
|
|
6995
|
+
/** @description Filter deployments by the interface types they support. Can accept multiple values as comma-separated list or array. <br> `chat` - Deployments that expose chat-based interfaces. This includes the OpenAI-compatible chat completion interface and Responses API. Matches models with `chat` type and applications with `dial:applicationTypeCompletionEndpoint`. Never includes toolsets. <br> `embedding` - Deployments that expose embedding endpoints. Matches only models with `embedding` type. Never includes applications and toolsets. <br> `mcp` - Deployments that expose MCP (Model Context Protocol) interface (toolsets and applications with `dial:applicationTypeMcp`). Never includes models. <br> `custom_ui` - Deployments that expose custom UI interfaces (applications with `dial:applicationTypeViewerUrl`). Never includes models and toolsets. <br> `all` - Include all deployments regardless of interface type (default behavior if parameter is omitted). */
|
|
6996
|
+
interface_type?: ('chat' | 'embeddings' | 'mcp' | 'custom_ui' | 'all')[];
|
|
6997
|
+
};
|
|
6998
|
+
header?: never;
|
|
6999
|
+
path?: never;
|
|
7000
|
+
cookie?: never;
|
|
7001
|
+
};
|
|
7002
|
+
requestBody?: never;
|
|
7003
|
+
responses: {
|
|
7004
|
+
/** @description Success */
|
|
7005
|
+
200: {
|
|
7006
|
+
headers: {
|
|
7007
|
+
[name: string]: unknown;
|
|
7008
|
+
};
|
|
7009
|
+
content: {
|
|
7010
|
+
'application/json': components['schemas']['Deployments'];
|
|
7011
|
+
};
|
|
7012
|
+
};
|
|
7013
|
+
/** @description Invalid Authentication */
|
|
7014
|
+
401: {
|
|
7015
|
+
headers: {
|
|
7016
|
+
[name: string]: unknown;
|
|
7017
|
+
};
|
|
7018
|
+
content: {
|
|
7019
|
+
'application/json': {
|
|
7020
|
+
error?: components['schemas']['Error'];
|
|
7021
|
+
};
|
|
7022
|
+
};
|
|
7023
|
+
};
|
|
7024
|
+
};
|
|
7025
|
+
};
|
|
6653
7026
|
getDeployments: {
|
|
6654
7027
|
parameters: {
|
|
6655
7028
|
query?: never;
|
|
@@ -6665,9 +7038,9 @@ interface operations {
|
|
|
6665
7038
|
[name: string]: unknown;
|
|
6666
7039
|
};
|
|
6667
7040
|
content: {
|
|
6668
|
-
|
|
7041
|
+
'application/json': {
|
|
6669
7042
|
/** @description An array of models. */
|
|
6670
|
-
data?: components[
|
|
7043
|
+
data?: components['schemas']['ModelOpenAi'][];
|
|
6671
7044
|
};
|
|
6672
7045
|
};
|
|
6673
7046
|
};
|
|
@@ -6677,8 +7050,8 @@ interface operations {
|
|
|
6677
7050
|
[name: string]: unknown;
|
|
6678
7051
|
};
|
|
6679
7052
|
content: {
|
|
6680
|
-
|
|
6681
|
-
error?: components[
|
|
7053
|
+
'application/json': {
|
|
7054
|
+
error?: components['schemas']['Error'];
|
|
6682
7055
|
};
|
|
6683
7056
|
};
|
|
6684
7057
|
};
|
|
@@ -6702,7 +7075,7 @@ interface operations {
|
|
|
6702
7075
|
[name: string]: unknown;
|
|
6703
7076
|
};
|
|
6704
7077
|
content: {
|
|
6705
|
-
|
|
7078
|
+
'application/json': components['schemas']['ModelOpenAi'];
|
|
6706
7079
|
};
|
|
6707
7080
|
};
|
|
6708
7081
|
/** @description Invalid Authentication */
|
|
@@ -6711,8 +7084,8 @@ interface operations {
|
|
|
6711
7084
|
[name: string]: unknown;
|
|
6712
7085
|
};
|
|
6713
7086
|
content: {
|
|
6714
|
-
|
|
6715
|
-
error?: components[
|
|
7087
|
+
'application/json': {
|
|
7088
|
+
error?: components['schemas']['Error'];
|
|
6716
7089
|
};
|
|
6717
7090
|
};
|
|
6718
7091
|
};
|
|
@@ -6733,9 +7106,9 @@ interface operations {
|
|
|
6733
7106
|
[name: string]: unknown;
|
|
6734
7107
|
};
|
|
6735
7108
|
content: {
|
|
6736
|
-
|
|
7109
|
+
'application/json': {
|
|
6737
7110
|
/** @description An array of models. */
|
|
6738
|
-
data?: components[
|
|
7111
|
+
data?: components['schemas']['ModelOpenAi'][];
|
|
6739
7112
|
};
|
|
6740
7113
|
};
|
|
6741
7114
|
};
|
|
@@ -6745,8 +7118,8 @@ interface operations {
|
|
|
6745
7118
|
[name: string]: unknown;
|
|
6746
7119
|
};
|
|
6747
7120
|
content: {
|
|
6748
|
-
|
|
6749
|
-
error?: components[
|
|
7121
|
+
'application/json': {
|
|
7122
|
+
error?: components['schemas']['Error'];
|
|
6750
7123
|
};
|
|
6751
7124
|
};
|
|
6752
7125
|
};
|
|
@@ -6770,7 +7143,7 @@ interface operations {
|
|
|
6770
7143
|
[name: string]: unknown;
|
|
6771
7144
|
};
|
|
6772
7145
|
content: {
|
|
6773
|
-
|
|
7146
|
+
'application/json': components['schemas']['ModelOpenAi'];
|
|
6774
7147
|
};
|
|
6775
7148
|
};
|
|
6776
7149
|
/** @description Invalid Authentication */
|
|
@@ -6779,8 +7152,8 @@ interface operations {
|
|
|
6779
7152
|
[name: string]: unknown;
|
|
6780
7153
|
};
|
|
6781
7154
|
content: {
|
|
6782
|
-
|
|
6783
|
-
error?: components[
|
|
7155
|
+
'application/json': {
|
|
7156
|
+
error?: components['schemas']['Error'];
|
|
6784
7157
|
};
|
|
6785
7158
|
};
|
|
6786
7159
|
};
|
|
@@ -6801,9 +7174,9 @@ interface operations {
|
|
|
6801
7174
|
[name: string]: unknown;
|
|
6802
7175
|
};
|
|
6803
7176
|
content: {
|
|
6804
|
-
|
|
7177
|
+
'application/json': {
|
|
6805
7178
|
/** @description An array of Applications. */
|
|
6806
|
-
data?: components[
|
|
7179
|
+
data?: components['schemas']['ApplicationOpenAi'][];
|
|
6807
7180
|
};
|
|
6808
7181
|
};
|
|
6809
7182
|
};
|
|
@@ -6813,8 +7186,8 @@ interface operations {
|
|
|
6813
7186
|
[name: string]: unknown;
|
|
6814
7187
|
};
|
|
6815
7188
|
content: {
|
|
6816
|
-
|
|
6817
|
-
error?: components[
|
|
7189
|
+
'application/json': {
|
|
7190
|
+
error?: components['schemas']['Error'];
|
|
6818
7191
|
};
|
|
6819
7192
|
};
|
|
6820
7193
|
};
|
|
@@ -6838,7 +7211,7 @@ interface operations {
|
|
|
6838
7211
|
[name: string]: unknown;
|
|
6839
7212
|
};
|
|
6840
7213
|
content: {
|
|
6841
|
-
|
|
7214
|
+
'application/json': components['schemas']['ApplicationOpenAi'];
|
|
6842
7215
|
};
|
|
6843
7216
|
};
|
|
6844
7217
|
/** @description Invalid Authentication */
|
|
@@ -6847,8 +7220,8 @@ interface operations {
|
|
|
6847
7220
|
[name: string]: unknown;
|
|
6848
7221
|
};
|
|
6849
7222
|
content: {
|
|
6850
|
-
|
|
6851
|
-
error?: components[
|
|
7223
|
+
'application/json': {
|
|
7224
|
+
error?: components['schemas']['Error'];
|
|
6852
7225
|
};
|
|
6853
7226
|
};
|
|
6854
7227
|
};
|
|
@@ -6869,9 +7242,9 @@ interface operations {
|
|
|
6869
7242
|
[name: string]: unknown;
|
|
6870
7243
|
};
|
|
6871
7244
|
content: {
|
|
6872
|
-
|
|
7245
|
+
'application/json': {
|
|
6873
7246
|
/** @description An array of toolsets. */
|
|
6874
|
-
data?: components[
|
|
7247
|
+
data?: components['schemas']['ToolsetOpenAi'][];
|
|
6875
7248
|
};
|
|
6876
7249
|
};
|
|
6877
7250
|
};
|
|
@@ -6881,8 +7254,8 @@ interface operations {
|
|
|
6881
7254
|
[name: string]: unknown;
|
|
6882
7255
|
};
|
|
6883
7256
|
content: {
|
|
6884
|
-
|
|
6885
|
-
error?: components[
|
|
7257
|
+
'application/json': {
|
|
7258
|
+
error?: components['schemas']['Error'];
|
|
6886
7259
|
};
|
|
6887
7260
|
};
|
|
6888
7261
|
};
|
|
@@ -6906,7 +7279,7 @@ interface operations {
|
|
|
6906
7279
|
[name: string]: unknown;
|
|
6907
7280
|
};
|
|
6908
7281
|
content: {
|
|
6909
|
-
|
|
7282
|
+
'application/json': components['schemas']['ToolsetOpenAi'];
|
|
6910
7283
|
};
|
|
6911
7284
|
};
|
|
6912
7285
|
/** @description Invalid Authentication */
|
|
@@ -6915,8 +7288,8 @@ interface operations {
|
|
|
6915
7288
|
[name: string]: unknown;
|
|
6916
7289
|
};
|
|
6917
7290
|
content: {
|
|
6918
|
-
|
|
6919
|
-
error?: components[
|
|
7291
|
+
'application/json': {
|
|
7292
|
+
error?: components['schemas']['Error'];
|
|
6920
7293
|
};
|
|
6921
7294
|
};
|
|
6922
7295
|
};
|
|
@@ -6940,7 +7313,7 @@ interface operations {
|
|
|
6940
7313
|
[name: string]: unknown;
|
|
6941
7314
|
};
|
|
6942
7315
|
content: {
|
|
6943
|
-
|
|
7316
|
+
'application/json': {
|
|
6944
7317
|
/** @description Statistics for requests per hour. */
|
|
6945
7318
|
hourRequestStats?: {
|
|
6946
7319
|
/** @description Total number of requests allowed per hour. */
|
|
@@ -7045,7 +7418,7 @@ interface operations {
|
|
|
7045
7418
|
[name: string]: unknown;
|
|
7046
7419
|
};
|
|
7047
7420
|
content: {
|
|
7048
|
-
|
|
7421
|
+
'application/json': string;
|
|
7049
7422
|
};
|
|
7050
7423
|
};
|
|
7051
7424
|
/** @description Forbidden */
|
|
@@ -7075,7 +7448,7 @@ interface operations {
|
|
|
7075
7448
|
[name: string]: unknown;
|
|
7076
7449
|
};
|
|
7077
7450
|
content: {
|
|
7078
|
-
|
|
7451
|
+
'application/json': components['schemas']['ReviewConsentResponse'];
|
|
7079
7452
|
};
|
|
7080
7453
|
};
|
|
7081
7454
|
/** @description Forbidden */
|
|
@@ -7099,7 +7472,7 @@ interface operations {
|
|
|
7099
7472
|
};
|
|
7100
7473
|
requestBody: {
|
|
7101
7474
|
content: {
|
|
7102
|
-
|
|
7475
|
+
'application/json': components['schemas']['AcceptConsentRequest'];
|
|
7103
7476
|
};
|
|
7104
7477
|
};
|
|
7105
7478
|
responses: {
|
|
@@ -7119,6 +7492,160 @@ interface operations {
|
|
|
7119
7492
|
};
|
|
7120
7493
|
};
|
|
7121
7494
|
};
|
|
7495
|
+
subscribeOnClientChannel: {
|
|
7496
|
+
parameters: {
|
|
7497
|
+
query?: never;
|
|
7498
|
+
header?: {
|
|
7499
|
+
/** @description Client channel ID. The client should provide the header in case of reconnect. */
|
|
7500
|
+
'X-DIAL-CLIENT-CHANNEL-ID'?: string;
|
|
7501
|
+
};
|
|
7502
|
+
path?: never;
|
|
7503
|
+
cookie?: never;
|
|
7504
|
+
};
|
|
7505
|
+
requestBody?: never;
|
|
7506
|
+
responses: {
|
|
7507
|
+
/** @description Success */
|
|
7508
|
+
200: {
|
|
7509
|
+
headers: {
|
|
7510
|
+
/** @description Client channel ID. **Note**: The header is optional and is passed in the response only if provided in the request. */
|
|
7511
|
+
'X-DIAL-CLIENT-CHANNEL-ID'?: string;
|
|
7512
|
+
[name: string]: unknown;
|
|
7513
|
+
};
|
|
7514
|
+
content: {
|
|
7515
|
+
'text/event-stream': string;
|
|
7516
|
+
};
|
|
7517
|
+
};
|
|
7518
|
+
/** @description Bad request */
|
|
7519
|
+
400: {
|
|
7520
|
+
headers: {
|
|
7521
|
+
[name: string]: unknown;
|
|
7522
|
+
};
|
|
7523
|
+
content?: never;
|
|
7524
|
+
};
|
|
7525
|
+
/** @description Unauthorized */
|
|
7526
|
+
401: {
|
|
7527
|
+
headers: {
|
|
7528
|
+
[name: string]: unknown;
|
|
7529
|
+
};
|
|
7530
|
+
content?: never;
|
|
7531
|
+
};
|
|
7532
|
+
};
|
|
7533
|
+
};
|
|
7534
|
+
unsubscribeOnClientChannel: {
|
|
7535
|
+
parameters: {
|
|
7536
|
+
query?: never;
|
|
7537
|
+
header: {
|
|
7538
|
+
/** @description Client channel ID */
|
|
7539
|
+
'X-DIAL-CLIENT-CHANNEL-ID': string;
|
|
7540
|
+
};
|
|
7541
|
+
path?: never;
|
|
7542
|
+
cookie?: never;
|
|
7543
|
+
};
|
|
7544
|
+
requestBody?: never;
|
|
7545
|
+
responses: {
|
|
7546
|
+
/** @description Success */
|
|
7547
|
+
200: {
|
|
7548
|
+
headers: {
|
|
7549
|
+
[name: string]: unknown;
|
|
7550
|
+
};
|
|
7551
|
+
content?: never;
|
|
7552
|
+
};
|
|
7553
|
+
/** @description Unauthorized */
|
|
7554
|
+
401: {
|
|
7555
|
+
headers: {
|
|
7556
|
+
[name: string]: unknown;
|
|
7557
|
+
};
|
|
7558
|
+
content?: never;
|
|
7559
|
+
};
|
|
7560
|
+
/** @description Client channel is not found */
|
|
7561
|
+
404: {
|
|
7562
|
+
headers: {
|
|
7563
|
+
[name: string]: unknown;
|
|
7564
|
+
};
|
|
7565
|
+
content?: never;
|
|
7566
|
+
};
|
|
7567
|
+
};
|
|
7568
|
+
};
|
|
7569
|
+
reportResponseToClientChannel: {
|
|
7570
|
+
parameters: {
|
|
7571
|
+
query?: never;
|
|
7572
|
+
header: {
|
|
7573
|
+
/** @description Client channel ID */
|
|
7574
|
+
'X-DIAL-CLIENT-CHANNEL-ID': string;
|
|
7575
|
+
};
|
|
7576
|
+
path?: never;
|
|
7577
|
+
cookie?: never;
|
|
7578
|
+
};
|
|
7579
|
+
requestBody: {
|
|
7580
|
+
content: {
|
|
7581
|
+
'application/json': components['schemas']['JsonRpcResponse'];
|
|
7582
|
+
};
|
|
7583
|
+
};
|
|
7584
|
+
responses: {
|
|
7585
|
+
/** @description Success */
|
|
7586
|
+
200: {
|
|
7587
|
+
headers: {
|
|
7588
|
+
[name: string]: unknown;
|
|
7589
|
+
};
|
|
7590
|
+
content?: never;
|
|
7591
|
+
};
|
|
7592
|
+
/** @description Bad request */
|
|
7593
|
+
400: {
|
|
7594
|
+
headers: {
|
|
7595
|
+
[name: string]: unknown;
|
|
7596
|
+
};
|
|
7597
|
+
content?: never;
|
|
7598
|
+
};
|
|
7599
|
+
/** @description Unauthorized */
|
|
7600
|
+
401: {
|
|
7601
|
+
headers: {
|
|
7602
|
+
[name: string]: unknown;
|
|
7603
|
+
};
|
|
7604
|
+
content?: never;
|
|
7605
|
+
};
|
|
7606
|
+
};
|
|
7607
|
+
};
|
|
7608
|
+
interactWithClientChannel: {
|
|
7609
|
+
parameters: {
|
|
7610
|
+
query?: never;
|
|
7611
|
+
header: {
|
|
7612
|
+
/** @description Client channel ID */
|
|
7613
|
+
'X-DIAL-CLIENT-CHANNEL-ID': string;
|
|
7614
|
+
};
|
|
7615
|
+
path?: never;
|
|
7616
|
+
cookie?: never;
|
|
7617
|
+
};
|
|
7618
|
+
requestBody: {
|
|
7619
|
+
content: {
|
|
7620
|
+
'application/json': components['schemas']['JsonRpcRequest'] | components['schemas']['JsonRpcRequest'][];
|
|
7621
|
+
};
|
|
7622
|
+
};
|
|
7623
|
+
responses: {
|
|
7624
|
+
/** @description Success */
|
|
7625
|
+
200: {
|
|
7626
|
+
headers: {
|
|
7627
|
+
[name: string]: unknown;
|
|
7628
|
+
};
|
|
7629
|
+
content: {
|
|
7630
|
+
'text/event-stream': string;
|
|
7631
|
+
};
|
|
7632
|
+
};
|
|
7633
|
+
/** @description Bad request */
|
|
7634
|
+
400: {
|
|
7635
|
+
headers: {
|
|
7636
|
+
[name: string]: unknown;
|
|
7637
|
+
};
|
|
7638
|
+
content?: never;
|
|
7639
|
+
};
|
|
7640
|
+
/** @description Unauthorized */
|
|
7641
|
+
401: {
|
|
7642
|
+
headers: {
|
|
7643
|
+
[name: string]: unknown;
|
|
7644
|
+
};
|
|
7645
|
+
content?: never;
|
|
7646
|
+
};
|
|
7647
|
+
};
|
|
7648
|
+
};
|
|
7122
7649
|
}
|
|
7123
7650
|
|
|
7124
7651
|
type SuccessStatus = 200 | 201 | 202 | 204;
|
|
@@ -7239,7 +7766,7 @@ type DeploymentData = components['schemas']['DeploymentBase'] & components['sche
|
|
|
7239
7766
|
type ModelCapabilities = components['schemas']['ModelCapabilities'];
|
|
7240
7767
|
type ModelLimits = components['schemas']['ModelLimits'];
|
|
7241
7768
|
type ModelPricing = components['schemas']['ModelPricing'];
|
|
7242
|
-
type ModelData = components['schemas']['
|
|
7769
|
+
type ModelData = components['schemas']['ModelOpenAi'];
|
|
7243
7770
|
interface ModelListData {
|
|
7244
7771
|
/** An array of models. */
|
|
7245
7772
|
data?: ModelData[];
|
|
@@ -7257,6 +7784,7 @@ interface SDKOptions {
|
|
|
7257
7784
|
interface DIAL_SDK {
|
|
7258
7785
|
acceptUserConsent: (deployment_id: string, init: SDKOperationInit<operations['acceptUserConsent']>) => Promise<SDKOperationResponse<operations['acceptUserConsent']>>;
|
|
7259
7786
|
approvePublication: (init: SDKOperationInit<operations['approvePublication']>) => Promise<SDKOperationResponse<operations['approvePublication']>>;
|
|
7787
|
+
callMcp: (deployment_id: string, init: SDKOperationInit<operations['callMcp']>) => Promise<SDKOperationResponse<operations['callMcp']>>;
|
|
7260
7788
|
callToolSet: (toolset_name: string, init: SDKOperationInit<operations['callToolSet']>) => Promise<SDKOperationResponse<operations['callToolSet']>>;
|
|
7261
7789
|
closeSession: (init: SDKOperationInit<operations['closeSession']>) => Promise<SDKOperationResponse<operations['closeSession']>>;
|
|
7262
7790
|
configurationDeployment: (deployment_name: string, init?: SDKOperationInit<operations['configurationDeployment']>) => Promise<SDKOperationResponse<operations['configurationDeployment']>>;
|
|
@@ -7276,6 +7804,8 @@ interface DIAL_SDK {
|
|
|
7276
7804
|
downloadFile: (bucket: string, file_path: string, init?: SDKOperationInit<operations['downloadFile']>) => Promise<SDKOperationResponse<operations['downloadFile']>>;
|
|
7277
7805
|
downloadFileFromCodeInterpreter: (init: SDKOperationInit<operations['downloadFileFromCodeInterpreter']>) => Promise<SDKOperationResponse<operations['downloadFileFromCodeInterpreter']>>;
|
|
7278
7806
|
executeCode: (init: SDKOperationInit<operations['executeCode']>) => Promise<SDKOperationResponse<operations['executeCode']>>;
|
|
7807
|
+
getAllToolSetAllowedTools: (toolset_id: string, init?: SDKOperationInit<operations['getAllToolSetAllowedTools']>) => Promise<SDKOperationResponse<operations['getAllToolSetAllowedTools']>>;
|
|
7808
|
+
getAllToolSetTools: (toolset_id: string, init?: SDKOperationInit<operations['getAllToolSetTools']>) => Promise<SDKOperationResponse<operations['getAllToolSetTools']>>;
|
|
7279
7809
|
getApplication: (application_name: string, init?: SDKOperationInit<operations['getApplication']>) => Promise<SDKOperationResponse<operations['getApplication']>>;
|
|
7280
7810
|
getApplicationLogs: (init: SDKOperationInit<operations['getApplicationLogs']>) => Promise<SDKOperationResponse<operations['getApplicationLogs']>>;
|
|
7281
7811
|
getApplicationMetadata: (bucket: string, path: string, init?: SDKOperationInit<operations['getApplicationMetadata']>) => Promise<SDKOperationResponse<operations['getApplicationMetadata']>>;
|
|
@@ -7288,6 +7818,7 @@ interface DIAL_SDK {
|
|
|
7288
7818
|
getDeployment: (deployment_name: string, init?: SDKOperationInit<operations['getDeployment']>) => Promise<SDKOperationResponse<operations['getDeployment']>>;
|
|
7289
7819
|
getDeploymentLimits: (deployment_name: string, init?: SDKOperationInit<operations['getDeploymentLimits']>) => Promise<SDKOperationResponse<operations['getDeploymentLimits']>>;
|
|
7290
7820
|
getDeployments: (init?: SDKOperationInit<operations['getDeployments']>) => Promise<SDKOperationResponse<operations['getDeployments']>>;
|
|
7821
|
+
getDeploymentsByInterfaceType: (init?: SDKOperationInit<operations['getDeploymentsByInterfaceType']>) => Promise<SDKOperationResponse<operations['getDeploymentsByInterfaceType']>>;
|
|
7291
7822
|
getFileMetadata: (bucket: string, path: string, init?: SDKOperationInit<operations['getFileMetadata']>) => Promise<SDKOperationResponse<operations['getFileMetadata']>>;
|
|
7292
7823
|
getInvitation: (invitation_id: string, init?: SDKOperationInit<operations['getInvitation']>) => Promise<SDKOperationResponse<operations['getInvitation']>>;
|
|
7293
7824
|
getInvitations: (init?: SDKOperationInit<operations['getInvitations']>) => Promise<SDKOperationResponse<operations['getInvitations']>>;
|
|
@@ -7309,6 +7840,7 @@ interface DIAL_SDK {
|
|
|
7309
7840
|
getUserBucket: (init?: SDKOperationInit<operations['getUserBucket']>) => Promise<SDKOperationResponse<operations['getUserBucket']>>;
|
|
7310
7841
|
getUserInfo: (init?: SDKOperationInit<operations['getUserInfo']>) => Promise<SDKOperationResponse<operations['getUserInfo']>>;
|
|
7311
7842
|
grantPerRequestPermissions: (init: SDKOperationInit<operations['grantPerRequestPermissions']>) => Promise<SDKOperationResponse<operations['grantPerRequestPermissions']>>;
|
|
7843
|
+
interactWithClientChannel: (init: SDKOperationInit<operations['interactWithClientChannel']>) => Promise<SDKOperationResponse<operations['interactWithClientChannel']>>;
|
|
7312
7844
|
listCustomApplicationSchemas: (init?: SDKOperationInit<operations['listCustomApplicationSchemas']>) => Promise<SDKOperationResponse<operations['listCustomApplicationSchemas']>>;
|
|
7313
7845
|
listFilesFromCodeInterpreter: (init: SDKOperationInit<operations['listFilesFromCodeInterpreter']>) => Promise<SDKOperationResponse<operations['listFilesFromCodeInterpreter']>>;
|
|
7314
7846
|
moveResource: (init: SDKOperationInit<operations['moveResource']>) => Promise<SDKOperationResponse<operations['moveResource']>>;
|
|
@@ -7317,6 +7849,7 @@ interface DIAL_SDK {
|
|
|
7317
7849
|
redeployApplication: (init: SDKOperationInit<operations['redeployApplication']>) => Promise<SDKOperationResponse<operations['redeployApplication']>>;
|
|
7318
7850
|
rejectPublication: (init: SDKOperationInit<operations['rejectPublication']>) => Promise<SDKOperationResponse<operations['rejectPublication']>>;
|
|
7319
7851
|
reloadConfig: (init?: SDKOperationInit<operations['reloadConfig']>) => Promise<SDKOperationResponse<operations['reloadConfig']>>;
|
|
7852
|
+
reportResponseToClientChannel: (init: SDKOperationInit<operations['reportResponseToClientChannel']>) => Promise<SDKOperationResponse<operations['reportResponseToClientChannel']>>;
|
|
7320
7853
|
requestUserConsent: (deployment_id: string, init?: SDKOperationInit<operations['requestUserConsent']>) => Promise<SDKOperationResponse<operations['requestUserConsent']>>;
|
|
7321
7854
|
revokePerRequestPermissions: (init: SDKOperationInit<operations['revokePerRequestPermissions']>) => Promise<SDKOperationResponse<operations['revokePerRequestPermissions']>>;
|
|
7322
7855
|
revokeSharedResources: (init: SDKOperationInit<operations['revokeSharedResources']>) => Promise<SDKOperationResponse<operations['revokeSharedResources']>>;
|
|
@@ -7329,12 +7862,14 @@ interface DIAL_SDK {
|
|
|
7329
7862
|
sendChatCompletionRequest: (deployment_name: string, init: SDKOperationInit<operations['sendChatCompletionRequest']>) => Promise<SDKOperationResponse<operations['sendChatCompletionRequest']>>;
|
|
7330
7863
|
sendEmbeddingsRequest: (deployment_name: string, init: SDKOperationInit<operations['sendEmbeddingsRequest']>) => Promise<SDKOperationResponse<operations['sendEmbeddingsRequest']>>;
|
|
7331
7864
|
shareResource: (init: SDKOperationInit<operations['shareResource']>) => Promise<SDKOperationResponse<operations['shareResource']>>;
|
|
7865
|
+
subscribeOnClientChannel: (init?: SDKOperationInit<operations['subscribeOnClientChannel']>) => Promise<SDKOperationResponse<operations['subscribeOnClientChannel']>>;
|
|
7332
7866
|
subscribeToResources: (init: SDKOperationInit<operations['subscribeToResources']>) => Promise<SDKOperationResponse<operations['subscribeToResources']>>;
|
|
7333
7867
|
toolSetSignout: (init: SDKOperationInit<operations['toolSetSignout']>) => Promise<SDKOperationResponse<operations['toolSetSignout']>>;
|
|
7334
7868
|
toolsetSignin: (init: SDKOperationInit<operations['toolsetSignin']>) => Promise<SDKOperationResponse<operations['toolsetSignin']>>;
|
|
7335
7869
|
transferInputFile: (init: SDKOperationInit<operations['transferInputFile']>) => Promise<SDKOperationResponse<operations['transferInputFile']>>;
|
|
7336
7870
|
transferOutputFile: (init: SDKOperationInit<operations['transferOutputFile']>) => Promise<SDKOperationResponse<operations['transferOutputFile']>>;
|
|
7337
7871
|
undeployApplication: (init: SDKOperationInit<operations['undeployApplication']>) => Promise<SDKOperationResponse<operations['undeployApplication']>>;
|
|
7872
|
+
unsubscribeOnClientChannel: (init: SDKOperationInit<operations['unsubscribeOnClientChannel']>) => Promise<SDKOperationResponse<operations['unsubscribeOnClientChannel']>>;
|
|
7338
7873
|
updatePublication: (init?: SDKOperationInit<operations['updatePublication']>) => Promise<SDKOperationResponse<operations['updatePublication']>>;
|
|
7339
7874
|
uploadFile: (bucket: string, file_path: string, init: SDKOperationInit<operations['uploadFile']>) => Promise<SDKOperationResponse<operations['uploadFile']>>;
|
|
7340
7875
|
uploadFileToCodeInterpreter: (init: SDKOperationInit<operations['uploadFileToCodeInterpreter']>) => Promise<SDKOperationResponse<operations['uploadFileToCodeInterpreter']>>;
|