@arizeai/phoenix-client 1.0.2 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -5
- package/dist/esm/__generated__/api/v1.d.ts +1809 -295
- package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
- package/dist/esm/experiments/runExperiment.d.ts +48 -13
- package/dist/esm/experiments/runExperiment.d.ts.map +1 -1
- package/dist/esm/experiments/runExperiment.js +139 -36
- package/dist/esm/experiments/runExperiment.js.map +1 -1
- package/dist/esm/schemas/llm/constants.d.ts +1 -1
- package/dist/esm/schemas/llm/converters.d.ts +4 -4
- package/dist/esm/schemas/llm/openai/converters.d.ts +1 -1
- package/dist/esm/schemas/llm/phoenixPrompt/converters.d.ts +8 -8
- package/dist/esm/schemas/llm/phoenixPrompt/messagePartSchemas.d.ts +5 -5
- package/dist/esm/schemas/llm/phoenixPrompt/messageSchemas.d.ts +8 -8
- package/dist/esm/schemas/llm/schemas.d.ts +4 -4
- package/dist/esm/spans/addSpanAnnotation.d.ts +39 -0
- package/dist/esm/spans/addSpanAnnotation.d.ts.map +1 -0
- package/dist/esm/spans/addSpanAnnotation.js +44 -0
- package/dist/esm/spans/addSpanAnnotation.js.map +1 -0
- package/dist/esm/spans/index.d.ts +3 -0
- package/dist/esm/spans/index.d.ts.map +1 -0
- package/dist/esm/spans/index.js +3 -0
- package/dist/esm/spans/index.js.map +1 -0
- package/dist/esm/spans/logSpanAnnotations.d.ts +51 -0
- package/dist/esm/spans/logSpanAnnotations.d.ts.map +1 -0
- package/dist/esm/spans/logSpanAnnotations.js +53 -0
- package/dist/esm/spans/logSpanAnnotations.js.map +1 -0
- package/dist/esm/spans/types.d.ts +43 -0
- package/dist/esm/spans/types.d.ts.map +1 -0
- package/dist/esm/spans/types.js +18 -0
- package/dist/esm/spans/types.js.map +1 -0
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/esm/types/annotations.d.ts +2 -1
- package/dist/esm/types/annotations.d.ts.map +1 -1
- package/dist/esm/types/experiments.d.ts +1 -7
- package/dist/esm/types/experiments.d.ts.map +1 -1
- package/dist/esm/utils/formatPromptMessages.d.ts +3 -1
- package/dist/esm/utils/formatPromptMessages.d.ts.map +1 -1
- package/dist/esm/utils/getPromptBySelector.d.ts.map +1 -1
- package/dist/src/__generated__/api/v1.d.ts +1809 -295
- package/dist/src/__generated__/api/v1.d.ts.map +1 -1
- package/dist/src/experiments/runExperiment.d.ts +48 -13
- package/dist/src/experiments/runExperiment.d.ts.map +1 -1
- package/dist/src/experiments/runExperiment.js +138 -36
- package/dist/src/experiments/runExperiment.js.map +1 -1
- package/dist/src/schemas/llm/constants.d.ts +1 -1
- package/dist/src/schemas/llm/converters.d.ts +4 -4
- package/dist/src/schemas/llm/openai/converters.d.ts +1 -1
- package/dist/src/schemas/llm/phoenixPrompt/converters.d.ts +8 -8
- package/dist/src/schemas/llm/phoenixPrompt/messagePartSchemas.d.ts +5 -5
- package/dist/src/schemas/llm/phoenixPrompt/messageSchemas.d.ts +8 -8
- package/dist/src/schemas/llm/schemas.d.ts +4 -4
- package/dist/src/spans/addSpanAnnotation.d.ts +39 -0
- package/dist/src/spans/addSpanAnnotation.d.ts.map +1 -0
- package/dist/src/spans/addSpanAnnotation.js +59 -0
- package/dist/src/spans/addSpanAnnotation.js.map +1 -0
- package/dist/src/spans/index.d.ts +3 -0
- package/dist/src/spans/index.d.ts.map +1 -0
- package/dist/src/spans/index.js +19 -0
- package/dist/src/spans/index.js.map +1 -0
- package/dist/src/spans/logSpanAnnotations.d.ts +51 -0
- package/dist/src/spans/logSpanAnnotations.d.ts.map +1 -0
- package/dist/src/spans/logSpanAnnotations.js +68 -0
- package/dist/src/spans/logSpanAnnotations.js.map +1 -0
- package/dist/src/spans/types.d.ts +43 -0
- package/dist/src/spans/types.d.ts.map +1 -0
- package/dist/src/spans/types.js +22 -0
- package/dist/src/spans/types.js.map +1 -0
- package/dist/src/types/annotations.d.ts +2 -1
- package/dist/src/types/annotations.d.ts.map +1 -1
- package/dist/src/types/experiments.d.ts +1 -7
- package/dist/src/types/experiments.d.ts.map +1 -1
- package/dist/src/utils/formatPromptMessages.d.ts +3 -1
- package/dist/src/utils/formatPromptMessages.d.ts.map +1 -1
- package/dist/src/utils/getPromptBySelector.d.ts.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +8 -2
- package/src/__generated__/api/v1.ts +1809 -295
- package/src/experiments/runExperiment.ts +211 -74
- package/src/spans/addSpanAnnotation.ts +59 -0
- package/src/spans/index.ts +2 -0
- package/src/spans/logSpanAnnotations.ts +71 -0
- package/src/spans/types.ts +60 -0
- package/src/types/annotations.ts +4 -1
- package/src/types/experiments.ts +1 -7
|
@@ -4,6 +4,79 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
+
"/v1/annotation_configs": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* List annotation configurations
|
|
16
|
+
* @description Retrieve a paginated list of all annotation configurations in the system.
|
|
17
|
+
*/
|
|
18
|
+
get: operations["list_annotation_configs_v1_annotation_configs_get"];
|
|
19
|
+
put?: never;
|
|
20
|
+
/** Create an annotation configuration */
|
|
21
|
+
post: operations["create_annotation_config_v1_annotation_configs_post"];
|
|
22
|
+
delete?: never;
|
|
23
|
+
options?: never;
|
|
24
|
+
head?: never;
|
|
25
|
+
patch?: never;
|
|
26
|
+
trace?: never;
|
|
27
|
+
};
|
|
28
|
+
"/v1/annotation_configs/{config_identifier}": {
|
|
29
|
+
parameters: {
|
|
30
|
+
query?: never;
|
|
31
|
+
header?: never;
|
|
32
|
+
path?: never;
|
|
33
|
+
cookie?: never;
|
|
34
|
+
};
|
|
35
|
+
/** Get an annotation configuration by ID or name */
|
|
36
|
+
get: operations["get_annotation_config_by_name_or_id_v1_annotation_configs__config_identifier__get"];
|
|
37
|
+
put?: never;
|
|
38
|
+
post?: never;
|
|
39
|
+
delete?: never;
|
|
40
|
+
options?: never;
|
|
41
|
+
head?: never;
|
|
42
|
+
patch?: never;
|
|
43
|
+
trace?: never;
|
|
44
|
+
};
|
|
45
|
+
"/v1/annotation_configs/{config_id}": {
|
|
46
|
+
parameters: {
|
|
47
|
+
query?: never;
|
|
48
|
+
header?: never;
|
|
49
|
+
path?: never;
|
|
50
|
+
cookie?: never;
|
|
51
|
+
};
|
|
52
|
+
get?: never;
|
|
53
|
+
/** Update an annotation configuration */
|
|
54
|
+
put: operations["update_annotation_config_v1_annotation_configs__config_id__put"];
|
|
55
|
+
post?: never;
|
|
56
|
+
/** Delete an annotation configuration */
|
|
57
|
+
delete: operations["delete_annotation_config_v1_annotation_configs__config_id__delete"];
|
|
58
|
+
options?: never;
|
|
59
|
+
head?: never;
|
|
60
|
+
patch?: never;
|
|
61
|
+
trace?: never;
|
|
62
|
+
};
|
|
63
|
+
"/v1/projects/{project_identifier}/span_annotations": {
|
|
64
|
+
parameters: {
|
|
65
|
+
query?: never;
|
|
66
|
+
header?: never;
|
|
67
|
+
path?: never;
|
|
68
|
+
cookie?: never;
|
|
69
|
+
};
|
|
70
|
+
/** Get span annotations for a list of span_ids. */
|
|
71
|
+
get: operations["listSpanAnnotationsBySpanIds"];
|
|
72
|
+
put?: never;
|
|
73
|
+
post?: never;
|
|
74
|
+
delete?: never;
|
|
75
|
+
options?: never;
|
|
76
|
+
head?: never;
|
|
77
|
+
patch?: never;
|
|
78
|
+
trace?: never;
|
|
79
|
+
};
|
|
7
80
|
"/v1/datasets": {
|
|
8
81
|
parameters: {
|
|
9
82
|
query?: never;
|
|
@@ -193,6 +266,58 @@ export interface paths {
|
|
|
193
266
|
patch?: never;
|
|
194
267
|
trace?: never;
|
|
195
268
|
};
|
|
269
|
+
"/v1/experiments/{experiment_id}/csv": {
|
|
270
|
+
parameters: {
|
|
271
|
+
query?: never;
|
|
272
|
+
header?: never;
|
|
273
|
+
path?: never;
|
|
274
|
+
cookie?: never;
|
|
275
|
+
};
|
|
276
|
+
/** Download experiment runs as a CSV file */
|
|
277
|
+
get: operations["getExperimentCSV"];
|
|
278
|
+
put?: never;
|
|
279
|
+
post?: never;
|
|
280
|
+
delete?: never;
|
|
281
|
+
options?: never;
|
|
282
|
+
head?: never;
|
|
283
|
+
patch?: never;
|
|
284
|
+
trace?: never;
|
|
285
|
+
};
|
|
286
|
+
"/v1/experiments/{experiment_id}/runs": {
|
|
287
|
+
parameters: {
|
|
288
|
+
query?: never;
|
|
289
|
+
header?: never;
|
|
290
|
+
path?: never;
|
|
291
|
+
cookie?: never;
|
|
292
|
+
};
|
|
293
|
+
/** List runs for an experiment */
|
|
294
|
+
get: operations["listExperimentRuns"];
|
|
295
|
+
put?: never;
|
|
296
|
+
/** Create run for an experiment */
|
|
297
|
+
post: operations["createExperimentRun"];
|
|
298
|
+
delete?: never;
|
|
299
|
+
options?: never;
|
|
300
|
+
head?: never;
|
|
301
|
+
patch?: never;
|
|
302
|
+
trace?: never;
|
|
303
|
+
};
|
|
304
|
+
"/v1/experiment_evaluations": {
|
|
305
|
+
parameters: {
|
|
306
|
+
query?: never;
|
|
307
|
+
header?: never;
|
|
308
|
+
path?: never;
|
|
309
|
+
cookie?: never;
|
|
310
|
+
};
|
|
311
|
+
get?: never;
|
|
312
|
+
put?: never;
|
|
313
|
+
/** Create or update evaluation for an experiment run */
|
|
314
|
+
post: operations["upsertExperimentEvaluation"];
|
|
315
|
+
delete?: never;
|
|
316
|
+
options?: never;
|
|
317
|
+
head?: never;
|
|
318
|
+
patch?: never;
|
|
319
|
+
trace?: never;
|
|
320
|
+
};
|
|
196
321
|
"/v1/span_annotations": {
|
|
197
322
|
parameters: {
|
|
198
323
|
query?: never;
|
|
@@ -202,7 +327,7 @@ export interface paths {
|
|
|
202
327
|
};
|
|
203
328
|
get?: never;
|
|
204
329
|
put?: never;
|
|
205
|
-
/** Create
|
|
330
|
+
/** Create span annotations */
|
|
206
331
|
post: operations["annotateSpans"];
|
|
207
332
|
delete?: never;
|
|
208
333
|
options?: never;
|
|
@@ -235,10 +360,16 @@ export interface paths {
|
|
|
235
360
|
path?: never;
|
|
236
361
|
cookie?: never;
|
|
237
362
|
};
|
|
238
|
-
/**
|
|
363
|
+
/**
|
|
364
|
+
* List all prompts
|
|
365
|
+
* @description Retrieve a paginated list of all prompts in the system. A prompt can have multiple versions.
|
|
366
|
+
*/
|
|
239
367
|
get: operations["getPrompts"];
|
|
240
368
|
put?: never;
|
|
241
|
-
/**
|
|
369
|
+
/**
|
|
370
|
+
* Create a new prompt
|
|
371
|
+
* @description Create a new prompt and its initial version. A prompt can have multiple versions.
|
|
372
|
+
*/
|
|
242
373
|
post: operations["postPromptVersion"];
|
|
243
374
|
delete?: never;
|
|
244
375
|
options?: never;
|
|
@@ -253,7 +384,10 @@ export interface paths {
|
|
|
253
384
|
path?: never;
|
|
254
385
|
cookie?: never;
|
|
255
386
|
};
|
|
256
|
-
/**
|
|
387
|
+
/**
|
|
388
|
+
* List prompt versions
|
|
389
|
+
* @description Retrieve all versions of a specific prompt with pagination support. Each prompt can have multiple versions with different configurations.
|
|
390
|
+
*/
|
|
257
391
|
get: operations["listPromptVersions"];
|
|
258
392
|
put?: never;
|
|
259
393
|
post?: never;
|
|
@@ -270,7 +404,10 @@ export interface paths {
|
|
|
270
404
|
path?: never;
|
|
271
405
|
cookie?: never;
|
|
272
406
|
};
|
|
273
|
-
/**
|
|
407
|
+
/**
|
|
408
|
+
* Get prompt version by ID
|
|
409
|
+
* @description Retrieve a specific prompt version using its unique identifier. A prompt version contains the actual template and configuration.
|
|
410
|
+
*/
|
|
274
411
|
get: operations["getPromptVersionByPromptVersionId"];
|
|
275
412
|
put?: never;
|
|
276
413
|
post?: never;
|
|
@@ -287,7 +424,10 @@ export interface paths {
|
|
|
287
424
|
path?: never;
|
|
288
425
|
cookie?: never;
|
|
289
426
|
};
|
|
290
|
-
/**
|
|
427
|
+
/**
|
|
428
|
+
* Get prompt version by tag
|
|
429
|
+
* @description Retrieve a specific prompt version using its tag name. Tags are used to identify specific versions of a prompt.
|
|
430
|
+
*/
|
|
291
431
|
get: operations["getPromptVersionByTagName"];
|
|
292
432
|
put?: never;
|
|
293
433
|
post?: never;
|
|
@@ -304,7 +444,10 @@ export interface paths {
|
|
|
304
444
|
path?: never;
|
|
305
445
|
cookie?: never;
|
|
306
446
|
};
|
|
307
|
-
/**
|
|
447
|
+
/**
|
|
448
|
+
* Get latest prompt version
|
|
449
|
+
* @description Retrieve the most recent version of a specific prompt.
|
|
450
|
+
*/
|
|
308
451
|
get: operations["getPromptVersionLatest"];
|
|
309
452
|
put?: never;
|
|
310
453
|
post?: never;
|
|
@@ -314,6 +457,82 @@ export interface paths {
|
|
|
314
457
|
patch?: never;
|
|
315
458
|
trace?: never;
|
|
316
459
|
};
|
|
460
|
+
"/v1/prompt_versions/{prompt_version_id}/tags": {
|
|
461
|
+
parameters: {
|
|
462
|
+
query?: never;
|
|
463
|
+
header?: never;
|
|
464
|
+
path?: never;
|
|
465
|
+
cookie?: never;
|
|
466
|
+
};
|
|
467
|
+
/**
|
|
468
|
+
* List prompt version tags
|
|
469
|
+
* @description Retrieve all tags associated with a specific prompt version. Tags are used to identify and categorize different versions of a prompt.
|
|
470
|
+
*/
|
|
471
|
+
get: operations["getPromptVersionTags"];
|
|
472
|
+
put?: never;
|
|
473
|
+
/**
|
|
474
|
+
* Add tag to prompt version
|
|
475
|
+
* @description Add a new tag to a specific prompt version. Tags help identify and categorize different versions of a prompt.
|
|
476
|
+
*/
|
|
477
|
+
post: operations["createPromptVersionTag"];
|
|
478
|
+
delete?: never;
|
|
479
|
+
options?: never;
|
|
480
|
+
head?: never;
|
|
481
|
+
patch?: never;
|
|
482
|
+
trace?: never;
|
|
483
|
+
};
|
|
484
|
+
"/v1/projects": {
|
|
485
|
+
parameters: {
|
|
486
|
+
query?: never;
|
|
487
|
+
header?: never;
|
|
488
|
+
path?: never;
|
|
489
|
+
cookie?: never;
|
|
490
|
+
};
|
|
491
|
+
/**
|
|
492
|
+
* List all projects
|
|
493
|
+
* @description Retrieve a paginated list of all projects in the system.
|
|
494
|
+
*/
|
|
495
|
+
get: operations["getProjects"];
|
|
496
|
+
put?: never;
|
|
497
|
+
/**
|
|
498
|
+
* Create a new project
|
|
499
|
+
* @description Create a new project with the specified configuration.
|
|
500
|
+
*/
|
|
501
|
+
post: operations["createProject"];
|
|
502
|
+
delete?: never;
|
|
503
|
+
options?: never;
|
|
504
|
+
head?: never;
|
|
505
|
+
patch?: never;
|
|
506
|
+
trace?: never;
|
|
507
|
+
};
|
|
508
|
+
"/v1/projects/{project_identifier}": {
|
|
509
|
+
parameters: {
|
|
510
|
+
query?: never;
|
|
511
|
+
header?: never;
|
|
512
|
+
path?: never;
|
|
513
|
+
cookie?: never;
|
|
514
|
+
};
|
|
515
|
+
/**
|
|
516
|
+
* Get project by ID or name
|
|
517
|
+
* @description Retrieve a specific project using its unique identifier: either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
|
|
518
|
+
*/
|
|
519
|
+
get: operations["getProject"];
|
|
520
|
+
/**
|
|
521
|
+
* Update a project by ID or name
|
|
522
|
+
* @description Update an existing project with new configuration. Project names cannot be changed. The project identifier is either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
|
|
523
|
+
*/
|
|
524
|
+
put: operations["updateProject"];
|
|
525
|
+
post?: never;
|
|
526
|
+
/**
|
|
527
|
+
* Delete a project by ID or name
|
|
528
|
+
* @description Delete an existing project and all its associated data. The project identifier is either project ID or project name. The default project cannot be deleted. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
|
|
529
|
+
*/
|
|
530
|
+
delete: operations["deleteProject"];
|
|
531
|
+
options?: never;
|
|
532
|
+
head?: never;
|
|
533
|
+
patch?: never;
|
|
534
|
+
trace?: never;
|
|
535
|
+
};
|
|
317
536
|
}
|
|
318
537
|
export type webhooks = Record<string, never>;
|
|
319
538
|
export interface components {
|
|
@@ -321,13 +540,95 @@ export interface components {
|
|
|
321
540
|
/** AnnotateSpansRequestBody */
|
|
322
541
|
AnnotateSpansRequestBody: {
|
|
323
542
|
/** Data */
|
|
324
|
-
data: components["schemas"]["
|
|
543
|
+
data: components["schemas"]["SpanAnnotationData"][];
|
|
325
544
|
};
|
|
326
545
|
/** AnnotateSpansResponseBody */
|
|
327
546
|
AnnotateSpansResponseBody: {
|
|
328
547
|
/** Data */
|
|
329
548
|
data: components["schemas"]["InsertedSpanAnnotation"][];
|
|
330
549
|
};
|
|
550
|
+
/** CategoricalAnnotationConfig */
|
|
551
|
+
CategoricalAnnotationConfig: {
|
|
552
|
+
/** Name */
|
|
553
|
+
name: string;
|
|
554
|
+
/**
|
|
555
|
+
* @description discriminator enum property added by openapi-typescript
|
|
556
|
+
* @enum {string}
|
|
557
|
+
*/
|
|
558
|
+
type: "CATEGORICAL";
|
|
559
|
+
/** Description */
|
|
560
|
+
description?: string | null;
|
|
561
|
+
optimization_direction: components["schemas"]["OptimizationDirection"];
|
|
562
|
+
/** Values */
|
|
563
|
+
values: components["schemas"]["CategoricalAnnotationValue"][];
|
|
564
|
+
/** Id */
|
|
565
|
+
id: string;
|
|
566
|
+
};
|
|
567
|
+
/** CategoricalAnnotationConfigData */
|
|
568
|
+
CategoricalAnnotationConfigData: {
|
|
569
|
+
/** Name */
|
|
570
|
+
name: string;
|
|
571
|
+
/**
|
|
572
|
+
* @description discriminator enum property added by openapi-typescript
|
|
573
|
+
* @enum {string}
|
|
574
|
+
*/
|
|
575
|
+
type: "CATEGORICAL";
|
|
576
|
+
/** Description */
|
|
577
|
+
description?: string | null;
|
|
578
|
+
optimization_direction: components["schemas"]["OptimizationDirection"];
|
|
579
|
+
/** Values */
|
|
580
|
+
values: components["schemas"]["CategoricalAnnotationValue"][];
|
|
581
|
+
};
|
|
582
|
+
/** CategoricalAnnotationValue */
|
|
583
|
+
CategoricalAnnotationValue: {
|
|
584
|
+
/** Label */
|
|
585
|
+
label: string;
|
|
586
|
+
/** Score */
|
|
587
|
+
score?: number | null;
|
|
588
|
+
};
|
|
589
|
+
/** ContinuousAnnotationConfig */
|
|
590
|
+
ContinuousAnnotationConfig: {
|
|
591
|
+
/** Name */
|
|
592
|
+
name: string;
|
|
593
|
+
/**
|
|
594
|
+
* @description discriminator enum property added by openapi-typescript
|
|
595
|
+
* @enum {string}
|
|
596
|
+
*/
|
|
597
|
+
type: "CONTINUOUS";
|
|
598
|
+
/** Description */
|
|
599
|
+
description?: string | null;
|
|
600
|
+
optimization_direction: components["schemas"]["OptimizationDirection"];
|
|
601
|
+
/** Lower Bound */
|
|
602
|
+
lower_bound?: number | null;
|
|
603
|
+
/** Upper Bound */
|
|
604
|
+
upper_bound?: number | null;
|
|
605
|
+
/** Id */
|
|
606
|
+
id: string;
|
|
607
|
+
};
|
|
608
|
+
/** ContinuousAnnotationConfigData */
|
|
609
|
+
ContinuousAnnotationConfigData: {
|
|
610
|
+
/** Name */
|
|
611
|
+
name: string;
|
|
612
|
+
/**
|
|
613
|
+
* @description discriminator enum property added by openapi-typescript
|
|
614
|
+
* @enum {string}
|
|
615
|
+
*/
|
|
616
|
+
type: "CONTINUOUS";
|
|
617
|
+
/** Description */
|
|
618
|
+
description?: string | null;
|
|
619
|
+
optimization_direction: components["schemas"]["OptimizationDirection"];
|
|
620
|
+
/** Lower Bound */
|
|
621
|
+
lower_bound?: number | null;
|
|
622
|
+
/** Upper Bound */
|
|
623
|
+
upper_bound?: number | null;
|
|
624
|
+
};
|
|
625
|
+
/** CreateAnnotationConfigData */
|
|
626
|
+
CreateAnnotationConfigData: components["schemas"]["CategoricalAnnotationConfigData"] | components["schemas"]["ContinuousAnnotationConfigData"] | components["schemas"]["FreeformAnnotationConfigData"];
|
|
627
|
+
/** CreateAnnotationConfigResponseBody */
|
|
628
|
+
CreateAnnotationConfigResponseBody: {
|
|
629
|
+
/** Data */
|
|
630
|
+
data: components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
|
|
631
|
+
};
|
|
331
632
|
/**
|
|
332
633
|
* CreateExperimentRequestBody
|
|
333
634
|
* @description Details of the experiment to be created
|
|
@@ -347,7 +648,9 @@ export interface components {
|
|
|
347
648
|
* Metadata
|
|
348
649
|
* @description Metadata for the experiment
|
|
349
650
|
*/
|
|
350
|
-
metadata?:
|
|
651
|
+
metadata?: {
|
|
652
|
+
[key: string]: unknown;
|
|
653
|
+
} | null;
|
|
351
654
|
/**
|
|
352
655
|
* Version Id
|
|
353
656
|
* @description ID of the dataset version over which the experiment will be run (if omitted, the latest version will be used)
|
|
@@ -358,12 +661,75 @@ export interface components {
|
|
|
358
661
|
* @description Number of times the experiment should be repeated for each example
|
|
359
662
|
* @default 1
|
|
360
663
|
*/
|
|
361
|
-
repetitions
|
|
664
|
+
repetitions?: number;
|
|
362
665
|
};
|
|
363
666
|
/** CreateExperimentResponseBody */
|
|
364
667
|
CreateExperimentResponseBody: {
|
|
365
668
|
data: components["schemas"]["Experiment"];
|
|
366
669
|
};
|
|
670
|
+
/** CreateExperimentRunRequestBody */
|
|
671
|
+
CreateExperimentRunRequestBody: {
|
|
672
|
+
/**
|
|
673
|
+
* Dataset Example Id
|
|
674
|
+
* @description The ID of the dataset example used in the experiment run
|
|
675
|
+
*/
|
|
676
|
+
dataset_example_id: string;
|
|
677
|
+
/**
|
|
678
|
+
* Output
|
|
679
|
+
* @description The output of the experiment task
|
|
680
|
+
*/
|
|
681
|
+
output: unknown;
|
|
682
|
+
/**
|
|
683
|
+
* Repetition Number
|
|
684
|
+
* @description The repetition number of the experiment run
|
|
685
|
+
*/
|
|
686
|
+
repetition_number: number;
|
|
687
|
+
/**
|
|
688
|
+
* Start Time
|
|
689
|
+
* Format: date-time
|
|
690
|
+
* @description The start time of the experiment run
|
|
691
|
+
*/
|
|
692
|
+
start_time: string;
|
|
693
|
+
/**
|
|
694
|
+
* End Time
|
|
695
|
+
* Format: date-time
|
|
696
|
+
* @description The end time of the experiment run
|
|
697
|
+
*/
|
|
698
|
+
end_time: string;
|
|
699
|
+
/**
|
|
700
|
+
* Trace Id
|
|
701
|
+
* @description The ID of the corresponding trace (if one exists)
|
|
702
|
+
*/
|
|
703
|
+
trace_id?: string | null;
|
|
704
|
+
/**
|
|
705
|
+
* Error
|
|
706
|
+
* @description Optional error message if the experiment run encountered an error
|
|
707
|
+
*/
|
|
708
|
+
error?: string | null;
|
|
709
|
+
};
|
|
710
|
+
/** CreateExperimentRunResponseBody */
|
|
711
|
+
CreateExperimentRunResponseBody: {
|
|
712
|
+
data: components["schemas"]["CreateExperimentRunResponseBodyData"];
|
|
713
|
+
};
|
|
714
|
+
/** CreateExperimentRunResponseBodyData */
|
|
715
|
+
CreateExperimentRunResponseBodyData: {
|
|
716
|
+
/**
|
|
717
|
+
* Id
|
|
718
|
+
* @description The ID of the newly created experiment run
|
|
719
|
+
*/
|
|
720
|
+
id: string;
|
|
721
|
+
};
|
|
722
|
+
/** CreateProjectRequestBody */
|
|
723
|
+
CreateProjectRequestBody: {
|
|
724
|
+
/** Name */
|
|
725
|
+
name: string;
|
|
726
|
+
/** Description */
|
|
727
|
+
description?: string | null;
|
|
728
|
+
};
|
|
729
|
+
/** CreateProjectResponseBody */
|
|
730
|
+
CreateProjectResponseBody: {
|
|
731
|
+
data: components["schemas"]["Project"];
|
|
732
|
+
};
|
|
367
733
|
/** CreatePromptRequestBody */
|
|
368
734
|
CreatePromptRequestBody: {
|
|
369
735
|
prompt: components["schemas"]["PromptData"];
|
|
@@ -382,7 +748,9 @@ export interface components {
|
|
|
382
748
|
/** Description */
|
|
383
749
|
description: string | null;
|
|
384
750
|
/** Metadata */
|
|
385
|
-
metadata:
|
|
751
|
+
metadata: {
|
|
752
|
+
[key: string]: unknown;
|
|
753
|
+
};
|
|
386
754
|
/**
|
|
387
755
|
* Created At
|
|
388
756
|
* Format: date-time
|
|
@@ -399,11 +767,17 @@ export interface components {
|
|
|
399
767
|
/** Id */
|
|
400
768
|
id: string;
|
|
401
769
|
/** Input */
|
|
402
|
-
input:
|
|
770
|
+
input: {
|
|
771
|
+
[key: string]: unknown;
|
|
772
|
+
};
|
|
403
773
|
/** Output */
|
|
404
|
-
output:
|
|
774
|
+
output: {
|
|
775
|
+
[key: string]: unknown;
|
|
776
|
+
};
|
|
405
777
|
/** Metadata */
|
|
406
|
-
metadata:
|
|
778
|
+
metadata: {
|
|
779
|
+
[key: string]: unknown;
|
|
780
|
+
};
|
|
407
781
|
/**
|
|
408
782
|
* Updated At
|
|
409
783
|
* Format: date-time
|
|
@@ -417,7 +791,9 @@ export interface components {
|
|
|
417
791
|
/** Description */
|
|
418
792
|
description: string | null;
|
|
419
793
|
/** Metadata */
|
|
420
|
-
metadata:
|
|
794
|
+
metadata: {
|
|
795
|
+
[key: string]: unknown;
|
|
796
|
+
};
|
|
421
797
|
/**
|
|
422
798
|
* Created At
|
|
423
799
|
* Format: date-time
|
|
@@ -433,7 +809,9 @@ export interface components {
|
|
|
433
809
|
/** Description */
|
|
434
810
|
description: string | null;
|
|
435
811
|
/** Metadata */
|
|
436
|
-
metadata:
|
|
812
|
+
metadata: {
|
|
813
|
+
[key: string]: unknown;
|
|
814
|
+
};
|
|
437
815
|
/**
|
|
438
816
|
* Created At
|
|
439
817
|
* Format: date-time
|
|
@@ -447,6 +825,11 @@ export interface components {
|
|
|
447
825
|
/** Example Count */
|
|
448
826
|
example_count: number;
|
|
449
827
|
};
|
|
828
|
+
/** DeleteAnnotationConfigResponseBody */
|
|
829
|
+
DeleteAnnotationConfigResponseBody: {
|
|
830
|
+
/** Data */
|
|
831
|
+
data: components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
|
|
832
|
+
};
|
|
450
833
|
/** Experiment */
|
|
451
834
|
Experiment: {
|
|
452
835
|
/**
|
|
@@ -473,7 +856,9 @@ export interface components {
|
|
|
473
856
|
* Metadata
|
|
474
857
|
* @description Metadata of the experiment
|
|
475
858
|
*/
|
|
476
|
-
metadata:
|
|
859
|
+
metadata: {
|
|
860
|
+
[key: string]: unknown;
|
|
861
|
+
};
|
|
477
862
|
/**
|
|
478
863
|
* Project Name
|
|
479
864
|
* @description The name of the project associated with the experiment
|
|
@@ -492,27 +877,155 @@ export interface components {
|
|
|
492
877
|
*/
|
|
493
878
|
updated_at: string;
|
|
494
879
|
};
|
|
495
|
-
/**
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
880
|
+
/** ExperimentEvaluationResult */
|
|
881
|
+
ExperimentEvaluationResult: {
|
|
882
|
+
/**
|
|
883
|
+
* Label
|
|
884
|
+
* @description The label assigned by the evaluation
|
|
885
|
+
*/
|
|
886
|
+
label?: string | null;
|
|
887
|
+
/**
|
|
888
|
+
* Score
|
|
889
|
+
* @description The score assigned by the evaluation
|
|
890
|
+
*/
|
|
891
|
+
score?: number | null;
|
|
892
|
+
/**
|
|
893
|
+
* Explanation
|
|
894
|
+
* @description Explanation of the evaluation result
|
|
895
|
+
*/
|
|
896
|
+
explanation?: string | null;
|
|
897
|
+
};
|
|
898
|
+
/** ExperimentRunResponse */
|
|
899
|
+
ExperimentRunResponse: {
|
|
900
|
+
/**
|
|
901
|
+
* Dataset Example Id
|
|
902
|
+
* @description The ID of the dataset example used in the experiment run
|
|
903
|
+
*/
|
|
904
|
+
dataset_example_id: string;
|
|
905
|
+
/**
|
|
906
|
+
* Output
|
|
907
|
+
* @description The output of the experiment task
|
|
908
|
+
*/
|
|
909
|
+
output: unknown;
|
|
910
|
+
/**
|
|
911
|
+
* Repetition Number
|
|
912
|
+
* @description The repetition number of the experiment run
|
|
913
|
+
*/
|
|
914
|
+
repetition_number: number;
|
|
915
|
+
/**
|
|
916
|
+
* Start Time
|
|
917
|
+
* Format: date-time
|
|
918
|
+
* @description The start time of the experiment run
|
|
919
|
+
*/
|
|
920
|
+
start_time: string;
|
|
921
|
+
/**
|
|
922
|
+
* End Time
|
|
923
|
+
* Format: date-time
|
|
924
|
+
* @description The end time of the experiment run
|
|
925
|
+
*/
|
|
926
|
+
end_time: string;
|
|
927
|
+
/**
|
|
928
|
+
* Trace Id
|
|
929
|
+
* @description The ID of the corresponding trace (if one exists)
|
|
930
|
+
*/
|
|
931
|
+
trace_id?: string | null;
|
|
932
|
+
/**
|
|
933
|
+
* Error
|
|
934
|
+
* @description Optional error message if the experiment run encountered an error
|
|
935
|
+
*/
|
|
936
|
+
error?: string | null;
|
|
937
|
+
/**
|
|
938
|
+
* Id
|
|
939
|
+
* @description The ID of the experiment run
|
|
940
|
+
*/
|
|
941
|
+
id: string;
|
|
942
|
+
/**
|
|
943
|
+
* Experiment Id
|
|
944
|
+
* @description The ID of the experiment
|
|
945
|
+
*/
|
|
946
|
+
experiment_id: string;
|
|
947
|
+
};
|
|
948
|
+
/** FreeformAnnotationConfig */
|
|
949
|
+
FreeformAnnotationConfig: {
|
|
950
|
+
/** Name */
|
|
951
|
+
name: string;
|
|
952
|
+
/**
|
|
953
|
+
* @description discriminator enum property added by openapi-typescript
|
|
954
|
+
* @enum {string}
|
|
955
|
+
*/
|
|
956
|
+
type: "FREEFORM";
|
|
957
|
+
/** Description */
|
|
958
|
+
description?: string | null;
|
|
959
|
+
/** Id */
|
|
960
|
+
id: string;
|
|
961
|
+
};
|
|
962
|
+
/** FreeformAnnotationConfigData */
|
|
963
|
+
FreeformAnnotationConfigData: {
|
|
964
|
+
/** Name */
|
|
965
|
+
name: string;
|
|
966
|
+
/**
|
|
967
|
+
* @description discriminator enum property added by openapi-typescript
|
|
968
|
+
* @enum {string}
|
|
969
|
+
*/
|
|
970
|
+
type: "FREEFORM";
|
|
971
|
+
/** Description */
|
|
972
|
+
description?: string | null;
|
|
973
|
+
};
|
|
974
|
+
/** GetAnnotationConfigResponseBody */
|
|
975
|
+
GetAnnotationConfigResponseBody: {
|
|
976
|
+
/** Data */
|
|
977
|
+
data: components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
|
|
978
|
+
};
|
|
979
|
+
/** GetAnnotationConfigsResponseBody */
|
|
980
|
+
GetAnnotationConfigsResponseBody: {
|
|
981
|
+
/** Data */
|
|
982
|
+
data: (components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"])[];
|
|
983
|
+
/** Next Cursor */
|
|
984
|
+
next_cursor: string | null;
|
|
985
|
+
};
|
|
986
|
+
/** GetDatasetResponseBody */
|
|
987
|
+
GetDatasetResponseBody: {
|
|
988
|
+
data: components["schemas"]["DatasetWithExampleCount"];
|
|
989
|
+
};
|
|
990
|
+
/** GetExperimentResponseBody */
|
|
991
|
+
GetExperimentResponseBody: {
|
|
992
|
+
data: components["schemas"]["Experiment"];
|
|
993
|
+
};
|
|
994
|
+
/** GetProjectResponseBody */
|
|
995
|
+
GetProjectResponseBody: {
|
|
996
|
+
data: components["schemas"]["Project"];
|
|
997
|
+
};
|
|
998
|
+
/** GetProjectsResponseBody */
|
|
999
|
+
GetProjectsResponseBody: {
|
|
1000
|
+
/** Data */
|
|
1001
|
+
data: components["schemas"]["Project"][];
|
|
1002
|
+
/** Next Cursor */
|
|
1003
|
+
next_cursor: string | null;
|
|
1004
|
+
};
|
|
1005
|
+
/** GetPromptResponseBody */
|
|
1006
|
+
GetPromptResponseBody: {
|
|
1007
|
+
data: components["schemas"]["PromptVersion"];
|
|
1008
|
+
};
|
|
1009
|
+
/** GetPromptVersionTagsResponseBody */
|
|
1010
|
+
GetPromptVersionTagsResponseBody: {
|
|
1011
|
+
/** Data */
|
|
1012
|
+
data: components["schemas"]["PromptVersionTag"][];
|
|
1013
|
+
/** Next Cursor */
|
|
1014
|
+
next_cursor: string | null;
|
|
1015
|
+
};
|
|
1016
|
+
/** GetPromptVersionsResponseBody */
|
|
508
1017
|
GetPromptVersionsResponseBody: {
|
|
509
1018
|
/** Data */
|
|
510
1019
|
data: components["schemas"]["PromptVersion"][];
|
|
1020
|
+
/** Next Cursor */
|
|
1021
|
+
next_cursor: string | null;
|
|
511
1022
|
};
|
|
512
1023
|
/** GetPromptsResponseBody */
|
|
513
1024
|
GetPromptsResponseBody: {
|
|
514
1025
|
/** Data */
|
|
515
1026
|
data: components["schemas"]["Prompt"][];
|
|
1027
|
+
/** Next Cursor */
|
|
1028
|
+
next_cursor: string | null;
|
|
516
1029
|
};
|
|
517
1030
|
/** HTTPValidationError */
|
|
518
1031
|
HTTPValidationError: {
|
|
@@ -556,6 +1069,11 @@ export interface components {
|
|
|
556
1069
|
/** Next Cursor */
|
|
557
1070
|
next_cursor: string | null;
|
|
558
1071
|
};
|
|
1072
|
+
/** ListExperimentRunsResponseBody */
|
|
1073
|
+
ListExperimentRunsResponseBody: {
|
|
1074
|
+
/** Data */
|
|
1075
|
+
data: components["schemas"]["ExperimentRunResponse"][];
|
|
1076
|
+
};
|
|
559
1077
|
/** ListExperimentsResponseBody */
|
|
560
1078
|
ListExperimentsResponseBody: {
|
|
561
1079
|
/** Data */
|
|
@@ -566,6 +1084,20 @@ export interface components {
|
|
|
566
1084
|
* @enum {string}
|
|
567
1085
|
*/
|
|
568
1086
|
ModelProvider: "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE";
|
|
1087
|
+
/**
|
|
1088
|
+
* OptimizationDirection
|
|
1089
|
+
* @enum {string}
|
|
1090
|
+
*/
|
|
1091
|
+
OptimizationDirection: "MINIMIZE" | "MAXIMIZE" | "NONE";
|
|
1092
|
+
/** Project */
|
|
1093
|
+
Project: {
|
|
1094
|
+
/** Name */
|
|
1095
|
+
name: string;
|
|
1096
|
+
/** Description */
|
|
1097
|
+
description?: string | null;
|
|
1098
|
+
/** Id */
|
|
1099
|
+
id: string;
|
|
1100
|
+
};
|
|
569
1101
|
/** Prompt */
|
|
570
1102
|
Prompt: {
|
|
571
1103
|
name: components["schemas"]["Identifier"];
|
|
@@ -748,7 +1280,9 @@ export interface components {
|
|
|
748
1280
|
/** Description */
|
|
749
1281
|
description?: string;
|
|
750
1282
|
/** Schema */
|
|
751
|
-
schema?:
|
|
1283
|
+
schema?: {
|
|
1284
|
+
[key: string]: unknown;
|
|
1285
|
+
};
|
|
752
1286
|
/** Strict */
|
|
753
1287
|
strict?: boolean;
|
|
754
1288
|
};
|
|
@@ -822,7 +1356,9 @@ export interface components {
|
|
|
822
1356
|
/** Description */
|
|
823
1357
|
description?: string;
|
|
824
1358
|
/** Parameters */
|
|
825
|
-
parameters?:
|
|
1359
|
+
parameters?: {
|
|
1360
|
+
[key: string]: unknown;
|
|
1361
|
+
};
|
|
826
1362
|
/** Strict */
|
|
827
1363
|
strict?: boolean;
|
|
828
1364
|
};
|
|
@@ -876,6 +1412,20 @@ export interface components {
|
|
|
876
1412
|
/** Response Format */
|
|
877
1413
|
response_format?: components["schemas"]["PromptResponseFormatJSONSchema"] | null;
|
|
878
1414
|
};
|
|
1415
|
+
/** PromptVersionTag */
|
|
1416
|
+
PromptVersionTag: {
|
|
1417
|
+
name: components["schemas"]["Identifier"];
|
|
1418
|
+
/** Description */
|
|
1419
|
+
description?: string | null;
|
|
1420
|
+
/** Id */
|
|
1421
|
+
id: string;
|
|
1422
|
+
};
|
|
1423
|
+
/** PromptVersionTagData */
|
|
1424
|
+
PromptVersionTagData: {
|
|
1425
|
+
name: components["schemas"]["Identifier"];
|
|
1426
|
+
/** Description */
|
|
1427
|
+
description?: string | null;
|
|
1428
|
+
};
|
|
879
1429
|
/** SpanAnnotation */
|
|
880
1430
|
SpanAnnotation: {
|
|
881
1431
|
/**
|
|
@@ -893,14 +1443,75 @@ export interface components {
|
|
|
893
1443
|
* @description The kind of annotator used for the annotation
|
|
894
1444
|
* @enum {string}
|
|
895
1445
|
*/
|
|
896
|
-
annotator_kind: "LLM" | "HUMAN";
|
|
1446
|
+
annotator_kind: "LLM" | "CODE" | "HUMAN";
|
|
1447
|
+
/** @description The result of the annotation */
|
|
1448
|
+
result?: components["schemas"]["SpanAnnotationResult"] | null;
|
|
1449
|
+
/**
|
|
1450
|
+
* Metadata
|
|
1451
|
+
* @description Metadata for the annotation
|
|
1452
|
+
*/
|
|
1453
|
+
metadata?: {
|
|
1454
|
+
[key: string]: unknown;
|
|
1455
|
+
} | null;
|
|
1456
|
+
/**
|
|
1457
|
+
* Identifier
|
|
1458
|
+
* @description The identifier of the annotation. If provided, the annotation will be updated if it already exists.
|
|
1459
|
+
* @default
|
|
1460
|
+
*/
|
|
1461
|
+
identifier?: string;
|
|
1462
|
+
/** Id */
|
|
1463
|
+
id: string;
|
|
1464
|
+
/**
|
|
1465
|
+
* Created At
|
|
1466
|
+
* Format: date-time
|
|
1467
|
+
*/
|
|
1468
|
+
created_at: string;
|
|
1469
|
+
/**
|
|
1470
|
+
* Updated At
|
|
1471
|
+
* Format: date-time
|
|
1472
|
+
*/
|
|
1473
|
+
updated_at: string;
|
|
1474
|
+
/**
|
|
1475
|
+
* Source
|
|
1476
|
+
* @enum {string}
|
|
1477
|
+
*/
|
|
1478
|
+
source: "API" | "APP";
|
|
1479
|
+
/** User Id */
|
|
1480
|
+
user_id: string | null;
|
|
1481
|
+
};
|
|
1482
|
+
/** SpanAnnotationData */
|
|
1483
|
+
SpanAnnotationData: {
|
|
1484
|
+
/**
|
|
1485
|
+
* Span Id
|
|
1486
|
+
* @description OpenTelemetry Span ID (hex format w/o 0x prefix)
|
|
1487
|
+
*/
|
|
1488
|
+
span_id: string;
|
|
1489
|
+
/**
|
|
1490
|
+
* Name
|
|
1491
|
+
* @description The name of the annotation
|
|
1492
|
+
*/
|
|
1493
|
+
name: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* Annotator Kind
|
|
1496
|
+
* @description The kind of annotator used for the annotation
|
|
1497
|
+
* @enum {string}
|
|
1498
|
+
*/
|
|
1499
|
+
annotator_kind: "LLM" | "CODE" | "HUMAN";
|
|
897
1500
|
/** @description The result of the annotation */
|
|
898
1501
|
result?: components["schemas"]["SpanAnnotationResult"] | null;
|
|
899
1502
|
/**
|
|
900
1503
|
* Metadata
|
|
901
1504
|
* @description Metadata for the annotation
|
|
902
1505
|
*/
|
|
903
|
-
metadata?:
|
|
1506
|
+
metadata?: {
|
|
1507
|
+
[key: string]: unknown;
|
|
1508
|
+
} | null;
|
|
1509
|
+
/**
|
|
1510
|
+
* Identifier
|
|
1511
|
+
* @description The identifier of the annotation. If provided, the annotation will be updated if it already exists.
|
|
1512
|
+
* @default
|
|
1513
|
+
*/
|
|
1514
|
+
identifier?: string;
|
|
904
1515
|
};
|
|
905
1516
|
/** SpanAnnotationResult */
|
|
906
1517
|
SpanAnnotationResult: {
|
|
@@ -920,6 +1531,13 @@ export interface components {
|
|
|
920
1531
|
*/
|
|
921
1532
|
explanation?: string | null;
|
|
922
1533
|
};
|
|
1534
|
+
/** SpanAnnotationsResponseBody */
|
|
1535
|
+
SpanAnnotationsResponseBody: {
|
|
1536
|
+
/** Data */
|
|
1537
|
+
data: components["schemas"]["SpanAnnotation"][];
|
|
1538
|
+
/** Next Cursor */
|
|
1539
|
+
next_cursor: string | null;
|
|
1540
|
+
};
|
|
923
1541
|
/** TextContentPart */
|
|
924
1542
|
TextContentPart: {
|
|
925
1543
|
/**
|
|
@@ -964,7 +1582,23 @@ export interface components {
|
|
|
964
1582
|
/** Tool Call Id */
|
|
965
1583
|
tool_call_id: string;
|
|
966
1584
|
/** Tool Result */
|
|
967
|
-
tool_result: boolean | number | string |
|
|
1585
|
+
tool_result: boolean | number | string | {
|
|
1586
|
+
[key: string]: unknown;
|
|
1587
|
+
} | unknown[] | null;
|
|
1588
|
+
};
|
|
1589
|
+
/** UpdateAnnotationConfigResponseBody */
|
|
1590
|
+
UpdateAnnotationConfigResponseBody: {
|
|
1591
|
+
/** Data */
|
|
1592
|
+
data: components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
|
|
1593
|
+
};
|
|
1594
|
+
/** UpdateProjectRequestBody */
|
|
1595
|
+
UpdateProjectRequestBody: {
|
|
1596
|
+
/** Description */
|
|
1597
|
+
description?: string | null;
|
|
1598
|
+
};
|
|
1599
|
+
/** UpdateProjectResponseBody */
|
|
1600
|
+
UpdateProjectResponseBody: {
|
|
1601
|
+
data: components["schemas"]["Project"];
|
|
968
1602
|
};
|
|
969
1603
|
/** UploadDatasetData */
|
|
970
1604
|
UploadDatasetData: {
|
|
@@ -975,6 +1609,68 @@ export interface components {
|
|
|
975
1609
|
UploadDatasetResponseBody: {
|
|
976
1610
|
data: components["schemas"]["UploadDatasetData"];
|
|
977
1611
|
};
|
|
1612
|
+
/** UpsertExperimentEvaluationRequestBody */
|
|
1613
|
+
UpsertExperimentEvaluationRequestBody: {
|
|
1614
|
+
/**
|
|
1615
|
+
* Experiment Run Id
|
|
1616
|
+
* @description The ID of the experiment run being evaluated
|
|
1617
|
+
*/
|
|
1618
|
+
experiment_run_id: string;
|
|
1619
|
+
/**
|
|
1620
|
+
* Name
|
|
1621
|
+
* @description The name of the evaluation
|
|
1622
|
+
*/
|
|
1623
|
+
name: string;
|
|
1624
|
+
/**
|
|
1625
|
+
* Annotator Kind
|
|
1626
|
+
* @description The kind of annotator used for the evaluation
|
|
1627
|
+
* @enum {string}
|
|
1628
|
+
*/
|
|
1629
|
+
annotator_kind: "LLM" | "CODE" | "HUMAN";
|
|
1630
|
+
/**
|
|
1631
|
+
* Start Time
|
|
1632
|
+
* Format: date-time
|
|
1633
|
+
* @description The start time of the evaluation in ISO format
|
|
1634
|
+
*/
|
|
1635
|
+
start_time: string;
|
|
1636
|
+
/**
|
|
1637
|
+
* End Time
|
|
1638
|
+
* Format: date-time
|
|
1639
|
+
* @description The end time of the evaluation in ISO format
|
|
1640
|
+
*/
|
|
1641
|
+
end_time: string;
|
|
1642
|
+
/** @description The result of the evaluation */
|
|
1643
|
+
result: components["schemas"]["ExperimentEvaluationResult"];
|
|
1644
|
+
/**
|
|
1645
|
+
* Error
|
|
1646
|
+
* @description Optional error message if the evaluation encountered an error
|
|
1647
|
+
*/
|
|
1648
|
+
error?: string | null;
|
|
1649
|
+
/**
|
|
1650
|
+
* Metadata
|
|
1651
|
+
* @description Metadata for the evaluation
|
|
1652
|
+
*/
|
|
1653
|
+
metadata?: {
|
|
1654
|
+
[key: string]: unknown;
|
|
1655
|
+
} | null;
|
|
1656
|
+
/**
|
|
1657
|
+
* Trace Id
|
|
1658
|
+
* @description Optional trace ID for tracking
|
|
1659
|
+
*/
|
|
1660
|
+
trace_id?: string | null;
|
|
1661
|
+
};
|
|
1662
|
+
/** UpsertExperimentEvaluationResponseBody */
|
|
1663
|
+
UpsertExperimentEvaluationResponseBody: {
|
|
1664
|
+
data: components["schemas"]["UpsertExperimentEvaluationResponseBodyData"];
|
|
1665
|
+
};
|
|
1666
|
+
/** UpsertExperimentEvaluationResponseBodyData */
|
|
1667
|
+
UpsertExperimentEvaluationResponseBodyData: {
|
|
1668
|
+
/**
|
|
1669
|
+
* Id
|
|
1670
|
+
* @description The ID of the upserted experiment evaluation
|
|
1671
|
+
*/
|
|
1672
|
+
id: string;
|
|
1673
|
+
};
|
|
978
1674
|
/** ValidationError */
|
|
979
1675
|
ValidationError: {
|
|
980
1676
|
/** Location */
|
|
@@ -993,14 +1689,12 @@ export interface components {
|
|
|
993
1689
|
}
|
|
994
1690
|
export type $defs = Record<string, never>;
|
|
995
1691
|
export interface operations {
|
|
996
|
-
|
|
1692
|
+
list_annotation_configs_v1_annotation_configs_get: {
|
|
997
1693
|
parameters: {
|
|
998
1694
|
query?: {
|
|
999
|
-
/** @description Cursor for pagination */
|
|
1695
|
+
/** @description Cursor for pagination (base64-encoded annotation config ID) */
|
|
1000
1696
|
cursor?: string | null;
|
|
1001
|
-
/** @description
|
|
1002
|
-
name?: string | null;
|
|
1003
|
-
/** @description The max number of datasets to return at a time. */
|
|
1697
|
+
/** @description Maximum number of configs to return */
|
|
1004
1698
|
limit?: number;
|
|
1005
1699
|
};
|
|
1006
1700
|
header?: never;
|
|
@@ -1009,13 +1703,13 @@ export interface operations {
|
|
|
1009
1703
|
};
|
|
1010
1704
|
requestBody?: never;
|
|
1011
1705
|
responses: {
|
|
1012
|
-
/** @description
|
|
1706
|
+
/** @description A list of annotation configurations with pagination information */
|
|
1013
1707
|
200: {
|
|
1014
1708
|
headers: {
|
|
1015
1709
|
[name: string]: unknown;
|
|
1016
1710
|
};
|
|
1017
1711
|
content: {
|
|
1018
|
-
"application/json": components["schemas"]["
|
|
1712
|
+
"application/json": components["schemas"]["GetAnnotationConfigsResponseBody"];
|
|
1019
1713
|
};
|
|
1020
1714
|
};
|
|
1021
1715
|
/** @description Forbidden */
|
|
@@ -1027,28 +1721,29 @@ export interface operations {
|
|
|
1027
1721
|
"text/plain": string;
|
|
1028
1722
|
};
|
|
1029
1723
|
};
|
|
1030
|
-
/** @description
|
|
1724
|
+
/** @description Validation Error */
|
|
1031
1725
|
422: {
|
|
1032
1726
|
headers: {
|
|
1033
1727
|
[name: string]: unknown;
|
|
1034
1728
|
};
|
|
1035
1729
|
content: {
|
|
1036
|
-
"
|
|
1730
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1037
1731
|
};
|
|
1038
1732
|
};
|
|
1039
1733
|
};
|
|
1040
1734
|
};
|
|
1041
|
-
|
|
1735
|
+
create_annotation_config_v1_annotation_configs_post: {
|
|
1042
1736
|
parameters: {
|
|
1043
1737
|
query?: never;
|
|
1044
1738
|
header?: never;
|
|
1045
|
-
path
|
|
1046
|
-
/** @description The ID of the dataset */
|
|
1047
|
-
id: string;
|
|
1048
|
-
};
|
|
1739
|
+
path?: never;
|
|
1049
1740
|
cookie?: never;
|
|
1050
1741
|
};
|
|
1051
|
-
requestBody
|
|
1742
|
+
requestBody: {
|
|
1743
|
+
content: {
|
|
1744
|
+
"application/json": components["schemas"]["CreateAnnotationConfigData"];
|
|
1745
|
+
};
|
|
1746
|
+
};
|
|
1052
1747
|
responses: {
|
|
1053
1748
|
/** @description Successful Response */
|
|
1054
1749
|
200: {
|
|
@@ -1056,7 +1751,7 @@ export interface operations {
|
|
|
1056
1751
|
[name: string]: unknown;
|
|
1057
1752
|
};
|
|
1058
1753
|
content: {
|
|
1059
|
-
"application/json": components["schemas"]["
|
|
1754
|
+
"application/json": components["schemas"]["CreateAnnotationConfigResponseBody"];
|
|
1060
1755
|
};
|
|
1061
1756
|
};
|
|
1062
1757
|
/** @description Forbidden */
|
|
@@ -1068,15 +1763,6 @@ export interface operations {
|
|
|
1068
1763
|
"text/plain": string;
|
|
1069
1764
|
};
|
|
1070
1765
|
};
|
|
1071
|
-
/** @description Not Found */
|
|
1072
|
-
404: {
|
|
1073
|
-
headers: {
|
|
1074
|
-
[name: string]: unknown;
|
|
1075
|
-
};
|
|
1076
|
-
content: {
|
|
1077
|
-
"text/plain": string;
|
|
1078
|
-
};
|
|
1079
|
-
};
|
|
1080
1766
|
/** @description Validation Error */
|
|
1081
1767
|
422: {
|
|
1082
1768
|
headers: {
|
|
@@ -1088,36 +1774,29 @@ export interface operations {
|
|
|
1088
1774
|
};
|
|
1089
1775
|
};
|
|
1090
1776
|
};
|
|
1091
|
-
|
|
1777
|
+
get_annotation_config_by_name_or_id_v1_annotation_configs__config_identifier__get: {
|
|
1092
1778
|
parameters: {
|
|
1093
1779
|
query?: never;
|
|
1094
1780
|
header?: never;
|
|
1095
1781
|
path: {
|
|
1096
|
-
/** @description
|
|
1097
|
-
|
|
1782
|
+
/** @description ID or name of the annotation configuration */
|
|
1783
|
+
config_identifier: string;
|
|
1098
1784
|
};
|
|
1099
1785
|
cookie?: never;
|
|
1100
1786
|
};
|
|
1101
1787
|
requestBody?: never;
|
|
1102
1788
|
responses: {
|
|
1103
1789
|
/** @description Successful Response */
|
|
1104
|
-
|
|
1105
|
-
headers: {
|
|
1106
|
-
[name: string]: unknown;
|
|
1107
|
-
};
|
|
1108
|
-
content?: never;
|
|
1109
|
-
};
|
|
1110
|
-
/** @description Forbidden */
|
|
1111
|
-
403: {
|
|
1790
|
+
200: {
|
|
1112
1791
|
headers: {
|
|
1113
1792
|
[name: string]: unknown;
|
|
1114
1793
|
};
|
|
1115
1794
|
content: {
|
|
1116
|
-
"
|
|
1795
|
+
"application/json": components["schemas"]["GetAnnotationConfigResponseBody"];
|
|
1117
1796
|
};
|
|
1118
1797
|
};
|
|
1119
|
-
/** @description
|
|
1120
|
-
|
|
1798
|
+
/** @description Forbidden */
|
|
1799
|
+
403: {
|
|
1121
1800
|
headers: {
|
|
1122
1801
|
[name: string]: unknown;
|
|
1123
1802
|
};
|
|
@@ -1125,33 +1804,32 @@ export interface operations {
|
|
|
1125
1804
|
"text/plain": string;
|
|
1126
1805
|
};
|
|
1127
1806
|
};
|
|
1128
|
-
/** @description
|
|
1807
|
+
/** @description Validation Error */
|
|
1129
1808
|
422: {
|
|
1130
1809
|
headers: {
|
|
1131
1810
|
[name: string]: unknown;
|
|
1132
1811
|
};
|
|
1133
1812
|
content: {
|
|
1134
|
-
"
|
|
1813
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1135
1814
|
};
|
|
1136
1815
|
};
|
|
1137
1816
|
};
|
|
1138
1817
|
};
|
|
1139
|
-
|
|
1818
|
+
update_annotation_config_v1_annotation_configs__config_id__put: {
|
|
1140
1819
|
parameters: {
|
|
1141
|
-
query?:
|
|
1142
|
-
/** @description Cursor for pagination */
|
|
1143
|
-
cursor?: string | null;
|
|
1144
|
-
/** @description The max number of dataset versions to return at a time */
|
|
1145
|
-
limit?: number;
|
|
1146
|
-
};
|
|
1820
|
+
query?: never;
|
|
1147
1821
|
header?: never;
|
|
1148
1822
|
path: {
|
|
1149
|
-
/** @description
|
|
1150
|
-
|
|
1823
|
+
/** @description ID of the annotation configuration */
|
|
1824
|
+
config_id: string;
|
|
1151
1825
|
};
|
|
1152
1826
|
cookie?: never;
|
|
1153
1827
|
};
|
|
1154
|
-
requestBody
|
|
1828
|
+
requestBody: {
|
|
1829
|
+
content: {
|
|
1830
|
+
"application/json": components["schemas"]["CreateAnnotationConfigData"];
|
|
1831
|
+
};
|
|
1832
|
+
};
|
|
1155
1833
|
responses: {
|
|
1156
1834
|
/** @description Successful Response */
|
|
1157
1835
|
200: {
|
|
@@ -1159,7 +1837,7 @@ export interface operations {
|
|
|
1159
1837
|
[name: string]: unknown;
|
|
1160
1838
|
};
|
|
1161
1839
|
content: {
|
|
1162
|
-
"application/json": components["schemas"]["
|
|
1840
|
+
"application/json": components["schemas"]["UpdateAnnotationConfigResponseBody"];
|
|
1163
1841
|
};
|
|
1164
1842
|
};
|
|
1165
1843
|
/** @description Forbidden */
|
|
@@ -1171,51 +1849,76 @@ export interface operations {
|
|
|
1171
1849
|
"text/plain": string;
|
|
1172
1850
|
};
|
|
1173
1851
|
};
|
|
1174
|
-
/** @description
|
|
1852
|
+
/** @description Validation Error */
|
|
1175
1853
|
422: {
|
|
1176
1854
|
headers: {
|
|
1177
1855
|
[name: string]: unknown;
|
|
1178
1856
|
};
|
|
1179
1857
|
content: {
|
|
1180
|
-
"
|
|
1858
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1181
1859
|
};
|
|
1182
1860
|
};
|
|
1183
1861
|
};
|
|
1184
1862
|
};
|
|
1185
|
-
|
|
1863
|
+
delete_annotation_config_v1_annotation_configs__config_id__delete: {
|
|
1186
1864
|
parameters: {
|
|
1187
|
-
query?:
|
|
1188
|
-
/** @description If true, fulfill request synchronously and return JSON containing dataset_id. */
|
|
1189
|
-
sync?: boolean;
|
|
1190
|
-
};
|
|
1865
|
+
query?: never;
|
|
1191
1866
|
header?: never;
|
|
1192
|
-
path
|
|
1867
|
+
path: {
|
|
1868
|
+
/** @description ID of the annotation configuration */
|
|
1869
|
+
config_id: string;
|
|
1870
|
+
};
|
|
1193
1871
|
cookie?: never;
|
|
1194
1872
|
};
|
|
1195
|
-
requestBody?:
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
name: string;
|
|
1201
|
-
description?: string;
|
|
1202
|
-
inputs: Record<string, unknown>[];
|
|
1203
|
-
outputs?: Record<string, unknown>[];
|
|
1204
|
-
metadata?: Record<string, unknown>[];
|
|
1873
|
+
requestBody?: never;
|
|
1874
|
+
responses: {
|
|
1875
|
+
/** @description Successful Response */
|
|
1876
|
+
200: {
|
|
1877
|
+
headers: {
|
|
1878
|
+
[name: string]: unknown;
|
|
1205
1879
|
};
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1880
|
+
content: {
|
|
1881
|
+
"application/json": components["schemas"]["DeleteAnnotationConfigResponseBody"];
|
|
1882
|
+
};
|
|
1883
|
+
};
|
|
1884
|
+
/** @description Forbidden */
|
|
1885
|
+
403: {
|
|
1886
|
+
headers: {
|
|
1887
|
+
[name: string]: unknown;
|
|
1888
|
+
};
|
|
1889
|
+
content: {
|
|
1890
|
+
"text/plain": string;
|
|
1891
|
+
};
|
|
1892
|
+
};
|
|
1893
|
+
/** @description Validation Error */
|
|
1894
|
+
422: {
|
|
1895
|
+
headers: {
|
|
1896
|
+
[name: string]: unknown;
|
|
1897
|
+
};
|
|
1898
|
+
content: {
|
|
1899
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1216
1900
|
};
|
|
1217
1901
|
};
|
|
1218
1902
|
};
|
|
1903
|
+
};
|
|
1904
|
+
listSpanAnnotationsBySpanIds: {
|
|
1905
|
+
parameters: {
|
|
1906
|
+
query: {
|
|
1907
|
+
/** @description One or more span id to fetch annotations for */
|
|
1908
|
+
span_ids: string[];
|
|
1909
|
+
/** @description A cursor for pagination */
|
|
1910
|
+
cursor?: string | null;
|
|
1911
|
+
/** @description The maximum number of annotations to return in a single request */
|
|
1912
|
+
limit?: number;
|
|
1913
|
+
};
|
|
1914
|
+
header?: never;
|
|
1915
|
+
path: {
|
|
1916
|
+
/** @description The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters. */
|
|
1917
|
+
project_identifier: string;
|
|
1918
|
+
};
|
|
1919
|
+
cookie?: never;
|
|
1920
|
+
};
|
|
1921
|
+
requestBody?: never;
|
|
1219
1922
|
responses: {
|
|
1220
1923
|
/** @description Successful Response */
|
|
1221
1924
|
200: {
|
|
@@ -1223,7 +1926,7 @@ export interface operations {
|
|
|
1223
1926
|
[name: string]: unknown;
|
|
1224
1927
|
};
|
|
1225
1928
|
content: {
|
|
1226
|
-
"application/json": components["schemas"]["
|
|
1929
|
+
"application/json": components["schemas"]["SpanAnnotationsResponseBody"];
|
|
1227
1930
|
};
|
|
1228
1931
|
};
|
|
1229
1932
|
/** @description Forbidden */
|
|
@@ -1235,8 +1938,8 @@ export interface operations {
|
|
|
1235
1938
|
"text/plain": string;
|
|
1236
1939
|
};
|
|
1237
1940
|
};
|
|
1238
|
-
/** @description
|
|
1239
|
-
|
|
1941
|
+
/** @description Project or spans not found */
|
|
1942
|
+
404: {
|
|
1240
1943
|
headers: {
|
|
1241
1944
|
[name: string]: unknown;
|
|
1242
1945
|
};
|
|
@@ -1244,7 +1947,7 @@ export interface operations {
|
|
|
1244
1947
|
"text/plain": string;
|
|
1245
1948
|
};
|
|
1246
1949
|
};
|
|
1247
|
-
/** @description Invalid
|
|
1950
|
+
/** @description Invalid parameters */
|
|
1248
1951
|
422: {
|
|
1249
1952
|
headers: {
|
|
1250
1953
|
[name: string]: unknown;
|
|
@@ -1255,12 +1958,54 @@ export interface operations {
|
|
|
1255
1958
|
};
|
|
1256
1959
|
};
|
|
1257
1960
|
};
|
|
1258
|
-
|
|
1961
|
+
listDatasets: {
|
|
1259
1962
|
parameters: {
|
|
1260
1963
|
query?: {
|
|
1261
|
-
/** @description
|
|
1262
|
-
|
|
1964
|
+
/** @description Cursor for pagination */
|
|
1965
|
+
cursor?: string | null;
|
|
1966
|
+
/** @description An optional dataset name to filter by */
|
|
1967
|
+
name?: string | null;
|
|
1968
|
+
/** @description The max number of datasets to return at a time. */
|
|
1969
|
+
limit?: number;
|
|
1970
|
+
};
|
|
1971
|
+
header?: never;
|
|
1972
|
+
path?: never;
|
|
1973
|
+
cookie?: never;
|
|
1974
|
+
};
|
|
1975
|
+
requestBody?: never;
|
|
1976
|
+
responses: {
|
|
1977
|
+
/** @description Successful Response */
|
|
1978
|
+
200: {
|
|
1979
|
+
headers: {
|
|
1980
|
+
[name: string]: unknown;
|
|
1981
|
+
};
|
|
1982
|
+
content: {
|
|
1983
|
+
"application/json": components["schemas"]["ListDatasetsResponseBody"];
|
|
1984
|
+
};
|
|
1985
|
+
};
|
|
1986
|
+
/** @description Forbidden */
|
|
1987
|
+
403: {
|
|
1988
|
+
headers: {
|
|
1989
|
+
[name: string]: unknown;
|
|
1990
|
+
};
|
|
1991
|
+
content: {
|
|
1992
|
+
"text/plain": string;
|
|
1993
|
+
};
|
|
1994
|
+
};
|
|
1995
|
+
/** @description Unprocessable Entity */
|
|
1996
|
+
422: {
|
|
1997
|
+
headers: {
|
|
1998
|
+
[name: string]: unknown;
|
|
1999
|
+
};
|
|
2000
|
+
content: {
|
|
2001
|
+
"text/plain": string;
|
|
2002
|
+
};
|
|
1263
2003
|
};
|
|
2004
|
+
};
|
|
2005
|
+
};
|
|
2006
|
+
getDataset: {
|
|
2007
|
+
parameters: {
|
|
2008
|
+
query?: never;
|
|
1264
2009
|
header?: never;
|
|
1265
2010
|
path: {
|
|
1266
2011
|
/** @description The ID of the dataset */
|
|
@@ -1276,7 +2021,7 @@ export interface operations {
|
|
|
1276
2021
|
[name: string]: unknown;
|
|
1277
2022
|
};
|
|
1278
2023
|
content: {
|
|
1279
|
-
"application/json": components["schemas"]["
|
|
2024
|
+
"application/json": components["schemas"]["GetDatasetResponseBody"];
|
|
1280
2025
|
};
|
|
1281
2026
|
};
|
|
1282
2027
|
/** @description Forbidden */
|
|
@@ -1308,11 +2053,61 @@ export interface operations {
|
|
|
1308
2053
|
};
|
|
1309
2054
|
};
|
|
1310
2055
|
};
|
|
1311
|
-
|
|
2056
|
+
deleteDatasetById: {
|
|
2057
|
+
parameters: {
|
|
2058
|
+
query?: never;
|
|
2059
|
+
header?: never;
|
|
2060
|
+
path: {
|
|
2061
|
+
/** @description The ID of the dataset to delete. */
|
|
2062
|
+
id: string;
|
|
2063
|
+
};
|
|
2064
|
+
cookie?: never;
|
|
2065
|
+
};
|
|
2066
|
+
requestBody?: never;
|
|
2067
|
+
responses: {
|
|
2068
|
+
/** @description Successful Response */
|
|
2069
|
+
204: {
|
|
2070
|
+
headers: {
|
|
2071
|
+
[name: string]: unknown;
|
|
2072
|
+
};
|
|
2073
|
+
content?: never;
|
|
2074
|
+
};
|
|
2075
|
+
/** @description Forbidden */
|
|
2076
|
+
403: {
|
|
2077
|
+
headers: {
|
|
2078
|
+
[name: string]: unknown;
|
|
2079
|
+
};
|
|
2080
|
+
content: {
|
|
2081
|
+
"text/plain": string;
|
|
2082
|
+
};
|
|
2083
|
+
};
|
|
2084
|
+
/** @description Dataset not found */
|
|
2085
|
+
404: {
|
|
2086
|
+
headers: {
|
|
2087
|
+
[name: string]: unknown;
|
|
2088
|
+
};
|
|
2089
|
+
content: {
|
|
2090
|
+
"text/plain": string;
|
|
2091
|
+
};
|
|
2092
|
+
};
|
|
2093
|
+
/** @description Invalid dataset ID */
|
|
2094
|
+
422: {
|
|
2095
|
+
headers: {
|
|
2096
|
+
[name: string]: unknown;
|
|
2097
|
+
};
|
|
2098
|
+
content: {
|
|
2099
|
+
"text/plain": string;
|
|
2100
|
+
};
|
|
2101
|
+
};
|
|
2102
|
+
};
|
|
2103
|
+
};
|
|
2104
|
+
listDatasetVersionsByDatasetId: {
|
|
1312
2105
|
parameters: {
|
|
1313
2106
|
query?: {
|
|
1314
|
-
/** @description
|
|
1315
|
-
|
|
2107
|
+
/** @description Cursor for pagination */
|
|
2108
|
+
cursor?: string | null;
|
|
2109
|
+
/** @description The max number of dataset versions to return at a time */
|
|
2110
|
+
limit?: number;
|
|
1316
2111
|
};
|
|
1317
2112
|
header?: never;
|
|
1318
2113
|
path: {
|
|
@@ -1329,7 +2124,7 @@ export interface operations {
|
|
|
1329
2124
|
[name: string]: unknown;
|
|
1330
2125
|
};
|
|
1331
2126
|
content: {
|
|
1332
|
-
"
|
|
2127
|
+
"application/json": components["schemas"]["ListDatasetVersionsResponseBody"];
|
|
1333
2128
|
};
|
|
1334
2129
|
};
|
|
1335
2130
|
/** @description Forbidden */
|
|
@@ -1352,23 +2147,779 @@ export interface operations {
|
|
|
1352
2147
|
};
|
|
1353
2148
|
};
|
|
1354
2149
|
};
|
|
1355
|
-
|
|
2150
|
+
uploadDataset: {
|
|
1356
2151
|
parameters: {
|
|
1357
2152
|
query?: {
|
|
1358
|
-
/** @description
|
|
1359
|
-
|
|
2153
|
+
/** @description If true, fulfill request synchronously and return JSON containing dataset_id. */
|
|
2154
|
+
sync?: boolean;
|
|
1360
2155
|
};
|
|
1361
2156
|
header?: never;
|
|
1362
|
-
path
|
|
1363
|
-
|
|
1364
|
-
|
|
2157
|
+
path?: never;
|
|
2158
|
+
cookie?: never;
|
|
2159
|
+
};
|
|
2160
|
+
requestBody?: {
|
|
2161
|
+
content: {
|
|
2162
|
+
"application/json": {
|
|
2163
|
+
/** @enum {string} */
|
|
2164
|
+
action?: "create" | "append";
|
|
2165
|
+
name: string;
|
|
2166
|
+
description?: string;
|
|
2167
|
+
inputs: Record<string, unknown>[];
|
|
2168
|
+
outputs?: Record<string, unknown>[];
|
|
2169
|
+
metadata?: Record<string, unknown>[];
|
|
2170
|
+
};
|
|
2171
|
+
"multipart/form-data": {
|
|
2172
|
+
/** @enum {string} */
|
|
2173
|
+
action?: "create" | "append";
|
|
2174
|
+
name: string;
|
|
2175
|
+
description?: string;
|
|
2176
|
+
"input_keys[]": string[];
|
|
2177
|
+
"output_keys[]": string[];
|
|
2178
|
+
"metadata_keys[]"?: string[];
|
|
2179
|
+
/** Format: binary */
|
|
2180
|
+
file: string;
|
|
2181
|
+
};
|
|
2182
|
+
};
|
|
2183
|
+
};
|
|
2184
|
+
responses: {
|
|
2185
|
+
/** @description Successful Response */
|
|
2186
|
+
200: {
|
|
2187
|
+
headers: {
|
|
2188
|
+
[name: string]: unknown;
|
|
2189
|
+
};
|
|
2190
|
+
content: {
|
|
2191
|
+
"application/json": components["schemas"]["UploadDatasetResponseBody"] | null;
|
|
2192
|
+
};
|
|
2193
|
+
};
|
|
2194
|
+
/** @description Forbidden */
|
|
2195
|
+
403: {
|
|
2196
|
+
headers: {
|
|
2197
|
+
[name: string]: unknown;
|
|
2198
|
+
};
|
|
2199
|
+
content: {
|
|
2200
|
+
"text/plain": string;
|
|
2201
|
+
};
|
|
2202
|
+
};
|
|
2203
|
+
/** @description Dataset of the same name already exists */
|
|
2204
|
+
409: {
|
|
2205
|
+
headers: {
|
|
2206
|
+
[name: string]: unknown;
|
|
2207
|
+
};
|
|
2208
|
+
content: {
|
|
2209
|
+
"text/plain": string;
|
|
2210
|
+
};
|
|
2211
|
+
};
|
|
2212
|
+
/** @description Invalid request body */
|
|
2213
|
+
422: {
|
|
2214
|
+
headers: {
|
|
2215
|
+
[name: string]: unknown;
|
|
2216
|
+
};
|
|
2217
|
+
content: {
|
|
2218
|
+
"text/plain": string;
|
|
2219
|
+
};
|
|
2220
|
+
};
|
|
2221
|
+
};
|
|
2222
|
+
};
|
|
2223
|
+
getDatasetExamples: {
|
|
2224
|
+
parameters: {
|
|
2225
|
+
query?: {
|
|
2226
|
+
/** @description The ID of the dataset version (if omitted, returns data from the latest version) */
|
|
2227
|
+
version_id?: string | null;
|
|
2228
|
+
};
|
|
2229
|
+
header?: never;
|
|
2230
|
+
path: {
|
|
2231
|
+
/** @description The ID of the dataset */
|
|
2232
|
+
id: string;
|
|
2233
|
+
};
|
|
2234
|
+
cookie?: never;
|
|
2235
|
+
};
|
|
2236
|
+
requestBody?: never;
|
|
2237
|
+
responses: {
|
|
2238
|
+
/** @description Successful Response */
|
|
2239
|
+
200: {
|
|
2240
|
+
headers: {
|
|
2241
|
+
[name: string]: unknown;
|
|
2242
|
+
};
|
|
2243
|
+
content: {
|
|
2244
|
+
"application/json": components["schemas"]["ListDatasetExamplesResponseBody"];
|
|
2245
|
+
};
|
|
2246
|
+
};
|
|
2247
|
+
/** @description Forbidden */
|
|
2248
|
+
403: {
|
|
2249
|
+
headers: {
|
|
2250
|
+
[name: string]: unknown;
|
|
2251
|
+
};
|
|
2252
|
+
content: {
|
|
2253
|
+
"text/plain": string;
|
|
2254
|
+
};
|
|
2255
|
+
};
|
|
2256
|
+
/** @description Not Found */
|
|
2257
|
+
404: {
|
|
2258
|
+
headers: {
|
|
2259
|
+
[name: string]: unknown;
|
|
2260
|
+
};
|
|
2261
|
+
content: {
|
|
2262
|
+
"text/plain": string;
|
|
2263
|
+
};
|
|
2264
|
+
};
|
|
2265
|
+
/** @description Validation Error */
|
|
2266
|
+
422: {
|
|
2267
|
+
headers: {
|
|
2268
|
+
[name: string]: unknown;
|
|
2269
|
+
};
|
|
2270
|
+
content: {
|
|
2271
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2272
|
+
};
|
|
2273
|
+
};
|
|
2274
|
+
};
|
|
2275
|
+
};
|
|
2276
|
+
getDatasetCsv: {
|
|
2277
|
+
parameters: {
|
|
2278
|
+
query?: {
|
|
2279
|
+
/** @description The ID of the dataset version (if omitted, returns data from the latest version) */
|
|
2280
|
+
version_id?: string | null;
|
|
2281
|
+
};
|
|
2282
|
+
header?: never;
|
|
2283
|
+
path: {
|
|
2284
|
+
/** @description The ID of the dataset */
|
|
2285
|
+
id: string;
|
|
2286
|
+
};
|
|
2287
|
+
cookie?: never;
|
|
2288
|
+
};
|
|
2289
|
+
requestBody?: never;
|
|
2290
|
+
responses: {
|
|
2291
|
+
/** @description Successful Response */
|
|
2292
|
+
200: {
|
|
2293
|
+
headers: {
|
|
2294
|
+
[name: string]: unknown;
|
|
2295
|
+
};
|
|
2296
|
+
content: {
|
|
2297
|
+
"text/csv": string;
|
|
2298
|
+
};
|
|
2299
|
+
};
|
|
2300
|
+
/** @description Forbidden */
|
|
2301
|
+
403: {
|
|
2302
|
+
headers: {
|
|
2303
|
+
[name: string]: unknown;
|
|
2304
|
+
};
|
|
2305
|
+
content: {
|
|
2306
|
+
"text/plain": string;
|
|
2307
|
+
};
|
|
2308
|
+
};
|
|
2309
|
+
/** @description Unprocessable Entity */
|
|
2310
|
+
422: {
|
|
2311
|
+
headers: {
|
|
2312
|
+
[name: string]: unknown;
|
|
2313
|
+
};
|
|
2314
|
+
content: {
|
|
2315
|
+
"text/plain": string;
|
|
2316
|
+
};
|
|
2317
|
+
};
|
|
2318
|
+
};
|
|
2319
|
+
};
|
|
2320
|
+
getDatasetJSONLOpenAIFineTuning: {
|
|
2321
|
+
parameters: {
|
|
2322
|
+
query?: {
|
|
2323
|
+
/** @description The ID of the dataset version (if omitted, returns data from the latest version) */
|
|
2324
|
+
version_id?: string | null;
|
|
2325
|
+
};
|
|
2326
|
+
header?: never;
|
|
2327
|
+
path: {
|
|
2328
|
+
/** @description The ID of the dataset */
|
|
2329
|
+
id: string;
|
|
2330
|
+
};
|
|
2331
|
+
cookie?: never;
|
|
2332
|
+
};
|
|
2333
|
+
requestBody?: never;
|
|
2334
|
+
responses: {
|
|
2335
|
+
/** @description Successful Response */
|
|
2336
|
+
200: {
|
|
2337
|
+
headers: {
|
|
2338
|
+
[name: string]: unknown;
|
|
2339
|
+
};
|
|
2340
|
+
content: {
|
|
2341
|
+
"text/plain": string;
|
|
2342
|
+
};
|
|
2343
|
+
};
|
|
2344
|
+
/** @description Forbidden */
|
|
2345
|
+
403: {
|
|
2346
|
+
headers: {
|
|
2347
|
+
[name: string]: unknown;
|
|
2348
|
+
};
|
|
2349
|
+
content: {
|
|
2350
|
+
"text/plain": string;
|
|
2351
|
+
};
|
|
2352
|
+
};
|
|
2353
|
+
/** @description Invalid dataset or version ID */
|
|
2354
|
+
422: {
|
|
2355
|
+
headers: {
|
|
2356
|
+
[name: string]: unknown;
|
|
2357
|
+
};
|
|
2358
|
+
content: {
|
|
2359
|
+
"text/plain": string;
|
|
2360
|
+
};
|
|
2361
|
+
};
|
|
2362
|
+
};
|
|
2363
|
+
};
|
|
2364
|
+
getDatasetJSONLOpenAIEvals: {
|
|
2365
|
+
parameters: {
|
|
2366
|
+
query?: {
|
|
2367
|
+
/** @description The ID of the dataset version (if omitted, returns data from the latest version) */
|
|
2368
|
+
version_id?: string | null;
|
|
2369
|
+
};
|
|
2370
|
+
header?: never;
|
|
2371
|
+
path: {
|
|
2372
|
+
/** @description The ID of the dataset */
|
|
2373
|
+
id: string;
|
|
2374
|
+
};
|
|
2375
|
+
cookie?: never;
|
|
2376
|
+
};
|
|
2377
|
+
requestBody?: never;
|
|
2378
|
+
responses: {
|
|
2379
|
+
/** @description Successful Response */
|
|
2380
|
+
200: {
|
|
2381
|
+
headers: {
|
|
2382
|
+
[name: string]: unknown;
|
|
2383
|
+
};
|
|
2384
|
+
content: {
|
|
2385
|
+
"text/plain": string;
|
|
2386
|
+
};
|
|
2387
|
+
};
|
|
2388
|
+
/** @description Forbidden */
|
|
2389
|
+
403: {
|
|
2390
|
+
headers: {
|
|
2391
|
+
[name: string]: unknown;
|
|
2392
|
+
};
|
|
2393
|
+
content: {
|
|
2394
|
+
"text/plain": string;
|
|
2395
|
+
};
|
|
2396
|
+
};
|
|
2397
|
+
/** @description Invalid dataset or version ID */
|
|
2398
|
+
422: {
|
|
2399
|
+
headers: {
|
|
2400
|
+
[name: string]: unknown;
|
|
2401
|
+
};
|
|
2402
|
+
content: {
|
|
2403
|
+
"text/plain": string;
|
|
2404
|
+
};
|
|
2405
|
+
};
|
|
2406
|
+
};
|
|
2407
|
+
};
|
|
2408
|
+
listExperiments: {
|
|
2409
|
+
parameters: {
|
|
2410
|
+
query?: never;
|
|
2411
|
+
header?: never;
|
|
2412
|
+
path: {
|
|
2413
|
+
dataset_id: string;
|
|
2414
|
+
};
|
|
2415
|
+
cookie?: never;
|
|
2416
|
+
};
|
|
2417
|
+
requestBody?: never;
|
|
2418
|
+
responses: {
|
|
2419
|
+
/** @description Experiments retrieved successfully */
|
|
2420
|
+
200: {
|
|
2421
|
+
headers: {
|
|
2422
|
+
[name: string]: unknown;
|
|
2423
|
+
};
|
|
2424
|
+
content: {
|
|
2425
|
+
"application/json": components["schemas"]["ListExperimentsResponseBody"];
|
|
2426
|
+
};
|
|
2427
|
+
};
|
|
2428
|
+
/** @description Forbidden */
|
|
2429
|
+
403: {
|
|
2430
|
+
headers: {
|
|
2431
|
+
[name: string]: unknown;
|
|
2432
|
+
};
|
|
2433
|
+
content: {
|
|
2434
|
+
"text/plain": string;
|
|
2435
|
+
};
|
|
2436
|
+
};
|
|
2437
|
+
/** @description Validation Error */
|
|
2438
|
+
422: {
|
|
2439
|
+
headers: {
|
|
2440
|
+
[name: string]: unknown;
|
|
2441
|
+
};
|
|
2442
|
+
content: {
|
|
2443
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2444
|
+
};
|
|
2445
|
+
};
|
|
2446
|
+
};
|
|
2447
|
+
};
|
|
2448
|
+
createExperiment: {
|
|
2449
|
+
parameters: {
|
|
2450
|
+
query?: never;
|
|
2451
|
+
header?: never;
|
|
2452
|
+
path: {
|
|
2453
|
+
dataset_id: string;
|
|
2454
|
+
};
|
|
2455
|
+
cookie?: never;
|
|
2456
|
+
};
|
|
2457
|
+
requestBody: {
|
|
2458
|
+
content: {
|
|
2459
|
+
"application/json": components["schemas"]["CreateExperimentRequestBody"];
|
|
2460
|
+
};
|
|
2461
|
+
};
|
|
2462
|
+
responses: {
|
|
2463
|
+
/** @description Experiment retrieved successfully */
|
|
2464
|
+
200: {
|
|
2465
|
+
headers: {
|
|
2466
|
+
[name: string]: unknown;
|
|
2467
|
+
};
|
|
2468
|
+
content: {
|
|
2469
|
+
"application/json": components["schemas"]["CreateExperimentResponseBody"];
|
|
2470
|
+
};
|
|
2471
|
+
};
|
|
2472
|
+
/** @description Forbidden */
|
|
2473
|
+
403: {
|
|
2474
|
+
headers: {
|
|
2475
|
+
[name: string]: unknown;
|
|
2476
|
+
};
|
|
2477
|
+
content: {
|
|
2478
|
+
"text/plain": string;
|
|
2479
|
+
};
|
|
2480
|
+
};
|
|
2481
|
+
/** @description Dataset or DatasetVersion not found */
|
|
2482
|
+
404: {
|
|
2483
|
+
headers: {
|
|
2484
|
+
[name: string]: unknown;
|
|
2485
|
+
};
|
|
2486
|
+
content: {
|
|
2487
|
+
"text/plain": string;
|
|
2488
|
+
};
|
|
2489
|
+
};
|
|
2490
|
+
/** @description Validation Error */
|
|
2491
|
+
422: {
|
|
2492
|
+
headers: {
|
|
2493
|
+
[name: string]: unknown;
|
|
2494
|
+
};
|
|
2495
|
+
content: {
|
|
2496
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2497
|
+
};
|
|
2498
|
+
};
|
|
2499
|
+
};
|
|
2500
|
+
};
|
|
2501
|
+
getExperiment: {
|
|
2502
|
+
parameters: {
|
|
2503
|
+
query?: never;
|
|
2504
|
+
header?: never;
|
|
2505
|
+
path: {
|
|
2506
|
+
experiment_id: string;
|
|
2507
|
+
};
|
|
2508
|
+
cookie?: never;
|
|
2509
|
+
};
|
|
2510
|
+
requestBody?: never;
|
|
2511
|
+
responses: {
|
|
2512
|
+
/** @description Experiment retrieved successfully */
|
|
2513
|
+
200: {
|
|
2514
|
+
headers: {
|
|
2515
|
+
[name: string]: unknown;
|
|
2516
|
+
};
|
|
2517
|
+
content: {
|
|
2518
|
+
"application/json": components["schemas"]["GetExperimentResponseBody"];
|
|
2519
|
+
};
|
|
2520
|
+
};
|
|
2521
|
+
/** @description Forbidden */
|
|
2522
|
+
403: {
|
|
2523
|
+
headers: {
|
|
2524
|
+
[name: string]: unknown;
|
|
2525
|
+
};
|
|
2526
|
+
content: {
|
|
2527
|
+
"text/plain": string;
|
|
2528
|
+
};
|
|
2529
|
+
};
|
|
2530
|
+
/** @description Experiment not found */
|
|
2531
|
+
404: {
|
|
2532
|
+
headers: {
|
|
2533
|
+
[name: string]: unknown;
|
|
2534
|
+
};
|
|
2535
|
+
content: {
|
|
2536
|
+
"text/plain": string;
|
|
2537
|
+
};
|
|
2538
|
+
};
|
|
2539
|
+
/** @description Validation Error */
|
|
2540
|
+
422: {
|
|
2541
|
+
headers: {
|
|
2542
|
+
[name: string]: unknown;
|
|
2543
|
+
};
|
|
2544
|
+
content: {
|
|
2545
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2546
|
+
};
|
|
2547
|
+
};
|
|
2548
|
+
};
|
|
2549
|
+
};
|
|
2550
|
+
getExperimentJSON: {
|
|
2551
|
+
parameters: {
|
|
2552
|
+
query?: never;
|
|
2553
|
+
header?: never;
|
|
2554
|
+
path: {
|
|
2555
|
+
experiment_id: string;
|
|
2556
|
+
};
|
|
2557
|
+
cookie?: never;
|
|
2558
|
+
};
|
|
2559
|
+
requestBody?: never;
|
|
2560
|
+
responses: {
|
|
2561
|
+
/** @description Successful Response */
|
|
2562
|
+
200: {
|
|
2563
|
+
headers: {
|
|
2564
|
+
[name: string]: unknown;
|
|
2565
|
+
};
|
|
2566
|
+
content: {
|
|
2567
|
+
"text/plain": string;
|
|
2568
|
+
};
|
|
2569
|
+
};
|
|
2570
|
+
/** @description Forbidden */
|
|
2571
|
+
403: {
|
|
2572
|
+
headers: {
|
|
2573
|
+
[name: string]: unknown;
|
|
2574
|
+
};
|
|
2575
|
+
content: {
|
|
2576
|
+
"text/plain": string;
|
|
2577
|
+
};
|
|
2578
|
+
};
|
|
2579
|
+
/** @description Experiment not found */
|
|
2580
|
+
404: {
|
|
2581
|
+
headers: {
|
|
2582
|
+
[name: string]: unknown;
|
|
2583
|
+
};
|
|
2584
|
+
content: {
|
|
2585
|
+
"text/plain": string;
|
|
2586
|
+
};
|
|
2587
|
+
};
|
|
2588
|
+
/** @description Validation Error */
|
|
2589
|
+
422: {
|
|
2590
|
+
headers: {
|
|
2591
|
+
[name: string]: unknown;
|
|
2592
|
+
};
|
|
2593
|
+
content: {
|
|
2594
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2595
|
+
};
|
|
2596
|
+
};
|
|
2597
|
+
};
|
|
2598
|
+
};
|
|
2599
|
+
getExperimentCSV: {
|
|
2600
|
+
parameters: {
|
|
2601
|
+
query?: never;
|
|
2602
|
+
header?: never;
|
|
2603
|
+
path: {
|
|
2604
|
+
experiment_id: string;
|
|
2605
|
+
};
|
|
2606
|
+
cookie?: never;
|
|
2607
|
+
};
|
|
2608
|
+
requestBody?: never;
|
|
2609
|
+
responses: {
|
|
2610
|
+
/** @description Successful Response */
|
|
2611
|
+
200: {
|
|
2612
|
+
headers: {
|
|
2613
|
+
[name: string]: unknown;
|
|
2614
|
+
};
|
|
2615
|
+
content: {
|
|
2616
|
+
"application/json": unknown;
|
|
2617
|
+
"text/csv": string;
|
|
2618
|
+
};
|
|
2619
|
+
};
|
|
2620
|
+
/** @description Forbidden */
|
|
2621
|
+
403: {
|
|
2622
|
+
headers: {
|
|
2623
|
+
[name: string]: unknown;
|
|
2624
|
+
};
|
|
2625
|
+
content: {
|
|
2626
|
+
"text/plain": string;
|
|
2627
|
+
};
|
|
2628
|
+
};
|
|
2629
|
+
/** @description Validation Error */
|
|
2630
|
+
422: {
|
|
2631
|
+
headers: {
|
|
2632
|
+
[name: string]: unknown;
|
|
2633
|
+
};
|
|
2634
|
+
content: {
|
|
2635
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2636
|
+
};
|
|
2637
|
+
};
|
|
2638
|
+
};
|
|
2639
|
+
};
|
|
2640
|
+
listExperimentRuns: {
|
|
2641
|
+
parameters: {
|
|
2642
|
+
query?: never;
|
|
2643
|
+
header?: never;
|
|
2644
|
+
path: {
|
|
2645
|
+
experiment_id: string;
|
|
2646
|
+
};
|
|
2647
|
+
cookie?: never;
|
|
2648
|
+
};
|
|
2649
|
+
requestBody?: never;
|
|
2650
|
+
responses: {
|
|
2651
|
+
/** @description Experiment runs retrieved successfully */
|
|
2652
|
+
200: {
|
|
2653
|
+
headers: {
|
|
2654
|
+
[name: string]: unknown;
|
|
2655
|
+
};
|
|
2656
|
+
content: {
|
|
2657
|
+
"application/json": components["schemas"]["ListExperimentRunsResponseBody"];
|
|
2658
|
+
};
|
|
2659
|
+
};
|
|
2660
|
+
/** @description Forbidden */
|
|
2661
|
+
403: {
|
|
2662
|
+
headers: {
|
|
2663
|
+
[name: string]: unknown;
|
|
2664
|
+
};
|
|
2665
|
+
content: {
|
|
2666
|
+
"text/plain": string;
|
|
2667
|
+
};
|
|
2668
|
+
};
|
|
2669
|
+
/** @description Experiment not found */
|
|
2670
|
+
404: {
|
|
2671
|
+
headers: {
|
|
2672
|
+
[name: string]: unknown;
|
|
2673
|
+
};
|
|
2674
|
+
content: {
|
|
2675
|
+
"text/plain": string;
|
|
2676
|
+
};
|
|
2677
|
+
};
|
|
2678
|
+
/** @description Validation Error */
|
|
2679
|
+
422: {
|
|
2680
|
+
headers: {
|
|
2681
|
+
[name: string]: unknown;
|
|
2682
|
+
};
|
|
2683
|
+
content: {
|
|
2684
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2685
|
+
};
|
|
2686
|
+
};
|
|
2687
|
+
};
|
|
2688
|
+
};
|
|
2689
|
+
createExperimentRun: {
|
|
2690
|
+
parameters: {
|
|
2691
|
+
query?: never;
|
|
2692
|
+
header?: never;
|
|
2693
|
+
path: {
|
|
2694
|
+
experiment_id: string;
|
|
2695
|
+
};
|
|
2696
|
+
cookie?: never;
|
|
2697
|
+
};
|
|
2698
|
+
requestBody: {
|
|
2699
|
+
content: {
|
|
2700
|
+
"application/json": components["schemas"]["CreateExperimentRunRequestBody"];
|
|
2701
|
+
};
|
|
2702
|
+
};
|
|
2703
|
+
responses: {
|
|
2704
|
+
/** @description Experiment run created successfully */
|
|
2705
|
+
200: {
|
|
2706
|
+
headers: {
|
|
2707
|
+
[name: string]: unknown;
|
|
2708
|
+
};
|
|
2709
|
+
content: {
|
|
2710
|
+
"application/json": components["schemas"]["CreateExperimentRunResponseBody"];
|
|
2711
|
+
};
|
|
2712
|
+
};
|
|
2713
|
+
/** @description Forbidden */
|
|
2714
|
+
403: {
|
|
2715
|
+
headers: {
|
|
2716
|
+
[name: string]: unknown;
|
|
2717
|
+
};
|
|
2718
|
+
content: {
|
|
2719
|
+
"text/plain": string;
|
|
2720
|
+
};
|
|
2721
|
+
};
|
|
2722
|
+
/** @description Experiment or dataset example not found */
|
|
2723
|
+
404: {
|
|
2724
|
+
headers: {
|
|
2725
|
+
[name: string]: unknown;
|
|
2726
|
+
};
|
|
2727
|
+
content: {
|
|
2728
|
+
"text/plain": string;
|
|
2729
|
+
};
|
|
2730
|
+
};
|
|
2731
|
+
/** @description Validation Error */
|
|
2732
|
+
422: {
|
|
2733
|
+
headers: {
|
|
2734
|
+
[name: string]: unknown;
|
|
2735
|
+
};
|
|
2736
|
+
content: {
|
|
2737
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2738
|
+
};
|
|
2739
|
+
};
|
|
2740
|
+
};
|
|
2741
|
+
};
|
|
2742
|
+
upsertExperimentEvaluation: {
|
|
2743
|
+
parameters: {
|
|
2744
|
+
query?: never;
|
|
2745
|
+
header?: never;
|
|
2746
|
+
path?: never;
|
|
2747
|
+
cookie?: never;
|
|
2748
|
+
};
|
|
2749
|
+
requestBody: {
|
|
2750
|
+
content: {
|
|
2751
|
+
"application/json": components["schemas"]["UpsertExperimentEvaluationRequestBody"];
|
|
2752
|
+
};
|
|
2753
|
+
};
|
|
2754
|
+
responses: {
|
|
2755
|
+
/** @description Successful Response */
|
|
2756
|
+
200: {
|
|
2757
|
+
headers: {
|
|
2758
|
+
[name: string]: unknown;
|
|
2759
|
+
};
|
|
2760
|
+
content: {
|
|
2761
|
+
"application/json": components["schemas"]["UpsertExperimentEvaluationResponseBody"];
|
|
2762
|
+
};
|
|
2763
|
+
};
|
|
2764
|
+
/** @description Forbidden */
|
|
2765
|
+
403: {
|
|
2766
|
+
headers: {
|
|
2767
|
+
[name: string]: unknown;
|
|
2768
|
+
};
|
|
2769
|
+
content: {
|
|
2770
|
+
"text/plain": string;
|
|
2771
|
+
};
|
|
2772
|
+
};
|
|
2773
|
+
/** @description Experiment run not found */
|
|
2774
|
+
404: {
|
|
2775
|
+
headers: {
|
|
2776
|
+
[name: string]: unknown;
|
|
2777
|
+
};
|
|
2778
|
+
content: {
|
|
2779
|
+
"text/plain": string;
|
|
2780
|
+
};
|
|
2781
|
+
};
|
|
2782
|
+
/** @description Validation Error */
|
|
2783
|
+
422: {
|
|
2784
|
+
headers: {
|
|
2785
|
+
[name: string]: unknown;
|
|
2786
|
+
};
|
|
2787
|
+
content: {
|
|
2788
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2789
|
+
};
|
|
2790
|
+
};
|
|
2791
|
+
};
|
|
2792
|
+
};
|
|
2793
|
+
annotateSpans: {
|
|
2794
|
+
parameters: {
|
|
2795
|
+
query?: {
|
|
2796
|
+
/** @description If true, fulfill request synchronously. */
|
|
2797
|
+
sync?: boolean;
|
|
2798
|
+
};
|
|
2799
|
+
header?: never;
|
|
2800
|
+
path?: never;
|
|
2801
|
+
cookie?: never;
|
|
2802
|
+
};
|
|
2803
|
+
requestBody: {
|
|
2804
|
+
content: {
|
|
2805
|
+
"application/json": components["schemas"]["AnnotateSpansRequestBody"];
|
|
2806
|
+
};
|
|
2807
|
+
};
|
|
2808
|
+
responses: {
|
|
2809
|
+
/** @description Span annotations inserted successfully */
|
|
2810
|
+
200: {
|
|
2811
|
+
headers: {
|
|
2812
|
+
[name: string]: unknown;
|
|
2813
|
+
};
|
|
2814
|
+
content: {
|
|
2815
|
+
"application/json": components["schemas"]["AnnotateSpansResponseBody"];
|
|
2816
|
+
};
|
|
2817
|
+
};
|
|
2818
|
+
/** @description Forbidden */
|
|
2819
|
+
403: {
|
|
2820
|
+
headers: {
|
|
2821
|
+
[name: string]: unknown;
|
|
2822
|
+
};
|
|
2823
|
+
content: {
|
|
2824
|
+
"text/plain": string;
|
|
2825
|
+
};
|
|
2826
|
+
};
|
|
2827
|
+
/** @description Span not found */
|
|
2828
|
+
404: {
|
|
2829
|
+
headers: {
|
|
2830
|
+
[name: string]: unknown;
|
|
2831
|
+
};
|
|
2832
|
+
content: {
|
|
2833
|
+
"text/plain": string;
|
|
2834
|
+
};
|
|
2835
|
+
};
|
|
2836
|
+
/** @description Validation Error */
|
|
2837
|
+
422: {
|
|
2838
|
+
headers: {
|
|
2839
|
+
[name: string]: unknown;
|
|
2840
|
+
};
|
|
2841
|
+
content: {
|
|
2842
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2843
|
+
};
|
|
2844
|
+
};
|
|
2845
|
+
};
|
|
2846
|
+
};
|
|
2847
|
+
getEvaluations: {
|
|
2848
|
+
parameters: {
|
|
2849
|
+
query?: {
|
|
2850
|
+
/** @description The name of the project to get evaluations from (if omitted, evaluations will be drawn from the `default` project) */
|
|
2851
|
+
project_name?: string | null;
|
|
2852
|
+
};
|
|
2853
|
+
header?: never;
|
|
2854
|
+
path?: never;
|
|
2855
|
+
cookie?: never;
|
|
2856
|
+
};
|
|
2857
|
+
requestBody?: never;
|
|
2858
|
+
responses: {
|
|
2859
|
+
/** @description Successful Response */
|
|
2860
|
+
200: {
|
|
2861
|
+
headers: {
|
|
2862
|
+
[name: string]: unknown;
|
|
2863
|
+
};
|
|
2864
|
+
content: {
|
|
2865
|
+
"application/json": unknown;
|
|
2866
|
+
};
|
|
2867
|
+
};
|
|
2868
|
+
/** @description Forbidden */
|
|
2869
|
+
403: {
|
|
2870
|
+
headers: {
|
|
2871
|
+
[name: string]: unknown;
|
|
2872
|
+
};
|
|
2873
|
+
content: {
|
|
2874
|
+
"text/plain": string;
|
|
2875
|
+
};
|
|
2876
|
+
};
|
|
2877
|
+
/** @description Not Found */
|
|
2878
|
+
404: {
|
|
2879
|
+
headers: {
|
|
2880
|
+
[name: string]: unknown;
|
|
2881
|
+
};
|
|
2882
|
+
content: {
|
|
2883
|
+
"text/plain": string;
|
|
2884
|
+
};
|
|
2885
|
+
};
|
|
2886
|
+
/** @description Validation Error */
|
|
2887
|
+
422: {
|
|
2888
|
+
headers: {
|
|
2889
|
+
[name: string]: unknown;
|
|
2890
|
+
};
|
|
2891
|
+
content: {
|
|
2892
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2893
|
+
};
|
|
2894
|
+
};
|
|
2895
|
+
};
|
|
2896
|
+
};
|
|
2897
|
+
addEvaluations: {
|
|
2898
|
+
parameters: {
|
|
2899
|
+
query?: never;
|
|
2900
|
+
header?: {
|
|
2901
|
+
"content-type"?: string | null;
|
|
2902
|
+
"content-encoding"?: string | null;
|
|
2903
|
+
};
|
|
2904
|
+
path?: never;
|
|
2905
|
+
cookie?: never;
|
|
2906
|
+
};
|
|
2907
|
+
requestBody: {
|
|
2908
|
+
content: {
|
|
2909
|
+
"application/x-protobuf": string;
|
|
2910
|
+
"application/x-pandas-arrow": string;
|
|
1365
2911
|
};
|
|
1366
|
-
cookie?: never;
|
|
1367
2912
|
};
|
|
1368
|
-
requestBody?: never;
|
|
1369
2913
|
responses: {
|
|
1370
2914
|
/** @description Successful Response */
|
|
1371
|
-
|
|
2915
|
+
204: {
|
|
2916
|
+
headers: {
|
|
2917
|
+
[name: string]: unknown;
|
|
2918
|
+
};
|
|
2919
|
+
content?: never;
|
|
2920
|
+
};
|
|
2921
|
+
/** @description Forbidden */
|
|
2922
|
+
403: {
|
|
1372
2923
|
headers: {
|
|
1373
2924
|
[name: string]: unknown;
|
|
1374
2925
|
};
|
|
@@ -1376,8 +2927,8 @@ export interface operations {
|
|
|
1376
2927
|
"text/plain": string;
|
|
1377
2928
|
};
|
|
1378
2929
|
};
|
|
1379
|
-
/** @description
|
|
1380
|
-
|
|
2930
|
+
/** @description Unsupported content type, only gzipped protobuf and pandas-arrow are supported */
|
|
2931
|
+
415: {
|
|
1381
2932
|
headers: {
|
|
1382
2933
|
[name: string]: unknown;
|
|
1383
2934
|
};
|
|
@@ -1385,7 +2936,7 @@ export interface operations {
|
|
|
1385
2936
|
"text/plain": string;
|
|
1386
2937
|
};
|
|
1387
2938
|
};
|
|
1388
|
-
/** @description
|
|
2939
|
+
/** @description Unprocessable Entity */
|
|
1389
2940
|
422: {
|
|
1390
2941
|
headers: {
|
|
1391
2942
|
[name: string]: unknown;
|
|
@@ -1396,28 +2947,27 @@ export interface operations {
|
|
|
1396
2947
|
};
|
|
1397
2948
|
};
|
|
1398
2949
|
};
|
|
1399
|
-
|
|
2950
|
+
getPrompts: {
|
|
1400
2951
|
parameters: {
|
|
1401
2952
|
query?: {
|
|
1402
|
-
/** @description
|
|
1403
|
-
|
|
2953
|
+
/** @description Cursor for pagination (base64-encoded prompt ID) */
|
|
2954
|
+
cursor?: string | null;
|
|
2955
|
+
/** @description The max number of prompts to return at a time. */
|
|
2956
|
+
limit?: number;
|
|
1404
2957
|
};
|
|
1405
2958
|
header?: never;
|
|
1406
|
-
path
|
|
1407
|
-
/** @description The ID of the dataset */
|
|
1408
|
-
id: string;
|
|
1409
|
-
};
|
|
2959
|
+
path?: never;
|
|
1410
2960
|
cookie?: never;
|
|
1411
2961
|
};
|
|
1412
2962
|
requestBody?: never;
|
|
1413
2963
|
responses: {
|
|
1414
|
-
/** @description
|
|
2964
|
+
/** @description A list of prompts with pagination information */
|
|
1415
2965
|
200: {
|
|
1416
2966
|
headers: {
|
|
1417
2967
|
[name: string]: unknown;
|
|
1418
2968
|
};
|
|
1419
2969
|
content: {
|
|
1420
|
-
"
|
|
2970
|
+
"application/json": components["schemas"]["GetPromptsResponseBody"];
|
|
1421
2971
|
};
|
|
1422
2972
|
};
|
|
1423
2973
|
/** @description Forbidden */
|
|
@@ -1429,7 +2979,7 @@ export interface operations {
|
|
|
1429
2979
|
"text/plain": string;
|
|
1430
2980
|
};
|
|
1431
2981
|
};
|
|
1432
|
-
/** @description
|
|
2982
|
+
/** @description Unprocessable Entity */
|
|
1433
2983
|
422: {
|
|
1434
2984
|
headers: {
|
|
1435
2985
|
[name: string]: unknown;
|
|
@@ -1440,24 +2990,26 @@ export interface operations {
|
|
|
1440
2990
|
};
|
|
1441
2991
|
};
|
|
1442
2992
|
};
|
|
1443
|
-
|
|
2993
|
+
postPromptVersion: {
|
|
1444
2994
|
parameters: {
|
|
1445
2995
|
query?: never;
|
|
1446
2996
|
header?: never;
|
|
1447
|
-
path
|
|
1448
|
-
dataset_id: string;
|
|
1449
|
-
};
|
|
2997
|
+
path?: never;
|
|
1450
2998
|
cookie?: never;
|
|
1451
2999
|
};
|
|
1452
|
-
requestBody
|
|
3000
|
+
requestBody: {
|
|
3001
|
+
content: {
|
|
3002
|
+
"application/json": components["schemas"]["CreatePromptRequestBody"];
|
|
3003
|
+
};
|
|
3004
|
+
};
|
|
1453
3005
|
responses: {
|
|
1454
|
-
/** @description
|
|
3006
|
+
/** @description The newly created prompt version */
|
|
1455
3007
|
200: {
|
|
1456
3008
|
headers: {
|
|
1457
3009
|
[name: string]: unknown;
|
|
1458
3010
|
};
|
|
1459
3011
|
content: {
|
|
1460
|
-
"application/json": components["schemas"]["
|
|
3012
|
+
"application/json": components["schemas"]["CreatePromptResponseBody"];
|
|
1461
3013
|
};
|
|
1462
3014
|
};
|
|
1463
3015
|
/** @description Forbidden */
|
|
@@ -1469,39 +3021,41 @@ export interface operations {
|
|
|
1469
3021
|
"text/plain": string;
|
|
1470
3022
|
};
|
|
1471
3023
|
};
|
|
1472
|
-
/** @description
|
|
3024
|
+
/** @description Unprocessable Entity */
|
|
1473
3025
|
422: {
|
|
1474
3026
|
headers: {
|
|
1475
3027
|
[name: string]: unknown;
|
|
1476
3028
|
};
|
|
1477
3029
|
content: {
|
|
1478
|
-
"
|
|
3030
|
+
"text/plain": string;
|
|
1479
3031
|
};
|
|
1480
3032
|
};
|
|
1481
3033
|
};
|
|
1482
3034
|
};
|
|
1483
|
-
|
|
3035
|
+
listPromptVersions: {
|
|
1484
3036
|
parameters: {
|
|
1485
|
-
query?:
|
|
3037
|
+
query?: {
|
|
3038
|
+
/** @description Cursor for pagination (base64-encoded promptVersion ID) */
|
|
3039
|
+
cursor?: string | null;
|
|
3040
|
+
/** @description The max number of prompt versions to return at a time. */
|
|
3041
|
+
limit?: number;
|
|
3042
|
+
};
|
|
1486
3043
|
header?: never;
|
|
1487
3044
|
path: {
|
|
1488
|
-
|
|
3045
|
+
/** @description The identifier of the prompt, i.e. name or ID. */
|
|
3046
|
+
prompt_identifier: string;
|
|
1489
3047
|
};
|
|
1490
3048
|
cookie?: never;
|
|
1491
3049
|
};
|
|
1492
|
-
requestBody
|
|
1493
|
-
content: {
|
|
1494
|
-
"application/json": components["schemas"]["CreateExperimentRequestBody"];
|
|
1495
|
-
};
|
|
1496
|
-
};
|
|
3050
|
+
requestBody?: never;
|
|
1497
3051
|
responses: {
|
|
1498
|
-
/** @description
|
|
3052
|
+
/** @description A list of prompt versions with pagination information */
|
|
1499
3053
|
200: {
|
|
1500
3054
|
headers: {
|
|
1501
3055
|
[name: string]: unknown;
|
|
1502
3056
|
};
|
|
1503
3057
|
content: {
|
|
1504
|
-
"application/json": components["schemas"]["
|
|
3058
|
+
"application/json": components["schemas"]["GetPromptVersionsResponseBody"];
|
|
1505
3059
|
};
|
|
1506
3060
|
};
|
|
1507
3061
|
/** @description Forbidden */
|
|
@@ -1513,7 +3067,7 @@ export interface operations {
|
|
|
1513
3067
|
"text/plain": string;
|
|
1514
3068
|
};
|
|
1515
3069
|
};
|
|
1516
|
-
/** @description
|
|
3070
|
+
/** @description Not Found */
|
|
1517
3071
|
404: {
|
|
1518
3072
|
headers: {
|
|
1519
3073
|
[name: string]: unknown;
|
|
@@ -1522,35 +3076,36 @@ export interface operations {
|
|
|
1522
3076
|
"text/plain": string;
|
|
1523
3077
|
};
|
|
1524
3078
|
};
|
|
1525
|
-
/** @description
|
|
3079
|
+
/** @description Unprocessable Entity */
|
|
1526
3080
|
422: {
|
|
1527
3081
|
headers: {
|
|
1528
3082
|
[name: string]: unknown;
|
|
1529
3083
|
};
|
|
1530
3084
|
content: {
|
|
1531
|
-
"
|
|
3085
|
+
"text/plain": string;
|
|
1532
3086
|
};
|
|
1533
3087
|
};
|
|
1534
3088
|
};
|
|
1535
3089
|
};
|
|
1536
|
-
|
|
3090
|
+
getPromptVersionByPromptVersionId: {
|
|
1537
3091
|
parameters: {
|
|
1538
3092
|
query?: never;
|
|
1539
3093
|
header?: never;
|
|
1540
3094
|
path: {
|
|
1541
|
-
|
|
3095
|
+
/** @description The ID of the prompt version. */
|
|
3096
|
+
prompt_version_id: string;
|
|
1542
3097
|
};
|
|
1543
3098
|
cookie?: never;
|
|
1544
3099
|
};
|
|
1545
3100
|
requestBody?: never;
|
|
1546
3101
|
responses: {
|
|
1547
|
-
/** @description
|
|
3102
|
+
/** @description The requested prompt version */
|
|
1548
3103
|
200: {
|
|
1549
3104
|
headers: {
|
|
1550
3105
|
[name: string]: unknown;
|
|
1551
3106
|
};
|
|
1552
3107
|
content: {
|
|
1553
|
-
"application/json": components["schemas"]["
|
|
3108
|
+
"application/json": components["schemas"]["GetPromptResponseBody"];
|
|
1554
3109
|
};
|
|
1555
3110
|
};
|
|
1556
3111
|
/** @description Forbidden */
|
|
@@ -1562,7 +3117,7 @@ export interface operations {
|
|
|
1562
3117
|
"text/plain": string;
|
|
1563
3118
|
};
|
|
1564
3119
|
};
|
|
1565
|
-
/** @description
|
|
3120
|
+
/** @description Not Found */
|
|
1566
3121
|
404: {
|
|
1567
3122
|
headers: {
|
|
1568
3123
|
[name: string]: unknown;
|
|
@@ -1571,35 +3126,38 @@ export interface operations {
|
|
|
1571
3126
|
"text/plain": string;
|
|
1572
3127
|
};
|
|
1573
3128
|
};
|
|
1574
|
-
/** @description
|
|
3129
|
+
/** @description Unprocessable Entity */
|
|
1575
3130
|
422: {
|
|
1576
3131
|
headers: {
|
|
1577
3132
|
[name: string]: unknown;
|
|
1578
3133
|
};
|
|
1579
3134
|
content: {
|
|
1580
|
-
"
|
|
3135
|
+
"text/plain": string;
|
|
1581
3136
|
};
|
|
1582
3137
|
};
|
|
1583
3138
|
};
|
|
1584
3139
|
};
|
|
1585
|
-
|
|
3140
|
+
getPromptVersionByTagName: {
|
|
1586
3141
|
parameters: {
|
|
1587
3142
|
query?: never;
|
|
1588
3143
|
header?: never;
|
|
1589
3144
|
path: {
|
|
1590
|
-
|
|
3145
|
+
/** @description The identifier of the prompt, i.e. name or ID. */
|
|
3146
|
+
prompt_identifier: string;
|
|
3147
|
+
/** @description The tag of the prompt version */
|
|
3148
|
+
tag_name: string;
|
|
1591
3149
|
};
|
|
1592
3150
|
cookie?: never;
|
|
1593
3151
|
};
|
|
1594
3152
|
requestBody?: never;
|
|
1595
3153
|
responses: {
|
|
1596
|
-
/** @description
|
|
3154
|
+
/** @description The prompt version with the specified tag */
|
|
1597
3155
|
200: {
|
|
1598
3156
|
headers: {
|
|
1599
3157
|
[name: string]: unknown;
|
|
1600
3158
|
};
|
|
1601
3159
|
content: {
|
|
1602
|
-
"
|
|
3160
|
+
"application/json": components["schemas"]["GetPromptResponseBody"];
|
|
1603
3161
|
};
|
|
1604
3162
|
};
|
|
1605
3163
|
/** @description Forbidden */
|
|
@@ -1611,7 +3169,7 @@ export interface operations {
|
|
|
1611
3169
|
"text/plain": string;
|
|
1612
3170
|
};
|
|
1613
3171
|
};
|
|
1614
|
-
/** @description
|
|
3172
|
+
/** @description Not Found */
|
|
1615
3173
|
404: {
|
|
1616
3174
|
headers: {
|
|
1617
3175
|
[name: string]: unknown;
|
|
@@ -1620,40 +3178,36 @@ export interface operations {
|
|
|
1620
3178
|
"text/plain": string;
|
|
1621
3179
|
};
|
|
1622
3180
|
};
|
|
1623
|
-
/** @description
|
|
3181
|
+
/** @description Unprocessable Entity */
|
|
1624
3182
|
422: {
|
|
1625
3183
|
headers: {
|
|
1626
3184
|
[name: string]: unknown;
|
|
1627
3185
|
};
|
|
1628
3186
|
content: {
|
|
1629
|
-
"
|
|
3187
|
+
"text/plain": string;
|
|
1630
3188
|
};
|
|
1631
3189
|
};
|
|
1632
3190
|
};
|
|
1633
3191
|
};
|
|
1634
|
-
|
|
3192
|
+
getPromptVersionLatest: {
|
|
1635
3193
|
parameters: {
|
|
1636
|
-
query?:
|
|
1637
|
-
/** @description If true, fulfill request synchronously. */
|
|
1638
|
-
sync?: boolean;
|
|
1639
|
-
};
|
|
3194
|
+
query?: never;
|
|
1640
3195
|
header?: never;
|
|
1641
|
-
path
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
requestBody: {
|
|
1645
|
-
content: {
|
|
1646
|
-
"application/json": components["schemas"]["AnnotateSpansRequestBody"];
|
|
3196
|
+
path: {
|
|
3197
|
+
/** @description The identifier of the prompt, i.e. name or ID. */
|
|
3198
|
+
prompt_identifier: string;
|
|
1647
3199
|
};
|
|
3200
|
+
cookie?: never;
|
|
1648
3201
|
};
|
|
3202
|
+
requestBody?: never;
|
|
1649
3203
|
responses: {
|
|
1650
|
-
/** @description
|
|
3204
|
+
/** @description The latest version of the specified prompt */
|
|
1651
3205
|
200: {
|
|
1652
3206
|
headers: {
|
|
1653
3207
|
[name: string]: unknown;
|
|
1654
3208
|
};
|
|
1655
3209
|
content: {
|
|
1656
|
-
"application/json": components["schemas"]["
|
|
3210
|
+
"application/json": components["schemas"]["GetPromptResponseBody"];
|
|
1657
3211
|
};
|
|
1658
3212
|
};
|
|
1659
3213
|
/** @description Forbidden */
|
|
@@ -1665,7 +3219,7 @@ export interface operations {
|
|
|
1665
3219
|
"text/plain": string;
|
|
1666
3220
|
};
|
|
1667
3221
|
};
|
|
1668
|
-
/** @description
|
|
3222
|
+
/** @description Not Found */
|
|
1669
3223
|
404: {
|
|
1670
3224
|
headers: {
|
|
1671
3225
|
[name: string]: unknown;
|
|
@@ -1674,36 +3228,41 @@ export interface operations {
|
|
|
1674
3228
|
"text/plain": string;
|
|
1675
3229
|
};
|
|
1676
3230
|
};
|
|
1677
|
-
/** @description
|
|
3231
|
+
/** @description Unprocessable Entity */
|
|
1678
3232
|
422: {
|
|
1679
3233
|
headers: {
|
|
1680
3234
|
[name: string]: unknown;
|
|
1681
3235
|
};
|
|
1682
3236
|
content: {
|
|
1683
|
-
"
|
|
3237
|
+
"text/plain": string;
|
|
1684
3238
|
};
|
|
1685
3239
|
};
|
|
1686
3240
|
};
|
|
1687
3241
|
};
|
|
1688
|
-
|
|
3242
|
+
getPromptVersionTags: {
|
|
1689
3243
|
parameters: {
|
|
1690
3244
|
query?: {
|
|
1691
|
-
/** @description
|
|
1692
|
-
|
|
3245
|
+
/** @description Cursor for pagination (base64-encoded promptVersionTag ID) */
|
|
3246
|
+
cursor?: string | null;
|
|
3247
|
+
/** @description The max number of tags to return at a time. */
|
|
3248
|
+
limit?: number;
|
|
1693
3249
|
};
|
|
1694
3250
|
header?: never;
|
|
1695
|
-
path
|
|
3251
|
+
path: {
|
|
3252
|
+
/** @description The ID of the prompt version. */
|
|
3253
|
+
prompt_version_id: string;
|
|
3254
|
+
};
|
|
1696
3255
|
cookie?: never;
|
|
1697
3256
|
};
|
|
1698
3257
|
requestBody?: never;
|
|
1699
3258
|
responses: {
|
|
1700
|
-
/** @description
|
|
3259
|
+
/** @description A list of tags associated with the prompt version */
|
|
1701
3260
|
200: {
|
|
1702
3261
|
headers: {
|
|
1703
3262
|
[name: string]: unknown;
|
|
1704
3263
|
};
|
|
1705
3264
|
content: {
|
|
1706
|
-
"application/json":
|
|
3265
|
+
"application/json": components["schemas"]["GetPromptVersionTagsResponseBody"];
|
|
1707
3266
|
};
|
|
1708
3267
|
};
|
|
1709
3268
|
/** @description Forbidden */
|
|
@@ -1724,35 +3283,34 @@ export interface operations {
|
|
|
1724
3283
|
"text/plain": string;
|
|
1725
3284
|
};
|
|
1726
3285
|
};
|
|
1727
|
-
/** @description
|
|
3286
|
+
/** @description Unprocessable Entity */
|
|
1728
3287
|
422: {
|
|
1729
3288
|
headers: {
|
|
1730
3289
|
[name: string]: unknown;
|
|
1731
3290
|
};
|
|
1732
3291
|
content: {
|
|
1733
|
-
"
|
|
3292
|
+
"text/plain": string;
|
|
1734
3293
|
};
|
|
1735
3294
|
};
|
|
1736
3295
|
};
|
|
1737
3296
|
};
|
|
1738
|
-
|
|
3297
|
+
createPromptVersionTag: {
|
|
1739
3298
|
parameters: {
|
|
1740
3299
|
query?: never;
|
|
1741
|
-
header?:
|
|
1742
|
-
|
|
1743
|
-
|
|
3300
|
+
header?: never;
|
|
3301
|
+
path: {
|
|
3302
|
+
/** @description The ID of the prompt version. */
|
|
3303
|
+
prompt_version_id: string;
|
|
1744
3304
|
};
|
|
1745
|
-
path?: never;
|
|
1746
3305
|
cookie?: never;
|
|
1747
3306
|
};
|
|
1748
3307
|
requestBody: {
|
|
1749
3308
|
content: {
|
|
1750
|
-
"application/
|
|
1751
|
-
"application/x-pandas-arrow": string;
|
|
3309
|
+
"application/json": components["schemas"]["PromptVersionTagData"];
|
|
1752
3310
|
};
|
|
1753
3311
|
};
|
|
1754
3312
|
responses: {
|
|
1755
|
-
/** @description
|
|
3313
|
+
/** @description No content returned on successful tag creation */
|
|
1756
3314
|
204: {
|
|
1757
3315
|
headers: {
|
|
1758
3316
|
[name: string]: unknown;
|
|
@@ -1768,8 +3326,8 @@ export interface operations {
|
|
|
1768
3326
|
"text/plain": string;
|
|
1769
3327
|
};
|
|
1770
3328
|
};
|
|
1771
|
-
/** @description
|
|
1772
|
-
|
|
3329
|
+
/** @description Not Found */
|
|
3330
|
+
404: {
|
|
1773
3331
|
headers: {
|
|
1774
3332
|
[name: string]: unknown;
|
|
1775
3333
|
};
|
|
@@ -1788,13 +3346,15 @@ export interface operations {
|
|
|
1788
3346
|
};
|
|
1789
3347
|
};
|
|
1790
3348
|
};
|
|
1791
|
-
|
|
3349
|
+
getProjects: {
|
|
1792
3350
|
parameters: {
|
|
1793
3351
|
query?: {
|
|
1794
|
-
/** @description Cursor for pagination (
|
|
3352
|
+
/** @description Cursor for pagination (project ID) */
|
|
1795
3353
|
cursor?: string | null;
|
|
1796
|
-
/** @description The max number of
|
|
3354
|
+
/** @description The max number of projects to return at a time. */
|
|
1797
3355
|
limit?: number;
|
|
3356
|
+
/** @description Include experiment projects in the response. Experiment projects are created from running experiments. */
|
|
3357
|
+
include_experiment_projects?: boolean;
|
|
1798
3358
|
};
|
|
1799
3359
|
header?: never;
|
|
1800
3360
|
path?: never;
|
|
@@ -1802,13 +3362,13 @@ export interface operations {
|
|
|
1802
3362
|
};
|
|
1803
3363
|
requestBody?: never;
|
|
1804
3364
|
responses: {
|
|
1805
|
-
/** @description
|
|
3365
|
+
/** @description A list of projects with pagination information */
|
|
1806
3366
|
200: {
|
|
1807
3367
|
headers: {
|
|
1808
3368
|
[name: string]: unknown;
|
|
1809
3369
|
};
|
|
1810
3370
|
content: {
|
|
1811
|
-
"application/json": components["schemas"]["
|
|
3371
|
+
"application/json": components["schemas"]["GetProjectsResponseBody"];
|
|
1812
3372
|
};
|
|
1813
3373
|
};
|
|
1814
3374
|
/** @description Forbidden */
|
|
@@ -1831,7 +3391,7 @@ export interface operations {
|
|
|
1831
3391
|
};
|
|
1832
3392
|
};
|
|
1833
3393
|
};
|
|
1834
|
-
|
|
3394
|
+
createProject: {
|
|
1835
3395
|
parameters: {
|
|
1836
3396
|
query?: never;
|
|
1837
3397
|
header?: never;
|
|
@@ -1840,63 +3400,17 @@ export interface operations {
|
|
|
1840
3400
|
};
|
|
1841
3401
|
requestBody: {
|
|
1842
3402
|
content: {
|
|
1843
|
-
"application/json": components["schemas"]["
|
|
1844
|
-
};
|
|
1845
|
-
};
|
|
1846
|
-
responses: {
|
|
1847
|
-
/** @description Successful Response */
|
|
1848
|
-
200: {
|
|
1849
|
-
headers: {
|
|
1850
|
-
[name: string]: unknown;
|
|
1851
|
-
};
|
|
1852
|
-
content: {
|
|
1853
|
-
"application/json": components["schemas"]["CreatePromptResponseBody"];
|
|
1854
|
-
};
|
|
3403
|
+
"application/json": components["schemas"]["CreateProjectRequestBody"];
|
|
1855
3404
|
};
|
|
1856
|
-
/** @description Forbidden */
|
|
1857
|
-
403: {
|
|
1858
|
-
headers: {
|
|
1859
|
-
[name: string]: unknown;
|
|
1860
|
-
};
|
|
1861
|
-
content: {
|
|
1862
|
-
"text/plain": string;
|
|
1863
|
-
};
|
|
1864
|
-
};
|
|
1865
|
-
/** @description Unprocessable Entity */
|
|
1866
|
-
422: {
|
|
1867
|
-
headers: {
|
|
1868
|
-
[name: string]: unknown;
|
|
1869
|
-
};
|
|
1870
|
-
content: {
|
|
1871
|
-
"text/plain": string;
|
|
1872
|
-
};
|
|
1873
|
-
};
|
|
1874
|
-
};
|
|
1875
|
-
};
|
|
1876
|
-
listPromptVersions: {
|
|
1877
|
-
parameters: {
|
|
1878
|
-
query?: {
|
|
1879
|
-
/** @description Cursor for pagination (base64-encoded promptVersion ID) */
|
|
1880
|
-
cursor?: string | null;
|
|
1881
|
-
/** @description The max number of prompt versions to return at a time. */
|
|
1882
|
-
limit?: number;
|
|
1883
|
-
};
|
|
1884
|
-
header?: never;
|
|
1885
|
-
path: {
|
|
1886
|
-
/** @description The identifier of the prompt, i.e. name or ID. */
|
|
1887
|
-
prompt_identifier: string;
|
|
1888
|
-
};
|
|
1889
|
-
cookie?: never;
|
|
1890
3405
|
};
|
|
1891
|
-
requestBody?: never;
|
|
1892
3406
|
responses: {
|
|
1893
|
-
/** @description
|
|
3407
|
+
/** @description The newly created project */
|
|
1894
3408
|
200: {
|
|
1895
3409
|
headers: {
|
|
1896
3410
|
[name: string]: unknown;
|
|
1897
3411
|
};
|
|
1898
3412
|
content: {
|
|
1899
|
-
"application/json": components["schemas"]["
|
|
3413
|
+
"application/json": components["schemas"]["CreateProjectResponseBody"];
|
|
1900
3414
|
};
|
|
1901
3415
|
};
|
|
1902
3416
|
/** @description Forbidden */
|
|
@@ -1919,25 +3433,25 @@ export interface operations {
|
|
|
1919
3433
|
};
|
|
1920
3434
|
};
|
|
1921
3435
|
};
|
|
1922
|
-
|
|
3436
|
+
getProject: {
|
|
1923
3437
|
parameters: {
|
|
1924
3438
|
query?: never;
|
|
1925
3439
|
header?: never;
|
|
1926
3440
|
path: {
|
|
1927
|
-
/** @description The ID
|
|
1928
|
-
|
|
3441
|
+
/** @description The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters. */
|
|
3442
|
+
project_identifier: string;
|
|
1929
3443
|
};
|
|
1930
3444
|
cookie?: never;
|
|
1931
3445
|
};
|
|
1932
3446
|
requestBody?: never;
|
|
1933
3447
|
responses: {
|
|
1934
|
-
/** @description
|
|
3448
|
+
/** @description The requested project */
|
|
1935
3449
|
200: {
|
|
1936
3450
|
headers: {
|
|
1937
3451
|
[name: string]: unknown;
|
|
1938
3452
|
};
|
|
1939
3453
|
content: {
|
|
1940
|
-
"application/json": components["schemas"]["
|
|
3454
|
+
"application/json": components["schemas"]["GetProjectResponseBody"];
|
|
1941
3455
|
};
|
|
1942
3456
|
};
|
|
1943
3457
|
/** @description Forbidden */
|
|
@@ -1969,27 +3483,29 @@ export interface operations {
|
|
|
1969
3483
|
};
|
|
1970
3484
|
};
|
|
1971
3485
|
};
|
|
1972
|
-
|
|
3486
|
+
updateProject: {
|
|
1973
3487
|
parameters: {
|
|
1974
3488
|
query?: never;
|
|
1975
3489
|
header?: never;
|
|
1976
3490
|
path: {
|
|
1977
|
-
/** @description The identifier
|
|
1978
|
-
|
|
1979
|
-
/** @description The tag of the prompt version */
|
|
1980
|
-
tag_name: string;
|
|
3491
|
+
/** @description The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters. */
|
|
3492
|
+
project_identifier: string;
|
|
1981
3493
|
};
|
|
1982
3494
|
cookie?: never;
|
|
1983
3495
|
};
|
|
1984
|
-
requestBody
|
|
3496
|
+
requestBody: {
|
|
3497
|
+
content: {
|
|
3498
|
+
"application/json": components["schemas"]["UpdateProjectRequestBody"];
|
|
3499
|
+
};
|
|
3500
|
+
};
|
|
1985
3501
|
responses: {
|
|
1986
|
-
/** @description
|
|
3502
|
+
/** @description The updated project */
|
|
1987
3503
|
200: {
|
|
1988
3504
|
headers: {
|
|
1989
3505
|
[name: string]: unknown;
|
|
1990
3506
|
};
|
|
1991
3507
|
content: {
|
|
1992
|
-
"application/json": components["schemas"]["
|
|
3508
|
+
"application/json": components["schemas"]["UpdateProjectResponseBody"];
|
|
1993
3509
|
};
|
|
1994
3510
|
};
|
|
1995
3511
|
/** @description Forbidden */
|
|
@@ -2021,26 +3537,24 @@ export interface operations {
|
|
|
2021
3537
|
};
|
|
2022
3538
|
};
|
|
2023
3539
|
};
|
|
2024
|
-
|
|
3540
|
+
deleteProject: {
|
|
2025
3541
|
parameters: {
|
|
2026
3542
|
query?: never;
|
|
2027
3543
|
header?: never;
|
|
2028
3544
|
path: {
|
|
2029
|
-
/** @description The identifier
|
|
2030
|
-
|
|
3545
|
+
/** @description The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters. */
|
|
3546
|
+
project_identifier: string;
|
|
2031
3547
|
};
|
|
2032
3548
|
cookie?: never;
|
|
2033
3549
|
};
|
|
2034
3550
|
requestBody?: never;
|
|
2035
3551
|
responses: {
|
|
2036
|
-
/** @description
|
|
2037
|
-
|
|
3552
|
+
/** @description No content returned on successful deletion */
|
|
3553
|
+
204: {
|
|
2038
3554
|
headers: {
|
|
2039
3555
|
[name: string]: unknown;
|
|
2040
3556
|
};
|
|
2041
|
-
content
|
|
2042
|
-
"application/json": components["schemas"]["GetPromptResponseBody"];
|
|
2043
|
-
};
|
|
3557
|
+
content?: never;
|
|
2044
3558
|
};
|
|
2045
3559
|
/** @description Forbidden */
|
|
2046
3560
|
403: {
|