@arizeai/phoenix-client 0.0.1

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.
Files changed (114) hide show
  1. package/README.md +53 -0
  2. package/dist/esm/__generated__/api/v1.d.ts +1253 -0
  3. package/dist/esm/__generated__/api/v1.d.ts.map +1 -0
  4. package/dist/esm/__generated__/api/v1.js +6 -0
  5. package/dist/esm/__generated__/api/v1.js.map +1 -0
  6. package/dist/esm/client.d.ts +36 -0
  7. package/dist/esm/client.d.ts.map +1 -0
  8. package/dist/esm/client.js +29 -0
  9. package/dist/esm/client.js.map +1 -0
  10. package/dist/esm/config.d.ts +14 -0
  11. package/dist/esm/config.d.ts.map +1 -0
  12. package/dist/esm/config.js +56 -0
  13. package/dist/esm/config.js.map +1 -0
  14. package/dist/esm/experiments/index.d.ts +2 -0
  15. package/dist/esm/experiments/index.d.ts.map +1 -0
  16. package/dist/esm/experiments/index.js +2 -0
  17. package/dist/esm/experiments/index.js.map +1 -0
  18. package/dist/esm/experiments/runExperiment.d.ts +58 -0
  19. package/dist/esm/experiments/runExperiment.d.ts.map +1 -0
  20. package/dist/esm/experiments/runExperiment.js +215 -0
  21. package/dist/esm/experiments/runExperiment.js.map +1 -0
  22. package/dist/esm/index.d.ts +3 -0
  23. package/dist/esm/index.d.ts.map +1 -0
  24. package/dist/esm/index.js +3 -0
  25. package/dist/esm/index.js.map +1 -0
  26. package/dist/esm/package.json +1 -0
  27. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -0
  28. package/dist/esm/types/annotations.d.ts +2 -0
  29. package/dist/esm/types/annotations.d.ts.map +1 -0
  30. package/dist/esm/types/annotations.js +2 -0
  31. package/dist/esm/types/annotations.js.map +1 -0
  32. package/dist/esm/types/core.d.ts +7 -0
  33. package/dist/esm/types/core.d.ts.map +1 -0
  34. package/dist/esm/types/core.js +2 -0
  35. package/dist/esm/types/core.js.map +1 -0
  36. package/dist/esm/types/datasets.d.ts +21 -0
  37. package/dist/esm/types/datasets.d.ts.map +1 -0
  38. package/dist/esm/types/datasets.js +2 -0
  39. package/dist/esm/types/datasets.js.map +1 -0
  40. package/dist/esm/types/experiments.d.ts +95 -0
  41. package/dist/esm/types/experiments.d.ts.map +1 -0
  42. package/dist/esm/types/experiments.js +2 -0
  43. package/dist/esm/types/experiments.js.map +1 -0
  44. package/dist/esm/utils/pluralize.d.ts +9 -0
  45. package/dist/esm/utils/pluralize.d.ts.map +1 -0
  46. package/dist/esm/utils/pluralize.js +11 -0
  47. package/dist/esm/utils/pluralize.js.map +1 -0
  48. package/dist/esm/utils/promisifyResult.d.ts +6 -0
  49. package/dist/esm/utils/promisifyResult.d.ts.map +1 -0
  50. package/dist/esm/utils/promisifyResult.js +11 -0
  51. package/dist/esm/utils/promisifyResult.js.map +1 -0
  52. package/dist/src/__generated__/api/v1.d.ts +1253 -0
  53. package/dist/src/__generated__/api/v1.d.ts.map +1 -0
  54. package/dist/src/__generated__/api/v1.js +7 -0
  55. package/dist/src/__generated__/api/v1.js.map +1 -0
  56. package/dist/src/client.d.ts +36 -0
  57. package/dist/src/client.d.ts.map +1 -0
  58. package/dist/src/client.js +33 -0
  59. package/dist/src/client.js.map +1 -0
  60. package/dist/src/config.d.ts +14 -0
  61. package/dist/src/config.d.ts.map +1 -0
  62. package/dist/src/config.js +65 -0
  63. package/dist/src/config.js.map +1 -0
  64. package/dist/src/experiments/index.d.ts +2 -0
  65. package/dist/src/experiments/index.d.ts.map +1 -0
  66. package/dist/src/experiments/index.js +18 -0
  67. package/dist/src/experiments/index.js.map +1 -0
  68. package/dist/src/experiments/runExperiment.d.ts +58 -0
  69. package/dist/src/experiments/runExperiment.d.ts.map +1 -0
  70. package/dist/src/experiments/runExperiment.js +227 -0
  71. package/dist/src/experiments/runExperiment.js.map +1 -0
  72. package/dist/src/index.d.ts +3 -0
  73. package/dist/src/index.d.ts.map +1 -0
  74. package/dist/src/index.js +19 -0
  75. package/dist/src/index.js.map +1 -0
  76. package/dist/src/types/annotations.d.ts +2 -0
  77. package/dist/src/types/annotations.d.ts.map +1 -0
  78. package/dist/src/types/annotations.js +3 -0
  79. package/dist/src/types/annotations.js.map +1 -0
  80. package/dist/src/types/core.d.ts +7 -0
  81. package/dist/src/types/core.d.ts.map +1 -0
  82. package/dist/src/types/core.js +3 -0
  83. package/dist/src/types/core.js.map +1 -0
  84. package/dist/src/types/datasets.d.ts +21 -0
  85. package/dist/src/types/datasets.d.ts.map +1 -0
  86. package/dist/src/types/datasets.js +3 -0
  87. package/dist/src/types/datasets.js.map +1 -0
  88. package/dist/src/types/experiments.d.ts +95 -0
  89. package/dist/src/types/experiments.d.ts.map +1 -0
  90. package/dist/src/types/experiments.js +3 -0
  91. package/dist/src/types/experiments.js.map +1 -0
  92. package/dist/src/utils/pluralize.d.ts +9 -0
  93. package/dist/src/utils/pluralize.d.ts.map +1 -0
  94. package/dist/src/utils/pluralize.js +14 -0
  95. package/dist/src/utils/pluralize.js.map +1 -0
  96. package/dist/src/utils/promisifyResult.d.ts +6 -0
  97. package/dist/src/utils/promisifyResult.d.ts.map +1 -0
  98. package/dist/src/utils/promisifyResult.js +14 -0
  99. package/dist/src/utils/promisifyResult.js.map +1 -0
  100. package/dist/tsconfig.tsbuildinfo +1 -0
  101. package/package.json +44 -0
  102. package/src/__generated__/api/v1.d.ts +1253 -0
  103. package/src/__generated__/api/v1.ts +1253 -0
  104. package/src/client.ts +63 -0
  105. package/src/config.ts +68 -0
  106. package/src/experiments/index.ts +1 -0
  107. package/src/experiments/runExperiment.ts +367 -0
  108. package/src/index.ts +3 -0
  109. package/src/types/annotations.ts +1 -0
  110. package/src/types/core.ts +6 -0
  111. package/src/types/datasets.ts +22 -0
  112. package/src/types/experiments.ts +108 -0
  113. package/src/utils/pluralize.ts +10 -0
  114. package/src/utils/promisifyResult.ts +13 -0
@@ -0,0 +1,1253 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export interface paths {
7
+ "/v1/datasets": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ /** List datasets */
15
+ get: operations["listDatasets"];
16
+ put?: never;
17
+ post?: never;
18
+ delete?: never;
19
+ options?: never;
20
+ head?: never;
21
+ patch?: never;
22
+ trace?: never;
23
+ };
24
+ "/v1/datasets/{id}": {
25
+ parameters: {
26
+ query?: never;
27
+ header?: never;
28
+ path?: never;
29
+ cookie?: never;
30
+ };
31
+ /** Get dataset by ID */
32
+ get: operations["getDataset"];
33
+ put?: never;
34
+ post?: never;
35
+ /** Delete dataset by ID */
36
+ delete: operations["deleteDatasetById"];
37
+ options?: never;
38
+ head?: never;
39
+ patch?: never;
40
+ trace?: never;
41
+ };
42
+ "/v1/datasets/{id}/versions": {
43
+ parameters: {
44
+ query?: never;
45
+ header?: never;
46
+ path?: never;
47
+ cookie?: never;
48
+ };
49
+ /** List dataset versions */
50
+ get: operations["listDatasetVersionsByDatasetId"];
51
+ put?: never;
52
+ post?: never;
53
+ delete?: never;
54
+ options?: never;
55
+ head?: never;
56
+ patch?: never;
57
+ trace?: never;
58
+ };
59
+ "/v1/datasets/upload": {
60
+ parameters: {
61
+ query?: never;
62
+ header?: never;
63
+ path?: never;
64
+ cookie?: never;
65
+ };
66
+ get?: never;
67
+ put?: never;
68
+ /** Upload dataset from JSON, CSV, or PyArrow */
69
+ post: operations["uploadDataset"];
70
+ delete?: never;
71
+ options?: never;
72
+ head?: never;
73
+ patch?: never;
74
+ trace?: never;
75
+ };
76
+ "/v1/datasets/{id}/examples": {
77
+ parameters: {
78
+ query?: never;
79
+ header?: never;
80
+ path?: never;
81
+ cookie?: never;
82
+ };
83
+ /** Get examples from a dataset */
84
+ get: operations["getDatasetExamples"];
85
+ put?: never;
86
+ post?: never;
87
+ delete?: never;
88
+ options?: never;
89
+ head?: never;
90
+ patch?: never;
91
+ trace?: never;
92
+ };
93
+ "/v1/datasets/{id}/csv": {
94
+ parameters: {
95
+ query?: never;
96
+ header?: never;
97
+ path?: never;
98
+ cookie?: never;
99
+ };
100
+ /** Download dataset examples as CSV file */
101
+ get: operations["getDatasetCsv"];
102
+ put?: never;
103
+ post?: never;
104
+ delete?: never;
105
+ options?: never;
106
+ head?: never;
107
+ patch?: never;
108
+ trace?: never;
109
+ };
110
+ "/v1/datasets/{id}/jsonl/openai_ft": {
111
+ parameters: {
112
+ query?: never;
113
+ header?: never;
114
+ path?: never;
115
+ cookie?: never;
116
+ };
117
+ /** Download dataset examples as OpenAI fine-tuning JSONL file */
118
+ get: operations["getDatasetJSONLOpenAIFineTuning"];
119
+ put?: never;
120
+ post?: never;
121
+ delete?: never;
122
+ options?: never;
123
+ head?: never;
124
+ patch?: never;
125
+ trace?: never;
126
+ };
127
+ "/v1/datasets/{id}/jsonl/openai_evals": {
128
+ parameters: {
129
+ query?: never;
130
+ header?: never;
131
+ path?: never;
132
+ cookie?: never;
133
+ };
134
+ /** Download dataset examples as OpenAI evals JSONL file */
135
+ get: operations["getDatasetJSONLOpenAIEvals"];
136
+ put?: never;
137
+ post?: never;
138
+ delete?: never;
139
+ options?: never;
140
+ head?: never;
141
+ patch?: never;
142
+ trace?: never;
143
+ };
144
+ "/v1/datasets/{dataset_id}/experiments": {
145
+ parameters: {
146
+ query?: never;
147
+ header?: never;
148
+ path?: never;
149
+ cookie?: never;
150
+ };
151
+ /** List experiments by dataset */
152
+ get: operations["listExperiments"];
153
+ put?: never;
154
+ /** Create experiment on a dataset */
155
+ post: operations["createExperiment"];
156
+ delete?: never;
157
+ options?: never;
158
+ head?: never;
159
+ patch?: never;
160
+ trace?: never;
161
+ };
162
+ "/v1/experiments/{experiment_id}": {
163
+ parameters: {
164
+ query?: never;
165
+ header?: never;
166
+ path?: never;
167
+ cookie?: never;
168
+ };
169
+ /** Get experiment by ID */
170
+ get: operations["getExperiment"];
171
+ put?: never;
172
+ post?: never;
173
+ delete?: never;
174
+ options?: never;
175
+ head?: never;
176
+ patch?: never;
177
+ trace?: never;
178
+ };
179
+ "/v1/span_annotations": {
180
+ parameters: {
181
+ query?: never;
182
+ header?: never;
183
+ path?: never;
184
+ cookie?: never;
185
+ };
186
+ get?: never;
187
+ put?: never;
188
+ /** Create or update span annotations */
189
+ post: operations["annotateSpans"];
190
+ delete?: never;
191
+ options?: never;
192
+ head?: never;
193
+ patch?: never;
194
+ trace?: never;
195
+ };
196
+ "/v1/evaluations": {
197
+ parameters: {
198
+ query?: never;
199
+ header?: never;
200
+ path?: never;
201
+ cookie?: never;
202
+ };
203
+ /** Get span, trace, or document evaluations from a project */
204
+ get: operations["getEvaluations"];
205
+ put?: never;
206
+ /** Add span, trace, or document evaluations */
207
+ post: operations["addEvaluations"];
208
+ delete?: never;
209
+ options?: never;
210
+ head?: never;
211
+ patch?: never;
212
+ trace?: never;
213
+ };
214
+ }
215
+ export type webhooks = Record<string, never>;
216
+ export interface components {
217
+ schemas: {
218
+ /** AnnotateSpansRequestBody */
219
+ AnnotateSpansRequestBody: {
220
+ /** Data */
221
+ data: components["schemas"]["SpanAnnotation"][];
222
+ };
223
+ /** AnnotateSpansResponseBody */
224
+ AnnotateSpansResponseBody: {
225
+ /** Data */
226
+ data: components["schemas"]["InsertedSpanAnnotation"][];
227
+ };
228
+ /**
229
+ * CreateExperimentRequestBody
230
+ * @description Details of the experiment to be created
231
+ */
232
+ CreateExperimentRequestBody: {
233
+ /**
234
+ * Name
235
+ * @description Name of the experiment (if omitted, a random name will be generated)
236
+ */
237
+ name?: string | null;
238
+ /**
239
+ * Description
240
+ * @description An optional description of the experiment
241
+ */
242
+ description?: string | null;
243
+ /**
244
+ * Metadata
245
+ * @description Metadata for the experiment
246
+ */
247
+ metadata?: Record<string, never> | null;
248
+ /**
249
+ * Version Id
250
+ * @description ID of the dataset version over which the experiment will be run (if omitted, the latest version will be used)
251
+ */
252
+ version_id?: string | null;
253
+ /**
254
+ * Repetitions
255
+ * @description Number of times the experiment should be repeated for each example
256
+ * @default 1
257
+ */
258
+ repetitions: number;
259
+ };
260
+ /** CreateExperimentResponseBody */
261
+ CreateExperimentResponseBody: {
262
+ data: components["schemas"]["Experiment"];
263
+ };
264
+ /** Dataset */
265
+ Dataset: {
266
+ /** Id */
267
+ id: string;
268
+ /** Name */
269
+ name: string;
270
+ /** Description */
271
+ description: string | null;
272
+ /** Metadata */
273
+ metadata: Record<string, never>;
274
+ /**
275
+ * Created At
276
+ * Format: date-time
277
+ */
278
+ created_at: string;
279
+ /**
280
+ * Updated At
281
+ * Format: date-time
282
+ */
283
+ updated_at: string;
284
+ };
285
+ /** DatasetExample */
286
+ DatasetExample: {
287
+ /** Id */
288
+ id: string;
289
+ /** Input */
290
+ input: Record<string, never>;
291
+ /** Output */
292
+ output: Record<string, never>;
293
+ /** Metadata */
294
+ metadata: Record<string, never>;
295
+ /**
296
+ * Updated At
297
+ * Format: date-time
298
+ */
299
+ updated_at: string;
300
+ };
301
+ /** DatasetVersion */
302
+ DatasetVersion: {
303
+ /** Version Id */
304
+ version_id: string;
305
+ /** Description */
306
+ description: string | null;
307
+ /** Metadata */
308
+ metadata: Record<string, never>;
309
+ /**
310
+ * Created At
311
+ * Format: date-time
312
+ */
313
+ created_at: string;
314
+ };
315
+ /** DatasetWithExampleCount */
316
+ DatasetWithExampleCount: {
317
+ /** Id */
318
+ id: string;
319
+ /** Name */
320
+ name: string;
321
+ /** Description */
322
+ description: string | null;
323
+ /** Metadata */
324
+ metadata: Record<string, never>;
325
+ /**
326
+ * Created At
327
+ * Format: date-time
328
+ */
329
+ created_at: string;
330
+ /**
331
+ * Updated At
332
+ * Format: date-time
333
+ */
334
+ updated_at: string;
335
+ /** Example Count */
336
+ example_count: number;
337
+ };
338
+ /** Experiment */
339
+ Experiment: {
340
+ /**
341
+ * Id
342
+ * @description The ID of the experiment
343
+ */
344
+ id: string;
345
+ /**
346
+ * Dataset Id
347
+ * @description The ID of the dataset associated with the experiment
348
+ */
349
+ dataset_id: string;
350
+ /**
351
+ * Dataset Version Id
352
+ * @description The ID of the dataset version associated with the experiment
353
+ */
354
+ dataset_version_id: string;
355
+ /**
356
+ * Repetitions
357
+ * @description Number of times the experiment is repeated
358
+ */
359
+ repetitions: number;
360
+ /**
361
+ * Metadata
362
+ * @description Metadata of the experiment
363
+ */
364
+ metadata: Record<string, never>;
365
+ /**
366
+ * Project Name
367
+ * @description The name of the project associated with the experiment
368
+ */
369
+ project_name: string | null;
370
+ /**
371
+ * Created At
372
+ * Format: date-time
373
+ * @description The creation timestamp of the experiment
374
+ */
375
+ created_at: string;
376
+ /**
377
+ * Updated At
378
+ * Format: date-time
379
+ * @description The last update timestamp of the experiment
380
+ */
381
+ updated_at: string;
382
+ };
383
+ /** GetDatasetResponseBody */
384
+ GetDatasetResponseBody: {
385
+ data: components["schemas"]["DatasetWithExampleCount"];
386
+ };
387
+ /** GetExperimentResponseBody */
388
+ GetExperimentResponseBody: {
389
+ data: components["schemas"]["Experiment"];
390
+ };
391
+ /** HTTPValidationError */
392
+ HTTPValidationError: {
393
+ /** Detail */
394
+ detail?: components["schemas"]["ValidationError"][];
395
+ };
396
+ /** InsertedSpanAnnotation */
397
+ InsertedSpanAnnotation: {
398
+ /**
399
+ * Id
400
+ * @description The ID of the inserted span annotation
401
+ */
402
+ id: string;
403
+ };
404
+ /** ListDatasetExamplesData */
405
+ ListDatasetExamplesData: {
406
+ /** Dataset Id */
407
+ dataset_id: string;
408
+ /** Version Id */
409
+ version_id: string;
410
+ /** Examples */
411
+ examples: components["schemas"]["DatasetExample"][];
412
+ };
413
+ /** ListDatasetExamplesResponseBody */
414
+ ListDatasetExamplesResponseBody: {
415
+ data: components["schemas"]["ListDatasetExamplesData"];
416
+ };
417
+ /** ListDatasetVersionsResponseBody */
418
+ ListDatasetVersionsResponseBody: {
419
+ /** Data */
420
+ data: components["schemas"]["DatasetVersion"][];
421
+ /** Next Cursor */
422
+ next_cursor: string | null;
423
+ };
424
+ /** ListDatasetsResponseBody */
425
+ ListDatasetsResponseBody: {
426
+ /** Data */
427
+ data: components["schemas"]["Dataset"][];
428
+ /** Next Cursor */
429
+ next_cursor: string | null;
430
+ };
431
+ /** ListExperimentsResponseBody */
432
+ ListExperimentsResponseBody: {
433
+ /** Data */
434
+ data: components["schemas"]["Experiment"][];
435
+ };
436
+ /** SpanAnnotation */
437
+ SpanAnnotation: {
438
+ /**
439
+ * Span Id
440
+ * @description OpenTelemetry Span ID (hex format w/o 0x prefix)
441
+ */
442
+ span_id: string;
443
+ /**
444
+ * Name
445
+ * @description The name of the annotation
446
+ */
447
+ name: string;
448
+ /**
449
+ * Annotator Kind
450
+ * @description The kind of annotator used for the annotation
451
+ * @enum {string}
452
+ */
453
+ annotator_kind: "LLM" | "HUMAN";
454
+ /** @description The result of the annotation */
455
+ result?: components["schemas"]["SpanAnnotationResult"] | null;
456
+ /**
457
+ * Metadata
458
+ * @description Metadata for the annotation
459
+ */
460
+ metadata?: Record<string, never> | null;
461
+ };
462
+ /** SpanAnnotationResult */
463
+ SpanAnnotationResult: {
464
+ /**
465
+ * Label
466
+ * @description The label assigned by the annotation
467
+ */
468
+ label?: string | null;
469
+ /**
470
+ * Score
471
+ * @description The score assigned by the annotation
472
+ */
473
+ score?: number | null;
474
+ /**
475
+ * Explanation
476
+ * @description Explanation of the annotation result
477
+ */
478
+ explanation?: string | null;
479
+ };
480
+ /** UploadDatasetData */
481
+ UploadDatasetData: {
482
+ /** Dataset Id */
483
+ dataset_id: string;
484
+ };
485
+ /** UploadDatasetResponseBody */
486
+ UploadDatasetResponseBody: {
487
+ data: components["schemas"]["UploadDatasetData"];
488
+ };
489
+ /** ValidationError */
490
+ ValidationError: {
491
+ /** Location */
492
+ loc: (string | number)[];
493
+ /** Message */
494
+ msg: string;
495
+ /** Error Type */
496
+ type: string;
497
+ };
498
+ };
499
+ responses: never;
500
+ parameters: never;
501
+ requestBodies: never;
502
+ headers: never;
503
+ pathItems: never;
504
+ }
505
+ export type $defs = Record<string, never>;
506
+ export interface operations {
507
+ listDatasets: {
508
+ parameters: {
509
+ query?: {
510
+ /** @description Cursor for pagination */
511
+ cursor?: string | null;
512
+ /** @description An optional dataset name to filter by */
513
+ name?: string | null;
514
+ /** @description The max number of datasets to return at a time. */
515
+ limit?: number;
516
+ };
517
+ header?: never;
518
+ path?: never;
519
+ cookie?: never;
520
+ };
521
+ requestBody?: never;
522
+ responses: {
523
+ /** @description Successful Response */
524
+ 200: {
525
+ headers: {
526
+ [name: string]: unknown;
527
+ };
528
+ content: {
529
+ "application/json": components["schemas"]["ListDatasetsResponseBody"];
530
+ };
531
+ };
532
+ /** @description Forbidden */
533
+ 403: {
534
+ headers: {
535
+ [name: string]: unknown;
536
+ };
537
+ content: {
538
+ "text/plain": string;
539
+ };
540
+ };
541
+ /** @description Unprocessable Entity */
542
+ 422: {
543
+ headers: {
544
+ [name: string]: unknown;
545
+ };
546
+ content: {
547
+ "text/plain": string;
548
+ };
549
+ };
550
+ };
551
+ };
552
+ getDataset: {
553
+ parameters: {
554
+ query?: never;
555
+ header?: never;
556
+ path: {
557
+ /** @description The ID of the dataset */
558
+ id: string;
559
+ };
560
+ cookie?: never;
561
+ };
562
+ requestBody?: never;
563
+ responses: {
564
+ /** @description Successful Response */
565
+ 200: {
566
+ headers: {
567
+ [name: string]: unknown;
568
+ };
569
+ content: {
570
+ "application/json": components["schemas"]["GetDatasetResponseBody"];
571
+ };
572
+ };
573
+ /** @description Forbidden */
574
+ 403: {
575
+ headers: {
576
+ [name: string]: unknown;
577
+ };
578
+ content: {
579
+ "text/plain": string;
580
+ };
581
+ };
582
+ /** @description Not Found */
583
+ 404: {
584
+ headers: {
585
+ [name: string]: unknown;
586
+ };
587
+ content: {
588
+ "text/plain": string;
589
+ };
590
+ };
591
+ /** @description Validation Error */
592
+ 422: {
593
+ headers: {
594
+ [name: string]: unknown;
595
+ };
596
+ content: {
597
+ "application/json": components["schemas"]["HTTPValidationError"];
598
+ };
599
+ };
600
+ };
601
+ };
602
+ deleteDatasetById: {
603
+ parameters: {
604
+ query?: never;
605
+ header?: never;
606
+ path: {
607
+ /** @description The ID of the dataset to delete. */
608
+ id: string;
609
+ };
610
+ cookie?: never;
611
+ };
612
+ requestBody?: never;
613
+ responses: {
614
+ /** @description Successful Response */
615
+ 204: {
616
+ headers: {
617
+ [name: string]: unknown;
618
+ };
619
+ content?: never;
620
+ };
621
+ /** @description Forbidden */
622
+ 403: {
623
+ headers: {
624
+ [name: string]: unknown;
625
+ };
626
+ content: {
627
+ "text/plain": string;
628
+ };
629
+ };
630
+ /** @description Dataset not found */
631
+ 404: {
632
+ headers: {
633
+ [name: string]: unknown;
634
+ };
635
+ content: {
636
+ "text/plain": string;
637
+ };
638
+ };
639
+ /** @description Invalid dataset ID */
640
+ 422: {
641
+ headers: {
642
+ [name: string]: unknown;
643
+ };
644
+ content: {
645
+ "text/plain": string;
646
+ };
647
+ };
648
+ };
649
+ };
650
+ listDatasetVersionsByDatasetId: {
651
+ parameters: {
652
+ query?: {
653
+ /** @description Cursor for pagination */
654
+ cursor?: string | null;
655
+ /** @description The max number of dataset versions to return at a time */
656
+ limit?: number;
657
+ };
658
+ header?: never;
659
+ path: {
660
+ /** @description The ID of the dataset */
661
+ id: string;
662
+ };
663
+ cookie?: never;
664
+ };
665
+ requestBody?: never;
666
+ responses: {
667
+ /** @description Successful Response */
668
+ 200: {
669
+ headers: {
670
+ [name: string]: unknown;
671
+ };
672
+ content: {
673
+ "application/json": components["schemas"]["ListDatasetVersionsResponseBody"];
674
+ };
675
+ };
676
+ /** @description Forbidden */
677
+ 403: {
678
+ headers: {
679
+ [name: string]: unknown;
680
+ };
681
+ content: {
682
+ "text/plain": string;
683
+ };
684
+ };
685
+ /** @description Unprocessable Entity */
686
+ 422: {
687
+ headers: {
688
+ [name: string]: unknown;
689
+ };
690
+ content: {
691
+ "text/plain": string;
692
+ };
693
+ };
694
+ };
695
+ };
696
+ uploadDataset: {
697
+ parameters: {
698
+ query?: {
699
+ /** @description If true, fulfill request synchronously and return JSON containing dataset_id. */
700
+ sync?: boolean;
701
+ };
702
+ header?: never;
703
+ path?: never;
704
+ cookie?: never;
705
+ };
706
+ requestBody?: {
707
+ content: {
708
+ "application/json": {
709
+ /** @enum {string} */
710
+ action?: "create" | "append";
711
+ name: string;
712
+ description?: string;
713
+ inputs: Record<string, never>[];
714
+ outputs?: Record<string, never>[];
715
+ metadata?: Record<string, never>[];
716
+ };
717
+ "multipart/form-data": {
718
+ /** @enum {string} */
719
+ action?: "create" | "append";
720
+ name: string;
721
+ description?: string;
722
+ "input_keys[]": string[];
723
+ "output_keys[]": string[];
724
+ "metadata_keys[]"?: string[];
725
+ /** Format: binary */
726
+ file: string;
727
+ };
728
+ };
729
+ };
730
+ responses: {
731
+ /** @description Successful Response */
732
+ 200: {
733
+ headers: {
734
+ [name: string]: unknown;
735
+ };
736
+ content: {
737
+ "application/json": components["schemas"]["UploadDatasetResponseBody"] | null;
738
+ };
739
+ };
740
+ /** @description Forbidden */
741
+ 403: {
742
+ headers: {
743
+ [name: string]: unknown;
744
+ };
745
+ content: {
746
+ "text/plain": string;
747
+ };
748
+ };
749
+ /** @description Dataset of the same name already exists */
750
+ 409: {
751
+ headers: {
752
+ [name: string]: unknown;
753
+ };
754
+ content: {
755
+ "text/plain": string;
756
+ };
757
+ };
758
+ /** @description Invalid request body */
759
+ 422: {
760
+ headers: {
761
+ [name: string]: unknown;
762
+ };
763
+ content: {
764
+ "text/plain": string;
765
+ };
766
+ };
767
+ };
768
+ };
769
+ getDatasetExamples: {
770
+ parameters: {
771
+ query?: {
772
+ /** @description The ID of the dataset version (if omitted, returns data from the latest version) */
773
+ version_id?: string | null;
774
+ };
775
+ header?: never;
776
+ path: {
777
+ /** @description The ID of the dataset */
778
+ id: string;
779
+ };
780
+ cookie?: never;
781
+ };
782
+ requestBody?: never;
783
+ responses: {
784
+ /** @description Successful Response */
785
+ 200: {
786
+ headers: {
787
+ [name: string]: unknown;
788
+ };
789
+ content: {
790
+ "application/json": components["schemas"]["ListDatasetExamplesResponseBody"];
791
+ };
792
+ };
793
+ /** @description Forbidden */
794
+ 403: {
795
+ headers: {
796
+ [name: string]: unknown;
797
+ };
798
+ content: {
799
+ "text/plain": string;
800
+ };
801
+ };
802
+ /** @description Not Found */
803
+ 404: {
804
+ headers: {
805
+ [name: string]: unknown;
806
+ };
807
+ content: {
808
+ "text/plain": string;
809
+ };
810
+ };
811
+ /** @description Validation Error */
812
+ 422: {
813
+ headers: {
814
+ [name: string]: unknown;
815
+ };
816
+ content: {
817
+ "application/json": components["schemas"]["HTTPValidationError"];
818
+ };
819
+ };
820
+ };
821
+ };
822
+ getDatasetCsv: {
823
+ parameters: {
824
+ query?: {
825
+ /** @description The ID of the dataset version (if omitted, returns data from the latest version) */
826
+ version_id?: string | null;
827
+ };
828
+ header?: never;
829
+ path: {
830
+ /** @description The ID of the dataset */
831
+ id: string;
832
+ };
833
+ cookie?: never;
834
+ };
835
+ requestBody?: never;
836
+ responses: {
837
+ /** @description Successful Response */
838
+ 200: {
839
+ headers: {
840
+ [name: string]: unknown;
841
+ };
842
+ content: {
843
+ "text/csv": string;
844
+ };
845
+ };
846
+ /** @description Forbidden */
847
+ 403: {
848
+ headers: {
849
+ [name: string]: unknown;
850
+ };
851
+ content: {
852
+ "text/plain": string;
853
+ };
854
+ };
855
+ /** @description Unprocessable Entity */
856
+ 422: {
857
+ headers: {
858
+ [name: string]: unknown;
859
+ };
860
+ content: {
861
+ "text/plain": string;
862
+ };
863
+ };
864
+ };
865
+ };
866
+ getDatasetJSONLOpenAIFineTuning: {
867
+ parameters: {
868
+ query?: {
869
+ /** @description The ID of the dataset version (if omitted, returns data from the latest version) */
870
+ version_id?: string | null;
871
+ };
872
+ header?: never;
873
+ path: {
874
+ /** @description The ID of the dataset */
875
+ id: string;
876
+ };
877
+ cookie?: never;
878
+ };
879
+ requestBody?: never;
880
+ responses: {
881
+ /** @description Successful Response */
882
+ 200: {
883
+ headers: {
884
+ [name: string]: unknown;
885
+ };
886
+ content: {
887
+ "text/plain": string;
888
+ };
889
+ };
890
+ /** @description Forbidden */
891
+ 403: {
892
+ headers: {
893
+ [name: string]: unknown;
894
+ };
895
+ content: {
896
+ "text/plain": string;
897
+ };
898
+ };
899
+ /** @description Invalid dataset or version ID */
900
+ 422: {
901
+ headers: {
902
+ [name: string]: unknown;
903
+ };
904
+ content: {
905
+ "text/plain": string;
906
+ };
907
+ };
908
+ };
909
+ };
910
+ getDatasetJSONLOpenAIEvals: {
911
+ parameters: {
912
+ query?: {
913
+ /** @description The ID of the dataset version (if omitted, returns data from the latest version) */
914
+ version_id?: string | null;
915
+ };
916
+ header?: never;
917
+ path: {
918
+ /** @description The ID of the dataset */
919
+ id: string;
920
+ };
921
+ cookie?: never;
922
+ };
923
+ requestBody?: never;
924
+ responses: {
925
+ /** @description Successful Response */
926
+ 200: {
927
+ headers: {
928
+ [name: string]: unknown;
929
+ };
930
+ content: {
931
+ "text/plain": string;
932
+ };
933
+ };
934
+ /** @description Forbidden */
935
+ 403: {
936
+ headers: {
937
+ [name: string]: unknown;
938
+ };
939
+ content: {
940
+ "text/plain": string;
941
+ };
942
+ };
943
+ /** @description Invalid dataset or version ID */
944
+ 422: {
945
+ headers: {
946
+ [name: string]: unknown;
947
+ };
948
+ content: {
949
+ "text/plain": string;
950
+ };
951
+ };
952
+ };
953
+ };
954
+ listExperiments: {
955
+ parameters: {
956
+ query?: never;
957
+ header?: never;
958
+ path: {
959
+ dataset_id: string;
960
+ };
961
+ cookie?: never;
962
+ };
963
+ requestBody?: never;
964
+ responses: {
965
+ /** @description Experiments retrieved successfully */
966
+ 200: {
967
+ headers: {
968
+ [name: string]: unknown;
969
+ };
970
+ content: {
971
+ "application/json": components["schemas"]["ListExperimentsResponseBody"];
972
+ };
973
+ };
974
+ /** @description Forbidden */
975
+ 403: {
976
+ headers: {
977
+ [name: string]: unknown;
978
+ };
979
+ content: {
980
+ "text/plain": string;
981
+ };
982
+ };
983
+ /** @description Validation Error */
984
+ 422: {
985
+ headers: {
986
+ [name: string]: unknown;
987
+ };
988
+ content: {
989
+ "application/json": components["schemas"]["HTTPValidationError"];
990
+ };
991
+ };
992
+ };
993
+ };
994
+ createExperiment: {
995
+ parameters: {
996
+ query?: never;
997
+ header?: never;
998
+ path: {
999
+ dataset_id: string;
1000
+ };
1001
+ cookie?: never;
1002
+ };
1003
+ requestBody: {
1004
+ content: {
1005
+ "application/json": components["schemas"]["CreateExperimentRequestBody"];
1006
+ };
1007
+ };
1008
+ responses: {
1009
+ /** @description Experiment retrieved successfully */
1010
+ 200: {
1011
+ headers: {
1012
+ [name: string]: unknown;
1013
+ };
1014
+ content: {
1015
+ "application/json": components["schemas"]["CreateExperimentResponseBody"];
1016
+ };
1017
+ };
1018
+ /** @description Forbidden */
1019
+ 403: {
1020
+ headers: {
1021
+ [name: string]: unknown;
1022
+ };
1023
+ content: {
1024
+ "text/plain": string;
1025
+ };
1026
+ };
1027
+ /** @description Dataset or DatasetVersion not found */
1028
+ 404: {
1029
+ headers: {
1030
+ [name: string]: unknown;
1031
+ };
1032
+ content: {
1033
+ "text/plain": string;
1034
+ };
1035
+ };
1036
+ /** @description Validation Error */
1037
+ 422: {
1038
+ headers: {
1039
+ [name: string]: unknown;
1040
+ };
1041
+ content: {
1042
+ "application/json": components["schemas"]["HTTPValidationError"];
1043
+ };
1044
+ };
1045
+ };
1046
+ };
1047
+ getExperiment: {
1048
+ parameters: {
1049
+ query?: never;
1050
+ header?: never;
1051
+ path: {
1052
+ experiment_id: string;
1053
+ };
1054
+ cookie?: never;
1055
+ };
1056
+ requestBody?: never;
1057
+ responses: {
1058
+ /** @description Experiment retrieved successfully */
1059
+ 200: {
1060
+ headers: {
1061
+ [name: string]: unknown;
1062
+ };
1063
+ content: {
1064
+ "application/json": components["schemas"]["GetExperimentResponseBody"];
1065
+ };
1066
+ };
1067
+ /** @description Forbidden */
1068
+ 403: {
1069
+ headers: {
1070
+ [name: string]: unknown;
1071
+ };
1072
+ content: {
1073
+ "text/plain": string;
1074
+ };
1075
+ };
1076
+ /** @description Experiment not found */
1077
+ 404: {
1078
+ headers: {
1079
+ [name: string]: unknown;
1080
+ };
1081
+ content: {
1082
+ "text/plain": string;
1083
+ };
1084
+ };
1085
+ /** @description Validation Error */
1086
+ 422: {
1087
+ headers: {
1088
+ [name: string]: unknown;
1089
+ };
1090
+ content: {
1091
+ "application/json": components["schemas"]["HTTPValidationError"];
1092
+ };
1093
+ };
1094
+ };
1095
+ };
1096
+ annotateSpans: {
1097
+ parameters: {
1098
+ query?: {
1099
+ /** @description If true, fulfill request synchronously. */
1100
+ sync?: boolean;
1101
+ };
1102
+ header?: never;
1103
+ path?: never;
1104
+ cookie?: never;
1105
+ };
1106
+ requestBody: {
1107
+ content: {
1108
+ "application/json": components["schemas"]["AnnotateSpansRequestBody"];
1109
+ };
1110
+ };
1111
+ responses: {
1112
+ /** @description Span annotations inserted successfully */
1113
+ 200: {
1114
+ headers: {
1115
+ [name: string]: unknown;
1116
+ };
1117
+ content: {
1118
+ "application/json": components["schemas"]["AnnotateSpansResponseBody"];
1119
+ };
1120
+ };
1121
+ /** @description Forbidden */
1122
+ 403: {
1123
+ headers: {
1124
+ [name: string]: unknown;
1125
+ };
1126
+ content: {
1127
+ "text/plain": string;
1128
+ };
1129
+ };
1130
+ /** @description Span not found */
1131
+ 404: {
1132
+ headers: {
1133
+ [name: string]: unknown;
1134
+ };
1135
+ content: {
1136
+ "text/plain": string;
1137
+ };
1138
+ };
1139
+ /** @description Validation Error */
1140
+ 422: {
1141
+ headers: {
1142
+ [name: string]: unknown;
1143
+ };
1144
+ content: {
1145
+ "application/json": components["schemas"]["HTTPValidationError"];
1146
+ };
1147
+ };
1148
+ };
1149
+ };
1150
+ getEvaluations: {
1151
+ parameters: {
1152
+ query?: {
1153
+ /** @description The name of the project to get evaluations from (if omitted, evaluations will be drawn from the `default` project) */
1154
+ project_name?: string | null;
1155
+ };
1156
+ header?: never;
1157
+ path?: never;
1158
+ cookie?: never;
1159
+ };
1160
+ requestBody?: never;
1161
+ responses: {
1162
+ /** @description Successful Response */
1163
+ 200: {
1164
+ headers: {
1165
+ [name: string]: unknown;
1166
+ };
1167
+ content: {
1168
+ "application/json": unknown;
1169
+ };
1170
+ };
1171
+ /** @description Forbidden */
1172
+ 403: {
1173
+ headers: {
1174
+ [name: string]: unknown;
1175
+ };
1176
+ content: {
1177
+ "text/plain": string;
1178
+ };
1179
+ };
1180
+ /** @description Not Found */
1181
+ 404: {
1182
+ headers: {
1183
+ [name: string]: unknown;
1184
+ };
1185
+ content: {
1186
+ "text/plain": string;
1187
+ };
1188
+ };
1189
+ /** @description Validation Error */
1190
+ 422: {
1191
+ headers: {
1192
+ [name: string]: unknown;
1193
+ };
1194
+ content: {
1195
+ "application/json": components["schemas"]["HTTPValidationError"];
1196
+ };
1197
+ };
1198
+ };
1199
+ };
1200
+ addEvaluations: {
1201
+ parameters: {
1202
+ query?: never;
1203
+ header?: {
1204
+ "content-type"?: string | null;
1205
+ "content-encoding"?: string | null;
1206
+ };
1207
+ path?: never;
1208
+ cookie?: never;
1209
+ };
1210
+ requestBody: {
1211
+ content: {
1212
+ "application/x-protobuf": string;
1213
+ "application/x-pandas-arrow": string;
1214
+ };
1215
+ };
1216
+ responses: {
1217
+ /** @description Successful Response */
1218
+ 204: {
1219
+ headers: {
1220
+ [name: string]: unknown;
1221
+ };
1222
+ content?: never;
1223
+ };
1224
+ /** @description Forbidden */
1225
+ 403: {
1226
+ headers: {
1227
+ [name: string]: unknown;
1228
+ };
1229
+ content: {
1230
+ "text/plain": string;
1231
+ };
1232
+ };
1233
+ /** @description Unsupported content type, only gzipped protobuf and pandas-arrow are supported */
1234
+ 415: {
1235
+ headers: {
1236
+ [name: string]: unknown;
1237
+ };
1238
+ content: {
1239
+ "text/plain": string;
1240
+ };
1241
+ };
1242
+ /** @description Unprocessable Entity */
1243
+ 422: {
1244
+ headers: {
1245
+ [name: string]: unknown;
1246
+ };
1247
+ content: {
1248
+ "text/plain": string;
1249
+ };
1250
+ };
1251
+ };
1252
+ };
1253
+ }