@aignostics/sdk 2.3.1 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aignostics-sdk-3.0.0.tgz +0 -0
- package/dist/api-3iWGLFaA.d.cts +1914 -0
- package/dist/api-3iWGLFaA.d.ts +1914 -0
- package/dist/index.cjs +567 -275
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +24 -1506
- package/dist/index.d.ts +24 -1506
- package/dist/index.js +558 -274
- package/dist/index.js.map +1 -1
- package/dist/test-utils/http-mocks.cjs +21936 -0
- package/dist/test-utils/http-mocks.cjs.map +1 -0
- package/dist/test-utils/http-mocks.d.cts +65 -0
- package/dist/test-utils/http-mocks.d.ts +65 -0
- package/dist/test-utils/http-mocks.js +21922 -0
- package/dist/test-utils/http-mocks.js.map +1 -0
- package/package.json +7 -2
- package/dist/aignostics-sdk-2.3.1.tgz +0 -0
|
@@ -0,0 +1,1914 @@
|
|
|
1
|
+
import * as axios from 'axios';
|
|
2
|
+
import { RawAxiosRequestConfig, AxiosInstance, AxiosPromise } from 'axios';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Aignostics Platform API
|
|
6
|
+
* The Aignostics Platform is a cloud-based service that enables organizations to access advanced computational pathology applications through a secure API. The platform provides standardized access to Aignostics\' portfolio of computational pathology solutions, with Atlas H&E-TME serving as an example of the available API endpoints. To begin using the platform, your organization must first be registered by our business support team. If you don\'t have an account yet, please contact your account manager or email support@aignostics.com to get started. More information about our applications can be found on [https://platform.aignostics.com](https://platform.aignostics.com). **How to authorize and test API endpoints:** 1. Click the \"Authorize\" button in the right corner below 3. Click \"Authorize\" button in the dialog to log in with your Aignostics Platform credentials 4. After successful login, you\'ll be redirected back and can use \"Try it out\" on any endpoint **Note**: You only need to authorize once per session. The lock icons next to endpoints will show green when authorized.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0-beta.7
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
interface ConfigurationParameters {
|
|
16
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
17
|
+
username?: string;
|
|
18
|
+
password?: string;
|
|
19
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
20
|
+
basePath?: string;
|
|
21
|
+
serverIndex?: number;
|
|
22
|
+
baseOptions?: any;
|
|
23
|
+
formDataCtor?: new () => any;
|
|
24
|
+
}
|
|
25
|
+
declare class Configuration {
|
|
26
|
+
/**
|
|
27
|
+
* parameter for apiKey security
|
|
28
|
+
* @param name security name
|
|
29
|
+
* @memberof Configuration
|
|
30
|
+
*/
|
|
31
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
32
|
+
/**
|
|
33
|
+
* parameter for basic security
|
|
34
|
+
*
|
|
35
|
+
* @type {string}
|
|
36
|
+
* @memberof Configuration
|
|
37
|
+
*/
|
|
38
|
+
username?: string;
|
|
39
|
+
/**
|
|
40
|
+
* parameter for basic security
|
|
41
|
+
*
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof Configuration
|
|
44
|
+
*/
|
|
45
|
+
password?: string;
|
|
46
|
+
/**
|
|
47
|
+
* parameter for oauth2 security
|
|
48
|
+
* @param name security name
|
|
49
|
+
* @param scopes oauth2 scope
|
|
50
|
+
* @memberof Configuration
|
|
51
|
+
*/
|
|
52
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
53
|
+
/**
|
|
54
|
+
* override base path
|
|
55
|
+
*
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof Configuration
|
|
58
|
+
*/
|
|
59
|
+
basePath?: string;
|
|
60
|
+
/**
|
|
61
|
+
* override server index
|
|
62
|
+
*
|
|
63
|
+
* @type {number}
|
|
64
|
+
* @memberof Configuration
|
|
65
|
+
*/
|
|
66
|
+
serverIndex?: number;
|
|
67
|
+
/**
|
|
68
|
+
* base options for axios calls
|
|
69
|
+
*
|
|
70
|
+
* @type {any}
|
|
71
|
+
* @memberof Configuration
|
|
72
|
+
*/
|
|
73
|
+
baseOptions?: any;
|
|
74
|
+
/**
|
|
75
|
+
* The FormData constructor that will be used to create multipart form data
|
|
76
|
+
* requests. You can inject this here so that execution environments that
|
|
77
|
+
* do not support the FormData class can still run the generated client.
|
|
78
|
+
*
|
|
79
|
+
* @type {new () => FormData}
|
|
80
|
+
*/
|
|
81
|
+
formDataCtor?: new () => any;
|
|
82
|
+
constructor(param?: ConfigurationParameters);
|
|
83
|
+
/**
|
|
84
|
+
* Check if the given MIME is a JSON MIME.
|
|
85
|
+
* JSON MIME examples:
|
|
86
|
+
* application/json
|
|
87
|
+
* application/json; charset=UTF8
|
|
88
|
+
* APPLICATION/JSON
|
|
89
|
+
* application/vnd.company+json
|
|
90
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
91
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
92
|
+
*/
|
|
93
|
+
isJsonMime(mime: string): boolean;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Aignostics Platform API
|
|
98
|
+
* The Aignostics Platform is a cloud-based service that enables organizations to access advanced computational pathology applications through a secure API. The platform provides standardized access to Aignostics\' portfolio of computational pathology solutions, with Atlas H&E-TME serving as an example of the available API endpoints. To begin using the platform, your organization must first be registered by our business support team. If you don\'t have an account yet, please contact your account manager or email support@aignostics.com to get started. More information about our applications can be found on [https://platform.aignostics.com](https://platform.aignostics.com). **How to authorize and test API endpoints:** 1. Click the \"Authorize\" button in the right corner below 3. Click \"Authorize\" button in the dialog to log in with your Aignostics Platform credentials 4. After successful login, you\'ll be redirected back and can use \"Try it out\" on any endpoint **Note**: You only need to authorize once per session. The lock icons next to endpoints will show green when authorized.
|
|
99
|
+
*
|
|
100
|
+
* The version of the OpenAPI document: 1.0.0-beta.7
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
104
|
+
* https://openapi-generator.tech
|
|
105
|
+
* Do not edit the class manually.
|
|
106
|
+
*/
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
*
|
|
110
|
+
* @export
|
|
111
|
+
* @interface RequestArgs
|
|
112
|
+
*/
|
|
113
|
+
interface RequestArgs {
|
|
114
|
+
url: string;
|
|
115
|
+
options: RawAxiosRequestConfig;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
*
|
|
119
|
+
* @export
|
|
120
|
+
* @class BaseAPI
|
|
121
|
+
*/
|
|
122
|
+
declare class BaseAPI {
|
|
123
|
+
protected basePath: string;
|
|
124
|
+
protected axios: AxiosInstance;
|
|
125
|
+
protected configuration: Configuration | undefined;
|
|
126
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* Response schema for `List available applications` and `Read Application by Id` endpoints
|
|
131
|
+
* @export
|
|
132
|
+
* @interface ApplicationReadResponse
|
|
133
|
+
*/
|
|
134
|
+
interface ApplicationReadResponse {
|
|
135
|
+
/**
|
|
136
|
+
* Application ID
|
|
137
|
+
* @type {string}
|
|
138
|
+
* @memberof ApplicationReadResponse
|
|
139
|
+
*/
|
|
140
|
+
'application_id': string;
|
|
141
|
+
/**
|
|
142
|
+
* Application display name
|
|
143
|
+
* @type {string}
|
|
144
|
+
* @memberof ApplicationReadResponse
|
|
145
|
+
*/
|
|
146
|
+
'name': string;
|
|
147
|
+
/**
|
|
148
|
+
* Regulatory classes, to which the applications comply with. Possible values include: RUO, IVDR, FDA.
|
|
149
|
+
* @type {Array<string>}
|
|
150
|
+
* @memberof ApplicationReadResponse
|
|
151
|
+
*/
|
|
152
|
+
'regulatory_classes': Array<string>;
|
|
153
|
+
/**
|
|
154
|
+
* Describing what the application can do
|
|
155
|
+
* @type {string}
|
|
156
|
+
* @memberof ApplicationReadResponse
|
|
157
|
+
*/
|
|
158
|
+
'description': string;
|
|
159
|
+
/**
|
|
160
|
+
* All version numbers available to the user
|
|
161
|
+
* @type {Array<ApplicationVersion>}
|
|
162
|
+
* @memberof ApplicationReadResponse
|
|
163
|
+
*/
|
|
164
|
+
'versions': Array<ApplicationVersion>;
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* Response schema for `List available applications` and `Read Application by Id` endpoints
|
|
168
|
+
* @export
|
|
169
|
+
* @interface ApplicationReadShortResponse
|
|
170
|
+
*/
|
|
171
|
+
interface ApplicationReadShortResponse {
|
|
172
|
+
/**
|
|
173
|
+
* Application ID
|
|
174
|
+
* @type {string}
|
|
175
|
+
* @memberof ApplicationReadShortResponse
|
|
176
|
+
*/
|
|
177
|
+
'application_id': string;
|
|
178
|
+
/**
|
|
179
|
+
* Application display name
|
|
180
|
+
* @type {string}
|
|
181
|
+
* @memberof ApplicationReadShortResponse
|
|
182
|
+
*/
|
|
183
|
+
'name': string;
|
|
184
|
+
/**
|
|
185
|
+
* Regulatory classes, to which the applications comply with. Possible values include: RUO, IVDR, FDA.
|
|
186
|
+
* @type {Array<string>}
|
|
187
|
+
* @memberof ApplicationReadShortResponse
|
|
188
|
+
*/
|
|
189
|
+
'regulatory_classes': Array<string>;
|
|
190
|
+
/**
|
|
191
|
+
* Describing what the application can do
|
|
192
|
+
* @type {string}
|
|
193
|
+
* @memberof ApplicationReadShortResponse
|
|
194
|
+
*/
|
|
195
|
+
'description': string;
|
|
196
|
+
/**
|
|
197
|
+
*
|
|
198
|
+
* @type {ApplicationVersion}
|
|
199
|
+
* @memberof ApplicationReadShortResponse
|
|
200
|
+
*/
|
|
201
|
+
'latest_version'?: ApplicationVersion | null;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
*
|
|
205
|
+
* @export
|
|
206
|
+
* @interface ApplicationVersion
|
|
207
|
+
*/
|
|
208
|
+
interface ApplicationVersion {
|
|
209
|
+
/**
|
|
210
|
+
* The number of the latest version
|
|
211
|
+
* @type {string}
|
|
212
|
+
* @memberof ApplicationVersion
|
|
213
|
+
*/
|
|
214
|
+
'number': string;
|
|
215
|
+
/**
|
|
216
|
+
* The timestamp for when the application version was made available in the Platform
|
|
217
|
+
* @type {string}
|
|
218
|
+
* @memberof ApplicationVersion
|
|
219
|
+
*/
|
|
220
|
+
'released_at': string;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
*
|
|
224
|
+
* @export
|
|
225
|
+
* @enum {string}
|
|
226
|
+
*/
|
|
227
|
+
declare const ArtifactOutput: {
|
|
228
|
+
readonly None: "NONE";
|
|
229
|
+
readonly Available: "AVAILABLE";
|
|
230
|
+
readonly DeletedByUser: "DELETED_BY_USER";
|
|
231
|
+
readonly DeletedBySystem: "DELETED_BY_SYSTEM";
|
|
232
|
+
};
|
|
233
|
+
type ArtifactOutput = typeof ArtifactOutput[keyof typeof ArtifactOutput];
|
|
234
|
+
/**
|
|
235
|
+
*
|
|
236
|
+
* @export
|
|
237
|
+
* @enum {string}
|
|
238
|
+
*/
|
|
239
|
+
declare const ArtifactState: {
|
|
240
|
+
readonly Pending: "PENDING";
|
|
241
|
+
readonly Processing: "PROCESSING";
|
|
242
|
+
readonly Terminated: "TERMINATED";
|
|
243
|
+
};
|
|
244
|
+
type ArtifactState = typeof ArtifactState[keyof typeof ArtifactState];
|
|
245
|
+
/**
|
|
246
|
+
*
|
|
247
|
+
* @export
|
|
248
|
+
* @enum {string}
|
|
249
|
+
*/
|
|
250
|
+
declare const ArtifactTerminationReason: {
|
|
251
|
+
readonly Succeeded: "SUCCEEDED";
|
|
252
|
+
readonly UserError: "USER_ERROR";
|
|
253
|
+
readonly SystemError: "SYSTEM_ERROR";
|
|
254
|
+
readonly Skipped: "SKIPPED";
|
|
255
|
+
};
|
|
256
|
+
type ArtifactTerminationReason = typeof ArtifactTerminationReason[keyof typeof ArtifactTerminationReason];
|
|
257
|
+
/**
|
|
258
|
+
*
|
|
259
|
+
* @export
|
|
260
|
+
* @interface CustomMetadataUpdateRequest
|
|
261
|
+
*/
|
|
262
|
+
interface CustomMetadataUpdateRequest {
|
|
263
|
+
/**
|
|
264
|
+
*
|
|
265
|
+
* @type {object}
|
|
266
|
+
* @memberof CustomMetadataUpdateRequest
|
|
267
|
+
*/
|
|
268
|
+
'custom_metadata'?: object | null;
|
|
269
|
+
/**
|
|
270
|
+
*
|
|
271
|
+
* @type {string}
|
|
272
|
+
* @memberof CustomMetadataUpdateRequest
|
|
273
|
+
*/
|
|
274
|
+
'custom_metadata_checksum'?: string | null;
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
*
|
|
278
|
+
* @export
|
|
279
|
+
* @interface HTTPValidationError
|
|
280
|
+
*/
|
|
281
|
+
interface HTTPValidationError {
|
|
282
|
+
/**
|
|
283
|
+
*
|
|
284
|
+
* @type {Array<ValidationError>}
|
|
285
|
+
* @memberof HTTPValidationError
|
|
286
|
+
*/
|
|
287
|
+
'detail'?: Array<ValidationError>;
|
|
288
|
+
}
|
|
289
|
+
/**
|
|
290
|
+
*
|
|
291
|
+
* @export
|
|
292
|
+
* @interface InputArtifact
|
|
293
|
+
*/
|
|
294
|
+
interface InputArtifact {
|
|
295
|
+
/**
|
|
296
|
+
*
|
|
297
|
+
* @type {string}
|
|
298
|
+
* @memberof InputArtifact
|
|
299
|
+
*/
|
|
300
|
+
'name': string;
|
|
301
|
+
/**
|
|
302
|
+
*
|
|
303
|
+
* @type {string}
|
|
304
|
+
* @memberof InputArtifact
|
|
305
|
+
*/
|
|
306
|
+
'mime_type': string;
|
|
307
|
+
/**
|
|
308
|
+
*
|
|
309
|
+
* @type {object}
|
|
310
|
+
* @memberof InputArtifact
|
|
311
|
+
*/
|
|
312
|
+
'metadata_schema': object;
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* Input artifact containing the slide image and associated metadata.
|
|
316
|
+
* @export
|
|
317
|
+
* @interface InputArtifactCreationRequest
|
|
318
|
+
*/
|
|
319
|
+
interface InputArtifactCreationRequest {
|
|
320
|
+
/**
|
|
321
|
+
* Type of artifact. For Atlas H&E-TME, use \"input_slide\"
|
|
322
|
+
* @type {string}
|
|
323
|
+
* @memberof InputArtifactCreationRequest
|
|
324
|
+
*/
|
|
325
|
+
'name': string;
|
|
326
|
+
/**
|
|
327
|
+
* [Signed URL](https://cloud.google.com/cdn/docs/using-signed-urls) to the input artifact file. The URL should be valid for at least 6 days from the payload submission time.
|
|
328
|
+
* @type {string}
|
|
329
|
+
* @memberof InputArtifactCreationRequest
|
|
330
|
+
*/
|
|
331
|
+
'download_url': string;
|
|
332
|
+
/**
|
|
333
|
+
* The metadata of the artifact, required by the application version. The JSON schema of the metadata can be requested by `/v1/versions/{application_version_id}`. The schema is located in `input_artifacts.[].metadata_schema`
|
|
334
|
+
* @type {object}
|
|
335
|
+
* @memberof InputArtifactCreationRequest
|
|
336
|
+
*/
|
|
337
|
+
'metadata': object;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Individual item (slide) to be processed in a run.
|
|
341
|
+
* @export
|
|
342
|
+
* @interface ItemCreationRequest
|
|
343
|
+
*/
|
|
344
|
+
interface ItemCreationRequest {
|
|
345
|
+
/**
|
|
346
|
+
* Unique identifier for this item within the run. Used for referencing items. Must be unique across all items in the same run
|
|
347
|
+
* @type {string}
|
|
348
|
+
* @memberof ItemCreationRequest
|
|
349
|
+
*/
|
|
350
|
+
'external_id': string;
|
|
351
|
+
/**
|
|
352
|
+
*
|
|
353
|
+
* @type {object}
|
|
354
|
+
* @memberof ItemCreationRequest
|
|
355
|
+
*/
|
|
356
|
+
'custom_metadata'?: object | null;
|
|
357
|
+
/**
|
|
358
|
+
* List of input artifacts for this item. For Atlas H&E-TME, typically contains one artifact (the slide image)
|
|
359
|
+
* @type {Array<InputArtifactCreationRequest>}
|
|
360
|
+
* @memberof ItemCreationRequest
|
|
361
|
+
*/
|
|
362
|
+
'input_artifacts': Array<InputArtifactCreationRequest>;
|
|
363
|
+
}
|
|
364
|
+
/**
|
|
365
|
+
*
|
|
366
|
+
* @export
|
|
367
|
+
* @enum {string}
|
|
368
|
+
*/
|
|
369
|
+
declare const ItemOutput: {
|
|
370
|
+
readonly None: "NONE";
|
|
371
|
+
readonly Full: "FULL";
|
|
372
|
+
};
|
|
373
|
+
type ItemOutput = typeof ItemOutput[keyof typeof ItemOutput];
|
|
374
|
+
/**
|
|
375
|
+
* Response schema for items in `List Run Items` endpoint
|
|
376
|
+
* @export
|
|
377
|
+
* @interface ItemResultReadResponse
|
|
378
|
+
*/
|
|
379
|
+
interface ItemResultReadResponse {
|
|
380
|
+
/**
|
|
381
|
+
* Item UUID generated by the Platform
|
|
382
|
+
* @type {string}
|
|
383
|
+
* @memberof ItemResultReadResponse
|
|
384
|
+
*/
|
|
385
|
+
'item_id': string;
|
|
386
|
+
/**
|
|
387
|
+
* The external_id of the item from the user payload
|
|
388
|
+
* @type {string}
|
|
389
|
+
* @memberof ItemResultReadResponse
|
|
390
|
+
*/
|
|
391
|
+
'external_id': string;
|
|
392
|
+
/**
|
|
393
|
+
*
|
|
394
|
+
* @type {object}
|
|
395
|
+
* @memberof ItemResultReadResponse
|
|
396
|
+
*/
|
|
397
|
+
'custom_metadata': object | null;
|
|
398
|
+
/**
|
|
399
|
+
*
|
|
400
|
+
* @type {string}
|
|
401
|
+
* @memberof ItemResultReadResponse
|
|
402
|
+
*/
|
|
403
|
+
'custom_metadata_checksum'?: string | null;
|
|
404
|
+
/**
|
|
405
|
+
* The item moves from `PENDING` to `PROCESSING` to `TERMINATED` state. When terminated, consult the `termination_reason` property to see whether it was successful.
|
|
406
|
+
* @type {ItemState}
|
|
407
|
+
* @memberof ItemResultReadResponse
|
|
408
|
+
*/
|
|
409
|
+
'state': ItemState;
|
|
410
|
+
/**
|
|
411
|
+
* The output status of the item (NONE, FULL)
|
|
412
|
+
* @type {ItemOutput}
|
|
413
|
+
* @memberof ItemResultReadResponse
|
|
414
|
+
*/
|
|
415
|
+
'output': ItemOutput;
|
|
416
|
+
/**
|
|
417
|
+
*
|
|
418
|
+
* @type {ItemTerminationReason}
|
|
419
|
+
* @memberof ItemResultReadResponse
|
|
420
|
+
*/
|
|
421
|
+
'termination_reason'?: ItemTerminationReason | null;
|
|
422
|
+
/**
|
|
423
|
+
*
|
|
424
|
+
* @type {string}
|
|
425
|
+
* @memberof ItemResultReadResponse
|
|
426
|
+
*/
|
|
427
|
+
'error_message'?: string | null;
|
|
428
|
+
/**
|
|
429
|
+
*
|
|
430
|
+
* @type {string}
|
|
431
|
+
* @memberof ItemResultReadResponse
|
|
432
|
+
*/
|
|
433
|
+
'terminated_at'?: string | null;
|
|
434
|
+
/**
|
|
435
|
+
* The list of the results generated by the application algorithm. The number of files and their types depend on the particular application version, call `/v1/versions/{version_id}` to get the details.
|
|
436
|
+
* @type {Array<OutputArtifactResultReadResponse>}
|
|
437
|
+
* @memberof ItemResultReadResponse
|
|
438
|
+
*/
|
|
439
|
+
'output_artifacts': Array<OutputArtifactResultReadResponse>;
|
|
440
|
+
/**
|
|
441
|
+
*
|
|
442
|
+
* @type {string}
|
|
443
|
+
* @memberof ItemResultReadResponse
|
|
444
|
+
*/
|
|
445
|
+
'error_code': string | null;
|
|
446
|
+
}
|
|
447
|
+
/**
|
|
448
|
+
*
|
|
449
|
+
* @export
|
|
450
|
+
* @enum {string}
|
|
451
|
+
*/
|
|
452
|
+
declare const ItemState: {
|
|
453
|
+
readonly Pending: "PENDING";
|
|
454
|
+
readonly Processing: "PROCESSING";
|
|
455
|
+
readonly Terminated: "TERMINATED";
|
|
456
|
+
};
|
|
457
|
+
type ItemState = typeof ItemState[keyof typeof ItemState];
|
|
458
|
+
/**
|
|
459
|
+
*
|
|
460
|
+
* @export
|
|
461
|
+
* @enum {string}
|
|
462
|
+
*/
|
|
463
|
+
declare const ItemTerminationReason: {
|
|
464
|
+
readonly Succeeded: "SUCCEEDED";
|
|
465
|
+
readonly UserError: "USER_ERROR";
|
|
466
|
+
readonly SystemError: "SYSTEM_ERROR";
|
|
467
|
+
readonly Skipped: "SKIPPED";
|
|
468
|
+
};
|
|
469
|
+
type ItemTerminationReason = typeof ItemTerminationReason[keyof typeof ItemTerminationReason];
|
|
470
|
+
/**
|
|
471
|
+
* Response schema for `Get current user` endpoint
|
|
472
|
+
* @export
|
|
473
|
+
* @interface MeReadResponse
|
|
474
|
+
*/
|
|
475
|
+
interface MeReadResponse {
|
|
476
|
+
/**
|
|
477
|
+
*
|
|
478
|
+
* @type {UserReadResponse}
|
|
479
|
+
* @memberof MeReadResponse
|
|
480
|
+
*/
|
|
481
|
+
'user': UserReadResponse;
|
|
482
|
+
/**
|
|
483
|
+
*
|
|
484
|
+
* @type {OrganizationReadResponse}
|
|
485
|
+
* @memberof MeReadResponse
|
|
486
|
+
*/
|
|
487
|
+
'organization': OrganizationReadResponse;
|
|
488
|
+
}
|
|
489
|
+
/**
|
|
490
|
+
* Part of response schema for Organization object in `Get current user` endpoint. This model corresponds to the response schema returned from Auth0 GET /v2/organizations/{id} endpoint, flattens out the metadata out and doesn\'t return branding or token_quota objects. For details, see: https://auth0.com/docs/api/management/v2/organizations/get-organizations-by-id #### Configuration for integrating with Aignostics Platform services. The Aignostics Platform API requires signed URLs for input artifacts (slide images). To simplify this process, Aignostics provides a dedicated storage bucket. The HMAC credentials below grant read and write access to this bucket, allowing you to upload files and generate the signed URLs needed for API calls. Additionally, logging and error reporting tokens enable Aignostics to provide better support and monitor system performance for your integration.
|
|
491
|
+
* @export
|
|
492
|
+
* @interface OrganizationReadResponse
|
|
493
|
+
*/
|
|
494
|
+
interface OrganizationReadResponse {
|
|
495
|
+
/**
|
|
496
|
+
* Unique organization identifier
|
|
497
|
+
* @type {string}
|
|
498
|
+
* @memberof OrganizationReadResponse
|
|
499
|
+
*/
|
|
500
|
+
'id': string;
|
|
501
|
+
/**
|
|
502
|
+
*
|
|
503
|
+
* @type {string}
|
|
504
|
+
* @memberof OrganizationReadResponse
|
|
505
|
+
*/
|
|
506
|
+
'name'?: string | null;
|
|
507
|
+
/**
|
|
508
|
+
*
|
|
509
|
+
* @type {string}
|
|
510
|
+
* @memberof OrganizationReadResponse
|
|
511
|
+
*/
|
|
512
|
+
'display_name'?: string | null;
|
|
513
|
+
/**
|
|
514
|
+
* HMAC access key ID for the Aignostics-provided storage bucket. Used to authenticate requests for uploading files and generating signed URLs
|
|
515
|
+
* @type {string}
|
|
516
|
+
* @memberof OrganizationReadResponse
|
|
517
|
+
*/
|
|
518
|
+
'aignostics_bucket_hmac_access_key_id': string;
|
|
519
|
+
/**
|
|
520
|
+
* HMAC secret access key paired with the access key ID. Keep this credential secure.
|
|
521
|
+
* @type {string}
|
|
522
|
+
* @memberof OrganizationReadResponse
|
|
523
|
+
*/
|
|
524
|
+
'aignostics_bucket_hmac_secret_access_key': string;
|
|
525
|
+
/**
|
|
526
|
+
* Name of the bucket provided by Aignostics for storing input artifacts (slide images)
|
|
527
|
+
* @type {string}
|
|
528
|
+
* @memberof OrganizationReadResponse
|
|
529
|
+
*/
|
|
530
|
+
'aignostics_bucket_name': string;
|
|
531
|
+
/**
|
|
532
|
+
* Protocol to use for bucket access. Defines the URL scheme for connecting to the storage service
|
|
533
|
+
* @type {string}
|
|
534
|
+
* @memberof OrganizationReadResponse
|
|
535
|
+
*/
|
|
536
|
+
'aignostics_bucket_protocol': string;
|
|
537
|
+
/**
|
|
538
|
+
* Authentication token for Logfire observability service. Enables sending application logs and performance metrics to Aignostics for monitoring and support
|
|
539
|
+
* @type {string}
|
|
540
|
+
* @memberof OrganizationReadResponse
|
|
541
|
+
*/
|
|
542
|
+
'aignostics_logfire_token': string;
|
|
543
|
+
/**
|
|
544
|
+
* Data Source Name (DSN) for Sentry error tracking service. Allows automatic reporting of errors and exceptions to Aignostics support team
|
|
545
|
+
* @type {string}
|
|
546
|
+
* @memberof OrganizationReadResponse
|
|
547
|
+
*/
|
|
548
|
+
'aignostics_sentry_dsn': string;
|
|
549
|
+
}
|
|
550
|
+
/**
|
|
551
|
+
*
|
|
552
|
+
* @export
|
|
553
|
+
* @interface OutputArtifact
|
|
554
|
+
*/
|
|
555
|
+
interface OutputArtifact {
|
|
556
|
+
/**
|
|
557
|
+
*
|
|
558
|
+
* @type {string}
|
|
559
|
+
* @memberof OutputArtifact
|
|
560
|
+
*/
|
|
561
|
+
'name': string;
|
|
562
|
+
/**
|
|
563
|
+
*
|
|
564
|
+
* @type {string}
|
|
565
|
+
* @memberof OutputArtifact
|
|
566
|
+
*/
|
|
567
|
+
'mime_type': string;
|
|
568
|
+
/**
|
|
569
|
+
*
|
|
570
|
+
* @type {object}
|
|
571
|
+
* @memberof OutputArtifact
|
|
572
|
+
*/
|
|
573
|
+
'metadata_schema': object;
|
|
574
|
+
/**
|
|
575
|
+
*
|
|
576
|
+
* @type {OutputArtifactScope}
|
|
577
|
+
* @memberof OutputArtifact
|
|
578
|
+
*/
|
|
579
|
+
'scope': OutputArtifactScope;
|
|
580
|
+
/**
|
|
581
|
+
*
|
|
582
|
+
* @type {OutputArtifactVisibility}
|
|
583
|
+
* @memberof OutputArtifact
|
|
584
|
+
*/
|
|
585
|
+
'visibility': OutputArtifactVisibility;
|
|
586
|
+
}
|
|
587
|
+
/**
|
|
588
|
+
*
|
|
589
|
+
* @export
|
|
590
|
+
* @interface OutputArtifactResultReadResponse
|
|
591
|
+
*/
|
|
592
|
+
interface OutputArtifactResultReadResponse {
|
|
593
|
+
/**
|
|
594
|
+
* The Id of the artifact. Used internally
|
|
595
|
+
* @type {string}
|
|
596
|
+
* @memberof OutputArtifactResultReadResponse
|
|
597
|
+
*/
|
|
598
|
+
'output_artifact_id': string;
|
|
599
|
+
/**
|
|
600
|
+
* Name of the output from the output schema from the `/v1/versions/{version_id}` endpoint.
|
|
601
|
+
* @type {string}
|
|
602
|
+
* @memberof OutputArtifactResultReadResponse
|
|
603
|
+
*/
|
|
604
|
+
'name': string;
|
|
605
|
+
/**
|
|
606
|
+
*
|
|
607
|
+
* @type {object}
|
|
608
|
+
* @memberof OutputArtifactResultReadResponse
|
|
609
|
+
*/
|
|
610
|
+
'metadata'?: object | null;
|
|
611
|
+
/**
|
|
612
|
+
* The current state of the artifact (PENDING, PROCESSING, TERMINATED)
|
|
613
|
+
* @type {ArtifactState}
|
|
614
|
+
* @memberof OutputArtifactResultReadResponse
|
|
615
|
+
*/
|
|
616
|
+
'state': ArtifactState;
|
|
617
|
+
/**
|
|
618
|
+
*
|
|
619
|
+
* @type {ArtifactTerminationReason}
|
|
620
|
+
* @memberof OutputArtifactResultReadResponse
|
|
621
|
+
*/
|
|
622
|
+
'termination_reason'?: ArtifactTerminationReason | null;
|
|
623
|
+
/**
|
|
624
|
+
* The output status of the artifact (NONE, FULL)
|
|
625
|
+
* @type {ArtifactOutput}
|
|
626
|
+
* @memberof OutputArtifactResultReadResponse
|
|
627
|
+
*/
|
|
628
|
+
'output': ArtifactOutput;
|
|
629
|
+
/**
|
|
630
|
+
*
|
|
631
|
+
* @type {string}
|
|
632
|
+
* @memberof OutputArtifactResultReadResponse
|
|
633
|
+
*/
|
|
634
|
+
'error_message'?: string | null;
|
|
635
|
+
/**
|
|
636
|
+
*
|
|
637
|
+
* @type {string}
|
|
638
|
+
* @memberof OutputArtifactResultReadResponse
|
|
639
|
+
*/
|
|
640
|
+
'download_url': string | null;
|
|
641
|
+
/**
|
|
642
|
+
*
|
|
643
|
+
* @type {string}
|
|
644
|
+
* @memberof OutputArtifactResultReadResponse
|
|
645
|
+
*/
|
|
646
|
+
'error_code': string | null;
|
|
647
|
+
}
|
|
648
|
+
/**
|
|
649
|
+
*
|
|
650
|
+
* @export
|
|
651
|
+
* @enum {string}
|
|
652
|
+
*/
|
|
653
|
+
declare const OutputArtifactScope: {
|
|
654
|
+
readonly Item: "ITEM";
|
|
655
|
+
readonly Global: "GLOBAL";
|
|
656
|
+
};
|
|
657
|
+
type OutputArtifactScope = typeof OutputArtifactScope[keyof typeof OutputArtifactScope];
|
|
658
|
+
/**
|
|
659
|
+
*
|
|
660
|
+
* @export
|
|
661
|
+
* @enum {string}
|
|
662
|
+
*/
|
|
663
|
+
declare const OutputArtifactVisibility: {
|
|
664
|
+
readonly Internal: "INTERNAL";
|
|
665
|
+
readonly External: "EXTERNAL";
|
|
666
|
+
};
|
|
667
|
+
type OutputArtifactVisibility = typeof OutputArtifactVisibility[keyof typeof OutputArtifactVisibility];
|
|
668
|
+
/**
|
|
669
|
+
* Request schema for `Initiate Run` endpoint. It describes which application version is chosen, and which user data should be processed.
|
|
670
|
+
* @export
|
|
671
|
+
* @interface RunCreationRequest
|
|
672
|
+
*/
|
|
673
|
+
interface RunCreationRequest {
|
|
674
|
+
/**
|
|
675
|
+
* Unique ID for the application to use for processing
|
|
676
|
+
* @type {string}
|
|
677
|
+
* @memberof RunCreationRequest
|
|
678
|
+
*/
|
|
679
|
+
'application_id': string;
|
|
680
|
+
/**
|
|
681
|
+
*
|
|
682
|
+
* @type {string}
|
|
683
|
+
* @memberof RunCreationRequest
|
|
684
|
+
*/
|
|
685
|
+
'version_number'?: string | null;
|
|
686
|
+
/**
|
|
687
|
+
*
|
|
688
|
+
* @type {object}
|
|
689
|
+
* @memberof RunCreationRequest
|
|
690
|
+
*/
|
|
691
|
+
'custom_metadata'?: object | null;
|
|
692
|
+
/**
|
|
693
|
+
* List of items (slides) to process. Each item represents a whole slide image (WSI) with its associated metadata and artifacts
|
|
694
|
+
* @type {Array<ItemCreationRequest>}
|
|
695
|
+
* @memberof RunCreationRequest
|
|
696
|
+
*/
|
|
697
|
+
'items': Array<ItemCreationRequest>;
|
|
698
|
+
}
|
|
699
|
+
/**
|
|
700
|
+
*
|
|
701
|
+
* @export
|
|
702
|
+
* @interface RunCreationResponse
|
|
703
|
+
*/
|
|
704
|
+
interface RunCreationResponse {
|
|
705
|
+
/**
|
|
706
|
+
*
|
|
707
|
+
* @type {string}
|
|
708
|
+
* @memberof RunCreationResponse
|
|
709
|
+
*/
|
|
710
|
+
'run_id'?: string;
|
|
711
|
+
}
|
|
712
|
+
/**
|
|
713
|
+
*
|
|
714
|
+
* @export
|
|
715
|
+
* @interface RunItemStatistics
|
|
716
|
+
*/
|
|
717
|
+
interface RunItemStatistics {
|
|
718
|
+
/**
|
|
719
|
+
* Total number of the items in the run
|
|
720
|
+
* @type {number}
|
|
721
|
+
* @memberof RunItemStatistics
|
|
722
|
+
*/
|
|
723
|
+
'item_count': number;
|
|
724
|
+
/**
|
|
725
|
+
* The number of items in `PENDING` state
|
|
726
|
+
* @type {number}
|
|
727
|
+
* @memberof RunItemStatistics
|
|
728
|
+
*/
|
|
729
|
+
'item_pending_count': number;
|
|
730
|
+
/**
|
|
731
|
+
* The number of items in `PROCESSING` state
|
|
732
|
+
* @type {number}
|
|
733
|
+
* @memberof RunItemStatistics
|
|
734
|
+
*/
|
|
735
|
+
'item_processing_count': number;
|
|
736
|
+
/**
|
|
737
|
+
* The number of items in `TERMINATED` state, and the item termination reason is `USER_ERROR`
|
|
738
|
+
* @type {number}
|
|
739
|
+
* @memberof RunItemStatistics
|
|
740
|
+
*/
|
|
741
|
+
'item_user_error_count': number;
|
|
742
|
+
/**
|
|
743
|
+
* The number of items in `TERMINATED` state, and the item termination reason is `SYSTEM_ERROR`
|
|
744
|
+
* @type {number}
|
|
745
|
+
* @memberof RunItemStatistics
|
|
746
|
+
*/
|
|
747
|
+
'item_system_error_count': number;
|
|
748
|
+
/**
|
|
749
|
+
* The number of items in `TERMINATED` state, and the item termination reason is `SKIPPED`
|
|
750
|
+
* @type {number}
|
|
751
|
+
* @memberof RunItemStatistics
|
|
752
|
+
*/
|
|
753
|
+
'item_skipped_count': number;
|
|
754
|
+
/**
|
|
755
|
+
* The number of items in `TERMINATED` state, and the item termination reason is `SUCCEEDED`
|
|
756
|
+
* @type {number}
|
|
757
|
+
* @memberof RunItemStatistics
|
|
758
|
+
*/
|
|
759
|
+
'item_succeeded_count': number;
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
*
|
|
763
|
+
* @export
|
|
764
|
+
* @enum {string}
|
|
765
|
+
*/
|
|
766
|
+
declare const RunOutput: {
|
|
767
|
+
readonly None: "NONE";
|
|
768
|
+
readonly Partial: "PARTIAL";
|
|
769
|
+
readonly Full: "FULL";
|
|
770
|
+
};
|
|
771
|
+
type RunOutput = typeof RunOutput[keyof typeof RunOutput];
|
|
772
|
+
/**
|
|
773
|
+
* Response schema for `Get run details` endpoint
|
|
774
|
+
* @export
|
|
775
|
+
* @interface RunReadResponse
|
|
776
|
+
*/
|
|
777
|
+
interface RunReadResponse {
|
|
778
|
+
/**
|
|
779
|
+
* UUID of the application
|
|
780
|
+
* @type {string}
|
|
781
|
+
* @memberof RunReadResponse
|
|
782
|
+
*/
|
|
783
|
+
'run_id': string;
|
|
784
|
+
/**
|
|
785
|
+
* Application id
|
|
786
|
+
* @type {string}
|
|
787
|
+
* @memberof RunReadResponse
|
|
788
|
+
*/
|
|
789
|
+
'application_id': string;
|
|
790
|
+
/**
|
|
791
|
+
* Application version number
|
|
792
|
+
* @type {string}
|
|
793
|
+
* @memberof RunReadResponse
|
|
794
|
+
*/
|
|
795
|
+
'version_number': string;
|
|
796
|
+
/**
|
|
797
|
+
* When the run request is received by the Platform, the `state` of it is set to `PENDING`. The state changes to `PROCESSING` when at least one item is being processed. After `PROCESSING`, the state of the run can switch back to `PENDING` if there are no processing items, or to `TERMINATED` when the run finished processing.
|
|
798
|
+
* @type {RunState}
|
|
799
|
+
* @memberof RunReadResponse
|
|
800
|
+
*/
|
|
801
|
+
'state': RunState;
|
|
802
|
+
/**
|
|
803
|
+
* The status of the output of the run. When 0 items are successfully processed the output is `NONE`, after one item is successfully processed, the value is set to `PARTIAL`. When all items of the run are successfully processed, the output is set to `FULL`.
|
|
804
|
+
* @type {RunOutput}
|
|
805
|
+
* @memberof RunReadResponse
|
|
806
|
+
*/
|
|
807
|
+
'output': RunOutput;
|
|
808
|
+
/**
|
|
809
|
+
*
|
|
810
|
+
* @type {RunTerminationReason}
|
|
811
|
+
* @memberof RunReadResponse
|
|
812
|
+
*/
|
|
813
|
+
'termination_reason': RunTerminationReason | null;
|
|
814
|
+
/**
|
|
815
|
+
*
|
|
816
|
+
* @type {string}
|
|
817
|
+
* @memberof RunReadResponse
|
|
818
|
+
*/
|
|
819
|
+
'error_code': string | null;
|
|
820
|
+
/**
|
|
821
|
+
*
|
|
822
|
+
* @type {string}
|
|
823
|
+
* @memberof RunReadResponse
|
|
824
|
+
*/
|
|
825
|
+
'error_message': string | null;
|
|
826
|
+
/**
|
|
827
|
+
* Aggregated statistics of the run execution
|
|
828
|
+
* @type {RunItemStatistics}
|
|
829
|
+
* @memberof RunReadResponse
|
|
830
|
+
*/
|
|
831
|
+
'statistics': RunItemStatistics;
|
|
832
|
+
/**
|
|
833
|
+
*
|
|
834
|
+
* @type {object}
|
|
835
|
+
* @memberof RunReadResponse
|
|
836
|
+
*/
|
|
837
|
+
'custom_metadata'?: object | null;
|
|
838
|
+
/**
|
|
839
|
+
*
|
|
840
|
+
* @type {string}
|
|
841
|
+
* @memberof RunReadResponse
|
|
842
|
+
*/
|
|
843
|
+
'custom_metadata_checksum'?: string | null;
|
|
844
|
+
/**
|
|
845
|
+
* Timestamp showing when the run was triggered
|
|
846
|
+
* @type {string}
|
|
847
|
+
* @memberof RunReadResponse
|
|
848
|
+
*/
|
|
849
|
+
'submitted_at': string;
|
|
850
|
+
/**
|
|
851
|
+
* Id of the user who triggered the run
|
|
852
|
+
* @type {string}
|
|
853
|
+
* @memberof RunReadResponse
|
|
854
|
+
*/
|
|
855
|
+
'submitted_by': string;
|
|
856
|
+
/**
|
|
857
|
+
*
|
|
858
|
+
* @type {string}
|
|
859
|
+
* @memberof RunReadResponse
|
|
860
|
+
*/
|
|
861
|
+
'terminated_at'?: string | null;
|
|
862
|
+
}
|
|
863
|
+
/**
|
|
864
|
+
*
|
|
865
|
+
* @export
|
|
866
|
+
* @enum {string}
|
|
867
|
+
*/
|
|
868
|
+
declare const RunState: {
|
|
869
|
+
readonly Pending: "PENDING";
|
|
870
|
+
readonly Processing: "PROCESSING";
|
|
871
|
+
readonly Terminated: "TERMINATED";
|
|
872
|
+
};
|
|
873
|
+
type RunState = typeof RunState[keyof typeof RunState];
|
|
874
|
+
/**
|
|
875
|
+
*
|
|
876
|
+
* @export
|
|
877
|
+
* @enum {string}
|
|
878
|
+
*/
|
|
879
|
+
declare const RunTerminationReason: {
|
|
880
|
+
readonly AllItemsProcessed: "ALL_ITEMS_PROCESSED";
|
|
881
|
+
readonly CanceledBySystem: "CANCELED_BY_SYSTEM";
|
|
882
|
+
readonly CanceledByUser: "CANCELED_BY_USER";
|
|
883
|
+
};
|
|
884
|
+
type RunTerminationReason = typeof RunTerminationReason[keyof typeof RunTerminationReason];
|
|
885
|
+
/**
|
|
886
|
+
* Part of response schema for User object in `Get current user` endpoint. This model corresponds to the response schema returned from Auth0 GET /v2/users/{id} endpoint. For details, see: https://auth0.com/docs/api/management/v2/users/get-users-by-id
|
|
887
|
+
* @export
|
|
888
|
+
* @interface UserReadResponse
|
|
889
|
+
*/
|
|
890
|
+
interface UserReadResponse {
|
|
891
|
+
/**
|
|
892
|
+
* Unique user identifier
|
|
893
|
+
* @type {string}
|
|
894
|
+
* @memberof UserReadResponse
|
|
895
|
+
*/
|
|
896
|
+
'id': string;
|
|
897
|
+
/**
|
|
898
|
+
*
|
|
899
|
+
* @type {string}
|
|
900
|
+
* @memberof UserReadResponse
|
|
901
|
+
*/
|
|
902
|
+
'email'?: string | null;
|
|
903
|
+
/**
|
|
904
|
+
*
|
|
905
|
+
* @type {boolean}
|
|
906
|
+
* @memberof UserReadResponse
|
|
907
|
+
*/
|
|
908
|
+
'email_verified'?: boolean | null;
|
|
909
|
+
/**
|
|
910
|
+
*
|
|
911
|
+
* @type {string}
|
|
912
|
+
* @memberof UserReadResponse
|
|
913
|
+
*/
|
|
914
|
+
'name'?: string | null;
|
|
915
|
+
/**
|
|
916
|
+
*
|
|
917
|
+
* @type {string}
|
|
918
|
+
* @memberof UserReadResponse
|
|
919
|
+
*/
|
|
920
|
+
'given_name'?: string | null;
|
|
921
|
+
/**
|
|
922
|
+
*
|
|
923
|
+
* @type {string}
|
|
924
|
+
* @memberof UserReadResponse
|
|
925
|
+
*/
|
|
926
|
+
'family_name'?: string | null;
|
|
927
|
+
/**
|
|
928
|
+
*
|
|
929
|
+
* @type {string}
|
|
930
|
+
* @memberof UserReadResponse
|
|
931
|
+
*/
|
|
932
|
+
'nickname'?: string | null;
|
|
933
|
+
/**
|
|
934
|
+
*
|
|
935
|
+
* @type {string}
|
|
936
|
+
* @memberof UserReadResponse
|
|
937
|
+
*/
|
|
938
|
+
'picture'?: string | null;
|
|
939
|
+
/**
|
|
940
|
+
*
|
|
941
|
+
* @type {string}
|
|
942
|
+
* @memberof UserReadResponse
|
|
943
|
+
*/
|
|
944
|
+
'updated_at'?: string | null;
|
|
945
|
+
}
|
|
946
|
+
/**
|
|
947
|
+
*
|
|
948
|
+
* @export
|
|
949
|
+
* @interface ValidationError
|
|
950
|
+
*/
|
|
951
|
+
interface ValidationError {
|
|
952
|
+
/**
|
|
953
|
+
*
|
|
954
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
955
|
+
* @memberof ValidationError
|
|
956
|
+
*/
|
|
957
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
958
|
+
/**
|
|
959
|
+
*
|
|
960
|
+
* @type {string}
|
|
961
|
+
* @memberof ValidationError
|
|
962
|
+
*/
|
|
963
|
+
'msg': string;
|
|
964
|
+
/**
|
|
965
|
+
*
|
|
966
|
+
* @type {string}
|
|
967
|
+
* @memberof ValidationError
|
|
968
|
+
*/
|
|
969
|
+
'type': string;
|
|
970
|
+
}
|
|
971
|
+
/**
|
|
972
|
+
*
|
|
973
|
+
* @export
|
|
974
|
+
* @interface ValidationErrorLocInner
|
|
975
|
+
*/
|
|
976
|
+
interface ValidationErrorLocInner {
|
|
977
|
+
}
|
|
978
|
+
/**
|
|
979
|
+
* Base Response schema for the `Application Version Details` endpoint
|
|
980
|
+
* @export
|
|
981
|
+
* @interface VersionReadResponse
|
|
982
|
+
*/
|
|
983
|
+
interface VersionReadResponse {
|
|
984
|
+
/**
|
|
985
|
+
* Semantic version of the application
|
|
986
|
+
* @type {string}
|
|
987
|
+
* @memberof VersionReadResponse
|
|
988
|
+
*/
|
|
989
|
+
'version_number': string;
|
|
990
|
+
/**
|
|
991
|
+
* Description of the changes relative to the previous version
|
|
992
|
+
* @type {string}
|
|
993
|
+
* @memberof VersionReadResponse
|
|
994
|
+
*/
|
|
995
|
+
'changelog': string;
|
|
996
|
+
/**
|
|
997
|
+
* List of the input fields, provided by the User
|
|
998
|
+
* @type {Array<InputArtifact>}
|
|
999
|
+
* @memberof VersionReadResponse
|
|
1000
|
+
*/
|
|
1001
|
+
'input_artifacts': Array<InputArtifact>;
|
|
1002
|
+
/**
|
|
1003
|
+
* List of the output fields, generated by the application
|
|
1004
|
+
* @type {Array<OutputArtifact>}
|
|
1005
|
+
* @memberof VersionReadResponse
|
|
1006
|
+
*/
|
|
1007
|
+
'output_artifacts': Array<OutputArtifact>;
|
|
1008
|
+
/**
|
|
1009
|
+
* The timestamp when the application version was registered
|
|
1010
|
+
* @type {string}
|
|
1011
|
+
* @memberof VersionReadResponse
|
|
1012
|
+
*/
|
|
1013
|
+
'released_at': string;
|
|
1014
|
+
}
|
|
1015
|
+
/**
|
|
1016
|
+
* PublicApi - axios parameter creator
|
|
1017
|
+
* @export
|
|
1018
|
+
*/
|
|
1019
|
+
declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1020
|
+
/**
|
|
1021
|
+
* Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
|
|
1022
|
+
* @summary Application Version Details
|
|
1023
|
+
* @param {string} applicationId
|
|
1024
|
+
* @param {string} version
|
|
1025
|
+
* @param {*} [options] Override http request option.
|
|
1026
|
+
* @throws {RequiredError}
|
|
1027
|
+
*/
|
|
1028
|
+
applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet: (applicationId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1029
|
+
/**
|
|
1030
|
+
* The run can be canceled by the user who created the run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
|
|
1031
|
+
* @summary Cancel Run
|
|
1032
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1033
|
+
* @param {*} [options] Override http request option.
|
|
1034
|
+
* @throws {RequiredError}
|
|
1035
|
+
*/
|
|
1036
|
+
cancelRunV1RunsRunIdCancelPost: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1037
|
+
/**
|
|
1038
|
+
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches of four, though this number may be reduced during periods of high demand. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The external_id should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and an segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain /bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI) application/dicom (for DICOM ) application/zip (for zipped DICOM) application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64 encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
|
|
1039
|
+
* @summary Initiate Run
|
|
1040
|
+
* @param {RunCreationRequest} runCreationRequest
|
|
1041
|
+
* @param {*} [options] Override http request option.
|
|
1042
|
+
* @throws {RequiredError}
|
|
1043
|
+
*/
|
|
1044
|
+
createRunV1RunsPost: (runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1045
|
+
/**
|
|
1046
|
+
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
|
|
1047
|
+
* @summary Delete Run Items
|
|
1048
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1049
|
+
* @param {*} [options] Override http request option.
|
|
1050
|
+
* @throws {RequiredError}
|
|
1051
|
+
*/
|
|
1052
|
+
deleteRunItemsV1RunsRunIdArtifactsDelete: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1053
|
+
/**
|
|
1054
|
+
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1055
|
+
* @summary Get Item By Run
|
|
1056
|
+
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
1057
|
+
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1058
|
+
* @param {*} [options] Override http request option.
|
|
1059
|
+
* @throws {RequiredError}
|
|
1060
|
+
*/
|
|
1061
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet: (runId: string, externalId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1062
|
+
/**
|
|
1063
|
+
* Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
|
|
1064
|
+
* @summary Get current user
|
|
1065
|
+
* @param {*} [options] Override http request option.
|
|
1066
|
+
* @throws {RequiredError}
|
|
1067
|
+
*/
|
|
1068
|
+
getMeV1MeGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1069
|
+
/**
|
|
1070
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the POST `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
1071
|
+
* @summary Get run details
|
|
1072
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1073
|
+
* @param {*} [options] Override http request option.
|
|
1074
|
+
* @throws {RequiredError}
|
|
1075
|
+
*/
|
|
1076
|
+
getRunV1RunsRunIdGet: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1077
|
+
/**
|
|
1078
|
+
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller’s organization. The response is paginated and sorted according to the provided parameters.
|
|
1079
|
+
* @summary List available applications
|
|
1080
|
+
* @param {number} [page]
|
|
1081
|
+
* @param {number} [pageSize]
|
|
1082
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `application_id` - `name` - `description` - `regulatory_classes` **Examples:** - `?sort=application_id` - Sort by application_id ascending - `?sort=-name` - Sort by name descending - `?sort=+description&sort=name` - Sort by description ascending, then name descending
|
|
1083
|
+
* @param {*} [options] Override http request option.
|
|
1084
|
+
* @throws {RequiredError}
|
|
1085
|
+
*/
|
|
1086
|
+
listApplicationsV1ApplicationsGet: (page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1087
|
+
/**
|
|
1088
|
+
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1089
|
+
* @summary List Run Items
|
|
1090
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1091
|
+
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
1092
|
+
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
1093
|
+
* @param {ItemState | null} [state] Filter items by their state
|
|
1094
|
+
* @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
|
|
1095
|
+
* @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
|
|
1096
|
+
* @param {number} [page]
|
|
1097
|
+
* @param {number} [pageSize]
|
|
1098
|
+
* @param {Array<string> | null} [sort] Sort the items by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `item_id` - `run_id` - `external_id` - `custom_metadata` **Examples:** - `?sort=item_id` - Sort by id of the item (ascending) - `?sort=-external_id` - Sort by external ID (descending) - `?sort=custom_metadata&sort=-external_id` - Sort by metadata, then by external ID (descending)
|
|
1099
|
+
* @param {*} [options] Override http request option.
|
|
1100
|
+
* @throws {RequiredError}
|
|
1101
|
+
*/
|
|
1102
|
+
listRunItemsV1RunsRunIdItemsGet: (runId: string, itemIdIn?: Array<string> | null, externalIdIn?: Array<string> | null, state?: ItemState | null, terminationReason?: ItemTerminationReason | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1103
|
+
/**
|
|
1104
|
+
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
1105
|
+
* @summary List Runs
|
|
1106
|
+
* @param {string | null} [applicationId] Optional application ID filter
|
|
1107
|
+
* @param {string | null} [applicationVersion] Optional Version Name
|
|
1108
|
+
* @param {string | null} [externalId] Optionally filter runs by items with this external ID
|
|
1109
|
+
* @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, ensure proper encoding. #### Examples (Clear Format): - **Field existence**: `$.study` - Runs that have a study field defined - **Exact value match**: `$.study ? (@ == \"high\")` - Runs with specific study value - **Numeric comparison**: `$.confidence_score ? (@ > 0.75)` - Runs with confidence score greater than 0.75 - **Array operations**: `$.tags[*] ? (@ == \"draft\")` - Runs with tags array containing \"draft\" - **Complex conditions**: `$.resources ? (@.gpu_count > 2 && @.memory_gb >= 16)` - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: `%24.study` - **Exact value match**: `%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)` - **Numeric comparison**: `%24.confidence_score%20%3F%20(%40%20%3E%200.75)` - **Array operations**: `%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)` - **Complex conditions**: `%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)` #### Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations - Regular expressions use `like_regex` with standard regex syntax - **Remember to URL-encode the entire JSONPath expression when making HTTP requests**
|
|
1110
|
+
* @param {number} [page]
|
|
1111
|
+
* @param {number} [pageSize]
|
|
1112
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `run_id` - `application_version_id` - `organization_id` - `status` - `submitted_at` - `submitted_by` **Examples:** - `?sort=submitted_at` - Sort by creation time (ascending) - `?sort=-submitted_at` - Sort by creation time (descending) - `?sort=status&sort=-submitted_at` - Sort by status, then by time (descending)
|
|
1113
|
+
* @param {*} [options] Override http request option.
|
|
1114
|
+
* @throws {RequiredError}
|
|
1115
|
+
*/
|
|
1116
|
+
listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1117
|
+
/**
|
|
1118
|
+
*
|
|
1119
|
+
* @summary Put Item Custom Metadata By Run
|
|
1120
|
+
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
1121
|
+
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1122
|
+
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
1123
|
+
* @param {*} [options] Override http request option.
|
|
1124
|
+
* @throws {RequiredError}
|
|
1125
|
+
*/
|
|
1126
|
+
putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut: (runId: string, externalId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1127
|
+
/**
|
|
1128
|
+
*
|
|
1129
|
+
* @summary Put Run Custom Metadata
|
|
1130
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1131
|
+
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
1132
|
+
* @param {*} [options] Override http request option.
|
|
1133
|
+
* @throws {RequiredError}
|
|
1134
|
+
*/
|
|
1135
|
+
putRunCustomMetadataV1RunsRunIdCustomMetadataPut: (runId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1136
|
+
/**
|
|
1137
|
+
* Retrieve details of a specific application by its ID.
|
|
1138
|
+
* @summary Read Application By Id
|
|
1139
|
+
* @param {string} applicationId
|
|
1140
|
+
* @param {*} [options] Override http request option.
|
|
1141
|
+
* @throws {RequiredError}
|
|
1142
|
+
*/
|
|
1143
|
+
readApplicationByIdV1ApplicationsApplicationIdGet: (applicationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1144
|
+
};
|
|
1145
|
+
/**
|
|
1146
|
+
* PublicApi - functional programming interface
|
|
1147
|
+
* @export
|
|
1148
|
+
*/
|
|
1149
|
+
declare const PublicApiFp: (configuration?: Configuration) => {
|
|
1150
|
+
/**
|
|
1151
|
+
* Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
|
|
1152
|
+
* @summary Application Version Details
|
|
1153
|
+
* @param {string} applicationId
|
|
1154
|
+
* @param {string} version
|
|
1155
|
+
* @param {*} [options] Override http request option.
|
|
1156
|
+
* @throws {RequiredError}
|
|
1157
|
+
*/
|
|
1158
|
+
applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(applicationId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VersionReadResponse>>;
|
|
1159
|
+
/**
|
|
1160
|
+
* The run can be canceled by the user who created the run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
|
|
1161
|
+
* @summary Cancel Run
|
|
1162
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1163
|
+
* @param {*} [options] Override http request option.
|
|
1164
|
+
* @throws {RequiredError}
|
|
1165
|
+
*/
|
|
1166
|
+
cancelRunV1RunsRunIdCancelPost(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1167
|
+
/**
|
|
1168
|
+
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches of four, though this number may be reduced during periods of high demand. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The external_id should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and an segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain /bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI) application/dicom (for DICOM ) application/zip (for zipped DICOM) application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64 encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
|
|
1169
|
+
* @summary Initiate Run
|
|
1170
|
+
* @param {RunCreationRequest} runCreationRequest
|
|
1171
|
+
* @param {*} [options] Override http request option.
|
|
1172
|
+
* @throws {RequiredError}
|
|
1173
|
+
*/
|
|
1174
|
+
createRunV1RunsPost(runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunCreationResponse>>;
|
|
1175
|
+
/**
|
|
1176
|
+
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
|
|
1177
|
+
* @summary Delete Run Items
|
|
1178
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1179
|
+
* @param {*} [options] Override http request option.
|
|
1180
|
+
* @throws {RequiredError}
|
|
1181
|
+
*/
|
|
1182
|
+
deleteRunItemsV1RunsRunIdArtifactsDelete(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1183
|
+
/**
|
|
1184
|
+
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1185
|
+
* @summary Get Item By Run
|
|
1186
|
+
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
1187
|
+
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1188
|
+
* @param {*} [options] Override http request option.
|
|
1189
|
+
* @throws {RequiredError}
|
|
1190
|
+
*/
|
|
1191
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet(runId: string, externalId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemResultReadResponse>>;
|
|
1192
|
+
/**
|
|
1193
|
+
* Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
|
|
1194
|
+
* @summary Get current user
|
|
1195
|
+
* @param {*} [options] Override http request option.
|
|
1196
|
+
* @throws {RequiredError}
|
|
1197
|
+
*/
|
|
1198
|
+
getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeReadResponse>>;
|
|
1199
|
+
/**
|
|
1200
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the POST `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
1201
|
+
* @summary Get run details
|
|
1202
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1203
|
+
* @param {*} [options] Override http request option.
|
|
1204
|
+
* @throws {RequiredError}
|
|
1205
|
+
*/
|
|
1206
|
+
getRunV1RunsRunIdGet(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunReadResponse>>;
|
|
1207
|
+
/**
|
|
1208
|
+
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller’s organization. The response is paginated and sorted according to the provided parameters.
|
|
1209
|
+
* @summary List available applications
|
|
1210
|
+
* @param {number} [page]
|
|
1211
|
+
* @param {number} [pageSize]
|
|
1212
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `application_id` - `name` - `description` - `regulatory_classes` **Examples:** - `?sort=application_id` - Sort by application_id ascending - `?sort=-name` - Sort by name descending - `?sort=+description&sort=name` - Sort by description ascending, then name descending
|
|
1213
|
+
* @param {*} [options] Override http request option.
|
|
1214
|
+
* @throws {RequiredError}
|
|
1215
|
+
*/
|
|
1216
|
+
listApplicationsV1ApplicationsGet(page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicationReadShortResponse>>>;
|
|
1217
|
+
/**
|
|
1218
|
+
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1219
|
+
* @summary List Run Items
|
|
1220
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1221
|
+
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
1222
|
+
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
1223
|
+
* @param {ItemState | null} [state] Filter items by their state
|
|
1224
|
+
* @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
|
|
1225
|
+
* @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
|
|
1226
|
+
* @param {number} [page]
|
|
1227
|
+
* @param {number} [pageSize]
|
|
1228
|
+
* @param {Array<string> | null} [sort] Sort the items by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `item_id` - `run_id` - `external_id` - `custom_metadata` **Examples:** - `?sort=item_id` - Sort by id of the item (ascending) - `?sort=-external_id` - Sort by external ID (descending) - `?sort=custom_metadata&sort=-external_id` - Sort by metadata, then by external ID (descending)
|
|
1229
|
+
* @param {*} [options] Override http request option.
|
|
1230
|
+
* @throws {RequiredError}
|
|
1231
|
+
*/
|
|
1232
|
+
listRunItemsV1RunsRunIdItemsGet(runId: string, itemIdIn?: Array<string> | null, externalIdIn?: Array<string> | null, state?: ItemState | null, terminationReason?: ItemTerminationReason | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ItemResultReadResponse>>>;
|
|
1233
|
+
/**
|
|
1234
|
+
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
1235
|
+
* @summary List Runs
|
|
1236
|
+
* @param {string | null} [applicationId] Optional application ID filter
|
|
1237
|
+
* @param {string | null} [applicationVersion] Optional Version Name
|
|
1238
|
+
* @param {string | null} [externalId] Optionally filter runs by items with this external ID
|
|
1239
|
+
* @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, ensure proper encoding. #### Examples (Clear Format): - **Field existence**: `$.study` - Runs that have a study field defined - **Exact value match**: `$.study ? (@ == \"high\")` - Runs with specific study value - **Numeric comparison**: `$.confidence_score ? (@ > 0.75)` - Runs with confidence score greater than 0.75 - **Array operations**: `$.tags[*] ? (@ == \"draft\")` - Runs with tags array containing \"draft\" - **Complex conditions**: `$.resources ? (@.gpu_count > 2 && @.memory_gb >= 16)` - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: `%24.study` - **Exact value match**: `%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)` - **Numeric comparison**: `%24.confidence_score%20%3F%20(%40%20%3E%200.75)` - **Array operations**: `%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)` - **Complex conditions**: `%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)` #### Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations - Regular expressions use `like_regex` with standard regex syntax - **Remember to URL-encode the entire JSONPath expression when making HTTP requests**
|
|
1240
|
+
* @param {number} [page]
|
|
1241
|
+
* @param {number} [pageSize]
|
|
1242
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `run_id` - `application_version_id` - `organization_id` - `status` - `submitted_at` - `submitted_by` **Examples:** - `?sort=submitted_at` - Sort by creation time (ascending) - `?sort=-submitted_at` - Sort by creation time (descending) - `?sort=status&sort=-submitted_at` - Sort by status, then by time (descending)
|
|
1243
|
+
* @param {*} [options] Override http request option.
|
|
1244
|
+
* @throws {RequiredError}
|
|
1245
|
+
*/
|
|
1246
|
+
listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
|
|
1247
|
+
/**
|
|
1248
|
+
*
|
|
1249
|
+
* @summary Put Item Custom Metadata By Run
|
|
1250
|
+
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
1251
|
+
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1252
|
+
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
1253
|
+
* @param {*} [options] Override http request option.
|
|
1254
|
+
* @throws {RequiredError}
|
|
1255
|
+
*/
|
|
1256
|
+
putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId: string, externalId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1257
|
+
/**
|
|
1258
|
+
*
|
|
1259
|
+
* @summary Put Run Custom Metadata
|
|
1260
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1261
|
+
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
1262
|
+
* @param {*} [options] Override http request option.
|
|
1263
|
+
* @throws {RequiredError}
|
|
1264
|
+
*/
|
|
1265
|
+
putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1266
|
+
/**
|
|
1267
|
+
* Retrieve details of a specific application by its ID.
|
|
1268
|
+
* @summary Read Application By Id
|
|
1269
|
+
* @param {string} applicationId
|
|
1270
|
+
* @param {*} [options] Override http request option.
|
|
1271
|
+
* @throws {RequiredError}
|
|
1272
|
+
*/
|
|
1273
|
+
readApplicationByIdV1ApplicationsApplicationIdGet(applicationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationReadResponse>>;
|
|
1274
|
+
};
|
|
1275
|
+
/**
|
|
1276
|
+
* PublicApi - factory interface
|
|
1277
|
+
* @export
|
|
1278
|
+
*/
|
|
1279
|
+
declare const PublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1280
|
+
/**
|
|
1281
|
+
* Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
|
|
1282
|
+
* @summary Application Version Details
|
|
1283
|
+
* @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
|
|
1284
|
+
* @param {*} [options] Override http request option.
|
|
1285
|
+
* @throws {RequiredError}
|
|
1286
|
+
*/
|
|
1287
|
+
applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionReadResponse>;
|
|
1288
|
+
/**
|
|
1289
|
+
* The run can be canceled by the user who created the run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
|
|
1290
|
+
* @summary Cancel Run
|
|
1291
|
+
* @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
|
|
1292
|
+
* @param {*} [options] Override http request option.
|
|
1293
|
+
* @throws {RequiredError}
|
|
1294
|
+
*/
|
|
1295
|
+
cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1296
|
+
/**
|
|
1297
|
+
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches of four, though this number may be reduced during periods of high demand. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The external_id should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and an segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain /bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI) application/dicom (for DICOM ) application/zip (for zipped DICOM) application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64 encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
|
|
1298
|
+
* @summary Initiate Run
|
|
1299
|
+
* @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
|
|
1300
|
+
* @param {*} [options] Override http request option.
|
|
1301
|
+
* @throws {RequiredError}
|
|
1302
|
+
*/
|
|
1303
|
+
createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
|
|
1304
|
+
/**
|
|
1305
|
+
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
|
|
1306
|
+
* @summary Delete Run Items
|
|
1307
|
+
* @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
|
|
1308
|
+
* @param {*} [options] Override http request option.
|
|
1309
|
+
* @throws {RequiredError}
|
|
1310
|
+
*/
|
|
1311
|
+
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1312
|
+
/**
|
|
1313
|
+
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1314
|
+
* @summary Get Item By Run
|
|
1315
|
+
* @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
|
|
1316
|
+
* @param {*} [options] Override http request option.
|
|
1317
|
+
* @throws {RequiredError}
|
|
1318
|
+
*/
|
|
1319
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters: PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemResultReadResponse>;
|
|
1320
|
+
/**
|
|
1321
|
+
* Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
|
|
1322
|
+
* @summary Get current user
|
|
1323
|
+
* @param {*} [options] Override http request option.
|
|
1324
|
+
* @throws {RequiredError}
|
|
1325
|
+
*/
|
|
1326
|
+
getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
|
|
1327
|
+
/**
|
|
1328
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the POST `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
1329
|
+
* @summary Get run details
|
|
1330
|
+
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
1331
|
+
* @param {*} [options] Override http request option.
|
|
1332
|
+
* @throws {RequiredError}
|
|
1333
|
+
*/
|
|
1334
|
+
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
|
|
1335
|
+
/**
|
|
1336
|
+
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller’s organization. The response is paginated and sorted according to the provided parameters.
|
|
1337
|
+
* @summary List available applications
|
|
1338
|
+
* @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
|
|
1339
|
+
* @param {*} [options] Override http request option.
|
|
1340
|
+
* @throws {RequiredError}
|
|
1341
|
+
*/
|
|
1342
|
+
listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
|
|
1343
|
+
/**
|
|
1344
|
+
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1345
|
+
* @summary List Run Items
|
|
1346
|
+
* @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
|
|
1347
|
+
* @param {*} [options] Override http request option.
|
|
1348
|
+
* @throws {RequiredError}
|
|
1349
|
+
*/
|
|
1350
|
+
listRunItemsV1RunsRunIdItemsGet(requestParameters: PublicApiListRunItemsV1RunsRunIdItemsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ItemResultReadResponse>>;
|
|
1351
|
+
/**
|
|
1352
|
+
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
1353
|
+
* @summary List Runs
|
|
1354
|
+
* @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
|
|
1355
|
+
* @param {*} [options] Override http request option.
|
|
1356
|
+
* @throws {RequiredError}
|
|
1357
|
+
*/
|
|
1358
|
+
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
|
|
1359
|
+
/**
|
|
1360
|
+
*
|
|
1361
|
+
* @summary Put Item Custom Metadata By Run
|
|
1362
|
+
* @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
1363
|
+
* @param {*} [options] Override http request option.
|
|
1364
|
+
* @throws {RequiredError}
|
|
1365
|
+
*/
|
|
1366
|
+
putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1367
|
+
/**
|
|
1368
|
+
*
|
|
1369
|
+
* @summary Put Run Custom Metadata
|
|
1370
|
+
* @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
1371
|
+
* @param {*} [options] Override http request option.
|
|
1372
|
+
* @throws {RequiredError}
|
|
1373
|
+
*/
|
|
1374
|
+
putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1375
|
+
/**
|
|
1376
|
+
* Retrieve details of a specific application by its ID.
|
|
1377
|
+
* @summary Read Application By Id
|
|
1378
|
+
* @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
|
|
1379
|
+
* @param {*} [options] Override http request option.
|
|
1380
|
+
* @throws {RequiredError}
|
|
1381
|
+
*/
|
|
1382
|
+
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationReadResponse>;
|
|
1383
|
+
};
|
|
1384
|
+
/**
|
|
1385
|
+
* PublicApi - interface
|
|
1386
|
+
* @export
|
|
1387
|
+
* @interface PublicApi
|
|
1388
|
+
*/
|
|
1389
|
+
interface PublicApiInterface {
|
|
1390
|
+
/**
|
|
1391
|
+
* Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
|
|
1392
|
+
* @summary Application Version Details
|
|
1393
|
+
* @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
|
|
1394
|
+
* @param {*} [options] Override http request option.
|
|
1395
|
+
* @throws {RequiredError}
|
|
1396
|
+
* @memberof PublicApiInterface
|
|
1397
|
+
*/
|
|
1398
|
+
applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionReadResponse>;
|
|
1399
|
+
/**
|
|
1400
|
+
* The run can be canceled by the user who created the run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
|
|
1401
|
+
* @summary Cancel Run
|
|
1402
|
+
* @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
|
|
1403
|
+
* @param {*} [options] Override http request option.
|
|
1404
|
+
* @throws {RequiredError}
|
|
1405
|
+
* @memberof PublicApiInterface
|
|
1406
|
+
*/
|
|
1407
|
+
cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1408
|
+
/**
|
|
1409
|
+
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches of four, though this number may be reduced during periods of high demand. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The external_id should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and an segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain /bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI) application/dicom (for DICOM ) application/zip (for zipped DICOM) application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64 encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
|
|
1410
|
+
* @summary Initiate Run
|
|
1411
|
+
* @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
|
|
1412
|
+
* @param {*} [options] Override http request option.
|
|
1413
|
+
* @throws {RequiredError}
|
|
1414
|
+
* @memberof PublicApiInterface
|
|
1415
|
+
*/
|
|
1416
|
+
createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
|
|
1417
|
+
/**
|
|
1418
|
+
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
|
|
1419
|
+
* @summary Delete Run Items
|
|
1420
|
+
* @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
|
|
1421
|
+
* @param {*} [options] Override http request option.
|
|
1422
|
+
* @throws {RequiredError}
|
|
1423
|
+
* @memberof PublicApiInterface
|
|
1424
|
+
*/
|
|
1425
|
+
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1426
|
+
/**
|
|
1427
|
+
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1428
|
+
* @summary Get Item By Run
|
|
1429
|
+
* @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
|
|
1430
|
+
* @param {*} [options] Override http request option.
|
|
1431
|
+
* @throws {RequiredError}
|
|
1432
|
+
* @memberof PublicApiInterface
|
|
1433
|
+
*/
|
|
1434
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters: PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemResultReadResponse>;
|
|
1435
|
+
/**
|
|
1436
|
+
* Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
|
|
1437
|
+
* @summary Get current user
|
|
1438
|
+
* @param {*} [options] Override http request option.
|
|
1439
|
+
* @throws {RequiredError}
|
|
1440
|
+
* @memberof PublicApiInterface
|
|
1441
|
+
*/
|
|
1442
|
+
getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
|
|
1443
|
+
/**
|
|
1444
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the POST `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
1445
|
+
* @summary Get run details
|
|
1446
|
+
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
1447
|
+
* @param {*} [options] Override http request option.
|
|
1448
|
+
* @throws {RequiredError}
|
|
1449
|
+
* @memberof PublicApiInterface
|
|
1450
|
+
*/
|
|
1451
|
+
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
|
|
1452
|
+
/**
|
|
1453
|
+
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller’s organization. The response is paginated and sorted according to the provided parameters.
|
|
1454
|
+
* @summary List available applications
|
|
1455
|
+
* @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
|
|
1456
|
+
* @param {*} [options] Override http request option.
|
|
1457
|
+
* @throws {RequiredError}
|
|
1458
|
+
* @memberof PublicApiInterface
|
|
1459
|
+
*/
|
|
1460
|
+
listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
|
|
1461
|
+
/**
|
|
1462
|
+
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1463
|
+
* @summary List Run Items
|
|
1464
|
+
* @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
|
|
1465
|
+
* @param {*} [options] Override http request option.
|
|
1466
|
+
* @throws {RequiredError}
|
|
1467
|
+
* @memberof PublicApiInterface
|
|
1468
|
+
*/
|
|
1469
|
+
listRunItemsV1RunsRunIdItemsGet(requestParameters: PublicApiListRunItemsV1RunsRunIdItemsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ItemResultReadResponse>>;
|
|
1470
|
+
/**
|
|
1471
|
+
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
1472
|
+
* @summary List Runs
|
|
1473
|
+
* @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
|
|
1474
|
+
* @param {*} [options] Override http request option.
|
|
1475
|
+
* @throws {RequiredError}
|
|
1476
|
+
* @memberof PublicApiInterface
|
|
1477
|
+
*/
|
|
1478
|
+
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
|
|
1479
|
+
/**
|
|
1480
|
+
*
|
|
1481
|
+
* @summary Put Item Custom Metadata By Run
|
|
1482
|
+
* @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
1483
|
+
* @param {*} [options] Override http request option.
|
|
1484
|
+
* @throws {RequiredError}
|
|
1485
|
+
* @memberof PublicApiInterface
|
|
1486
|
+
*/
|
|
1487
|
+
putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1488
|
+
/**
|
|
1489
|
+
*
|
|
1490
|
+
* @summary Put Run Custom Metadata
|
|
1491
|
+
* @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
1492
|
+
* @param {*} [options] Override http request option.
|
|
1493
|
+
* @throws {RequiredError}
|
|
1494
|
+
* @memberof PublicApiInterface
|
|
1495
|
+
*/
|
|
1496
|
+
putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1497
|
+
/**
|
|
1498
|
+
* Retrieve details of a specific application by its ID.
|
|
1499
|
+
* @summary Read Application By Id
|
|
1500
|
+
* @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
|
|
1501
|
+
* @param {*} [options] Override http request option.
|
|
1502
|
+
* @throws {RequiredError}
|
|
1503
|
+
* @memberof PublicApiInterface
|
|
1504
|
+
*/
|
|
1505
|
+
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationReadResponse>;
|
|
1506
|
+
}
|
|
1507
|
+
/**
|
|
1508
|
+
* Request parameters for applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet operation in PublicApi.
|
|
1509
|
+
* @export
|
|
1510
|
+
* @interface PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest
|
|
1511
|
+
*/
|
|
1512
|
+
interface PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest {
|
|
1513
|
+
/**
|
|
1514
|
+
*
|
|
1515
|
+
* @type {string}
|
|
1516
|
+
* @memberof PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet
|
|
1517
|
+
*/
|
|
1518
|
+
readonly applicationId: string;
|
|
1519
|
+
/**
|
|
1520
|
+
*
|
|
1521
|
+
* @type {string}
|
|
1522
|
+
* @memberof PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet
|
|
1523
|
+
*/
|
|
1524
|
+
readonly version: string;
|
|
1525
|
+
}
|
|
1526
|
+
/**
|
|
1527
|
+
* Request parameters for cancelRunV1RunsRunIdCancelPost operation in PublicApi.
|
|
1528
|
+
* @export
|
|
1529
|
+
* @interface PublicApiCancelRunV1RunsRunIdCancelPostRequest
|
|
1530
|
+
*/
|
|
1531
|
+
interface PublicApiCancelRunV1RunsRunIdCancelPostRequest {
|
|
1532
|
+
/**
|
|
1533
|
+
* Run id, returned by `POST /runs/` endpoint
|
|
1534
|
+
* @type {string}
|
|
1535
|
+
* @memberof PublicApiCancelRunV1RunsRunIdCancelPost
|
|
1536
|
+
*/
|
|
1537
|
+
readonly runId: string;
|
|
1538
|
+
}
|
|
1539
|
+
/**
|
|
1540
|
+
* Request parameters for createRunV1RunsPost operation in PublicApi.
|
|
1541
|
+
* @export
|
|
1542
|
+
* @interface PublicApiCreateRunV1RunsPostRequest
|
|
1543
|
+
*/
|
|
1544
|
+
interface PublicApiCreateRunV1RunsPostRequest {
|
|
1545
|
+
/**
|
|
1546
|
+
*
|
|
1547
|
+
* @type {RunCreationRequest}
|
|
1548
|
+
* @memberof PublicApiCreateRunV1RunsPost
|
|
1549
|
+
*/
|
|
1550
|
+
readonly runCreationRequest: RunCreationRequest;
|
|
1551
|
+
}
|
|
1552
|
+
/**
|
|
1553
|
+
* Request parameters for deleteRunItemsV1RunsRunIdArtifactsDelete operation in PublicApi.
|
|
1554
|
+
* @export
|
|
1555
|
+
* @interface PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest
|
|
1556
|
+
*/
|
|
1557
|
+
interface PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest {
|
|
1558
|
+
/**
|
|
1559
|
+
* Run id, returned by `POST /runs/` endpoint
|
|
1560
|
+
* @type {string}
|
|
1561
|
+
* @memberof PublicApiDeleteRunItemsV1RunsRunIdArtifactsDelete
|
|
1562
|
+
*/
|
|
1563
|
+
readonly runId: string;
|
|
1564
|
+
}
|
|
1565
|
+
/**
|
|
1566
|
+
* Request parameters for getItemByRunV1RunsRunIdItemsExternalIdGet operation in PublicApi.
|
|
1567
|
+
* @export
|
|
1568
|
+
* @interface PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest
|
|
1569
|
+
*/
|
|
1570
|
+
interface PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest {
|
|
1571
|
+
/**
|
|
1572
|
+
* The run id, returned by `POST /runs/` endpoint
|
|
1573
|
+
* @type {string}
|
|
1574
|
+
* @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
|
|
1575
|
+
*/
|
|
1576
|
+
readonly runId: string;
|
|
1577
|
+
/**
|
|
1578
|
+
* The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1579
|
+
* @type {string}
|
|
1580
|
+
* @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
|
|
1581
|
+
*/
|
|
1582
|
+
readonly externalId: string;
|
|
1583
|
+
}
|
|
1584
|
+
/**
|
|
1585
|
+
* Request parameters for getRunV1RunsRunIdGet operation in PublicApi.
|
|
1586
|
+
* @export
|
|
1587
|
+
* @interface PublicApiGetRunV1RunsRunIdGetRequest
|
|
1588
|
+
*/
|
|
1589
|
+
interface PublicApiGetRunV1RunsRunIdGetRequest {
|
|
1590
|
+
/**
|
|
1591
|
+
* Run id, returned by `POST /runs/` endpoint
|
|
1592
|
+
* @type {string}
|
|
1593
|
+
* @memberof PublicApiGetRunV1RunsRunIdGet
|
|
1594
|
+
*/
|
|
1595
|
+
readonly runId: string;
|
|
1596
|
+
}
|
|
1597
|
+
/**
|
|
1598
|
+
* Request parameters for listApplicationsV1ApplicationsGet operation in PublicApi.
|
|
1599
|
+
* @export
|
|
1600
|
+
* @interface PublicApiListApplicationsV1ApplicationsGetRequest
|
|
1601
|
+
*/
|
|
1602
|
+
interface PublicApiListApplicationsV1ApplicationsGetRequest {
|
|
1603
|
+
/**
|
|
1604
|
+
*
|
|
1605
|
+
* @type {number}
|
|
1606
|
+
* @memberof PublicApiListApplicationsV1ApplicationsGet
|
|
1607
|
+
*/
|
|
1608
|
+
readonly page?: number;
|
|
1609
|
+
/**
|
|
1610
|
+
*
|
|
1611
|
+
* @type {number}
|
|
1612
|
+
* @memberof PublicApiListApplicationsV1ApplicationsGet
|
|
1613
|
+
*/
|
|
1614
|
+
readonly pageSize?: number;
|
|
1615
|
+
/**
|
|
1616
|
+
* Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `application_id` - `name` - `description` - `regulatory_classes` **Examples:** - `?sort=application_id` - Sort by application_id ascending - `?sort=-name` - Sort by name descending - `?sort=+description&sort=name` - Sort by description ascending, then name descending
|
|
1617
|
+
* @type {Array<string>}
|
|
1618
|
+
* @memberof PublicApiListApplicationsV1ApplicationsGet
|
|
1619
|
+
*/
|
|
1620
|
+
readonly sort?: Array<string> | null;
|
|
1621
|
+
}
|
|
1622
|
+
/**
|
|
1623
|
+
* Request parameters for listRunItemsV1RunsRunIdItemsGet operation in PublicApi.
|
|
1624
|
+
* @export
|
|
1625
|
+
* @interface PublicApiListRunItemsV1RunsRunIdItemsGetRequest
|
|
1626
|
+
*/
|
|
1627
|
+
interface PublicApiListRunItemsV1RunsRunIdItemsGetRequest {
|
|
1628
|
+
/**
|
|
1629
|
+
* Run id, returned by `POST /runs/` endpoint
|
|
1630
|
+
* @type {string}
|
|
1631
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
1632
|
+
*/
|
|
1633
|
+
readonly runId: string;
|
|
1634
|
+
/**
|
|
1635
|
+
* Filter for item ids
|
|
1636
|
+
* @type {Array<string>}
|
|
1637
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
1638
|
+
*/
|
|
1639
|
+
readonly itemIdIn?: Array<string> | null;
|
|
1640
|
+
/**
|
|
1641
|
+
* Filter for items by their external_id from the input payload
|
|
1642
|
+
* @type {Array<string>}
|
|
1643
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
1644
|
+
*/
|
|
1645
|
+
readonly externalIdIn?: Array<string> | null;
|
|
1646
|
+
/**
|
|
1647
|
+
* Filter items by their state
|
|
1648
|
+
* @type {ItemState}
|
|
1649
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
1650
|
+
*/
|
|
1651
|
+
readonly state?: ItemState | null;
|
|
1652
|
+
/**
|
|
1653
|
+
* Filter items by their termination reason. Only applies to TERMINATED items.
|
|
1654
|
+
* @type {ItemTerminationReason}
|
|
1655
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
1656
|
+
*/
|
|
1657
|
+
readonly terminationReason?: ItemTerminationReason | null;
|
|
1658
|
+
/**
|
|
1659
|
+
* JSONPath expression to filter items by their custom_metadata
|
|
1660
|
+
* @type {string}
|
|
1661
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
1662
|
+
*/
|
|
1663
|
+
readonly customMetadata?: string | null;
|
|
1664
|
+
/**
|
|
1665
|
+
*
|
|
1666
|
+
* @type {number}
|
|
1667
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
1668
|
+
*/
|
|
1669
|
+
readonly page?: number;
|
|
1670
|
+
/**
|
|
1671
|
+
*
|
|
1672
|
+
* @type {number}
|
|
1673
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
1674
|
+
*/
|
|
1675
|
+
readonly pageSize?: number;
|
|
1676
|
+
/**
|
|
1677
|
+
* Sort the items by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `item_id` - `run_id` - `external_id` - `custom_metadata` **Examples:** - `?sort=item_id` - Sort by id of the item (ascending) - `?sort=-external_id` - Sort by external ID (descending) - `?sort=custom_metadata&sort=-external_id` - Sort by metadata, then by external ID (descending)
|
|
1678
|
+
* @type {Array<string>}
|
|
1679
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
1680
|
+
*/
|
|
1681
|
+
readonly sort?: Array<string> | null;
|
|
1682
|
+
}
|
|
1683
|
+
/**
|
|
1684
|
+
* Request parameters for listRunsV1RunsGet operation in PublicApi.
|
|
1685
|
+
* @export
|
|
1686
|
+
* @interface PublicApiListRunsV1RunsGetRequest
|
|
1687
|
+
*/
|
|
1688
|
+
interface PublicApiListRunsV1RunsGetRequest {
|
|
1689
|
+
/**
|
|
1690
|
+
* Optional application ID filter
|
|
1691
|
+
* @type {string}
|
|
1692
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
1693
|
+
*/
|
|
1694
|
+
readonly applicationId?: string | null;
|
|
1695
|
+
/**
|
|
1696
|
+
* Optional Version Name
|
|
1697
|
+
* @type {string}
|
|
1698
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
1699
|
+
*/
|
|
1700
|
+
readonly applicationVersion?: string | null;
|
|
1701
|
+
/**
|
|
1702
|
+
* Optionally filter runs by items with this external ID
|
|
1703
|
+
* @type {string}
|
|
1704
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
1705
|
+
*/
|
|
1706
|
+
readonly externalId?: string | null;
|
|
1707
|
+
/**
|
|
1708
|
+
* Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, ensure proper encoding. #### Examples (Clear Format): - **Field existence**: `$.study` - Runs that have a study field defined - **Exact value match**: `$.study ? (@ == \"high\")` - Runs with specific study value - **Numeric comparison**: `$.confidence_score ? (@ > 0.75)` - Runs with confidence score greater than 0.75 - **Array operations**: `$.tags[*] ? (@ == \"draft\")` - Runs with tags array containing \"draft\" - **Complex conditions**: `$.resources ? (@.gpu_count > 2 && @.memory_gb >= 16)` - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: `%24.study` - **Exact value match**: `%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)` - **Numeric comparison**: `%24.confidence_score%20%3F%20(%40%20%3E%200.75)` - **Array operations**: `%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)` - **Complex conditions**: `%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)` #### Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations - Regular expressions use `like_regex` with standard regex syntax - **Remember to URL-encode the entire JSONPath expression when making HTTP requests**
|
|
1709
|
+
* @type {string}
|
|
1710
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
1711
|
+
*/
|
|
1712
|
+
readonly customMetadata?: string | null;
|
|
1713
|
+
/**
|
|
1714
|
+
*
|
|
1715
|
+
* @type {number}
|
|
1716
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
1717
|
+
*/
|
|
1718
|
+
readonly page?: number;
|
|
1719
|
+
/**
|
|
1720
|
+
*
|
|
1721
|
+
* @type {number}
|
|
1722
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
1723
|
+
*/
|
|
1724
|
+
readonly pageSize?: number;
|
|
1725
|
+
/**
|
|
1726
|
+
* Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `run_id` - `application_version_id` - `organization_id` - `status` - `submitted_at` - `submitted_by` **Examples:** - `?sort=submitted_at` - Sort by creation time (ascending) - `?sort=-submitted_at` - Sort by creation time (descending) - `?sort=status&sort=-submitted_at` - Sort by status, then by time (descending)
|
|
1727
|
+
* @type {Array<string>}
|
|
1728
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
1729
|
+
*/
|
|
1730
|
+
readonly sort?: Array<string> | null;
|
|
1731
|
+
}
|
|
1732
|
+
/**
|
|
1733
|
+
* Request parameters for putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut operation in PublicApi.
|
|
1734
|
+
* @export
|
|
1735
|
+
* @interface PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest
|
|
1736
|
+
*/
|
|
1737
|
+
interface PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest {
|
|
1738
|
+
/**
|
|
1739
|
+
* The run id, returned by `POST /runs/` endpoint
|
|
1740
|
+
* @type {string}
|
|
1741
|
+
* @memberof PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut
|
|
1742
|
+
*/
|
|
1743
|
+
readonly runId: string;
|
|
1744
|
+
/**
|
|
1745
|
+
* The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1746
|
+
* @type {string}
|
|
1747
|
+
* @memberof PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut
|
|
1748
|
+
*/
|
|
1749
|
+
readonly externalId: string;
|
|
1750
|
+
/**
|
|
1751
|
+
*
|
|
1752
|
+
* @type {CustomMetadataUpdateRequest}
|
|
1753
|
+
* @memberof PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut
|
|
1754
|
+
*/
|
|
1755
|
+
readonly customMetadataUpdateRequest: CustomMetadataUpdateRequest;
|
|
1756
|
+
}
|
|
1757
|
+
/**
|
|
1758
|
+
* Request parameters for putRunCustomMetadataV1RunsRunIdCustomMetadataPut operation in PublicApi.
|
|
1759
|
+
* @export
|
|
1760
|
+
* @interface PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest
|
|
1761
|
+
*/
|
|
1762
|
+
interface PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest {
|
|
1763
|
+
/**
|
|
1764
|
+
* Run id, returned by `POST /runs/` endpoint
|
|
1765
|
+
* @type {string}
|
|
1766
|
+
* @memberof PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPut
|
|
1767
|
+
*/
|
|
1768
|
+
readonly runId: string;
|
|
1769
|
+
/**
|
|
1770
|
+
*
|
|
1771
|
+
* @type {CustomMetadataUpdateRequest}
|
|
1772
|
+
* @memberof PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPut
|
|
1773
|
+
*/
|
|
1774
|
+
readonly customMetadataUpdateRequest: CustomMetadataUpdateRequest;
|
|
1775
|
+
}
|
|
1776
|
+
/**
|
|
1777
|
+
* Request parameters for readApplicationByIdV1ApplicationsApplicationIdGet operation in PublicApi.
|
|
1778
|
+
* @export
|
|
1779
|
+
* @interface PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest
|
|
1780
|
+
*/
|
|
1781
|
+
interface PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest {
|
|
1782
|
+
/**
|
|
1783
|
+
*
|
|
1784
|
+
* @type {string}
|
|
1785
|
+
* @memberof PublicApiReadApplicationByIdV1ApplicationsApplicationIdGet
|
|
1786
|
+
*/
|
|
1787
|
+
readonly applicationId: string;
|
|
1788
|
+
}
|
|
1789
|
+
/**
|
|
1790
|
+
* PublicApi - object-oriented interface
|
|
1791
|
+
* @export
|
|
1792
|
+
* @class PublicApi
|
|
1793
|
+
* @extends {BaseAPI}
|
|
1794
|
+
*/
|
|
1795
|
+
declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
1796
|
+
/**
|
|
1797
|
+
* Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
|
|
1798
|
+
* @summary Application Version Details
|
|
1799
|
+
* @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
|
|
1800
|
+
* @param {*} [options] Override http request option.
|
|
1801
|
+
* @throws {RequiredError}
|
|
1802
|
+
* @memberof PublicApi
|
|
1803
|
+
*/
|
|
1804
|
+
applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionReadResponse, any, {}>>;
|
|
1805
|
+
/**
|
|
1806
|
+
* The run can be canceled by the user who created the run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
|
|
1807
|
+
* @summary Cancel Run
|
|
1808
|
+
* @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
|
|
1809
|
+
* @param {*} [options] Override http request option.
|
|
1810
|
+
* @throws {RequiredError}
|
|
1811
|
+
* @memberof PublicApi
|
|
1812
|
+
*/
|
|
1813
|
+
cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
1814
|
+
/**
|
|
1815
|
+
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches of four, though this number may be reduced during periods of high demand. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The external_id should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and an segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain /bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI) application/dicom (for DICOM ) application/zip (for zipped DICOM) application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64 encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
|
|
1816
|
+
* @summary Initiate Run
|
|
1817
|
+
* @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
|
|
1818
|
+
* @param {*} [options] Override http request option.
|
|
1819
|
+
* @throws {RequiredError}
|
|
1820
|
+
* @memberof PublicApi
|
|
1821
|
+
*/
|
|
1822
|
+
createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunCreationResponse, any, {}>>;
|
|
1823
|
+
/**
|
|
1824
|
+
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
|
|
1825
|
+
* @summary Delete Run Items
|
|
1826
|
+
* @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
|
|
1827
|
+
* @param {*} [options] Override http request option.
|
|
1828
|
+
* @throws {RequiredError}
|
|
1829
|
+
* @memberof PublicApi
|
|
1830
|
+
*/
|
|
1831
|
+
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
1832
|
+
/**
|
|
1833
|
+
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1834
|
+
* @summary Get Item By Run
|
|
1835
|
+
* @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
|
|
1836
|
+
* @param {*} [options] Override http request option.
|
|
1837
|
+
* @throws {RequiredError}
|
|
1838
|
+
* @memberof PublicApi
|
|
1839
|
+
*/
|
|
1840
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters: PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ItemResultReadResponse, any, {}>>;
|
|
1841
|
+
/**
|
|
1842
|
+
* Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
|
|
1843
|
+
* @summary Get current user
|
|
1844
|
+
* @param {*} [options] Override http request option.
|
|
1845
|
+
* @throws {RequiredError}
|
|
1846
|
+
* @memberof PublicApi
|
|
1847
|
+
*/
|
|
1848
|
+
getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<MeReadResponse, any, {}>>;
|
|
1849
|
+
/**
|
|
1850
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the POST `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
1851
|
+
* @summary Get run details
|
|
1852
|
+
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
1853
|
+
* @param {*} [options] Override http request option.
|
|
1854
|
+
* @throws {RequiredError}
|
|
1855
|
+
* @memberof PublicApi
|
|
1856
|
+
*/
|
|
1857
|
+
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse, any, {}>>;
|
|
1858
|
+
/**
|
|
1859
|
+
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller’s organization. The response is paginated and sorted according to the provided parameters.
|
|
1860
|
+
* @summary List available applications
|
|
1861
|
+
* @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
|
|
1862
|
+
* @param {*} [options] Override http request option.
|
|
1863
|
+
* @throws {RequiredError}
|
|
1864
|
+
* @memberof PublicApi
|
|
1865
|
+
*/
|
|
1866
|
+
listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadShortResponse[], any, {}>>;
|
|
1867
|
+
/**
|
|
1868
|
+
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1869
|
+
* @summary List Run Items
|
|
1870
|
+
* @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
|
|
1871
|
+
* @param {*} [options] Override http request option.
|
|
1872
|
+
* @throws {RequiredError}
|
|
1873
|
+
* @memberof PublicApi
|
|
1874
|
+
*/
|
|
1875
|
+
listRunItemsV1RunsRunIdItemsGet(requestParameters: PublicApiListRunItemsV1RunsRunIdItemsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ItemResultReadResponse[], any, {}>>;
|
|
1876
|
+
/**
|
|
1877
|
+
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
1878
|
+
* @summary List Runs
|
|
1879
|
+
* @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
|
|
1880
|
+
* @param {*} [options] Override http request option.
|
|
1881
|
+
* @throws {RequiredError}
|
|
1882
|
+
* @memberof PublicApi
|
|
1883
|
+
*/
|
|
1884
|
+
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse[], any, {}>>;
|
|
1885
|
+
/**
|
|
1886
|
+
*
|
|
1887
|
+
* @summary Put Item Custom Metadata By Run
|
|
1888
|
+
* @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
1889
|
+
* @param {*} [options] Override http request option.
|
|
1890
|
+
* @throws {RequiredError}
|
|
1891
|
+
* @memberof PublicApi
|
|
1892
|
+
*/
|
|
1893
|
+
putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
1894
|
+
/**
|
|
1895
|
+
*
|
|
1896
|
+
* @summary Put Run Custom Metadata
|
|
1897
|
+
* @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
1898
|
+
* @param {*} [options] Override http request option.
|
|
1899
|
+
* @throws {RequiredError}
|
|
1900
|
+
* @memberof PublicApi
|
|
1901
|
+
*/
|
|
1902
|
+
putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
1903
|
+
/**
|
|
1904
|
+
* Retrieve details of a specific application by its ID.
|
|
1905
|
+
* @summary Read Application By Id
|
|
1906
|
+
* @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
|
|
1907
|
+
* @param {*} [options] Override http request option.
|
|
1908
|
+
* @throws {RequiredError}
|
|
1909
|
+
* @memberof PublicApi
|
|
1910
|
+
*/
|
|
1911
|
+
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadResponse, any, {}>>;
|
|
1912
|
+
}
|
|
1913
|
+
|
|
1914
|
+
export { type ApplicationReadShortResponse as A, type PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest as B, type CustomMetadataUpdateRequest as C, type PublicApiCancelRunV1RunsRunIdCancelPostRequest as D, type PublicApiCreateRunV1RunsPostRequest as E, type PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest as F, type PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest as G, type HTTPValidationError as H, type ItemResultReadResponse as I, type PublicApiGetRunV1RunsRunIdGetRequest as J, type PublicApiListApplicationsV1ApplicationsGetRequest as K, type PublicApiListRunItemsV1RunsRunIdItemsGetRequest as L, type MeReadResponse as M, type PublicApiListRunsV1RunsGetRequest as N, type OrganizationReadResponse as O, PublicApiAxiosParamCreator as P, type PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest as Q, type RunReadResponse as R, type PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest as S, type PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest as T, type UserReadResponse as U, type ValidationError as V, PublicApi as W, type ConfigurationParameters as X, Configuration as Y, type ApplicationReadResponse as a, type RunCreationRequest as b, type RunCreationResponse as c, type ApplicationVersion as d, ArtifactOutput as e, ArtifactState as f, ArtifactTerminationReason as g, type InputArtifact as h, type InputArtifactCreationRequest as i, type ItemCreationRequest as j, ItemOutput as k, ItemState as l, ItemTerminationReason as m, type OutputArtifact as n, type OutputArtifactResultReadResponse as o, OutputArtifactScope as p, OutputArtifactVisibility as q, type RunItemStatistics as r, RunOutput as s, RunState as t, RunTerminationReason as u, type ValidationErrorLocInner as v, type VersionReadResponse as w, PublicApiFp as x, PublicApiFactory as y, type PublicApiInterface as z };
|