@eigenpal/sdk 0.8.0 → 0.9.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 +10 -0
- package/package.json +2 -2
- package/src/generated/index.ts +2 -2
- package/src/generated/sdk.gen.ts +354 -63
- package/src/generated/types.gen.ts +2467 -622
- package/src/index.ts +4 -0
- package/src/lib/files.ts +9 -0
- package/src/resources/automations.ts +58 -0
- package/src/resources/runs.ts +108 -7
- package/src/telemetry.ts +1 -1
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import { type Client, formDataBodySerializer, type Options as Options2, type TDataShape } from './client';
|
|
4
4
|
import { client } from './client.gen';
|
|
5
|
-
import type { AuthCheckData, AuthCheckErrors, AuthCheckResponses, AutomationsDatasetExportData, AutomationsDatasetExportErrors, AutomationsDatasetExportResponses, AutomationsDatasetImportData, AutomationsDatasetImportErrors, AutomationsDatasetImportResponses, AutomationsEvaluatorsGetData, AutomationsEvaluatorsGetErrors, AutomationsEvaluatorsGetResponses, AutomationsEvaluatorsUpdateData, AutomationsEvaluatorsUpdateErrors, AutomationsEvaluatorsUpdateResponses, AutomationsExamplesCreateData, AutomationsExamplesCreateErrors, AutomationsExamplesCreateResponses, AutomationsExamplesDeleteData, AutomationsExamplesDeleteErrors, AutomationsExamplesDeleteResponses, AutomationsExamplesGetData, AutomationsExamplesGetErrors, AutomationsExamplesGetResponses, AutomationsExamplesListData, AutomationsExamplesListErrors, AutomationsExamplesListResponses, AutomationsExamplesRunData, AutomationsExamplesRunErrors, AutomationsExamplesRunResponses, AutomationsExamplesUpdateData, AutomationsExamplesUpdateErrors, AutomationsExamplesUpdateResponses, AutomationsExperimentsCancelData, AutomationsExperimentsCancelErrors, AutomationsExperimentsCancelResponses, AutomationsExperimentsCreateData, AutomationsExperimentsCreateErrors, AutomationsExperimentsCreateResponses, AutomationsExperimentsGetData, AutomationsExperimentsGetErrors, AutomationsExperimentsGetResponses, AutomationsExperimentsListData, AutomationsExperimentsListErrors, AutomationsExperimentsListResponses, AutomationsGetData, AutomationsGetErrors, AutomationsGetResponses, AutomationsListData, AutomationsListErrors, AutomationsListResponses, AutomationsTriggersGetData, AutomationsTriggersGetErrors, AutomationsTriggersGetResponses, AutomationsVersionsListData, AutomationsVersionsListErrors, AutomationsVersionsListResponses, FilesContentGetData, FilesContentGetErrors, FilesContentGetResponses, FilesCreateData, FilesCreateErrors, FilesCreateResponses, FilesDeleteData, FilesDeleteErrors, FilesDeleteResponses, FilesGetData, FilesGetErrors, FilesGetResponses, RunsArtifactsGetData, RunsArtifactsGetErrors, RunsArtifactsGetResponses, RunsArtifactsListData, RunsArtifactsListErrors, RunsArtifactsListResponses, RunsCancelData, RunsCancelErrors, RunsCancelResponses,
|
|
5
|
+
import type { AuthCheckData, AuthCheckErrors, AuthCheckResponses, AutomationsDatasetExportData, AutomationsDatasetExportErrors, AutomationsDatasetExportResponses, AutomationsDatasetImportData, AutomationsDatasetImportErrors, AutomationsDatasetImportResponses, AutomationsEvaluatorsGetData, AutomationsEvaluatorsGetErrors, AutomationsEvaluatorsGetResponses, AutomationsEvaluatorsUpdateData, AutomationsEvaluatorsUpdateErrors, AutomationsEvaluatorsUpdateResponses, AutomationsExamplesCreateData, AutomationsExamplesCreateErrors, AutomationsExamplesCreateResponses, AutomationsExamplesDeleteData, AutomationsExamplesDeleteErrors, AutomationsExamplesDeleteResponses, AutomationsExamplesExpectedFileDeleteData, AutomationsExamplesExpectedFileDeleteErrors, AutomationsExamplesExpectedFileDeleteResponses, AutomationsExamplesExpectedFileGetData, AutomationsExamplesExpectedFileGetErrors, AutomationsExamplesExpectedFileGetResponses, AutomationsExamplesExpectedFilesCreateData, AutomationsExamplesExpectedFilesCreateErrors, AutomationsExamplesExpectedFilesCreateResponses, AutomationsExamplesExpectedFilesListData, AutomationsExamplesExpectedFilesListErrors, AutomationsExamplesExpectedFilesListResponses, AutomationsExamplesExpectedFileUpdateData, AutomationsExamplesExpectedFileUpdateErrors, AutomationsExamplesExpectedFileUpdateResponses, AutomationsExamplesGetData, AutomationsExamplesGetErrors, AutomationsExamplesGetResponses, AutomationsExamplesInputFileDeleteData, AutomationsExamplesInputFileDeleteErrors, AutomationsExamplesInputFileDeleteResponses, AutomationsExamplesInputFileGetData, AutomationsExamplesInputFileGetErrors, AutomationsExamplesInputFileGetResponses, AutomationsExamplesInputFilesCreateData, AutomationsExamplesInputFilesCreateErrors, AutomationsExamplesInputFilesCreateResponses, AutomationsExamplesInputFilesListData, AutomationsExamplesInputFilesListErrors, AutomationsExamplesInputFilesListResponses, AutomationsExamplesInputFileUpdateData, AutomationsExamplesInputFileUpdateErrors, AutomationsExamplesInputFileUpdateResponses, AutomationsExamplesListData, AutomationsExamplesListErrors, AutomationsExamplesListResponses, AutomationsExamplesRunData, AutomationsExamplesRunErrors, AutomationsExamplesRunResponses, AutomationsExamplesUpdateData, AutomationsExamplesUpdateErrors, AutomationsExamplesUpdateResponses, AutomationsExperimentsCancelData, AutomationsExperimentsCancelErrors, AutomationsExperimentsCancelResponses, AutomationsExperimentsCreateData, AutomationsExperimentsCreateErrors, AutomationsExperimentsCreateResponses, AutomationsExperimentsCreateStreamData, AutomationsExperimentsCreateStreamErrors, AutomationsExperimentsCreateStreamResponses, AutomationsExperimentsExportAllData, AutomationsExperimentsExportAllErrors, AutomationsExperimentsExportAllResponses, AutomationsExperimentsExportData, AutomationsExperimentsExportErrors, AutomationsExperimentsExportResponses, AutomationsExperimentsGetData, AutomationsExperimentsGetErrors, AutomationsExperimentsGetResponses, AutomationsExperimentsListData, AutomationsExperimentsListErrors, AutomationsExperimentsListResponses, AutomationsGetData, AutomationsGetErrors, AutomationsGetResponses, AutomationsListData, AutomationsListErrors, AutomationsListResponses, AutomationsSyncData, AutomationsSyncErrors, AutomationsSyncResponses, AutomationsTriggersGetData, AutomationsTriggersGetErrors, AutomationsTriggersGetResponses, AutomationsVersionsListData, AutomationsVersionsListErrors, AutomationsVersionsListResponses, ExperimentsResolveData, ExperimentsResolveErrors, ExperimentsResolveResponses, FilesContentGetData, FilesContentGetErrors, FilesContentGetResponses, FilesCreateData, FilesCreateErrors, FilesCreateResponses, FilesDeleteData, FilesDeleteErrors, FilesDeleteResponses, FilesGetData, FilesGetErrors, FilesGetResponses, RunsArtifactsGetData, RunsArtifactsGetErrors, RunsArtifactsGetResponses, RunsArtifactsListData, RunsArtifactsListErrors, RunsArtifactsListResponses, RunsCancelData, RunsCancelErrors, RunsCancelResponses, RunsEventsListData, RunsEventsListErrors, RunsEventsListResponses, RunsFeedbackClearData, RunsFeedbackClearErrors, RunsFeedbackClearResponses, RunsFeedbackExpectedCreateData, RunsFeedbackExpectedCreateErrors, RunsFeedbackExpectedCreateResponses, RunsFeedbackExpectedFileDeleteData, RunsFeedbackExpectedFileDeleteErrors, RunsFeedbackExpectedFileDeleteResponses, RunsFeedbackExpectedFileGetData, RunsFeedbackExpectedFileGetErrors, RunsFeedbackExpectedFileGetResponses, RunsFeedbackExpectedFileUpdateData, RunsFeedbackExpectedFileUpdateErrors, RunsFeedbackExpectedFileUpdateResponses, RunsFeedbackExpectedGetData, RunsFeedbackExpectedGetErrors, RunsFeedbackExpectedGetResponses, RunsFeedbackGetData, RunsFeedbackGetErrors, RunsFeedbackGetResponses, RunsFeedbackUpdateData, RunsFeedbackUpdateErrors, RunsFeedbackUpdateResponses, RunsGetData, RunsGetErrors, RunsGetResponses, RunsListData, RunsListErrors, RunsListResponses, RunsPromoteData, RunsPromoteErrors, RunsPromoteResponses, RunsRerunData, RunsRerunErrors, RunsRerunResponses, RunsScoresListData, RunsScoresListErrors, RunsScoresListResponses, RunsStartData, RunsStartErrors, RunsStartResponses, RunsStepsListData, RunsStepsListErrors, RunsStepsListResponses, RunsTraceGetData, RunsTraceGetErrors, RunsTraceGetResponses, RunsUsageGetData, RunsUsageGetErrors, RunsUsageGetResponses } from './types.gen';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
8
8
|
/**
|
|
@@ -29,8 +29,32 @@ export const authCheck = <ThrowOnError extends boolean = false>(options?: Option
|
|
|
29
29
|
...options
|
|
30
30
|
});
|
|
31
31
|
|
|
32
|
+
/**
|
|
33
|
+
* List automations
|
|
34
|
+
*
|
|
35
|
+
* Returns workflows and agents through one runnable automation collection. Use `type` to narrow to workflows or agents, and `search` to find automations by slug, name, or description.
|
|
36
|
+
*/
|
|
37
|
+
export const automationsList = <ThrowOnError extends boolean = false>(options?: Options<AutomationsListData, ThrowOnError>) => (options?.client ?? client).get<AutomationsListResponses, AutomationsListErrors, ThrowOnError>({
|
|
38
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
39
|
+
url: '/api/v1/automations',
|
|
40
|
+
...options
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* Get automation
|
|
45
|
+
*
|
|
46
|
+
* Get one runnable workflow or agent automation by id or typed alias.
|
|
47
|
+
*/
|
|
48
|
+
export const automationsGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsGetResponses, AutomationsGetErrors, ThrowOnError>({
|
|
49
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
50
|
+
url: '/api/v1/automations/{id}',
|
|
51
|
+
...options
|
|
52
|
+
});
|
|
53
|
+
|
|
32
54
|
/**
|
|
33
55
|
* Export automation dataset
|
|
56
|
+
*
|
|
57
|
+
* Download the automation dataset as a ZIP archive. The archive uses the examples/<name>/input and examples/<name>/expected folder convention, so it can be re-imported into another automation or environment.
|
|
34
58
|
*/
|
|
35
59
|
export const automationsDatasetExport = <ThrowOnError extends boolean = false>(options: Options<AutomationsDatasetExportData, ThrowOnError>) => (options.client ?? client).get<AutomationsDatasetExportResponses, AutomationsDatasetExportErrors, ThrowOnError>({
|
|
36
60
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -40,6 +64,8 @@ export const automationsDatasetExport = <ThrowOnError extends boolean = false>(o
|
|
|
40
64
|
|
|
41
65
|
/**
|
|
42
66
|
* Import automation dataset
|
|
67
|
+
*
|
|
68
|
+
* Import a dataset ZIP archive using the examples/<name>/input and examples/<name>/expected folder convention. Use `mode=append` for additive imports or `mode=replace` to replace the dataset.
|
|
43
69
|
*/
|
|
44
70
|
export const automationsDatasetImport = <ThrowOnError extends boolean = false>(options: Options<AutomationsDatasetImportData, ThrowOnError>) => (options.client ?? client).post<AutomationsDatasetImportResponses, AutomationsDatasetImportErrors, ThrowOnError>({
|
|
45
71
|
...formDataBodySerializer,
|
|
@@ -53,7 +79,9 @@ export const automationsDatasetImport = <ThrowOnError extends boolean = false>(o
|
|
|
53
79
|
});
|
|
54
80
|
|
|
55
81
|
/**
|
|
56
|
-
* Get
|
|
82
|
+
* Get evaluators
|
|
83
|
+
*
|
|
84
|
+
* Fetch the evaluator configuration for an automation. Evaluators produce automated `score` results, which are separate from human feedback `rating` values.
|
|
57
85
|
*/
|
|
58
86
|
export const automationsEvaluatorsGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsEvaluatorsGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsEvaluatorsGetResponses, AutomationsEvaluatorsGetErrors, ThrowOnError>({
|
|
59
87
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -62,7 +90,9 @@ export const automationsEvaluatorsGet = <ThrowOnError extends boolean = false>(o
|
|
|
62
90
|
});
|
|
63
91
|
|
|
64
92
|
/**
|
|
65
|
-
* Replace
|
|
93
|
+
* Replace evaluators
|
|
94
|
+
*
|
|
95
|
+
* Replace the evaluator YAML for an automation. The submitted YAML is validated before it becomes the source for future experiment scores.
|
|
66
96
|
*/
|
|
67
97
|
export const automationsEvaluatorsUpdate = <ThrowOnError extends boolean = false>(options: Options<AutomationsEvaluatorsUpdateData, ThrowOnError>) => (options.client ?? client).put<AutomationsEvaluatorsUpdateResponses, AutomationsEvaluatorsUpdateErrors, ThrowOnError>({
|
|
68
98
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -75,7 +105,35 @@ export const automationsEvaluatorsUpdate = <ThrowOnError extends boolean = false
|
|
|
75
105
|
});
|
|
76
106
|
|
|
77
107
|
/**
|
|
78
|
-
*
|
|
108
|
+
* List dataset examples
|
|
109
|
+
*
|
|
110
|
+
* List dataset examples for one automation. Examples contain input, expected output, expected files, metadata, and optional overrides used by evaluation runs.
|
|
111
|
+
*/
|
|
112
|
+
export const automationsExamplesList = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesListData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesListResponses, AutomationsExamplesListErrors, ThrowOnError>({
|
|
113
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
114
|
+
url: '/api/v1/automations/{id}/examples',
|
|
115
|
+
...options
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Create dataset example
|
|
120
|
+
*
|
|
121
|
+
* Create one dataset example from JSON fields. Use dataset import for archive-based uploads and file-bearing examples.
|
|
122
|
+
*/
|
|
123
|
+
export const automationsExamplesCreate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesCreateData, ThrowOnError>) => (options.client ?? client).post<AutomationsExamplesCreateResponses, AutomationsExamplesCreateErrors, ThrowOnError>({
|
|
124
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
125
|
+
url: '/api/v1/automations/{id}/examples',
|
|
126
|
+
...options,
|
|
127
|
+
headers: {
|
|
128
|
+
'Content-Type': 'application/json',
|
|
129
|
+
...options.headers
|
|
130
|
+
}
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* Delete dataset example
|
|
135
|
+
*
|
|
136
|
+
* Delete one dataset example from the automation dataset. This removes the example from future experiments.
|
|
79
137
|
*/
|
|
80
138
|
export const automationsExamplesDelete = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesDeleteData, ThrowOnError>) => (options.client ?? client).delete<AutomationsExamplesDeleteResponses, AutomationsExamplesDeleteErrors, ThrowOnError>({
|
|
81
139
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -84,7 +142,9 @@ export const automationsExamplesDelete = <ThrowOnError extends boolean = false>(
|
|
|
84
142
|
});
|
|
85
143
|
|
|
86
144
|
/**
|
|
87
|
-
* Get
|
|
145
|
+
* Get dataset example
|
|
146
|
+
*
|
|
147
|
+
* Fetch one dataset example, including input, expected output, expected files, metadata, and overrides.
|
|
88
148
|
*/
|
|
89
149
|
export const automationsExamplesGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesGetResponses, AutomationsExamplesGetErrors, ThrowOnError>({
|
|
90
150
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -93,7 +153,9 @@ export const automationsExamplesGet = <ThrowOnError extends boolean = false>(opt
|
|
|
93
153
|
});
|
|
94
154
|
|
|
95
155
|
/**
|
|
96
|
-
* Update
|
|
156
|
+
* Update dataset example
|
|
157
|
+
*
|
|
158
|
+
* Partially update a dataset example. Omitted fields are preserved; pass null for nullable fields to clear them.
|
|
97
159
|
*/
|
|
98
160
|
export const automationsExamplesUpdate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesUpdateData, ThrowOnError>) => (options.client ?? client).patch<AutomationsExamplesUpdateResponses, AutomationsExamplesUpdateErrors, ThrowOnError>({
|
|
99
161
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -106,29 +168,62 @@ export const automationsExamplesUpdate = <ThrowOnError extends boolean = false>(
|
|
|
106
168
|
});
|
|
107
169
|
|
|
108
170
|
/**
|
|
109
|
-
*
|
|
171
|
+
* List expected files
|
|
172
|
+
*
|
|
173
|
+
* List files stored under the expected folder for one automation dataset example.
|
|
110
174
|
*/
|
|
111
|
-
export const
|
|
175
|
+
export const automationsExamplesExpectedFilesList = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesExpectedFilesListData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesExpectedFilesListResponses, AutomationsExamplesExpectedFilesListErrors, ThrowOnError>({
|
|
112
176
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
113
|
-
url: '/api/v1/automations/{id}/examples/{exampleId}/
|
|
177
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/expected',
|
|
114
178
|
...options
|
|
115
179
|
});
|
|
116
180
|
|
|
117
181
|
/**
|
|
118
|
-
*
|
|
182
|
+
* Upload expected files
|
|
183
|
+
*
|
|
184
|
+
* Upload one or more files into the expected folder for an automation dataset example. Use `$file` references such as `expected/result.pdf` from expected JSON to compare file outputs.
|
|
119
185
|
*/
|
|
120
|
-
export const
|
|
186
|
+
export const automationsExamplesExpectedFilesCreate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesExpectedFilesCreateData, ThrowOnError>) => (options.client ?? client).post<AutomationsExamplesExpectedFilesCreateResponses, AutomationsExamplesExpectedFilesCreateErrors, ThrowOnError>({
|
|
187
|
+
...formDataBodySerializer,
|
|
121
188
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
122
|
-
url: '/api/v1/automations/{id}/examples',
|
|
189
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/expected',
|
|
190
|
+
...options,
|
|
191
|
+
headers: {
|
|
192
|
+
'Content-Type': null,
|
|
193
|
+
...options.headers
|
|
194
|
+
}
|
|
195
|
+
});
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Delete expected file
|
|
199
|
+
*
|
|
200
|
+
* Delete one file from an automation dataset example expected folder.
|
|
201
|
+
*/
|
|
202
|
+
export const automationsExamplesExpectedFileDelete = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesExpectedFileDeleteData, ThrowOnError>) => (options.client ?? client).delete<AutomationsExamplesExpectedFileDeleteResponses, AutomationsExamplesExpectedFileDeleteErrors, ThrowOnError>({
|
|
203
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
204
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/expected/{path}',
|
|
123
205
|
...options
|
|
124
206
|
});
|
|
125
207
|
|
|
126
208
|
/**
|
|
127
|
-
*
|
|
209
|
+
* Download expected dataset file
|
|
210
|
+
*
|
|
211
|
+
* Download one expected file attached to an automation dataset example.
|
|
128
212
|
*/
|
|
129
|
-
export const
|
|
213
|
+
export const automationsExamplesExpectedFileGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesExpectedFileGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesExpectedFileGetResponses, AutomationsExamplesExpectedFileGetErrors, ThrowOnError>({
|
|
130
214
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
131
|
-
url: '/api/v1/automations/{id}/examples',
|
|
215
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/expected/{path}',
|
|
216
|
+
...options
|
|
217
|
+
});
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* Rename expected file
|
|
221
|
+
*
|
|
222
|
+
* Rename one expected file attached to an automation dataset example. The parent folder is preserved.
|
|
223
|
+
*/
|
|
224
|
+
export const automationsExamplesExpectedFileUpdate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesExpectedFileUpdateData, ThrowOnError>) => (options.client ?? client).patch<AutomationsExamplesExpectedFileUpdateResponses, AutomationsExamplesExpectedFileUpdateErrors, ThrowOnError>({
|
|
225
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
226
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/expected/{path}',
|
|
132
227
|
...options,
|
|
133
228
|
headers: {
|
|
134
229
|
'Content-Type': 'application/json',
|
|
@@ -137,7 +232,84 @@ export const automationsExamplesCreate = <ThrowOnError extends boolean = false>(
|
|
|
137
232
|
});
|
|
138
233
|
|
|
139
234
|
/**
|
|
140
|
-
* List
|
|
235
|
+
* List input files
|
|
236
|
+
*
|
|
237
|
+
* List files stored under the input folder for one automation dataset example.
|
|
238
|
+
*/
|
|
239
|
+
export const automationsExamplesInputFilesList = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesInputFilesListData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesInputFilesListResponses, AutomationsExamplesInputFilesListErrors, ThrowOnError>({
|
|
240
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
241
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/input',
|
|
242
|
+
...options
|
|
243
|
+
});
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* Upload input files
|
|
247
|
+
*
|
|
248
|
+
* Upload one or more files into the input folder for an automation dataset example. Use `$file` references such as `input/invoice.pdf` from the example input JSON to consume them.
|
|
249
|
+
*/
|
|
250
|
+
export const automationsExamplesInputFilesCreate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesInputFilesCreateData, ThrowOnError>) => (options.client ?? client).post<AutomationsExamplesInputFilesCreateResponses, AutomationsExamplesInputFilesCreateErrors, ThrowOnError>({
|
|
251
|
+
...formDataBodySerializer,
|
|
252
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
253
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/input',
|
|
254
|
+
...options,
|
|
255
|
+
headers: {
|
|
256
|
+
'Content-Type': null,
|
|
257
|
+
...options.headers
|
|
258
|
+
}
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* Delete input file
|
|
263
|
+
*
|
|
264
|
+
* Delete one file from an automation dataset example input folder.
|
|
265
|
+
*/
|
|
266
|
+
export const automationsExamplesInputFileDelete = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesInputFileDeleteData, ThrowOnError>) => (options.client ?? client).delete<AutomationsExamplesInputFileDeleteResponses, AutomationsExamplesInputFileDeleteErrors, ThrowOnError>({
|
|
267
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
268
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/input/{path}',
|
|
269
|
+
...options
|
|
270
|
+
});
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Download input file
|
|
274
|
+
*
|
|
275
|
+
* Download one file from an automation dataset example input folder.
|
|
276
|
+
*/
|
|
277
|
+
export const automationsExamplesInputFileGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesInputFileGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesInputFileGetResponses, AutomationsExamplesInputFileGetErrors, ThrowOnError>({
|
|
278
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
279
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/input/{path}',
|
|
280
|
+
...options
|
|
281
|
+
});
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Rename input file
|
|
285
|
+
*
|
|
286
|
+
* Rename one input file attached to an automation dataset example. The parent folder is preserved.
|
|
287
|
+
*/
|
|
288
|
+
export const automationsExamplesInputFileUpdate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesInputFileUpdateData, ThrowOnError>) => (options.client ?? client).patch<AutomationsExamplesInputFileUpdateResponses, AutomationsExamplesInputFileUpdateErrors, ThrowOnError>({
|
|
289
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
290
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/input/{path}',
|
|
291
|
+
...options,
|
|
292
|
+
headers: {
|
|
293
|
+
'Content-Type': 'application/json',
|
|
294
|
+
...options.headers
|
|
295
|
+
}
|
|
296
|
+
});
|
|
297
|
+
|
|
298
|
+
/**
|
|
299
|
+
* Run dataset example
|
|
300
|
+
*
|
|
301
|
+
* Start an asynchronous run using the input from one dataset example. Poll `GET /api/v1/runs/{id}` for completion and use run scores or feedback endpoints to review the result.
|
|
302
|
+
*/
|
|
303
|
+
export const automationsExamplesRun = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesRunData, ThrowOnError>) => (options.client ?? client).post<AutomationsExamplesRunResponses, AutomationsExamplesRunErrors, ThrowOnError>({
|
|
304
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
305
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/run',
|
|
306
|
+
...options
|
|
307
|
+
});
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* List experiments
|
|
311
|
+
*
|
|
312
|
+
* List experiment batches for one automation. Each experiment runs selected dataset examples and records automated evaluator scores.
|
|
141
313
|
*/
|
|
142
314
|
export const automationsExperimentsList = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsListData, ThrowOnError>) => (options.client ?? client).get<AutomationsExperimentsListResponses, AutomationsExperimentsListErrors, ThrowOnError>({
|
|
143
315
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -146,7 +318,9 @@ export const automationsExperimentsList = <ThrowOnError extends boolean = false>
|
|
|
146
318
|
});
|
|
147
319
|
|
|
148
320
|
/**
|
|
149
|
-
* Create
|
|
321
|
+
* Create experiment
|
|
322
|
+
*
|
|
323
|
+
* Start an asynchronous experiment batch for one automation. Omit `examples` to run the full dataset, or pass specific example ids to run a subset.
|
|
150
324
|
*/
|
|
151
325
|
export const automationsExperimentsCreate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsCreateData, ThrowOnError>) => (options.client ?? client).post<AutomationsExperimentsCreateResponses, AutomationsExperimentsCreateErrors, ThrowOnError>({
|
|
152
326
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -159,7 +333,20 @@ export const automationsExperimentsCreate = <ThrowOnError extends boolean = fals
|
|
|
159
333
|
});
|
|
160
334
|
|
|
161
335
|
/**
|
|
162
|
-
*
|
|
336
|
+
* Get experiment
|
|
337
|
+
*
|
|
338
|
+
* Fetch one experiment batch with its run summaries and evaluator results grouped by run id.
|
|
339
|
+
*/
|
|
340
|
+
export const automationsExperimentsGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsExperimentsGetResponses, AutomationsExperimentsGetErrors, ThrowOnError>({
|
|
341
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
342
|
+
url: '/api/v1/automations/{id}/experiments/{experimentId}',
|
|
343
|
+
...options
|
|
344
|
+
});
|
|
345
|
+
|
|
346
|
+
/**
|
|
347
|
+
* Cancel experiment
|
|
348
|
+
*
|
|
349
|
+
* Request cancellation for an experiment batch. Already-completed runs remain recorded; queued or running work is cancelled when possible.
|
|
163
350
|
*/
|
|
164
351
|
export const automationsExperimentsCancel = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsCancelData, ThrowOnError>) => (options.client ?? client).post<AutomationsExperimentsCancelResponses, AutomationsExperimentsCancelErrors, ThrowOnError>({
|
|
165
352
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -168,22 +355,50 @@ export const automationsExperimentsCancel = <ThrowOnError extends boolean = fals
|
|
|
168
355
|
});
|
|
169
356
|
|
|
170
357
|
/**
|
|
171
|
-
*
|
|
358
|
+
* Export experiment eval results
|
|
359
|
+
*
|
|
360
|
+
* Download eval result rows for a single experiment batch as CSV or JSON.
|
|
172
361
|
*/
|
|
173
|
-
export const
|
|
362
|
+
export const automationsExperimentsExport = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsExportData, ThrowOnError>) => (options.client ?? client).get<AutomationsExperimentsExportResponses, AutomationsExperimentsExportErrors, ThrowOnError>({
|
|
174
363
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
175
|
-
url: '/api/v1/automations/{id}/experiments/{experimentId}',
|
|
364
|
+
url: '/api/v1/automations/{id}/experiments/{experimentId}/export',
|
|
176
365
|
...options
|
|
177
366
|
});
|
|
178
367
|
|
|
179
368
|
/**
|
|
180
|
-
*
|
|
369
|
+
* Export all experiment eval results
|
|
181
370
|
*
|
|
182
|
-
*
|
|
371
|
+
* Download every eval result row for an automation as CSV or JSON.
|
|
183
372
|
*/
|
|
184
|
-
export const
|
|
373
|
+
export const automationsExperimentsExportAll = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsExportAllData, ThrowOnError>) => (options.client ?? client).get<AutomationsExperimentsExportAllResponses, AutomationsExperimentsExportAllErrors, ThrowOnError>({
|
|
185
374
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
186
|
-
url: '/api/v1/automations/{id}',
|
|
375
|
+
url: '/api/v1/automations/{id}/experiments/export',
|
|
376
|
+
...options
|
|
377
|
+
});
|
|
378
|
+
|
|
379
|
+
/**
|
|
380
|
+
* Create automation experiment with NDJSON progress
|
|
381
|
+
*
|
|
382
|
+
* Starts a batch eval experiment for workflow or agent automations and streams per-run completion events as NDJSON.
|
|
383
|
+
*/
|
|
384
|
+
export const automationsExperimentsCreateStream = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsCreateStreamData, ThrowOnError>) => (options.client ?? client).post<AutomationsExperimentsCreateStreamResponses, AutomationsExperimentsCreateStreamErrors, ThrowOnError>({
|
|
385
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
386
|
+
url: '/api/v1/automations/{id}/experiments/stream',
|
|
387
|
+
...options,
|
|
388
|
+
headers: {
|
|
389
|
+
'Content-Type': 'application/json',
|
|
390
|
+
...options.headers
|
|
391
|
+
}
|
|
392
|
+
});
|
|
393
|
+
|
|
394
|
+
/**
|
|
395
|
+
* Sync automation from latest Git release
|
|
396
|
+
*
|
|
397
|
+
* Reconciles automation registry metadata and trigger projections from the latest Git source release. This operation is idempotent for unchanged source state: repeated calls against the same latest release leave the same automation registry state and may repeat the same warnings. Requires a Bearer API token for the organization and a user-backed API key. It does not publish source; it reads the already-published latest release manifest. Versioned targets are rejected with 400, missing organization/source/release/manifest state returns 404, invalid manifests return 400, and provider or persistence failures return 5xx.
|
|
398
|
+
*/
|
|
399
|
+
export const automationsSync = <ThrowOnError extends boolean = false>(options: Options<AutomationsSyncData, ThrowOnError>) => (options.client ?? client).post<AutomationsSyncResponses, AutomationsSyncErrors, ThrowOnError>({
|
|
400
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
401
|
+
url: '/api/v1/automations/{id}/sync',
|
|
187
402
|
...options
|
|
188
403
|
});
|
|
189
404
|
|
|
@@ -210,25 +425,30 @@ export const automationsVersionsList = <ThrowOnError extends boolean = false>(op
|
|
|
210
425
|
});
|
|
211
426
|
|
|
212
427
|
/**
|
|
213
|
-
*
|
|
428
|
+
* Resolve experiment by id
|
|
214
429
|
*
|
|
215
|
-
*
|
|
430
|
+
* Returns the owning automation for an experiment batch id. Used when callers only know the experiment id.
|
|
216
431
|
*/
|
|
217
|
-
export const
|
|
432
|
+
export const experimentsResolve = <ThrowOnError extends boolean = false>(options: Options<ExperimentsResolveData, ThrowOnError>) => (options.client ?? client).get<ExperimentsResolveResponses, ExperimentsResolveErrors, ThrowOnError>({
|
|
218
433
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
219
|
-
url: '/api/v1/
|
|
434
|
+
url: '/api/v1/experiments/{experimentId}',
|
|
220
435
|
...options
|
|
221
436
|
});
|
|
222
437
|
|
|
223
438
|
/**
|
|
224
|
-
*
|
|
439
|
+
* Upload file
|
|
225
440
|
*
|
|
226
|
-
*
|
|
441
|
+
* Upload a reusable file that can later be referenced by run inputs or dataset examples.
|
|
227
442
|
*/
|
|
228
|
-
export const
|
|
443
|
+
export const filesCreate = <ThrowOnError extends boolean = false>(options: Options<FilesCreateData, ThrowOnError>) => (options.client ?? client).post<FilesCreateResponses, FilesCreateErrors, ThrowOnError>({
|
|
444
|
+
...formDataBodySerializer,
|
|
229
445
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
230
|
-
url: '/api/v1/files
|
|
231
|
-
...options
|
|
446
|
+
url: '/api/v1/files',
|
|
447
|
+
...options,
|
|
448
|
+
headers: {
|
|
449
|
+
'Content-Type': null,
|
|
450
|
+
...options.headers
|
|
451
|
+
}
|
|
232
452
|
});
|
|
233
453
|
|
|
234
454
|
/**
|
|
@@ -254,19 +474,14 @@ export const filesGet = <ThrowOnError extends boolean = false>(options: Options<
|
|
|
254
474
|
});
|
|
255
475
|
|
|
256
476
|
/**
|
|
257
|
-
*
|
|
477
|
+
* Download file content
|
|
258
478
|
*
|
|
259
|
-
*
|
|
479
|
+
* Download bytes for a reusable uploaded file.
|
|
260
480
|
*/
|
|
261
|
-
export const
|
|
262
|
-
...formDataBodySerializer,
|
|
481
|
+
export const filesContentGet = <ThrowOnError extends boolean = false>(options: Options<FilesContentGetData, ThrowOnError>) => (options.client ?? client).get<FilesContentGetResponses, FilesContentGetErrors, ThrowOnError>({
|
|
263
482
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
264
|
-
url: '/api/v1/files',
|
|
265
|
-
...options
|
|
266
|
-
headers: {
|
|
267
|
-
'Content-Type': null,
|
|
268
|
-
...options.headers
|
|
269
|
-
}
|
|
483
|
+
url: '/api/v1/files/{id}/content',
|
|
484
|
+
...options
|
|
270
485
|
});
|
|
271
486
|
|
|
272
487
|
/**
|
|
@@ -296,20 +511,20 @@ export const runsStart = <ThrowOnError extends boolean = false>(options: Options
|
|
|
296
511
|
});
|
|
297
512
|
|
|
298
513
|
/**
|
|
299
|
-
*
|
|
514
|
+
* Get a run
|
|
300
515
|
*
|
|
301
|
-
*
|
|
516
|
+
* Fetch one run by id. By default this returns core metadata plus terminal output/error fields. Pass `?expand=input,usage,execution,debug` to include detailed sub-objects; `expand=execution` is also where embedded feedback and expected artifacts appear.
|
|
302
517
|
*/
|
|
303
|
-
export const
|
|
518
|
+
export const runsGet = <ThrowOnError extends boolean = false>(options: Options<RunsGetData, ThrowOnError>) => (options.client ?? client).get<RunsGetResponses, RunsGetErrors, ThrowOnError>({
|
|
304
519
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
305
|
-
url: '/api/v1/runs/{id}
|
|
520
|
+
url: '/api/v1/runs/{id}',
|
|
306
521
|
...options
|
|
307
522
|
});
|
|
308
523
|
|
|
309
524
|
/**
|
|
310
525
|
* List run artifacts
|
|
311
526
|
*
|
|
312
|
-
*
|
|
527
|
+
* Returns a JSON list of downloadable artifact paths for a run. Pass `zip=1` to switch the response to a ZIP download containing output files.
|
|
313
528
|
*/
|
|
314
529
|
export const runsArtifactsList = <ThrowOnError extends boolean = false>(options: Options<RunsArtifactsListData, ThrowOnError>) => (options.client ?? client).get<RunsArtifactsListResponses, RunsArtifactsListErrors, ThrowOnError>({
|
|
315
530
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -318,22 +533,24 @@ export const runsArtifactsList = <ThrowOnError extends boolean = false>(options:
|
|
|
318
533
|
});
|
|
319
534
|
|
|
320
535
|
/**
|
|
321
|
-
*
|
|
536
|
+
* Download run artifact
|
|
322
537
|
*
|
|
323
|
-
*
|
|
538
|
+
* Download one artifact by path.
|
|
324
539
|
*/
|
|
325
|
-
export const
|
|
540
|
+
export const runsArtifactsGet = <ThrowOnError extends boolean = false>(options: Options<RunsArtifactsGetData, ThrowOnError>) => (options.client ?? client).get<RunsArtifactsGetResponses, RunsArtifactsGetErrors, ThrowOnError>({
|
|
326
541
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
327
|
-
url: '/api/v1/runs/{id}/
|
|
542
|
+
url: '/api/v1/runs/{id}/artifacts/{path}',
|
|
328
543
|
...options
|
|
329
544
|
});
|
|
330
545
|
|
|
331
546
|
/**
|
|
332
|
-
*
|
|
547
|
+
* Cancel run
|
|
548
|
+
*
|
|
549
|
+
* Cancel a queued run or request cancellation of an in-flight run.
|
|
333
550
|
*/
|
|
334
|
-
export const
|
|
551
|
+
export const runsCancel = <ThrowOnError extends boolean = false>(options: Options<RunsCancelData, ThrowOnError>) => (options.client ?? client).post<RunsCancelResponses, RunsCancelErrors, ThrowOnError>({
|
|
335
552
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
336
|
-
url: '/api/v1/runs/{id}/
|
|
553
|
+
url: '/api/v1/runs/{id}/cancel',
|
|
337
554
|
...options
|
|
338
555
|
});
|
|
339
556
|
|
|
@@ -350,6 +567,8 @@ export const runsEventsList = <ThrowOnError extends boolean = false>(options: Op
|
|
|
350
567
|
|
|
351
568
|
/**
|
|
352
569
|
* Clear run feedback
|
|
570
|
+
*
|
|
571
|
+
* Deletes all feedback state for the run: human feedback, expected JSON output, and every expected artifact file.
|
|
353
572
|
*/
|
|
354
573
|
export const runsFeedbackClear = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackClearData, ThrowOnError>) => (options.client ?? client).delete<RunsFeedbackClearResponses, RunsFeedbackClearErrors, ThrowOnError>({
|
|
355
574
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -359,6 +578,8 @@ export const runsFeedbackClear = <ThrowOnError extends boolean = false>(options:
|
|
|
359
578
|
|
|
360
579
|
/**
|
|
361
580
|
* Get run feedback
|
|
581
|
+
*
|
|
582
|
+
* Returns the complete feedback state for one run, including the human feedback object, expected JSON output, and expected files. Use `GET /api/v1/runs/{id}` with `expand=execution` when you only need feedback embedded in a run response.
|
|
362
583
|
*/
|
|
363
584
|
export const runsFeedbackGet = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackGetData, ThrowOnError>) => (options.client ?? client).get<RunsFeedbackGetResponses, RunsFeedbackGetErrors, ThrowOnError>({
|
|
364
585
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -368,6 +589,8 @@ export const runsFeedbackGet = <ThrowOnError extends boolean = false>(options: O
|
|
|
368
589
|
|
|
369
590
|
/**
|
|
370
591
|
* Update run feedback
|
|
592
|
+
*
|
|
593
|
+
* Partially update human feedback and expected JSON output for a run. Omitted fields are left unchanged. Pass null to clear a field.
|
|
371
594
|
*/
|
|
372
595
|
export const runsFeedbackUpdate = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackUpdateData, ThrowOnError>) => (options.client ?? client).put<RunsFeedbackUpdateResponses, RunsFeedbackUpdateErrors, ThrowOnError>({
|
|
373
596
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -380,7 +603,73 @@ export const runsFeedbackUpdate = <ThrowOnError extends boolean = false>(options
|
|
|
380
603
|
});
|
|
381
604
|
|
|
382
605
|
/**
|
|
383
|
-
*
|
|
606
|
+
* Get expected output
|
|
607
|
+
*
|
|
608
|
+
* Returns the expected JSON output and expected files currently attached to the run feedback record.
|
|
609
|
+
*/
|
|
610
|
+
export const runsFeedbackExpectedGet = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackExpectedGetData, ThrowOnError>) => (options.client ?? client).get<RunsFeedbackExpectedGetResponses, RunsFeedbackExpectedGetErrors, ThrowOnError>({
|
|
611
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
612
|
+
url: '/api/v1/runs/{id}/feedback/expected',
|
|
613
|
+
...options
|
|
614
|
+
});
|
|
615
|
+
|
|
616
|
+
/**
|
|
617
|
+
* Add expected file
|
|
618
|
+
*
|
|
619
|
+
* Attach one expected file to run feedback. Send multipart/form-data with `file` and optional `name` to upload a local file, or JSON with `outputFileName` and optional `expectedName` to copy an existing run output file.
|
|
620
|
+
*/
|
|
621
|
+
export const runsFeedbackExpectedCreate = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackExpectedCreateData, ThrowOnError>) => (options.client ?? client).post<RunsFeedbackExpectedCreateResponses, RunsFeedbackExpectedCreateErrors, ThrowOnError>({
|
|
622
|
+
...((options.body && typeof options.body === 'object' && 'file' in options.body) ? formDataBodySerializer : {}),
|
|
623
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
624
|
+
url: '/api/v1/runs/{id}/feedback/expected',
|
|
625
|
+
...options,
|
|
626
|
+
headers: {
|
|
627
|
+
'Content-Type': (options.body && typeof options.body === 'object' && 'file' in options.body) ? null : 'application/json',
|
|
628
|
+
...options.headers
|
|
629
|
+
}
|
|
630
|
+
});
|
|
631
|
+
|
|
632
|
+
/**
|
|
633
|
+
* Delete expected artifact file
|
|
634
|
+
*
|
|
635
|
+
* Deletes one expected artifact file attached to the run feedback record. The feedback text and expected JSON output are left unchanged.
|
|
636
|
+
*/
|
|
637
|
+
export const runsFeedbackExpectedFileDelete = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackExpectedFileDeleteData, ThrowOnError>) => (options.client ?? client).delete<RunsFeedbackExpectedFileDeleteResponses, RunsFeedbackExpectedFileDeleteErrors, ThrowOnError>({
|
|
638
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
639
|
+
url: '/api/v1/runs/{id}/feedback/expected/{filename}',
|
|
640
|
+
...options
|
|
641
|
+
});
|
|
642
|
+
|
|
643
|
+
/**
|
|
644
|
+
* Download expected artifact file
|
|
645
|
+
*
|
|
646
|
+
* Downloads one expected artifact file attached to the run feedback record. Use the `filename` returned by the expected-output collection endpoint.
|
|
647
|
+
*/
|
|
648
|
+
export const runsFeedbackExpectedFileGet = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackExpectedFileGetData, ThrowOnError>) => (options.client ?? client).get<RunsFeedbackExpectedFileGetResponses, RunsFeedbackExpectedFileGetErrors, ThrowOnError>({
|
|
649
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
650
|
+
url: '/api/v1/runs/{id}/feedback/expected/{filename}',
|
|
651
|
+
...options
|
|
652
|
+
});
|
|
653
|
+
|
|
654
|
+
/**
|
|
655
|
+
* Rename expected artifact file
|
|
656
|
+
*
|
|
657
|
+
* Renames one expected artifact file attached to the run feedback record.
|
|
658
|
+
*/
|
|
659
|
+
export const runsFeedbackExpectedFileUpdate = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackExpectedFileUpdateData, ThrowOnError>) => (options.client ?? client).patch<RunsFeedbackExpectedFileUpdateResponses, RunsFeedbackExpectedFileUpdateErrors, ThrowOnError>({
|
|
660
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
661
|
+
url: '/api/v1/runs/{id}/feedback/expected/{filename}',
|
|
662
|
+
...options,
|
|
663
|
+
headers: {
|
|
664
|
+
'Content-Type': 'application/json',
|
|
665
|
+
...options.headers
|
|
666
|
+
}
|
|
667
|
+
});
|
|
668
|
+
|
|
669
|
+
/**
|
|
670
|
+
* Promote run to example
|
|
671
|
+
*
|
|
672
|
+
* Turn a reviewed run into a dataset example. The new example uses the run input, the run output, and any expected output/files stored through the feedback endpoints. Use this after adding feedback or expected artifacts to capture a regression test.
|
|
384
673
|
*/
|
|
385
674
|
export const runsPromote = <ThrowOnError extends boolean = false>(options: Options<RunsPromoteData, ThrowOnError>) => (options.client ?? client).post<RunsPromoteResponses, RunsPromoteErrors, ThrowOnError>({
|
|
386
675
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -393,9 +682,9 @@ export const runsPromote = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
393
682
|
});
|
|
394
683
|
|
|
395
684
|
/**
|
|
396
|
-
*
|
|
685
|
+
* Retry run
|
|
397
686
|
*
|
|
398
|
-
* Start a new run
|
|
687
|
+
* Start a new run using the source run input. By default the retry uses the latest automation version; pass `version=original` to pin the same source version as the original run.
|
|
399
688
|
*/
|
|
400
689
|
export const runsRerun = <ThrowOnError extends boolean = false>(options: Options<RunsRerunData, ThrowOnError>) => (options.client ?? client).post<RunsRerunResponses, RunsRerunErrors, ThrowOnError>({
|
|
401
690
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -404,13 +693,13 @@ export const runsRerun = <ThrowOnError extends boolean = false>(options: Options
|
|
|
404
693
|
});
|
|
405
694
|
|
|
406
695
|
/**
|
|
407
|
-
*
|
|
696
|
+
* List run evaluator scores
|
|
408
697
|
*
|
|
409
|
-
*
|
|
698
|
+
* List automated evaluator results for one run. Use `score` for evaluator output and `rating` on run feedback for human verdicts.
|
|
410
699
|
*/
|
|
411
|
-
export const
|
|
700
|
+
export const runsScoresList = <ThrowOnError extends boolean = false>(options: Options<RunsScoresListData, ThrowOnError>) => (options.client ?? client).get<RunsScoresListResponses, RunsScoresListErrors, ThrowOnError>({
|
|
412
701
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
413
|
-
url: '/api/v1/runs/{id}',
|
|
702
|
+
url: '/api/v1/runs/{id}/scores',
|
|
414
703
|
...options
|
|
415
704
|
});
|
|
416
705
|
|
|
@@ -427,6 +716,8 @@ export const runsStepsList = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
427
716
|
|
|
428
717
|
/**
|
|
429
718
|
* Get run trace
|
|
719
|
+
*
|
|
720
|
+
* Return low-level execution trace events for debugging one run. Workflow runs expose observability phases or step records; agent runs expose parsed trace.jsonl events. The shape is intentionally extensible, but common fields are documented.
|
|
430
721
|
*/
|
|
431
722
|
export const runsTraceGet = <ThrowOnError extends boolean = false>(options: Options<RunsTraceGetData, ThrowOnError>) => (options.client ?? client).get<RunsTraceGetResponses, RunsTraceGetErrors, ThrowOnError>({
|
|
432
723
|
security: [{ scheme: 'bearer', type: 'http' }],
|