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