@roarkanalytics/sdk 0.327.0 → 0.329.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/package.json +1 -1
- package/resources/evaluation.d.ts +217 -5
- package/resources/evaluation.d.ts.map +1 -1
- package/src/resources/evaluation.ts +256 -6
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.329.0 (2025-06-04)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.328.0...v0.329.0](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v0.328.0...v0.329.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([fcb8db5](https://github.com/roarkhq/sdk-roark-analytics-node/commit/fcb8db545bab66fb84be18f322dcd3847c91fe0d))
|
|
10
|
+
|
|
11
|
+
## 0.328.0 (2025-06-04)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v0.327.0...v0.328.0](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v0.327.0...v0.328.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** api update ([f93e716](https://github.com/roarkhq/sdk-roark-analytics-node/commit/f93e7165b3a5519085d791ff9477b4ffd93cd0ad))
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Chores
|
|
21
|
+
|
|
22
|
+
* **docs:** use top-level-await in example snippets ([3ac865f](https://github.com/roarkhq/sdk-roark-analytics-node/commit/3ac865fa817d34d58bd9f82ee7d07f923157245a))
|
|
23
|
+
|
|
3
24
|
## 0.327.0 (2025-06-04)
|
|
4
25
|
|
|
5
26
|
Full Changelog: [v0.326.0...v0.327.0](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v0.326.0...v0.327.0)
|
package/package.json
CHANGED
|
@@ -8,12 +8,12 @@ export declare class Evaluation extends APIResource {
|
|
|
8
8
|
/**
|
|
9
9
|
* Retrieve details of a specific evaluation job
|
|
10
10
|
*/
|
|
11
|
-
getJob(jobId: string, options?: Core.RequestOptions): Core.APIPromise<
|
|
11
|
+
getJob(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobResponse>;
|
|
12
12
|
/**
|
|
13
13
|
* Retrieve paginated details of a specific evaluation job runs
|
|
14
14
|
*/
|
|
15
|
-
getJobRuns(jobId: string, query?: EvaluationGetJobRunsParams, options?: Core.RequestOptions): Core.APIPromise<
|
|
16
|
-
getJobRuns(jobId: string, options?: Core.RequestOptions): Core.APIPromise<
|
|
15
|
+
getJobRuns(jobId: string, query?: EvaluationGetJobRunsParams, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobRunsResponse>;
|
|
16
|
+
getJobRuns(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobRunsResponse>;
|
|
17
17
|
}
|
|
18
18
|
export interface EvaluationCreateJobResponse {
|
|
19
19
|
data: EvaluationCreateJobResponse.Data;
|
|
@@ -30,8 +30,220 @@ export declare namespace EvaluationCreateJobResponse {
|
|
|
30
30
|
status: 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILURE';
|
|
31
31
|
}
|
|
32
32
|
}
|
|
33
|
-
export
|
|
34
|
-
|
|
33
|
+
export interface EvaluationGetJobResponse {
|
|
34
|
+
/**
|
|
35
|
+
* Evaluation job response payload
|
|
36
|
+
*/
|
|
37
|
+
data: EvaluationGetJobResponse.Data;
|
|
38
|
+
}
|
|
39
|
+
export declare namespace EvaluationGetJobResponse {
|
|
40
|
+
/**
|
|
41
|
+
* Evaluation job response payload
|
|
42
|
+
*/
|
|
43
|
+
interface Data {
|
|
44
|
+
/**
|
|
45
|
+
* ID of the evaluation job
|
|
46
|
+
*/
|
|
47
|
+
id: string;
|
|
48
|
+
/**
|
|
49
|
+
* Status of the evaluation job
|
|
50
|
+
*/
|
|
51
|
+
status: 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILURE';
|
|
52
|
+
/**
|
|
53
|
+
* Call being evaluated
|
|
54
|
+
*/
|
|
55
|
+
call?: Data.Call;
|
|
56
|
+
/**
|
|
57
|
+
* Dataset being evaluated
|
|
58
|
+
*/
|
|
59
|
+
dataset?: Data.Dataset;
|
|
60
|
+
}
|
|
61
|
+
namespace Data {
|
|
62
|
+
/**
|
|
63
|
+
* Call being evaluated
|
|
64
|
+
*/
|
|
65
|
+
interface Call {
|
|
66
|
+
/**
|
|
67
|
+
* ID of the call being evaluated
|
|
68
|
+
*/
|
|
69
|
+
id: string | null;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Dataset being evaluated
|
|
73
|
+
*/
|
|
74
|
+
interface Dataset {
|
|
75
|
+
/**
|
|
76
|
+
* ID of the dataset
|
|
77
|
+
*/
|
|
78
|
+
id: string | null;
|
|
79
|
+
/**
|
|
80
|
+
* Calls in the dataset
|
|
81
|
+
*/
|
|
82
|
+
calls: Array<Dataset.Call>;
|
|
83
|
+
}
|
|
84
|
+
namespace Dataset {
|
|
85
|
+
interface Call {
|
|
86
|
+
/**
|
|
87
|
+
* ID of the call
|
|
88
|
+
*/
|
|
89
|
+
id: string | null;
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
export interface EvaluationGetJobRunsResponse {
|
|
95
|
+
/**
|
|
96
|
+
* Evaluation job runs response payload
|
|
97
|
+
*/
|
|
98
|
+
data: EvaluationGetJobRunsResponse.Data;
|
|
99
|
+
}
|
|
100
|
+
export declare namespace EvaluationGetJobRunsResponse {
|
|
101
|
+
/**
|
|
102
|
+
* Evaluation job runs response payload
|
|
103
|
+
*/
|
|
104
|
+
interface Data {
|
|
105
|
+
/**
|
|
106
|
+
* Evaluator runs of the evaluation job
|
|
107
|
+
*/
|
|
108
|
+
data: Array<Data.Data> | null;
|
|
109
|
+
/**
|
|
110
|
+
* Pagination information
|
|
111
|
+
*/
|
|
112
|
+
pagination: Data.Pagination | null;
|
|
113
|
+
}
|
|
114
|
+
namespace Data {
|
|
115
|
+
interface Data {
|
|
116
|
+
/**
|
|
117
|
+
* ID of the evaluator run
|
|
118
|
+
*/
|
|
119
|
+
id: string;
|
|
120
|
+
/**
|
|
121
|
+
* When the evaluator run completed
|
|
122
|
+
*/
|
|
123
|
+
completedAt: string | null;
|
|
124
|
+
/**
|
|
125
|
+
* Evaluator of the evaluator run
|
|
126
|
+
*/
|
|
127
|
+
evaluator: Data.Evaluator | null;
|
|
128
|
+
/**
|
|
129
|
+
* Evidence of the evaluator run
|
|
130
|
+
*/
|
|
131
|
+
evidence: Array<Data.Evidence> | null;
|
|
132
|
+
/**
|
|
133
|
+
* Metrics of the evaluator run
|
|
134
|
+
*/
|
|
135
|
+
metrics: Array<Data.Metric> | null;
|
|
136
|
+
/**
|
|
137
|
+
* Score of the evaluator run
|
|
138
|
+
*/
|
|
139
|
+
score: number | null;
|
|
140
|
+
/**
|
|
141
|
+
* Score classification of the evaluator run
|
|
142
|
+
*/
|
|
143
|
+
scoreClassification: 'SUCCESS' | 'FAILURE' | 'IRRELEVANT' | null;
|
|
144
|
+
/**
|
|
145
|
+
* When the evaluator run started
|
|
146
|
+
*/
|
|
147
|
+
startedAt: string | null;
|
|
148
|
+
/**
|
|
149
|
+
* Status of the evaluator run
|
|
150
|
+
*/
|
|
151
|
+
status: 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
152
|
+
/**
|
|
153
|
+
* Summary of the evaluator run
|
|
154
|
+
*/
|
|
155
|
+
summary: string | null;
|
|
156
|
+
}
|
|
157
|
+
namespace Data {
|
|
158
|
+
/**
|
|
159
|
+
* Evaluator of the evaluator run
|
|
160
|
+
*/
|
|
161
|
+
interface Evaluator {
|
|
162
|
+
/**
|
|
163
|
+
* ID of the evaluator
|
|
164
|
+
*/
|
|
165
|
+
id: string | null;
|
|
166
|
+
/**
|
|
167
|
+
* Name of the evaluator
|
|
168
|
+
*/
|
|
169
|
+
name: string | null;
|
|
170
|
+
}
|
|
171
|
+
interface Evidence {
|
|
172
|
+
/**
|
|
173
|
+
* ID of the evidence
|
|
174
|
+
*/
|
|
175
|
+
id: string | null;
|
|
176
|
+
/**
|
|
177
|
+
* Comment on the evidence
|
|
178
|
+
*/
|
|
179
|
+
commentText: string | null;
|
|
180
|
+
/**
|
|
181
|
+
* Whether this is a positive example of the metric
|
|
182
|
+
*/
|
|
183
|
+
isPositive: boolean | null;
|
|
184
|
+
/**
|
|
185
|
+
* Snippet of the evidence
|
|
186
|
+
*/
|
|
187
|
+
snippetText: string | null;
|
|
188
|
+
}
|
|
189
|
+
interface Metric {
|
|
190
|
+
/**
|
|
191
|
+
* ID of the metric
|
|
192
|
+
*/
|
|
193
|
+
id: string | null;
|
|
194
|
+
/**
|
|
195
|
+
* Boolean value of the metric
|
|
196
|
+
*/
|
|
197
|
+
booleanValue: boolean | null;
|
|
198
|
+
/**
|
|
199
|
+
* Confidence of the metric
|
|
200
|
+
*/
|
|
201
|
+
confidence: number | null;
|
|
202
|
+
/**
|
|
203
|
+
* Name of the metric
|
|
204
|
+
*/
|
|
205
|
+
name: string | null;
|
|
206
|
+
/**
|
|
207
|
+
* Numeric value of the metric
|
|
208
|
+
*/
|
|
209
|
+
numericValue: number | null;
|
|
210
|
+
/**
|
|
211
|
+
* Reasoning for the metric
|
|
212
|
+
*/
|
|
213
|
+
reasoning: string | null;
|
|
214
|
+
/**
|
|
215
|
+
* Role of the metric
|
|
216
|
+
*/
|
|
217
|
+
role: 'PRIMARY' | 'SECONDARY' | null;
|
|
218
|
+
/**
|
|
219
|
+
* Text value of the metric
|
|
220
|
+
*/
|
|
221
|
+
textValue: string | null;
|
|
222
|
+
/**
|
|
223
|
+
* Value type of the metric
|
|
224
|
+
*/
|
|
225
|
+
valueType: 'NUMERIC' | 'BOOLEAN' | 'TEXT' | null;
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Pagination information
|
|
230
|
+
*/
|
|
231
|
+
interface Pagination {
|
|
232
|
+
/**
|
|
233
|
+
* Whether there are more items to fetch
|
|
234
|
+
*/
|
|
235
|
+
hasMore: boolean;
|
|
236
|
+
/**
|
|
237
|
+
* Cursor for the next page of items
|
|
238
|
+
*/
|
|
239
|
+
nextCursor: string | null;
|
|
240
|
+
/**
|
|
241
|
+
* Total number of items
|
|
242
|
+
*/
|
|
243
|
+
total: number;
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
}
|
|
35
247
|
export interface EvaluationCreateJobParams {
|
|
36
248
|
/**
|
|
37
249
|
* List of evaluators slugs to evaluate the calls or "all" to evaluate all
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"evaluation.d.ts","sourceRoot":"","sources":["../src/resources/evaluation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,SAAS,CACP,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAI/C;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,
|
|
1
|
+
{"version":3,"file":"evaluation.d.ts","sourceRoot":"","sources":["../src/resources/evaluation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,SAAS,CACP,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAI/C;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI/F;;OAEG;IACH,UAAU,CACR,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAChD,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;CAWxG;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC;KAC1D;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC;QAEzD;;WAEG;QACH,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC;QAEjB;;WAEG;QACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;KACxB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;SACnB;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;YAElB;;eAEG;YACH,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC5B;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;aACnB;SACF;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC,IAAI,CAAC;CACzC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;YAEtC;;eAEG;YACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,mBAAmB,EAAE,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,IAAI,CAAC;YAEjE;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,CAAC;YAE3D;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,IAAI,CAAC;YACpB;;eAEG;YACH,UAAiB,SAAS;gBACxB;;mBAEG;gBACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElB;;mBAEG;gBACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;aACrB;YAED,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElB;;mBAEG;gBACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;aAC5B;YAED,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElB;;mBAEG;gBACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;gBAE7B;;mBAEG;gBACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE1B;;mBAEG;gBACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEpB;;mBAEG;gBACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEzB;;mBAEG;gBACH,IAAI,EAAE,SAAS,GAAG,WAAW,GAAG,IAAI,CAAC;gBAErC;;mBAEG;gBACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEzB;;mBAEG;gBACH,SAAS,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,CAAC;aAClD;SACF;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,EAAE,OAAO,CAAC;YAEjB;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,yBAAyB,CAAC,IAAI,CAAC;IAEtC,OAAO,CAAC,EAAE,yBAAyB,CAAC,OAAO,CAAC;CAC7C;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,aAAa,EAAE,SAAS,GAAG,UAAU,CAAC;QAEtC;;WAEG;QACH,aAAa,EAAE,OAAO,GAAG,KAAK,CAAC;QAE/B;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEtC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EACR,kBAAkB,GAClB,wBAAwB,GACxB,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,kBAAkB,GAClB,sCAAsC,GACtC,yBAAyB,GACzB,eAAe,GACf,YAAY,GACZ,sBAAsB,GACtB,SAAS,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAErC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE7C;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,WAAW;YAC1B,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;YAE3B,WAAW,CAAC,EAAE,OAAO,CAAC;YAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,UAAU,CAAC,EAAE,OAAO,CAAC;SACtB;QAED,UAAiB,cAAc;YAC7B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,YAAY,GAAG,OAAO,CAAC,CAAC;YAElE;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAEzC;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;QAED,UAAiB,cAAc,CAAC;YAC9B,UAAiB,YAAY;gBAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;gBAEvC,KAAK,CAAC,EAAE,OAAO,CAAC;aACjB;SACF;KACF;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE3B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,IAAI;YACnB;;eAEG;YACH,aAAa,EAAE,SAAS,GAAG,UAAU,CAAC;YAEtC;;eAEG;YACH,aAAa,EAAE,OAAO,GAAG,KAAK,CAAC;YAE/B;;eAEG;YACH,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAEtC;;;eAGG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EACR,kBAAkB,GAClB,wBAAwB,GACxB,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,kBAAkB,GAClB,sCAAsC,GACtC,yBAAyB,GACzB,eAAe,GACf,YAAY,GACZ,sBAAsB,GACtB,SAAS,CAAC;YAEd;;eAEG;YACH,MAAM,CAAC,EAAE,OAAO,CAAC;YAEjB;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAErC;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;;eAGG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B;;eAEG;YACH,eAAe,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAE7C;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;gBAE3B,WAAW,CAAC,EAAE,OAAO,CAAC;gBAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B,UAAU,CAAC,EAAE,OAAO,CAAC;aACtB;YAED,UAAiB,cAAc;gBAC7B;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,YAAY,GAAG,OAAO,CAAC,CAAC;gBAElE;;mBAEG;gBACH,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAEzC;;mBAEG;gBACH,aAAa,EAAE,MAAM,CAAC;gBAEtB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;;mBAGG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;aACtB;YAED,UAAiB,cAAc,CAAC;gBAC9B,UAAiB,YAAY;oBAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;oBAErB,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;oBAEvC,KAAK,CAAC,EAAE,OAAO,CAAC;iBACjB;aACF;SACF;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
|
|
@@ -18,7 +18,7 @@ export class Evaluation extends APIResource {
|
|
|
18
18
|
/**
|
|
19
19
|
* Retrieve details of a specific evaluation job
|
|
20
20
|
*/
|
|
21
|
-
getJob(jobId: string, options?: Core.RequestOptions): Core.APIPromise<
|
|
21
|
+
getJob(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobResponse> {
|
|
22
22
|
return this._client.get(`/v1/evaluation/job/${jobId}`, options);
|
|
23
23
|
}
|
|
24
24
|
|
|
@@ -29,13 +29,13 @@ export class Evaluation extends APIResource {
|
|
|
29
29
|
jobId: string,
|
|
30
30
|
query?: EvaluationGetJobRunsParams,
|
|
31
31
|
options?: Core.RequestOptions,
|
|
32
|
-
): Core.APIPromise<
|
|
33
|
-
getJobRuns(jobId: string, options?: Core.RequestOptions): Core.APIPromise<
|
|
32
|
+
): Core.APIPromise<EvaluationGetJobRunsResponse>;
|
|
33
|
+
getJobRuns(jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvaluationGetJobRunsResponse>;
|
|
34
34
|
getJobRuns(
|
|
35
35
|
jobId: string,
|
|
36
36
|
query: EvaluationGetJobRunsParams | Core.RequestOptions = {},
|
|
37
37
|
options?: Core.RequestOptions,
|
|
38
|
-
): Core.APIPromise<
|
|
38
|
+
): Core.APIPromise<EvaluationGetJobRunsResponse> {
|
|
39
39
|
if (isRequestOptions(query)) {
|
|
40
40
|
return this.getJobRuns(jobId, {}, query);
|
|
41
41
|
}
|
|
@@ -61,9 +61,259 @@ export namespace EvaluationCreateJobResponse {
|
|
|
61
61
|
}
|
|
62
62
|
}
|
|
63
63
|
|
|
64
|
-
export
|
|
64
|
+
export interface EvaluationGetJobResponse {
|
|
65
|
+
/**
|
|
66
|
+
* Evaluation job response payload
|
|
67
|
+
*/
|
|
68
|
+
data: EvaluationGetJobResponse.Data;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export namespace EvaluationGetJobResponse {
|
|
72
|
+
/**
|
|
73
|
+
* Evaluation job response payload
|
|
74
|
+
*/
|
|
75
|
+
export interface Data {
|
|
76
|
+
/**
|
|
77
|
+
* ID of the evaluation job
|
|
78
|
+
*/
|
|
79
|
+
id: string;
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Status of the evaluation job
|
|
83
|
+
*/
|
|
84
|
+
status: 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILURE';
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Call being evaluated
|
|
88
|
+
*/
|
|
89
|
+
call?: Data.Call;
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Dataset being evaluated
|
|
93
|
+
*/
|
|
94
|
+
dataset?: Data.Dataset;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export namespace Data {
|
|
98
|
+
/**
|
|
99
|
+
* Call being evaluated
|
|
100
|
+
*/
|
|
101
|
+
export interface Call {
|
|
102
|
+
/**
|
|
103
|
+
* ID of the call being evaluated
|
|
104
|
+
*/
|
|
105
|
+
id: string | null;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Dataset being evaluated
|
|
110
|
+
*/
|
|
111
|
+
export interface Dataset {
|
|
112
|
+
/**
|
|
113
|
+
* ID of the dataset
|
|
114
|
+
*/
|
|
115
|
+
id: string | null;
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* Calls in the dataset
|
|
119
|
+
*/
|
|
120
|
+
calls: Array<Dataset.Call>;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
export namespace Dataset {
|
|
124
|
+
export interface Call {
|
|
125
|
+
/**
|
|
126
|
+
* ID of the call
|
|
127
|
+
*/
|
|
128
|
+
id: string | null;
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
export interface EvaluationGetJobRunsResponse {
|
|
135
|
+
/**
|
|
136
|
+
* Evaluation job runs response payload
|
|
137
|
+
*/
|
|
138
|
+
data: EvaluationGetJobRunsResponse.Data;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
export namespace EvaluationGetJobRunsResponse {
|
|
142
|
+
/**
|
|
143
|
+
* Evaluation job runs response payload
|
|
144
|
+
*/
|
|
145
|
+
export interface Data {
|
|
146
|
+
/**
|
|
147
|
+
* Evaluator runs of the evaluation job
|
|
148
|
+
*/
|
|
149
|
+
data: Array<Data.Data> | null;
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Pagination information
|
|
153
|
+
*/
|
|
154
|
+
pagination: Data.Pagination | null;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
export namespace Data {
|
|
158
|
+
export interface Data {
|
|
159
|
+
/**
|
|
160
|
+
* ID of the evaluator run
|
|
161
|
+
*/
|
|
162
|
+
id: string;
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* When the evaluator run completed
|
|
166
|
+
*/
|
|
167
|
+
completedAt: string | null;
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Evaluator of the evaluator run
|
|
171
|
+
*/
|
|
172
|
+
evaluator: Data.Evaluator | null;
|
|
173
|
+
|
|
174
|
+
/**
|
|
175
|
+
* Evidence of the evaluator run
|
|
176
|
+
*/
|
|
177
|
+
evidence: Array<Data.Evidence> | null;
|
|
178
|
+
|
|
179
|
+
/**
|
|
180
|
+
* Metrics of the evaluator run
|
|
181
|
+
*/
|
|
182
|
+
metrics: Array<Data.Metric> | null;
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
* Score of the evaluator run
|
|
186
|
+
*/
|
|
187
|
+
score: number | null;
|
|
65
188
|
|
|
66
|
-
|
|
189
|
+
/**
|
|
190
|
+
* Score classification of the evaluator run
|
|
191
|
+
*/
|
|
192
|
+
scoreClassification: 'SUCCESS' | 'FAILURE' | 'IRRELEVANT' | null;
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* When the evaluator run started
|
|
196
|
+
*/
|
|
197
|
+
startedAt: string | null;
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* Status of the evaluator run
|
|
201
|
+
*/
|
|
202
|
+
status: 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* Summary of the evaluator run
|
|
206
|
+
*/
|
|
207
|
+
summary: string | null;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
export namespace Data {
|
|
211
|
+
/**
|
|
212
|
+
* Evaluator of the evaluator run
|
|
213
|
+
*/
|
|
214
|
+
export interface Evaluator {
|
|
215
|
+
/**
|
|
216
|
+
* ID of the evaluator
|
|
217
|
+
*/
|
|
218
|
+
id: string | null;
|
|
219
|
+
|
|
220
|
+
/**
|
|
221
|
+
* Name of the evaluator
|
|
222
|
+
*/
|
|
223
|
+
name: string | null;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
export interface Evidence {
|
|
227
|
+
/**
|
|
228
|
+
* ID of the evidence
|
|
229
|
+
*/
|
|
230
|
+
id: string | null;
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* Comment on the evidence
|
|
234
|
+
*/
|
|
235
|
+
commentText: string | null;
|
|
236
|
+
|
|
237
|
+
/**
|
|
238
|
+
* Whether this is a positive example of the metric
|
|
239
|
+
*/
|
|
240
|
+
isPositive: boolean | null;
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* Snippet of the evidence
|
|
244
|
+
*/
|
|
245
|
+
snippetText: string | null;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
export interface Metric {
|
|
249
|
+
/**
|
|
250
|
+
* ID of the metric
|
|
251
|
+
*/
|
|
252
|
+
id: string | null;
|
|
253
|
+
|
|
254
|
+
/**
|
|
255
|
+
* Boolean value of the metric
|
|
256
|
+
*/
|
|
257
|
+
booleanValue: boolean | null;
|
|
258
|
+
|
|
259
|
+
/**
|
|
260
|
+
* Confidence of the metric
|
|
261
|
+
*/
|
|
262
|
+
confidence: number | null;
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* Name of the metric
|
|
266
|
+
*/
|
|
267
|
+
name: string | null;
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* Numeric value of the metric
|
|
271
|
+
*/
|
|
272
|
+
numericValue: number | null;
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* Reasoning for the metric
|
|
276
|
+
*/
|
|
277
|
+
reasoning: string | null;
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
* Role of the metric
|
|
281
|
+
*/
|
|
282
|
+
role: 'PRIMARY' | 'SECONDARY' | null;
|
|
283
|
+
|
|
284
|
+
/**
|
|
285
|
+
* Text value of the metric
|
|
286
|
+
*/
|
|
287
|
+
textValue: string | null;
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* Value type of the metric
|
|
291
|
+
*/
|
|
292
|
+
valueType: 'NUMERIC' | 'BOOLEAN' | 'TEXT' | null;
|
|
293
|
+
}
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
/**
|
|
297
|
+
* Pagination information
|
|
298
|
+
*/
|
|
299
|
+
export interface Pagination {
|
|
300
|
+
/**
|
|
301
|
+
* Whether there are more items to fetch
|
|
302
|
+
*/
|
|
303
|
+
hasMore: boolean;
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* Cursor for the next page of items
|
|
307
|
+
*/
|
|
308
|
+
nextCursor: string | null;
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Total number of items
|
|
312
|
+
*/
|
|
313
|
+
total: number;
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
}
|
|
67
317
|
|
|
68
318
|
export interface EvaluationCreateJobParams {
|
|
69
319
|
/**
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.
|
|
1
|
+
export const VERSION = '0.329.0'; // x-release-please-version
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.329.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '0.
|
|
1
|
+
export const VERSION = '0.329.0'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|