@eigenpal/sdk 0.7.2 → 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 +74 -3
- package/README.md +56 -152
- package/package.json +2 -2
- package/src/client.ts +34 -19
- package/src/generated/index.ts +2 -2
- package/src/generated/sdk.gen.ts +365 -197
- package/src/generated/types.gen.ts +2665 -1115
- package/src/index.ts +24 -44
- package/src/lib/files.ts +9 -0
- package/src/resources/auth.ts +18 -0
- package/src/resources/automations.ts +342 -7
- package/src/resources/files.ts +51 -0
- package/src/resources/runs.ts +117 -413
- package/src/telemetry.ts +1 -1
- package/src/resources/agents.ts +0 -221
- package/src/resources/executions.ts +0 -142
- package/src/resources/source.ts +0 -101
- package/src/resources/workflows.ts +0 -82
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 {
|
|
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
|
/**
|
|
@@ -19,65 +19,84 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
19
19
|
};
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* Check API key identity
|
|
23
23
|
*
|
|
24
|
-
*
|
|
24
|
+
* Return the tenant, user, API key, and scope represented by the current API key.
|
|
25
25
|
*/
|
|
26
|
-
export const
|
|
26
|
+
export const authCheck = <ThrowOnError extends boolean = false>(options?: Options<AuthCheckData, ThrowOnError>) => (options?.client ?? client).get<AuthCheckResponses, AuthCheckErrors, ThrowOnError>({
|
|
27
27
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
28
|
-
url: '/api/v1/
|
|
28
|
+
url: '/api/v1/auth/check',
|
|
29
29
|
...options
|
|
30
30
|
});
|
|
31
31
|
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* List automations
|
|
34
34
|
*
|
|
35
|
-
*
|
|
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
36
|
*/
|
|
37
|
-
export const
|
|
37
|
+
export const automationsList = <ThrowOnError extends boolean = false>(options?: Options<AutomationsListData, ThrowOnError>) => (options?.client ?? client).get<AutomationsListResponses, AutomationsListErrors, ThrowOnError>({
|
|
38
38
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
39
|
-
url: '/api/v1/
|
|
40
|
-
...options
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
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
|
+
|
|
54
|
+
/**
|
|
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.
|
|
58
|
+
*/
|
|
59
|
+
export const automationsDatasetExport = <ThrowOnError extends boolean = false>(options: Options<AutomationsDatasetExportData, ThrowOnError>) => (options.client ?? client).get<AutomationsDatasetExportResponses, AutomationsDatasetExportErrors, ThrowOnError>({
|
|
60
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
61
|
+
url: '/api/v1/automations/{id}/dataset/export',
|
|
62
|
+
...options
|
|
45
63
|
});
|
|
46
64
|
|
|
47
65
|
/**
|
|
48
|
-
*
|
|
66
|
+
* Import automation dataset
|
|
49
67
|
*
|
|
50
|
-
*
|
|
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.
|
|
51
69
|
*/
|
|
52
|
-
export const
|
|
70
|
+
export const automationsDatasetImport = <ThrowOnError extends boolean = false>(options: Options<AutomationsDatasetImportData, ThrowOnError>) => (options.client ?? client).post<AutomationsDatasetImportResponses, AutomationsDatasetImportErrors, ThrowOnError>({
|
|
71
|
+
...formDataBodySerializer,
|
|
53
72
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
54
|
-
url: '/api/v1/
|
|
73
|
+
url: '/api/v1/automations/{id}/dataset/import',
|
|
55
74
|
...options,
|
|
56
75
|
headers: {
|
|
57
|
-
'Content-Type':
|
|
76
|
+
'Content-Type': null,
|
|
58
77
|
...options.headers
|
|
59
78
|
}
|
|
60
79
|
});
|
|
61
80
|
|
|
62
81
|
/**
|
|
63
|
-
* Get
|
|
82
|
+
* Get evaluators
|
|
64
83
|
*
|
|
65
|
-
*
|
|
84
|
+
* Fetch the evaluator configuration for an automation. Evaluators produce automated `score` results, which are separate from human feedback `rating` values.
|
|
66
85
|
*/
|
|
67
|
-
export const
|
|
86
|
+
export const automationsEvaluatorsGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsEvaluatorsGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsEvaluatorsGetResponses, AutomationsEvaluatorsGetErrors, ThrowOnError>({
|
|
68
87
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
69
|
-
url: '/api/v1/
|
|
88
|
+
url: '/api/v1/automations/{id}/evaluators',
|
|
70
89
|
...options
|
|
71
90
|
});
|
|
72
91
|
|
|
73
92
|
/**
|
|
74
|
-
*
|
|
93
|
+
* Replace evaluators
|
|
75
94
|
*
|
|
76
|
-
*
|
|
95
|
+
* Replace the evaluator YAML for an automation. The submitted YAML is validated before it becomes the source for future experiment scores.
|
|
77
96
|
*/
|
|
78
|
-
export const
|
|
97
|
+
export const automationsEvaluatorsUpdate = <ThrowOnError extends boolean = false>(options: Options<AutomationsEvaluatorsUpdateData, ThrowOnError>) => (options.client ?? client).put<AutomationsEvaluatorsUpdateResponses, AutomationsEvaluatorsUpdateErrors, ThrowOnError>({
|
|
79
98
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
80
|
-
url: '/api/v1/
|
|
99
|
+
url: '/api/v1/automations/{id}/evaluators',
|
|
81
100
|
...options,
|
|
82
101
|
headers: {
|
|
83
102
|
'Content-Type': 'application/json',
|
|
@@ -86,24 +105,24 @@ export const agentsUpdate = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
86
105
|
});
|
|
87
106
|
|
|
88
107
|
/**
|
|
89
|
-
*
|
|
108
|
+
* List dataset examples
|
|
90
109
|
*
|
|
91
|
-
*
|
|
110
|
+
* List dataset examples for one automation. Examples contain input, expected output, expected files, metadata, and optional overrides used by evaluation runs.
|
|
92
111
|
*/
|
|
93
|
-
export const
|
|
112
|
+
export const automationsExamplesList = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesListData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesListResponses, AutomationsExamplesListErrors, ThrowOnError>({
|
|
94
113
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
95
|
-
url: '/api/v1/
|
|
114
|
+
url: '/api/v1/automations/{id}/examples',
|
|
96
115
|
...options
|
|
97
116
|
});
|
|
98
117
|
|
|
99
118
|
/**
|
|
100
|
-
*
|
|
119
|
+
* Create dataset example
|
|
101
120
|
*
|
|
102
|
-
*
|
|
121
|
+
* Create one dataset example from JSON fields. Use dataset import for archive-based uploads and file-bearing examples.
|
|
103
122
|
*/
|
|
104
|
-
export const
|
|
123
|
+
export const automationsExamplesCreate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesCreateData, ThrowOnError>) => (options.client ?? client).post<AutomationsExamplesCreateResponses, AutomationsExamplesCreateErrors, ThrowOnError>({
|
|
105
124
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
106
|
-
url: '/api/v1/
|
|
125
|
+
url: '/api/v1/automations/{id}/examples',
|
|
107
126
|
...options,
|
|
108
127
|
headers: {
|
|
109
128
|
'Content-Type': 'application/json',
|
|
@@ -112,24 +131,35 @@ export const agentsTriggersEmailUpdateAlias = <ThrowOnError extends boolean = fa
|
|
|
112
131
|
});
|
|
113
132
|
|
|
114
133
|
/**
|
|
115
|
-
*
|
|
134
|
+
* Delete dataset example
|
|
135
|
+
*
|
|
136
|
+
* Delete one dataset example from the automation dataset. This removes the example from future experiments.
|
|
137
|
+
*/
|
|
138
|
+
export const automationsExamplesDelete = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesDeleteData, ThrowOnError>) => (options.client ?? client).delete<AutomationsExamplesDeleteResponses, AutomationsExamplesDeleteErrors, ThrowOnError>({
|
|
139
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
140
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}',
|
|
141
|
+
...options
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* Get dataset example
|
|
116
146
|
*
|
|
117
|
-
*
|
|
147
|
+
* Fetch one dataset example, including input, expected output, expected files, metadata, and overrides.
|
|
118
148
|
*/
|
|
119
|
-
export const
|
|
149
|
+
export const automationsExamplesGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesGetResponses, AutomationsExamplesGetErrors, ThrowOnError>({
|
|
120
150
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
121
|
-
url: '/api/v1/
|
|
151
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}',
|
|
122
152
|
...options
|
|
123
153
|
});
|
|
124
154
|
|
|
125
155
|
/**
|
|
126
|
-
* Update
|
|
156
|
+
* Update dataset example
|
|
127
157
|
*
|
|
128
|
-
*
|
|
158
|
+
* Partially update a dataset example. Omitted fields are preserved; pass null for nullable fields to clear them.
|
|
129
159
|
*/
|
|
130
|
-
export const
|
|
160
|
+
export const automationsExamplesUpdate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesUpdateData, ThrowOnError>) => (options.client ?? client).patch<AutomationsExamplesUpdateResponses, AutomationsExamplesUpdateErrors, ThrowOnError>({
|
|
131
161
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
132
|
-
url: '/api/v1/
|
|
162
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}',
|
|
133
163
|
...options,
|
|
134
164
|
headers: {
|
|
135
165
|
'Content-Type': 'application/json',
|
|
@@ -138,50 +168,62 @@ export const agentsTriggersEmailUpdate = <ThrowOnError extends boolean = false>(
|
|
|
138
168
|
});
|
|
139
169
|
|
|
140
170
|
/**
|
|
141
|
-
*
|
|
171
|
+
* List expected files
|
|
172
|
+
*
|
|
173
|
+
* List files stored under the expected folder for one automation dataset example.
|
|
174
|
+
*/
|
|
175
|
+
export const automationsExamplesExpectedFilesList = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesExpectedFilesListData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesExpectedFilesListResponses, AutomationsExamplesExpectedFilesListErrors, ThrowOnError>({
|
|
176
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
177
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/expected',
|
|
178
|
+
...options
|
|
179
|
+
});
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* Upload expected files
|
|
142
183
|
*
|
|
143
|
-
*
|
|
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.
|
|
144
185
|
*/
|
|
145
|
-
export const
|
|
186
|
+
export const automationsExamplesExpectedFilesCreate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesExpectedFilesCreateData, ThrowOnError>) => (options.client ?? client).post<AutomationsExamplesExpectedFilesCreateResponses, AutomationsExamplesExpectedFilesCreateErrors, ThrowOnError>({
|
|
187
|
+
...formDataBodySerializer,
|
|
146
188
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
147
|
-
url: '/api/v1/
|
|
189
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/expected',
|
|
148
190
|
...options,
|
|
149
191
|
headers: {
|
|
150
|
-
'Content-Type':
|
|
192
|
+
'Content-Type': null,
|
|
151
193
|
...options.headers
|
|
152
194
|
}
|
|
153
195
|
});
|
|
154
196
|
|
|
155
197
|
/**
|
|
156
|
-
*
|
|
198
|
+
* Delete expected file
|
|
157
199
|
*
|
|
158
|
-
*
|
|
200
|
+
* Delete one file from an automation dataset example expected folder.
|
|
159
201
|
*/
|
|
160
|
-
export const
|
|
202
|
+
export const automationsExamplesExpectedFileDelete = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesExpectedFileDeleteData, ThrowOnError>) => (options.client ?? client).delete<AutomationsExamplesExpectedFileDeleteResponses, AutomationsExamplesExpectedFileDeleteErrors, ThrowOnError>({
|
|
161
203
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
162
|
-
url: '/api/v1/
|
|
204
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/expected/{path}',
|
|
163
205
|
...options
|
|
164
206
|
});
|
|
165
207
|
|
|
166
208
|
/**
|
|
167
|
-
*
|
|
209
|
+
* Download expected dataset file
|
|
168
210
|
*
|
|
169
|
-
*
|
|
211
|
+
* Download one expected file attached to an automation dataset example.
|
|
170
212
|
*/
|
|
171
|
-
export const
|
|
213
|
+
export const automationsExamplesExpectedFileGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesExpectedFileGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesExpectedFileGetResponses, AutomationsExamplesExpectedFileGetErrors, ThrowOnError>({
|
|
172
214
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
173
|
-
url: '/api/v1/
|
|
215
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/expected/{path}',
|
|
174
216
|
...options
|
|
175
217
|
});
|
|
176
218
|
|
|
177
219
|
/**
|
|
178
|
-
*
|
|
220
|
+
* Rename expected file
|
|
179
221
|
*
|
|
180
|
-
*
|
|
222
|
+
* Rename one expected file attached to an automation dataset example. The parent folder is preserved.
|
|
181
223
|
*/
|
|
182
|
-
export const
|
|
224
|
+
export const automationsExamplesExpectedFileUpdate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesExpectedFileUpdateData, ThrowOnError>) => (options.client ?? client).patch<AutomationsExamplesExpectedFileUpdateResponses, AutomationsExamplesExpectedFileUpdateErrors, ThrowOnError>({
|
|
183
225
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
184
|
-
url: '/api/v1/
|
|
226
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/expected/{path}',
|
|
185
227
|
...options,
|
|
186
228
|
headers: {
|
|
187
229
|
'Content-Type': 'application/json',
|
|
@@ -190,46 +232,62 @@ export const agentsCreate = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
190
232
|
});
|
|
191
233
|
|
|
192
234
|
/**
|
|
193
|
-
* List
|
|
235
|
+
* List input files
|
|
194
236
|
*
|
|
195
|
-
*
|
|
237
|
+
* List files stored under the input folder for one automation dataset example.
|
|
196
238
|
*/
|
|
197
|
-
export const
|
|
239
|
+
export const automationsExamplesInputFilesList = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesInputFilesListData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesInputFilesListResponses, AutomationsExamplesInputFilesListErrors, ThrowOnError>({
|
|
198
240
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
199
|
-
url: '/api/v1/
|
|
241
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/input',
|
|
200
242
|
...options
|
|
201
243
|
});
|
|
202
244
|
|
|
203
245
|
/**
|
|
204
|
-
*
|
|
246
|
+
* Upload input files
|
|
205
247
|
*
|
|
206
|
-
*
|
|
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.
|
|
207
249
|
*/
|
|
208
|
-
export const
|
|
250
|
+
export const automationsExamplesInputFilesCreate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesInputFilesCreateData, ThrowOnError>) => (options.client ?? client).post<AutomationsExamplesInputFilesCreateResponses, AutomationsExamplesInputFilesCreateErrors, ThrowOnError>({
|
|
251
|
+
...formDataBodySerializer,
|
|
209
252
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
210
|
-
url: '/api/v1/automations/{
|
|
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}',
|
|
211
269
|
...options
|
|
212
270
|
});
|
|
213
271
|
|
|
214
272
|
/**
|
|
215
|
-
*
|
|
273
|
+
* Download input file
|
|
216
274
|
*
|
|
217
|
-
*
|
|
275
|
+
* Download one file from an automation dataset example input folder.
|
|
218
276
|
*/
|
|
219
|
-
export const
|
|
277
|
+
export const automationsExamplesInputFileGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesInputFileGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsExamplesInputFileGetResponses, AutomationsExamplesInputFileGetErrors, ThrowOnError>({
|
|
220
278
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
221
|
-
url: '/api/v1/
|
|
279
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/input/{path}',
|
|
222
280
|
...options
|
|
223
281
|
});
|
|
224
282
|
|
|
225
283
|
/**
|
|
226
|
-
*
|
|
284
|
+
* Rename input file
|
|
227
285
|
*
|
|
228
|
-
*
|
|
286
|
+
* Rename one input file attached to an automation dataset example. The parent folder is preserved.
|
|
229
287
|
*/
|
|
230
|
-
export const
|
|
288
|
+
export const automationsExamplesInputFileUpdate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesInputFileUpdateData, ThrowOnError>) => (options.client ?? client).patch<AutomationsExamplesInputFileUpdateResponses, AutomationsExamplesInputFileUpdateErrors, ThrowOnError>({
|
|
231
289
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
232
|
-
url: '/api/v1/
|
|
290
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/input/{path}',
|
|
233
291
|
...options,
|
|
234
292
|
headers: {
|
|
235
293
|
'Content-Type': 'application/json',
|
|
@@ -238,144 +296,213 @@ export const runsStart = <ThrowOnError extends boolean = false>(options: Options
|
|
|
238
296
|
});
|
|
239
297
|
|
|
240
298
|
/**
|
|
241
|
-
*
|
|
299
|
+
* Run dataset example
|
|
242
300
|
*
|
|
243
|
-
*
|
|
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.
|
|
244
302
|
*/
|
|
245
|
-
export const
|
|
303
|
+
export const automationsExamplesRun = <ThrowOnError extends boolean = false>(options: Options<AutomationsExamplesRunData, ThrowOnError>) => (options.client ?? client).post<AutomationsExamplesRunResponses, AutomationsExamplesRunErrors, ThrowOnError>({
|
|
246
304
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
247
|
-
url: '/api/v1/
|
|
305
|
+
url: '/api/v1/automations/{id}/examples/{exampleId}/run',
|
|
248
306
|
...options
|
|
249
307
|
});
|
|
250
308
|
|
|
251
309
|
/**
|
|
252
|
-
* List
|
|
310
|
+
* List experiments
|
|
253
311
|
*
|
|
254
|
-
* List
|
|
312
|
+
* List experiment batches for one automation. Each experiment runs selected dataset examples and records automated evaluator scores.
|
|
255
313
|
*/
|
|
256
|
-
export const
|
|
314
|
+
export const automationsExperimentsList = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsListData, ThrowOnError>) => (options.client ?? client).get<AutomationsExperimentsListResponses, AutomationsExperimentsListErrors, ThrowOnError>({
|
|
257
315
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
258
|
-
url: '/api/v1/
|
|
316
|
+
url: '/api/v1/automations/{id}/experiments',
|
|
259
317
|
...options
|
|
260
318
|
});
|
|
261
319
|
|
|
262
320
|
/**
|
|
263
|
-
*
|
|
321
|
+
* Create experiment
|
|
264
322
|
*
|
|
265
|
-
*
|
|
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.
|
|
266
324
|
*/
|
|
267
|
-
export const
|
|
325
|
+
export const automationsExperimentsCreate = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsCreateData, ThrowOnError>) => (options.client ?? client).post<AutomationsExperimentsCreateResponses, AutomationsExperimentsCreateErrors, ThrowOnError>({
|
|
268
326
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
269
|
-
url: '/api/v1/
|
|
327
|
+
url: '/api/v1/automations/{id}/experiments',
|
|
328
|
+
...options,
|
|
329
|
+
headers: {
|
|
330
|
+
'Content-Type': 'application/json',
|
|
331
|
+
...options.headers
|
|
332
|
+
}
|
|
333
|
+
});
|
|
334
|
+
|
|
335
|
+
/**
|
|
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}',
|
|
270
343
|
...options
|
|
271
344
|
});
|
|
272
345
|
|
|
273
346
|
/**
|
|
274
|
-
*
|
|
347
|
+
* Cancel experiment
|
|
348
|
+
*
|
|
349
|
+
* Request cancellation for an experiment batch. Already-completed runs remain recorded; queued or running work is cancelled when possible.
|
|
275
350
|
*/
|
|
276
|
-
export const
|
|
351
|
+
export const automationsExperimentsCancel = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsCancelData, ThrowOnError>) => (options.client ?? client).post<AutomationsExperimentsCancelResponses, AutomationsExperimentsCancelErrors, ThrowOnError>({
|
|
277
352
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
278
|
-
url: '/api/v1/
|
|
353
|
+
url: '/api/v1/automations/{id}/experiments/{experimentId}/cancel',
|
|
279
354
|
...options
|
|
280
355
|
});
|
|
281
356
|
|
|
282
357
|
/**
|
|
283
|
-
*
|
|
358
|
+
* Export experiment eval results
|
|
359
|
+
*
|
|
360
|
+
* Download eval result rows for a single experiment batch as CSV or JSON.
|
|
284
361
|
*/
|
|
285
|
-
export const
|
|
362
|
+
export const automationsExperimentsExport = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsExportData, ThrowOnError>) => (options.client ?? client).get<AutomationsExperimentsExportResponses, AutomationsExperimentsExportErrors, ThrowOnError>({
|
|
286
363
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
287
|
-
url: '/api/v1/
|
|
364
|
+
url: '/api/v1/automations/{id}/experiments/{experimentId}/export',
|
|
288
365
|
...options
|
|
289
366
|
});
|
|
290
367
|
|
|
291
368
|
/**
|
|
292
|
-
*
|
|
369
|
+
* Export all experiment eval results
|
|
293
370
|
*
|
|
294
|
-
*
|
|
371
|
+
* Download every eval result row for an automation as CSV or JSON.
|
|
295
372
|
*/
|
|
296
|
-
export const
|
|
373
|
+
export const automationsExperimentsExportAll = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsExportAllData, ThrowOnError>) => (options.client ?? client).get<AutomationsExperimentsExportAllResponses, AutomationsExperimentsExportAllErrors, ThrowOnError>({
|
|
297
374
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
298
|
-
url: '/api/v1/
|
|
375
|
+
url: '/api/v1/automations/{id}/experiments/export',
|
|
299
376
|
...options
|
|
300
377
|
});
|
|
301
378
|
|
|
302
379
|
/**
|
|
303
|
-
*
|
|
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.
|
|
304
383
|
*/
|
|
305
|
-
export const
|
|
384
|
+
export const automationsExperimentsCreateStream = <ThrowOnError extends boolean = false>(options: Options<AutomationsExperimentsCreateStreamData, ThrowOnError>) => (options.client ?? client).post<AutomationsExperimentsCreateStreamResponses, AutomationsExperimentsCreateStreamErrors, ThrowOnError>({
|
|
306
385
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
307
|
-
url: '/api/v1/
|
|
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',
|
|
308
402
|
...options
|
|
309
403
|
});
|
|
310
404
|
|
|
311
405
|
/**
|
|
312
|
-
*
|
|
406
|
+
* Get automation triggers
|
|
407
|
+
*
|
|
408
|
+
* Read trigger state for a workflow or agent automation. Trigger mutation is not public v1.
|
|
313
409
|
*/
|
|
314
|
-
export const
|
|
410
|
+
export const automationsTriggersGet = <ThrowOnError extends boolean = false>(options: Options<AutomationsTriggersGetData, ThrowOnError>) => (options.client ?? client).get<AutomationsTriggersGetResponses, AutomationsTriggersGetErrors, ThrowOnError>({
|
|
315
411
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
316
|
-
url: '/api/v1/
|
|
412
|
+
url: '/api/v1/automations/{id}/triggers',
|
|
317
413
|
...options
|
|
318
414
|
});
|
|
319
415
|
|
|
320
416
|
/**
|
|
321
|
-
*
|
|
417
|
+
* List automation versions
|
|
418
|
+
*
|
|
419
|
+
* List versions for a workflow or agent automation through one read-only route.
|
|
322
420
|
*/
|
|
323
|
-
export const
|
|
421
|
+
export const automationsVersionsList = <ThrowOnError extends boolean = false>(options: Options<AutomationsVersionsListData, ThrowOnError>) => (options.client ?? client).get<AutomationsVersionsListResponses, AutomationsVersionsListErrors, ThrowOnError>({
|
|
324
422
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
325
|
-
url: '/api/v1/
|
|
326
|
-
...options
|
|
327
|
-
headers: {
|
|
328
|
-
'Content-Type': 'application/json',
|
|
329
|
-
...options.headers
|
|
330
|
-
}
|
|
423
|
+
url: '/api/v1/automations/{id}/versions',
|
|
424
|
+
...options
|
|
331
425
|
});
|
|
332
426
|
|
|
333
427
|
/**
|
|
334
|
-
*
|
|
428
|
+
* Resolve experiment by id
|
|
429
|
+
*
|
|
430
|
+
* Returns the owning automation for an experiment batch id. Used when callers only know the experiment id.
|
|
335
431
|
*/
|
|
336
|
-
export const
|
|
432
|
+
export const experimentsResolve = <ThrowOnError extends boolean = false>(options: Options<ExperimentsResolveData, ThrowOnError>) => (options.client ?? client).get<ExperimentsResolveResponses, ExperimentsResolveErrors, ThrowOnError>({
|
|
337
433
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
338
|
-
url: '/api/v1/
|
|
434
|
+
url: '/api/v1/experiments/{experimentId}',
|
|
339
435
|
...options
|
|
340
436
|
});
|
|
341
437
|
|
|
342
438
|
/**
|
|
343
|
-
*
|
|
439
|
+
* Upload file
|
|
440
|
+
*
|
|
441
|
+
* Upload a reusable file that can later be referenced by run inputs or dataset examples.
|
|
344
442
|
*/
|
|
345
|
-
export const
|
|
443
|
+
export const filesCreate = <ThrowOnError extends boolean = false>(options: Options<FilesCreateData, ThrowOnError>) => (options.client ?? client).post<FilesCreateResponses, FilesCreateErrors, ThrowOnError>({
|
|
444
|
+
...formDataBodySerializer,
|
|
346
445
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
347
|
-
url: '/api/v1/
|
|
446
|
+
url: '/api/v1/files',
|
|
348
447
|
...options,
|
|
349
448
|
headers: {
|
|
350
|
-
'Content-Type':
|
|
449
|
+
'Content-Type': null,
|
|
351
450
|
...options.headers
|
|
352
451
|
}
|
|
353
452
|
});
|
|
354
453
|
|
|
355
454
|
/**
|
|
356
|
-
*
|
|
455
|
+
* Delete file
|
|
456
|
+
*
|
|
457
|
+
* Delete a reusable uploaded file. Historical run and dataset snapshots are separate artifacts.
|
|
357
458
|
*/
|
|
358
|
-
export const
|
|
459
|
+
export const filesDelete = <ThrowOnError extends boolean = false>(options: Options<FilesDeleteData, ThrowOnError>) => (options.client ?? client).delete<FilesDeleteResponses, FilesDeleteErrors, ThrowOnError>({
|
|
359
460
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
360
|
-
url: '/api/v1/
|
|
461
|
+
url: '/api/v1/files/{id}',
|
|
361
462
|
...options
|
|
362
463
|
});
|
|
363
464
|
|
|
364
465
|
/**
|
|
365
|
-
* Get
|
|
466
|
+
* Get file metadata
|
|
467
|
+
*
|
|
468
|
+
* Get metadata for a reusable uploaded file.
|
|
366
469
|
*/
|
|
367
|
-
export const
|
|
470
|
+
export const filesGet = <ThrowOnError extends boolean = false>(options: Options<FilesGetData, ThrowOnError>) => (options.client ?? client).get<FilesGetResponses, FilesGetErrors, ThrowOnError>({
|
|
368
471
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
369
|
-
url: '/api/v1/
|
|
472
|
+
url: '/api/v1/files/{id}',
|
|
370
473
|
...options
|
|
371
474
|
});
|
|
372
475
|
|
|
373
476
|
/**
|
|
374
|
-
*
|
|
477
|
+
* Download file content
|
|
478
|
+
*
|
|
479
|
+
* Download bytes for a reusable uploaded file.
|
|
375
480
|
*/
|
|
376
|
-
export const
|
|
481
|
+
export const filesContentGet = <ThrowOnError extends boolean = false>(options: Options<FilesContentGetData, ThrowOnError>) => (options.client ?? client).get<FilesContentGetResponses, FilesContentGetErrors, ThrowOnError>({
|
|
377
482
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
378
|
-
url: '/api/v1/
|
|
483
|
+
url: '/api/v1/files/{id}/content',
|
|
484
|
+
...options
|
|
485
|
+
});
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* List runs
|
|
489
|
+
*
|
|
490
|
+
* List workflow and agent runs with cursor pagination.
|
|
491
|
+
*/
|
|
492
|
+
export const runsList = <ThrowOnError extends boolean = false>(options?: Options<RunsListData, ThrowOnError>) => (options?.client ?? client).get<RunsListResponses, RunsListErrors, ThrowOnError>({
|
|
493
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
494
|
+
url: '/api/v1/runs',
|
|
495
|
+
...options
|
|
496
|
+
});
|
|
497
|
+
|
|
498
|
+
/**
|
|
499
|
+
* Start a run
|
|
500
|
+
*
|
|
501
|
+
* Start a run. Send JSON or multipart/form-data.
|
|
502
|
+
*/
|
|
503
|
+
export const runsStart = <ThrowOnError extends boolean = false>(options: Options<RunsStartData, ThrowOnError>) => (options.client ?? client).post<RunsStartResponses, RunsStartErrors, ThrowOnError>({
|
|
504
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
505
|
+
url: '/api/v1/runs',
|
|
379
506
|
...options,
|
|
380
507
|
headers: {
|
|
381
508
|
'Content-Type': 'application/json',
|
|
@@ -384,135 +511,154 @@ export const runsFeedbackUpdate = <ThrowOnError extends boolean = false>(options
|
|
|
384
511
|
});
|
|
385
512
|
|
|
386
513
|
/**
|
|
387
|
-
*
|
|
514
|
+
* Get a run
|
|
388
515
|
*
|
|
389
|
-
*
|
|
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.
|
|
390
517
|
*/
|
|
391
|
-
export const
|
|
518
|
+
export const runsGet = <ThrowOnError extends boolean = false>(options: Options<RunsGetData, ThrowOnError>) => (options.client ?? client).get<RunsGetResponses, RunsGetErrors, ThrowOnError>({
|
|
392
519
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
393
|
-
url: '/api/v1/runs/{id}
|
|
520
|
+
url: '/api/v1/runs/{id}',
|
|
394
521
|
...options
|
|
395
522
|
});
|
|
396
523
|
|
|
397
524
|
/**
|
|
398
|
-
*
|
|
525
|
+
* List run artifacts
|
|
526
|
+
*
|
|
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.
|
|
399
528
|
*/
|
|
400
|
-
export const
|
|
529
|
+
export const runsArtifactsList = <ThrowOnError extends boolean = false>(options: Options<RunsArtifactsListData, ThrowOnError>) => (options.client ?? client).get<RunsArtifactsListResponses, RunsArtifactsListErrors, ThrowOnError>({
|
|
401
530
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
402
|
-
url: '/api/v1/runs/{id}/
|
|
531
|
+
url: '/api/v1/runs/{id}/artifacts',
|
|
403
532
|
...options
|
|
404
533
|
});
|
|
405
534
|
|
|
406
535
|
/**
|
|
407
|
-
*
|
|
536
|
+
* Download run artifact
|
|
408
537
|
*
|
|
409
|
-
*
|
|
538
|
+
* Download one artifact by path.
|
|
410
539
|
*/
|
|
411
|
-
export const
|
|
540
|
+
export const runsArtifactsGet = <ThrowOnError extends boolean = false>(options: Options<RunsArtifactsGetData, ThrowOnError>) => (options.client ?? client).get<RunsArtifactsGetResponses, RunsArtifactsGetErrors, ThrowOnError>({
|
|
412
541
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
413
|
-
url: '/api/v1/runs/{id}/
|
|
542
|
+
url: '/api/v1/runs/{id}/artifacts/{path}',
|
|
414
543
|
...options
|
|
415
544
|
});
|
|
416
545
|
|
|
417
546
|
/**
|
|
418
|
-
*
|
|
547
|
+
* Cancel run
|
|
419
548
|
*
|
|
420
|
-
*
|
|
549
|
+
* Cancel a queued run or request cancellation of an in-flight run.
|
|
421
550
|
*/
|
|
422
|
-
export const
|
|
423
|
-
...formDataBodySerializer,
|
|
551
|
+
export const runsCancel = <ThrowOnError extends boolean = false>(options: Options<RunsCancelData, ThrowOnError>) => (options.client ?? client).post<RunsCancelResponses, RunsCancelErrors, ThrowOnError>({
|
|
424
552
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
425
|
-
url: '/api/v1/runs/{id}/
|
|
426
|
-
...options
|
|
427
|
-
headers: {
|
|
428
|
-
'Content-Type': null,
|
|
429
|
-
...options.headers
|
|
430
|
-
}
|
|
553
|
+
url: '/api/v1/runs/{id}/cancel',
|
|
554
|
+
...options
|
|
431
555
|
});
|
|
432
556
|
|
|
433
557
|
/**
|
|
434
|
-
*
|
|
558
|
+
* List run events
|
|
435
559
|
*
|
|
436
|
-
*
|
|
560
|
+
* List a stable chronological lifecycle timeline for a run.
|
|
437
561
|
*/
|
|
438
|
-
export const
|
|
562
|
+
export const runsEventsList = <ThrowOnError extends boolean = false>(options: Options<RunsEventsListData, ThrowOnError>) => (options.client ?? client).get<RunsEventsListResponses, RunsEventsListErrors, ThrowOnError>({
|
|
439
563
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
440
|
-
url: '/api/v1/runs/{id}/
|
|
564
|
+
url: '/api/v1/runs/{id}/events',
|
|
441
565
|
...options
|
|
442
566
|
});
|
|
443
567
|
|
|
444
568
|
/**
|
|
445
|
-
*
|
|
569
|
+
* Clear run feedback
|
|
446
570
|
*
|
|
447
|
-
*
|
|
571
|
+
* Deletes all feedback state for the run: human feedback, expected JSON output, and every expected artifact file.
|
|
448
572
|
*/
|
|
449
|
-
export const
|
|
573
|
+
export const runsFeedbackClear = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackClearData, ThrowOnError>) => (options.client ?? client).delete<RunsFeedbackClearResponses, RunsFeedbackClearErrors, ThrowOnError>({
|
|
450
574
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
451
|
-
url: '/api/v1/runs/{id}',
|
|
575
|
+
url: '/api/v1/runs/{id}/feedback',
|
|
452
576
|
...options
|
|
453
577
|
});
|
|
454
578
|
|
|
455
579
|
/**
|
|
456
|
-
* Get run
|
|
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.
|
|
457
583
|
*/
|
|
458
|
-
export const
|
|
584
|
+
export const runsFeedbackGet = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackGetData, ThrowOnError>) => (options.client ?? client).get<RunsFeedbackGetResponses, RunsFeedbackGetErrors, ThrowOnError>({
|
|
459
585
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
460
|
-
url: '/api/v1/runs/{id}/
|
|
586
|
+
url: '/api/v1/runs/{id}/feedback',
|
|
461
587
|
...options
|
|
462
588
|
});
|
|
463
589
|
|
|
464
590
|
/**
|
|
465
|
-
*
|
|
591
|
+
* Update run feedback
|
|
466
592
|
*
|
|
467
|
-
*
|
|
593
|
+
* Partially update human feedback and expected JSON output for a run. Omitted fields are left unchanged. Pass null to clear a field.
|
|
468
594
|
*/
|
|
469
|
-
export const
|
|
595
|
+
export const runsFeedbackUpdate = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackUpdateData, ThrowOnError>) => (options.client ?? client).put<RunsFeedbackUpdateResponses, RunsFeedbackUpdateErrors, ThrowOnError>({
|
|
470
596
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
471
|
-
url: '/api/v1/
|
|
472
|
-
...options
|
|
597
|
+
url: '/api/v1/runs/{id}/feedback',
|
|
598
|
+
...options,
|
|
599
|
+
headers: {
|
|
600
|
+
'Content-Type': 'application/json',
|
|
601
|
+
...options.headers
|
|
602
|
+
}
|
|
473
603
|
});
|
|
474
604
|
|
|
475
605
|
/**
|
|
476
|
-
*
|
|
606
|
+
* Get expected output
|
|
477
607
|
*
|
|
478
|
-
*
|
|
608
|
+
* Returns the expected JSON output and expected files currently attached to the run feedback record.
|
|
479
609
|
*/
|
|
480
|
-
export const
|
|
610
|
+
export const runsFeedbackExpectedGet = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackExpectedGetData, ThrowOnError>) => (options.client ?? client).get<RunsFeedbackExpectedGetResponses, RunsFeedbackExpectedGetErrors, ThrowOnError>({
|
|
481
611
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
482
|
-
url: '/api/v1/
|
|
612
|
+
url: '/api/v1/runs/{id}/feedback/expected',
|
|
483
613
|
...options
|
|
484
614
|
});
|
|
485
615
|
|
|
486
616
|
/**
|
|
487
|
-
*
|
|
617
|
+
* Add expected file
|
|
488
618
|
*
|
|
489
|
-
*
|
|
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.
|
|
490
620
|
*/
|
|
491
|
-
export const
|
|
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 : {}),
|
|
492
623
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
493
|
-
url: '/api/v1/
|
|
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}',
|
|
494
640
|
...options
|
|
495
641
|
});
|
|
496
642
|
|
|
497
643
|
/**
|
|
498
|
-
*
|
|
644
|
+
* Download expected artifact file
|
|
499
645
|
*
|
|
500
|
-
*
|
|
646
|
+
* Downloads one expected artifact file attached to the run feedback record. Use the `filename` returned by the expected-output collection endpoint.
|
|
501
647
|
*/
|
|
502
|
-
export const
|
|
648
|
+
export const runsFeedbackExpectedFileGet = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackExpectedFileGetData, ThrowOnError>) => (options.client ?? client).get<RunsFeedbackExpectedFileGetResponses, RunsFeedbackExpectedFileGetErrors, ThrowOnError>({
|
|
503
649
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
504
|
-
url: '/api/v1/
|
|
650
|
+
url: '/api/v1/runs/{id}/feedback/expected/{filename}',
|
|
505
651
|
...options
|
|
506
652
|
});
|
|
507
653
|
|
|
508
654
|
/**
|
|
509
|
-
*
|
|
655
|
+
* Rename expected artifact file
|
|
510
656
|
*
|
|
511
|
-
*
|
|
657
|
+
* Renames one expected artifact file attached to the run feedback record.
|
|
512
658
|
*/
|
|
513
|
-
export const
|
|
659
|
+
export const runsFeedbackExpectedFileUpdate = <ThrowOnError extends boolean = false>(options: Options<RunsFeedbackExpectedFileUpdateData, ThrowOnError>) => (options.client ?? client).patch<RunsFeedbackExpectedFileUpdateResponses, RunsFeedbackExpectedFileUpdateErrors, ThrowOnError>({
|
|
514
660
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
515
|
-
url: '/api/v1/
|
|
661
|
+
url: '/api/v1/runs/{id}/feedback/expected/{filename}',
|
|
516
662
|
...options,
|
|
517
663
|
headers: {
|
|
518
664
|
'Content-Type': 'application/json',
|
|
@@ -521,13 +667,13 @@ export const sourceSecretsDecrypt = <ThrowOnError extends boolean = false>(optio
|
|
|
521
667
|
});
|
|
522
668
|
|
|
523
669
|
/**
|
|
524
|
-
*
|
|
670
|
+
* Promote run to example
|
|
525
671
|
*
|
|
526
|
-
*
|
|
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.
|
|
527
673
|
*/
|
|
528
|
-
export const
|
|
674
|
+
export const runsPromote = <ThrowOnError extends boolean = false>(options: Options<RunsPromoteData, ThrowOnError>) => (options.client ?? client).post<RunsPromoteResponses, RunsPromoteErrors, ThrowOnError>({
|
|
529
675
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
530
|
-
url: '/api/v1/
|
|
676
|
+
url: '/api/v1/runs/{id}/promote',
|
|
531
677
|
...options,
|
|
532
678
|
headers: {
|
|
533
679
|
'Content-Type': 'application/json',
|
|
@@ -536,34 +682,56 @@ export const sourceSecretsEncrypt = <ThrowOnError extends boolean = false>(optio
|
|
|
536
682
|
});
|
|
537
683
|
|
|
538
684
|
/**
|
|
539
|
-
*
|
|
685
|
+
* Retry run
|
|
540
686
|
*
|
|
541
|
-
*
|
|
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.
|
|
542
688
|
*/
|
|
543
|
-
export const
|
|
689
|
+
export const runsRerun = <ThrowOnError extends boolean = false>(options: Options<RunsRerunData, ThrowOnError>) => (options.client ?? client).post<RunsRerunResponses, RunsRerunErrors, ThrowOnError>({
|
|
544
690
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
545
|
-
url: '/api/v1/
|
|
691
|
+
url: '/api/v1/runs/{id}/rerun',
|
|
546
692
|
...options
|
|
547
693
|
});
|
|
548
694
|
|
|
549
695
|
/**
|
|
550
|
-
* List
|
|
696
|
+
* List run evaluator scores
|
|
551
697
|
*
|
|
552
|
-
* List
|
|
698
|
+
* List automated evaluator results for one run. Use `score` for evaluator output and `rating` on run feedback for human verdicts.
|
|
553
699
|
*/
|
|
554
|
-
export const
|
|
700
|
+
export const runsScoresList = <ThrowOnError extends boolean = false>(options: Options<RunsScoresListData, ThrowOnError>) => (options.client ?? client).get<RunsScoresListResponses, RunsScoresListErrors, ThrowOnError>({
|
|
555
701
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
556
|
-
url: '/api/v1/
|
|
702
|
+
url: '/api/v1/runs/{id}/scores',
|
|
703
|
+
...options
|
|
704
|
+
});
|
|
705
|
+
|
|
706
|
+
/**
|
|
707
|
+
* List run steps
|
|
708
|
+
*
|
|
709
|
+
* List workflow steps or an agent-compatible execution step summary for a run.
|
|
710
|
+
*/
|
|
711
|
+
export const runsStepsList = <ThrowOnError extends boolean = false>(options: Options<RunsStepsListData, ThrowOnError>) => (options.client ?? client).get<RunsStepsListResponses, RunsStepsListErrors, ThrowOnError>({
|
|
712
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
713
|
+
url: '/api/v1/runs/{id}/steps',
|
|
714
|
+
...options
|
|
715
|
+
});
|
|
716
|
+
|
|
717
|
+
/**
|
|
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.
|
|
721
|
+
*/
|
|
722
|
+
export const runsTraceGet = <ThrowOnError extends boolean = false>(options: Options<RunsTraceGetData, ThrowOnError>) => (options.client ?? client).get<RunsTraceGetResponses, RunsTraceGetErrors, ThrowOnError>({
|
|
723
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
724
|
+
url: '/api/v1/runs/{id}/trace',
|
|
557
725
|
...options
|
|
558
726
|
});
|
|
559
727
|
|
|
560
728
|
/**
|
|
561
|
-
*
|
|
729
|
+
* Get run usage
|
|
562
730
|
*
|
|
563
|
-
*
|
|
731
|
+
* Get token, credit, duration, and execution usage for a run.
|
|
564
732
|
*/
|
|
565
|
-
export const
|
|
733
|
+
export const runsUsageGet = <ThrowOnError extends boolean = false>(options: Options<RunsUsageGetData, ThrowOnError>) => (options.client ?? client).get<RunsUsageGetResponses, RunsUsageGetErrors, ThrowOnError>({
|
|
566
734
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
567
|
-
url: '/api/v1/
|
|
735
|
+
url: '/api/v1/runs/{id}/usage',
|
|
568
736
|
...options
|
|
569
737
|
});
|