@roarkanalytics/sdk 0.332.0 → 2.0.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.
@@ -18,79 +18,1015 @@ export class Evaluation extends APIResource {
18
18
  /**
19
19
  * Returns a specific evaluator with its blocks and configuration.
20
20
  */
21
- getEvaluatorById(evaluatorId: string, options?: Core.RequestOptions): Core.APIPromise<unknown> {
21
+ getEvaluatorById(
22
+ evaluatorId: string,
23
+ options?: Core.RequestOptions,
24
+ ): Core.APIPromise<EvaluationGetEvaluatorByIDResponse> {
22
25
  return this._client.get(`/v1/evaluation/evaluators/${evaluatorId}`, options);
23
26
  }
24
27
 
25
- /**
26
- * Returns a list of evaluators with their blocks and configuration for the
27
- * authenticated project.
28
- */
29
- getEvaluators(
30
- query?: EvaluationGetEvaluatorsParams,
31
- options?: Core.RequestOptions,
32
- ): Core.APIPromise<unknown>;
33
- getEvaluators(options?: Core.RequestOptions): Core.APIPromise<unknown>;
34
- getEvaluators(
35
- query: EvaluationGetEvaluatorsParams | Core.RequestOptions = {},
36
- options?: Core.RequestOptions,
37
- ): Core.APIPromise<unknown> {
38
- if (isRequestOptions(query)) {
39
- return this.getEvaluators({}, query);
28
+ /**
29
+ * Returns a list of evaluators with their blocks and configuration for the
30
+ * authenticated project.
31
+ */
32
+ getEvaluators(
33
+ query?: EvaluationGetEvaluatorsParams,
34
+ options?: Core.RequestOptions,
35
+ ): Core.APIPromise<EvaluationGetEvaluatorsResponse>;
36
+ getEvaluators(options?: Core.RequestOptions): Core.APIPromise<EvaluationGetEvaluatorsResponse>;
37
+ getEvaluators(
38
+ query: EvaluationGetEvaluatorsParams | Core.RequestOptions = {},
39
+ options?: Core.RequestOptions,
40
+ ): Core.APIPromise<EvaluationGetEvaluatorsResponse> {
41
+ if (isRequestOptions(query)) {
42
+ return this.getEvaluators({}, query);
43
+ }
44
+ return this._client.get('/v1/evaluation/evaluators', { query, ...options });
45
+ }
46
+
47
+ /**
48
+ * Retrieve details of a specific evaluation job
49
+ */
50
+ getJob(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobResponse> {
51
+ return this._client.get(`/v1/evaluation/job/${jobId}`, options);
52
+ }
53
+
54
+ /**
55
+ * Retrieve paginated details of a specific evaluation job runs
56
+ */
57
+ getJobRuns(
58
+ jobId: string,
59
+ query?: EvaluationGetJobRunsParams,
60
+ options?: Core.RequestOptions,
61
+ ): Core.APIPromise<EvaluationGetJobRunsResponse>;
62
+ getJobRuns(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobRunsResponse>;
63
+ getJobRuns(
64
+ jobId: string,
65
+ query: EvaluationGetJobRunsParams | Core.RequestOptions = {},
66
+ options?: Core.RequestOptions,
67
+ ): Core.APIPromise<EvaluationGetJobRunsResponse> {
68
+ if (isRequestOptions(query)) {
69
+ return this.getJobRuns(jobId, {}, query);
70
+ }
71
+ return this._client.get(`/v1/evaluation/job/${jobId}/runs`, { query, ...options });
72
+ }
73
+ }
74
+
75
+ export interface EvaluationCreateJobResponse {
76
+ data: EvaluationCreateJobResponse.Data;
77
+ }
78
+
79
+ export namespace EvaluationCreateJobResponse {
80
+ export interface Data {
81
+ /**
82
+ * ID of the evaluation job
83
+ */
84
+ jobId: string;
85
+
86
+ /**
87
+ * Status of the evaluation job
88
+ */
89
+ status: 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILURE';
90
+ }
91
+ }
92
+
93
+ /**
94
+ * Evaluator with its configured blocks
95
+ */
96
+ export interface EvaluationGetEvaluatorByIDResponse {
97
+ /**
98
+ * Unique identifier for the evaluator
99
+ */
100
+ id: string;
101
+
102
+ /**
103
+ * Array of evaluation blocks configured for this evaluator
104
+ */
105
+ blocks: Array<
106
+ | EvaluationGetEvaluatorByIDResponse.UnionMember0
107
+ | EvaluationGetEvaluatorByIDResponse.UnionMember1
108
+ | EvaluationGetEvaluatorByIDResponse.UnionMember2
109
+ | EvaluationGetEvaluatorByIDResponse.UnionMember3
110
+ | EvaluationGetEvaluatorByIDResponse.UnionMember4
111
+ | EvaluationGetEvaluatorByIDResponse.UnionMember5
112
+ | EvaluationGetEvaluatorByIDResponse.UnionMember6
113
+ | EvaluationGetEvaluatorByIDResponse.UnionMember7
114
+ | EvaluationGetEvaluatorByIDResponse.UnionMember8
115
+ >;
116
+
117
+ /**
118
+ * ISO timestamp when the evaluator was created
119
+ */
120
+ createdAt: string;
121
+
122
+ /**
123
+ * Optional description of the evaluator
124
+ */
125
+ description: string | null;
126
+
127
+ /**
128
+ * Name of the evaluator
129
+ */
130
+ name: string;
131
+
132
+ /**
133
+ * Unique slug identifier for the evaluator
134
+ */
135
+ slug: string;
136
+
137
+ /**
138
+ * ISO timestamp when the evaluator was last updated
139
+ */
140
+ updatedAt: string;
141
+ }
142
+
143
+ export namespace EvaluationGetEvaluatorByIDResponse {
144
+ export interface UnionMember0 {
145
+ /**
146
+ * Unique identifier for the block
147
+ */
148
+ id: string;
149
+
150
+ /**
151
+ * Block type identifier
152
+ */
153
+ blockType: 'CUSTOM_PROMPT';
154
+
155
+ /**
156
+ * Optional description of what this block evaluates
157
+ */
158
+ description: string | null;
159
+
160
+ /**
161
+ * Name of the metric this prompt evaluates
162
+ */
163
+ metricName: string;
164
+
165
+ /**
166
+ * Display name of the evaluation block
167
+ */
168
+ name: string;
169
+
170
+ /**
171
+ * Order in which this block is executed
172
+ */
173
+ orderIndex: number;
174
+
175
+ /**
176
+ * The prompt to evaluate the call against
177
+ */
178
+ prompt: string;
179
+
180
+ /**
181
+ * Minimum score threshold to pass evaluation (0-1)
182
+ */
183
+ threshold: number;
184
+
185
+ /**
186
+ * Weight of this block in the overall evaluation score (0-100)
187
+ */
188
+ weight: number;
189
+ }
190
+
191
+ export interface UnionMember1 {
192
+ /**
193
+ * Unique identifier for the block
194
+ */
195
+ id: string;
196
+
197
+ /**
198
+ * Block type identifier
199
+ */
200
+ blockType: 'DATAFIELD_CHECK';
201
+
202
+ /**
203
+ * Optional description of what this block evaluates
204
+ */
205
+ description: string | null;
206
+
207
+ /**
208
+ * Criteria for evaluating the property
209
+ */
210
+ evaluationCriteria: string;
211
+
212
+ /**
213
+ * Whether this property must be present
214
+ */
215
+ isRequired: boolean;
216
+
217
+ /**
218
+ * Display name of the evaluation block
219
+ */
220
+ name: string;
221
+
222
+ /**
223
+ * Order in which this block is executed
224
+ */
225
+ orderIndex: number;
226
+
227
+ /**
228
+ * Name of the property to check
229
+ */
230
+ propertyName: string;
231
+
232
+ /**
233
+ * Minimum score threshold to pass evaluation (0-1)
234
+ */
235
+ threshold: number;
236
+
237
+ /**
238
+ * Expected type of the property value
239
+ */
240
+ valueType: string;
241
+
242
+ /**
243
+ * Weight of this block in the overall evaluation score (0-100)
244
+ */
245
+ weight: number;
246
+ }
247
+
248
+ export interface UnionMember2 {
249
+ /**
250
+ * Unique identifier for the block
251
+ */
252
+ id: string;
253
+
254
+ /**
255
+ * Block type identifier
256
+ */
257
+ blockType: 'EMOTION';
258
+
259
+ /**
260
+ * Optional description of what this block evaluates
261
+ */
262
+ description: string | null;
263
+
264
+ /**
265
+ * Display name of the evaluation block
266
+ */
267
+ name: string;
268
+
269
+ /**
270
+ * Order in which this block is executed
271
+ */
272
+ orderIndex: number;
273
+
274
+ /**
275
+ * The emotion to detect (e.g., "joy", "anger", "sadness")
276
+ */
277
+ selectedEmotion: string;
278
+
279
+ /**
280
+ * Minimum confidence threshold for emotion detection (0-1)
281
+ */
282
+ threshold: number;
283
+
284
+ /**
285
+ * Weight of this block in the overall evaluation score (0-100)
286
+ */
287
+ weight: number;
288
+ }
289
+
290
+ export interface UnionMember3 {
291
+ /**
292
+ * Unique identifier for the block
293
+ */
294
+ id: string;
295
+
296
+ /**
297
+ * Block type identifier
298
+ */
299
+ blockType: 'LATENCY';
300
+
301
+ /**
302
+ * Optional description of what this block evaluates
303
+ */
304
+ description: string | null;
305
+
306
+ /**
307
+ * Maximum number of silence periods allowed
308
+ */
309
+ maxAllowedSilences: number;
310
+
311
+ /**
312
+ * Minimum duration of silence in milliseconds to be considered
313
+ */
314
+ minSilenceDuration: number;
315
+
316
+ /**
317
+ * Display name of the evaluation block
318
+ */
319
+ name: string;
320
+
321
+ /**
322
+ * Order in which this block is executed
323
+ */
324
+ orderIndex: number;
325
+
326
+ /**
327
+ * Maximum allowed latency score
328
+ */
329
+ threshold: number;
330
+
331
+ /**
332
+ * Weight of this block in the overall evaluation score (0-100)
333
+ */
334
+ weight: number;
335
+ }
336
+
337
+ export interface UnionMember4 {
338
+ /**
339
+ * Unique identifier for the block
340
+ */
341
+ id: string;
342
+
343
+ /**
344
+ * Block type identifier
345
+ */
346
+ blockType: 'POLITENESS';
347
+
348
+ /**
349
+ * Optional description of what this block evaluates
350
+ */
351
+ description: string | null;
352
+
353
+ /**
354
+ * Display name of the evaluation block
355
+ */
356
+ name: string;
357
+
358
+ /**
359
+ * Order in which this block is executed
360
+ */
361
+ orderIndex: number;
362
+
363
+ /**
364
+ * Minimum politeness score threshold (0-1)
365
+ */
366
+ threshold: number;
367
+
368
+ /**
369
+ * Weight of this block in the overall evaluation score (0-100)
370
+ */
371
+ weight: number;
372
+ }
373
+
374
+ export interface UnionMember5 {
375
+ /**
376
+ * Unique identifier for the block
377
+ */
378
+ id: string;
379
+
380
+ /**
381
+ * Block type identifier
382
+ */
383
+ blockType: 'SENTIMENT';
384
+
385
+ /**
386
+ * Optional description of what this block evaluates
387
+ */
388
+ description: string | null;
389
+
390
+ /**
391
+ * Display name of the evaluation block
392
+ */
393
+ name: string;
394
+
395
+ /**
396
+ * Order in which this block is executed
397
+ */
398
+ orderIndex: number;
399
+
400
+ /**
401
+ * Minimum sentiment score threshold (0-1)
402
+ */
403
+ threshold: number;
404
+
405
+ /**
406
+ * Weight of this block in the overall evaluation score (0-100)
407
+ */
408
+ weight: number;
409
+ }
410
+
411
+ export interface UnionMember6 {
412
+ /**
413
+ * Unique identifier for the block
414
+ */
415
+ id: string;
416
+
417
+ /**
418
+ * Block type identifier
419
+ */
420
+ blockType: 'TOOL_CALLS';
421
+
422
+ /**
423
+ * Optional description of what this block evaluates
424
+ */
425
+ description: string | null;
426
+
427
+ /**
428
+ * Condition that must be met for tool invocation
429
+ */
430
+ invocationCondition: string | null;
431
+
432
+ /**
433
+ * Minimum number of times the tool should be invoked
434
+ */
435
+ minInvocationCount: number | null;
436
+
437
+ /**
438
+ * Display name of the evaluation block
439
+ */
440
+ name: string;
441
+
442
+ /**
443
+ * Order in which this block is executed
444
+ */
445
+ orderIndex: number;
446
+
447
+ /**
448
+ * Whether the tool should be invoked
449
+ */
450
+ shouldBeInvoked: boolean;
451
+
452
+ /**
453
+ * ID of the tool definition
454
+ */
455
+ toolDefinitionId: string;
456
+
457
+ /**
458
+ * Weight of this block in the overall evaluation score (0-100)
459
+ */
460
+ weight: number;
461
+ }
462
+
463
+ export interface UnionMember7 {
464
+ /**
465
+ * Unique identifier for the block
466
+ */
467
+ id: string;
468
+
469
+ /**
470
+ * Block type identifier
471
+ */
472
+ blockType: 'TOXICITY';
473
+
474
+ /**
475
+ * Optional description of what this block evaluates
476
+ */
477
+ description: string | null;
478
+
479
+ /**
480
+ * Display name of the evaluation block
481
+ */
482
+ name: string;
483
+
484
+ /**
485
+ * Order in which this block is executed
486
+ */
487
+ orderIndex: number;
488
+
489
+ /**
490
+ * Maximum allowed toxicity score (0-1)
491
+ */
492
+ threshold: number;
493
+
494
+ /**
495
+ * Weight of this block in the overall evaluation score (0-100)
496
+ */
497
+ weight: number;
498
+ }
499
+
500
+ export interface UnionMember8 {
501
+ /**
502
+ * Unique identifier for the block
503
+ */
504
+ id: string;
505
+
506
+ /**
507
+ * Block type identifier
508
+ */
509
+ blockType: 'VOCAL_CUE';
510
+
511
+ /**
512
+ * Optional description of what this block evaluates
513
+ */
514
+ description: string | null;
515
+
516
+ /**
517
+ * Display name of the evaluation block
518
+ */
519
+ name: string;
520
+
521
+ /**
522
+ * Order in which this block is executed
523
+ */
524
+ orderIndex: number;
525
+
526
+ /**
527
+ * The vocal cue to detect (e.g., "pace", "tone", "volume")
528
+ */
529
+ selectedCue: string;
530
+
531
+ /**
532
+ * Minimum confidence threshold for vocal cue detection (0-1)
533
+ */
534
+ threshold: number;
535
+
536
+ /**
537
+ * Weight of this block in the overall evaluation score (0-100)
538
+ */
539
+ weight: number;
540
+ }
541
+ }
542
+
543
+ /**
544
+ * Response containing evaluators and pagination info
545
+ */
546
+ export interface EvaluationGetEvaluatorsResponse {
547
+ /**
548
+ * Array of evaluators with their blocks
549
+ */
550
+ data: Array<EvaluationGetEvaluatorsResponse.Data>;
551
+
552
+ /**
553
+ * Pagination information
554
+ */
555
+ pagination: EvaluationGetEvaluatorsResponse.Pagination;
556
+ }
557
+
558
+ export namespace EvaluationGetEvaluatorsResponse {
559
+ /**
560
+ * Evaluator with its configured blocks
561
+ */
562
+ export interface Data {
563
+ /**
564
+ * Unique identifier for the evaluator
565
+ */
566
+ id: string;
567
+
568
+ /**
569
+ * Array of evaluation blocks configured for this evaluator
570
+ */
571
+ blocks: Array<
572
+ | Data.UnionMember0
573
+ | Data.UnionMember1
574
+ | Data.UnionMember2
575
+ | Data.UnionMember3
576
+ | Data.UnionMember4
577
+ | Data.UnionMember5
578
+ | Data.UnionMember6
579
+ | Data.UnionMember7
580
+ | Data.UnionMember8
581
+ >;
582
+
583
+ /**
584
+ * ISO timestamp when the evaluator was created
585
+ */
586
+ createdAt: string;
587
+
588
+ /**
589
+ * Optional description of the evaluator
590
+ */
591
+ description: string | null;
592
+
593
+ /**
594
+ * Name of the evaluator
595
+ */
596
+ name: string;
597
+
598
+ /**
599
+ * Unique slug identifier for the evaluator
600
+ */
601
+ slug: string;
602
+
603
+ /**
604
+ * ISO timestamp when the evaluator was last updated
605
+ */
606
+ updatedAt: string;
607
+ }
608
+
609
+ export namespace Data {
610
+ export interface UnionMember0 {
611
+ /**
612
+ * Unique identifier for the block
613
+ */
614
+ id: string;
615
+
616
+ /**
617
+ * Block type identifier
618
+ */
619
+ blockType: 'CUSTOM_PROMPT';
620
+
621
+ /**
622
+ * Optional description of what this block evaluates
623
+ */
624
+ description: string | null;
625
+
626
+ /**
627
+ * Name of the metric this prompt evaluates
628
+ */
629
+ metricName: string;
630
+
631
+ /**
632
+ * Display name of the evaluation block
633
+ */
634
+ name: string;
635
+
636
+ /**
637
+ * Order in which this block is executed
638
+ */
639
+ orderIndex: number;
640
+
641
+ /**
642
+ * The prompt to evaluate the call against
643
+ */
644
+ prompt: string;
645
+
646
+ /**
647
+ * Minimum score threshold to pass evaluation (0-1)
648
+ */
649
+ threshold: number;
650
+
651
+ /**
652
+ * Weight of this block in the overall evaluation score (0-100)
653
+ */
654
+ weight: number;
655
+ }
656
+
657
+ export interface UnionMember1 {
658
+ /**
659
+ * Unique identifier for the block
660
+ */
661
+ id: string;
662
+
663
+ /**
664
+ * Block type identifier
665
+ */
666
+ blockType: 'DATAFIELD_CHECK';
667
+
668
+ /**
669
+ * Optional description of what this block evaluates
670
+ */
671
+ description: string | null;
672
+
673
+ /**
674
+ * Criteria for evaluating the property
675
+ */
676
+ evaluationCriteria: string;
677
+
678
+ /**
679
+ * Whether this property must be present
680
+ */
681
+ isRequired: boolean;
682
+
683
+ /**
684
+ * Display name of the evaluation block
685
+ */
686
+ name: string;
687
+
688
+ /**
689
+ * Order in which this block is executed
690
+ */
691
+ orderIndex: number;
692
+
693
+ /**
694
+ * Name of the property to check
695
+ */
696
+ propertyName: string;
697
+
698
+ /**
699
+ * Minimum score threshold to pass evaluation (0-1)
700
+ */
701
+ threshold: number;
702
+
703
+ /**
704
+ * Expected type of the property value
705
+ */
706
+ valueType: string;
707
+
708
+ /**
709
+ * Weight of this block in the overall evaluation score (0-100)
710
+ */
711
+ weight: number;
712
+ }
713
+
714
+ export interface UnionMember2 {
715
+ /**
716
+ * Unique identifier for the block
717
+ */
718
+ id: string;
719
+
720
+ /**
721
+ * Block type identifier
722
+ */
723
+ blockType: 'EMOTION';
724
+
725
+ /**
726
+ * Optional description of what this block evaluates
727
+ */
728
+ description: string | null;
729
+
730
+ /**
731
+ * Display name of the evaluation block
732
+ */
733
+ name: string;
734
+
735
+ /**
736
+ * Order in which this block is executed
737
+ */
738
+ orderIndex: number;
739
+
740
+ /**
741
+ * The emotion to detect (e.g., "joy", "anger", "sadness")
742
+ */
743
+ selectedEmotion: string;
744
+
745
+ /**
746
+ * Minimum confidence threshold for emotion detection (0-1)
747
+ */
748
+ threshold: number;
749
+
750
+ /**
751
+ * Weight of this block in the overall evaluation score (0-100)
752
+ */
753
+ weight: number;
754
+ }
755
+
756
+ export interface UnionMember3 {
757
+ /**
758
+ * Unique identifier for the block
759
+ */
760
+ id: string;
761
+
762
+ /**
763
+ * Block type identifier
764
+ */
765
+ blockType: 'LATENCY';
766
+
767
+ /**
768
+ * Optional description of what this block evaluates
769
+ */
770
+ description: string | null;
771
+
772
+ /**
773
+ * Maximum number of silence periods allowed
774
+ */
775
+ maxAllowedSilences: number;
776
+
777
+ /**
778
+ * Minimum duration of silence in milliseconds to be considered
779
+ */
780
+ minSilenceDuration: number;
781
+
782
+ /**
783
+ * Display name of the evaluation block
784
+ */
785
+ name: string;
786
+
787
+ /**
788
+ * Order in which this block is executed
789
+ */
790
+ orderIndex: number;
791
+
792
+ /**
793
+ * Maximum allowed latency score
794
+ */
795
+ threshold: number;
796
+
797
+ /**
798
+ * Weight of this block in the overall evaluation score (0-100)
799
+ */
800
+ weight: number;
40
801
  }
41
- return this._client.get('/v1/evaluation/evaluators', { query, ...options });
42
- }
43
802
 
44
- /**
45
- * Retrieve details of a specific evaluation job
46
- */
47
- getJob(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobResponse> {
48
- return this._client.get(`/v1/evaluation/job/${jobId}`, options);
49
- }
803
+ export interface UnionMember4 {
804
+ /**
805
+ * Unique identifier for the block
806
+ */
807
+ id: string;
50
808
 
51
- /**
52
- * Retrieve paginated details of a specific evaluation job runs
53
- */
54
- getJobRuns(
55
- jobId: string,
56
- query?: EvaluationGetJobRunsParams,
57
- options?: Core.RequestOptions,
58
- ): Core.APIPromise<EvaluationGetJobRunsResponse>;
59
- getJobRuns(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobRunsResponse>;
60
- getJobRuns(
61
- jobId: string,
62
- query: EvaluationGetJobRunsParams | Core.RequestOptions = {},
63
- options?: Core.RequestOptions,
64
- ): Core.APIPromise<EvaluationGetJobRunsResponse> {
65
- if (isRequestOptions(query)) {
66
- return this.getJobRuns(jobId, {}, query);
809
+ /**
810
+ * Block type identifier
811
+ */
812
+ blockType: 'POLITENESS';
813
+
814
+ /**
815
+ * Optional description of what this block evaluates
816
+ */
817
+ description: string | null;
818
+
819
+ /**
820
+ * Display name of the evaluation block
821
+ */
822
+ name: string;
823
+
824
+ /**
825
+ * Order in which this block is executed
826
+ */
827
+ orderIndex: number;
828
+
829
+ /**
830
+ * Minimum politeness score threshold (0-1)
831
+ */
832
+ threshold: number;
833
+
834
+ /**
835
+ * Weight of this block in the overall evaluation score (0-100)
836
+ */
837
+ weight: number;
838
+ }
839
+
840
+ export interface UnionMember5 {
841
+ /**
842
+ * Unique identifier for the block
843
+ */
844
+ id: string;
845
+
846
+ /**
847
+ * Block type identifier
848
+ */
849
+ blockType: 'SENTIMENT';
850
+
851
+ /**
852
+ * Optional description of what this block evaluates
853
+ */
854
+ description: string | null;
855
+
856
+ /**
857
+ * Display name of the evaluation block
858
+ */
859
+ name: string;
860
+
861
+ /**
862
+ * Order in which this block is executed
863
+ */
864
+ orderIndex: number;
865
+
866
+ /**
867
+ * Minimum sentiment score threshold (0-1)
868
+ */
869
+ threshold: number;
870
+
871
+ /**
872
+ * Weight of this block in the overall evaluation score (0-100)
873
+ */
874
+ weight: number;
875
+ }
876
+
877
+ export interface UnionMember6 {
878
+ /**
879
+ * Unique identifier for the block
880
+ */
881
+ id: string;
882
+
883
+ /**
884
+ * Block type identifier
885
+ */
886
+ blockType: 'TOOL_CALLS';
887
+
888
+ /**
889
+ * Optional description of what this block evaluates
890
+ */
891
+ description: string | null;
892
+
893
+ /**
894
+ * Condition that must be met for tool invocation
895
+ */
896
+ invocationCondition: string | null;
897
+
898
+ /**
899
+ * Minimum number of times the tool should be invoked
900
+ */
901
+ minInvocationCount: number | null;
902
+
903
+ /**
904
+ * Display name of the evaluation block
905
+ */
906
+ name: string;
907
+
908
+ /**
909
+ * Order in which this block is executed
910
+ */
911
+ orderIndex: number;
912
+
913
+ /**
914
+ * Whether the tool should be invoked
915
+ */
916
+ shouldBeInvoked: boolean;
917
+
918
+ /**
919
+ * ID of the tool definition
920
+ */
921
+ toolDefinitionId: string;
922
+
923
+ /**
924
+ * Weight of this block in the overall evaluation score (0-100)
925
+ */
926
+ weight: number;
927
+ }
928
+
929
+ export interface UnionMember7 {
930
+ /**
931
+ * Unique identifier for the block
932
+ */
933
+ id: string;
934
+
935
+ /**
936
+ * Block type identifier
937
+ */
938
+ blockType: 'TOXICITY';
939
+
940
+ /**
941
+ * Optional description of what this block evaluates
942
+ */
943
+ description: string | null;
944
+
945
+ /**
946
+ * Display name of the evaluation block
947
+ */
948
+ name: string;
949
+
950
+ /**
951
+ * Order in which this block is executed
952
+ */
953
+ orderIndex: number;
954
+
955
+ /**
956
+ * Maximum allowed toxicity score (0-1)
957
+ */
958
+ threshold: number;
959
+
960
+ /**
961
+ * Weight of this block in the overall evaluation score (0-100)
962
+ */
963
+ weight: number;
964
+ }
965
+
966
+ export interface UnionMember8 {
967
+ /**
968
+ * Unique identifier for the block
969
+ */
970
+ id: string;
971
+
972
+ /**
973
+ * Block type identifier
974
+ */
975
+ blockType: 'VOCAL_CUE';
976
+
977
+ /**
978
+ * Optional description of what this block evaluates
979
+ */
980
+ description: string | null;
981
+
982
+ /**
983
+ * Display name of the evaluation block
984
+ */
985
+ name: string;
986
+
987
+ /**
988
+ * Order in which this block is executed
989
+ */
990
+ orderIndex: number;
991
+
992
+ /**
993
+ * The vocal cue to detect (e.g., "pace", "tone", "volume")
994
+ */
995
+ selectedCue: string;
996
+
997
+ /**
998
+ * Minimum confidence threshold for vocal cue detection (0-1)
999
+ */
1000
+ threshold: number;
1001
+
1002
+ /**
1003
+ * Weight of this block in the overall evaluation score (0-100)
1004
+ */
1005
+ weight: number;
67
1006
  }
68
- return this._client.get(`/v1/evaluation/job/${jobId}/runs`, { query, ...options });
69
1007
  }
70
- }
71
1008
 
72
- export interface EvaluationCreateJobResponse {
73
- data: EvaluationCreateJobResponse.Data;
74
- }
1009
+ /**
1010
+ * Pagination information
1011
+ */
1012
+ export interface Pagination {
1013
+ /**
1014
+ * Whether there are more evaluators to fetch
1015
+ */
1016
+ hasMore: boolean;
75
1017
 
76
- export namespace EvaluationCreateJobResponse {
77
- export interface Data {
78
1018
  /**
79
- * ID of the evaluation job
1019
+ * Cursor for the next page, null if no more pages
80
1020
  */
81
- jobId: string;
1021
+ nextCursor: string | null;
82
1022
 
83
1023
  /**
84
- * Status of the evaluation job
1024
+ * Total number of evaluators
85
1025
  */
86
- status: 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILURE';
1026
+ total: number;
87
1027
  }
88
1028
  }
89
1029
 
90
- export type EvaluationGetEvaluatorByIDResponse = unknown;
91
-
92
- export type EvaluationGetEvaluatorsResponse = unknown;
93
-
94
1030
  export interface EvaluationGetJobResponse {
95
1031
  /**
96
1032
  * Evaluation job response payload
@@ -187,114 +1123,155 @@ export namespace EvaluationGetJobRunsResponse {
187
1123
  export namespace Data {
188
1124
  export interface Data {
189
1125
  /**
190
- * ID of the evaluator run
1126
+ * All block runs for this evaluator, including skipped ones
191
1127
  */
192
- id: string;
1128
+ blockRuns: Array<Data.BlockRun>;
193
1129
 
194
- /**
195
- * When the evaluator run completed
196
- */
197
- completedAt: string | null;
1130
+ evaluator: Data.Evaluator;
198
1131
 
199
- /**
200
- * Evaluator of the evaluator run
201
- */
202
- evaluator: Data.Evaluator | null;
1132
+ evidence: Array<Data.Evidence>;
1133
+
1134
+ metrics: Array<Data.Metric>;
203
1135
 
204
1136
  /**
205
- * Evidence of the evaluator run
1137
+ * Status of the evaluator run
206
1138
  */
207
- evidence: Array<Data.Evidence> | null;
1139
+ status: 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
208
1140
 
209
1141
  /**
210
- * Metrics of the evaluator run
1142
+ * ID of the evaluator run
211
1143
  */
212
- metrics: Array<Data.Metric> | null;
1144
+ id?: string;
213
1145
 
214
1146
  /**
215
- * Score of the evaluator run
1147
+ * When the evaluator run completed
216
1148
  */
217
- score: number | null;
1149
+ completedAt?: string | null;
218
1150
 
219
1151
  /**
220
- * Score classification of the evaluator run
1152
+ * Score of the evaluation run (0-1)
221
1153
  */
222
- scoreClassification: 'SUCCESS' | 'FAILURE' | 'IRRELEVANT' | null;
1154
+ score?: number | null;
223
1155
 
224
1156
  /**
225
- * When the evaluator run started
1157
+ * Score classification of the evaluator run based on score threshold (IRRELEVANT
1158
+ * is mapped to SKIPPED)
226
1159
  */
227
- startedAt: string | null;
1160
+ scoreClassification?: 'SUCCESS' | 'FAILURE' | 'SKIPPED' | null;
228
1161
 
229
1162
  /**
230
- * Status of the evaluator run
1163
+ * When the evaluator run started
231
1164
  */
232
- status: 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
1165
+ startedAt?: string | null;
233
1166
 
234
1167
  /**
235
- * Summary of the evaluator run
1168
+ * Summary of the evaluation run
236
1169
  */
237
- summary: string | null;
1170
+ summary?: string | null;
238
1171
  }
239
1172
 
240
1173
  export namespace Data {
241
- /**
242
- * Evaluator of the evaluator run
243
- */
1174
+ export interface BlockRun {
1175
+ /**
1176
+ * ID of the block definition
1177
+ */
1178
+ blockDefinitionId: string;
1179
+
1180
+ /**
1181
+ * Name of the evaluation block
1182
+ */
1183
+ blockName: string;
1184
+
1185
+ /**
1186
+ * ID of the block run instance
1187
+ */
1188
+ blockRunId: string;
1189
+
1190
+ /**
1191
+ * When the block run was created
1192
+ */
1193
+ createdAt: string;
1194
+
1195
+ /**
1196
+ * Reason for the outcome (pass/fail explanation or skip reason)
1197
+ */
1198
+ reason: string | null;
1199
+
1200
+ /**
1201
+ * Result of the block run
1202
+ */
1203
+ result: 'PASSED' | 'FAILED' | 'SKIPPED' | null;
1204
+
1205
+ /**
1206
+ * Score of the block run (0-1)
1207
+ */
1208
+ score: number | null;
1209
+
1210
+ /**
1211
+ * Status of the block run
1212
+ */
1213
+ status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
1214
+ }
1215
+
244
1216
  export interface Evaluator {
245
1217
  /**
246
1218
  * ID of the evaluator
247
1219
  */
248
- id: string | null;
1220
+ id: string;
249
1221
 
250
1222
  /**
251
1223
  * Name of the evaluator
252
1224
  */
253
- name: string | null;
254
- }
1225
+ name: string;
255
1226
 
256
- export interface Evidence {
257
1227
  /**
258
- * ID of the evidence
1228
+ * Weight of the evaluator
259
1229
  */
260
- id: string | null;
1230
+ weight?: number;
1231
+ }
261
1232
 
1233
+ export interface Evidence {
262
1234
  /**
263
- * Comment on the evidence
1235
+ * Comment text of the evidence
264
1236
  */
265
1237
  commentText: string | null;
266
1238
 
267
1239
  /**
268
- * Whether this is a positive example of the metric
1240
+ * Created at of the evidence
269
1241
  */
270
- isPositive: boolean | null;
1242
+ createdAt: string;
271
1243
 
272
1244
  /**
273
- * Snippet of the evidence
1245
+ * Is positive of the evidence
274
1246
  */
275
- snippetText: string | null;
276
- }
1247
+ isPositive: boolean;
277
1248
 
278
- export interface Metric {
279
1249
  /**
280
- * ID of the metric
1250
+ * Snippet text of the evidence
281
1251
  */
282
- id: string | null;
1252
+ snippetText: string;
1253
+ }
283
1254
 
1255
+ export interface Metric {
284
1256
  /**
285
1257
  * Boolean value of the metric
286
1258
  */
287
1259
  booleanValue: boolean | null;
288
1260
 
289
1261
  /**
290
- * Confidence of the metric
1262
+ * Confidence level of the metric (0-1)
291
1263
  */
292
1264
  confidence: number | null;
293
1265
 
1266
+ /**
1267
+ * Created at of the metric
1268
+ */
1269
+ createdAt: string;
1270
+
294
1271
  /**
295
1272
  * Name of the metric
296
1273
  */
297
- name: string | null;
1274
+ name: string;
298
1275
 
299
1276
  /**
300
1277
  * Numeric value of the metric
@@ -302,14 +1279,14 @@ export namespace EvaluationGetJobRunsResponse {
302
1279
  numericValue: number | null;
303
1280
 
304
1281
  /**
305
- * Reasoning for the metric
1282
+ * Reasoning of the metric
306
1283
  */
307
1284
  reasoning: string | null;
308
1285
 
309
1286
  /**
310
1287
  * Role of the metric
311
1288
  */
312
- role: 'PRIMARY' | 'SECONDARY' | null;
1289
+ role: string;
313
1290
 
314
1291
  /**
315
1292
  * Text value of the metric
@@ -319,7 +1296,7 @@ export namespace EvaluationGetJobRunsResponse {
319
1296
  /**
320
1297
  * Value type of the metric
321
1298
  */
322
- valueType: 'NUMERIC' | 'BOOLEAN' | 'TEXT' | null;
1299
+ valueType: string;
323
1300
  }
324
1301
  }
325
1302
 
@@ -658,8 +1635,14 @@ export namespace EvaluationCreateJobParams {
658
1635
  }
659
1636
 
660
1637
  export interface EvaluationGetEvaluatorsParams {
1638
+ /**
1639
+ * Cursor for pagination - evaluator ID to start after
1640
+ */
661
1641
  after?: string;
662
1642
 
1643
+ /**
1644
+ * Maximum number of evaluators to return (default: 20, max: 50)
1645
+ */
663
1646
  limit?: string;
664
1647
  }
665
1648