@aignostics/sdk 2.3.1 → 3.1.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.1.0.tgz +0 -0
- package/dist/api-CZ17GBr_.d.cts +1951 -0
- package/dist/api-CZ17GBr_.d.ts +1951 -0
- package/dist/index.cjs +607 -275
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +53 -1505
- package/dist/index.d.ts +53 -1505
- package/dist/index.js +598 -274
- package/dist/index.js.map +1 -1
- package/dist/test-utils/http-mocks.cjs +21994 -0
- package/dist/test-utils/http-mocks.cjs.map +1 -0
- package/dist/test-utils/http-mocks.d.cts +69 -0
- package/dist/test-utils/http-mocks.d.ts +69 -0
- package/dist/test-utils/http-mocks.js +21980 -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
package/dist/index.js
CHANGED
|
@@ -4,7 +4,7 @@ import z from 'zod';
|
|
|
4
4
|
// package.json
|
|
5
5
|
var package_default = {
|
|
6
6
|
version: "0.0.0-development"};
|
|
7
|
-
var BASE_PATH = "https://
|
|
7
|
+
var BASE_PATH = "https://platform-staging.aignostics.com/api".replace(/\/+$/, "");
|
|
8
8
|
var BaseAPI = class {
|
|
9
9
|
constructor(configuration, basePath = BASE_PATH, axios = globalAxios2) {
|
|
10
10
|
this.basePath = basePath;
|
|
@@ -77,40 +77,102 @@ var createRequestFunction = function(axiosArgs, globalAxios3, BASE_PATH2, config
|
|
|
77
77
|
};
|
|
78
78
|
|
|
79
79
|
// src/generated/api.ts
|
|
80
|
-
var
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
Received: "RECEIVED",
|
|
86
|
-
Rejected: "REJECTED",
|
|
87
|
-
Running: "RUNNING",
|
|
88
|
-
Scheduled: "SCHEDULED"
|
|
80
|
+
var ArtifactOutput = {
|
|
81
|
+
None: "NONE",
|
|
82
|
+
Available: "AVAILABLE",
|
|
83
|
+
DeletedByUser: "DELETED_BY_USER",
|
|
84
|
+
DeletedBySystem: "DELETED_BY_SYSTEM"
|
|
89
85
|
};
|
|
90
|
-
var
|
|
86
|
+
var ArtifactState = {
|
|
91
87
|
Pending: "PENDING",
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
Succeeded: "SUCCEEDED"
|
|
88
|
+
Processing: "PROCESSING",
|
|
89
|
+
Terminated: "TERMINATED"
|
|
90
|
+
};
|
|
91
|
+
var ArtifactTerminationReason = {
|
|
92
|
+
Succeeded: "SUCCEEDED",
|
|
93
|
+
UserError: "USER_ERROR",
|
|
94
|
+
SystemError: "SYSTEM_ERROR",
|
|
95
|
+
Skipped: "SKIPPED"
|
|
96
|
+
};
|
|
97
|
+
var ItemOutput = {
|
|
98
|
+
None: "NONE",
|
|
99
|
+
Full: "FULL"
|
|
100
|
+
};
|
|
101
|
+
var ItemState = {
|
|
102
|
+
Pending: "PENDING",
|
|
103
|
+
Processing: "PROCESSING",
|
|
104
|
+
Terminated: "TERMINATED"
|
|
105
|
+
};
|
|
106
|
+
var ItemTerminationReason = {
|
|
107
|
+
Succeeded: "SUCCEEDED",
|
|
108
|
+
UserError: "USER_ERROR",
|
|
109
|
+
SystemError: "SYSTEM_ERROR",
|
|
110
|
+
Skipped: "SKIPPED"
|
|
97
111
|
};
|
|
98
112
|
var OutputArtifactScope = {
|
|
99
113
|
Item: "ITEM",
|
|
100
114
|
Global: "GLOBAL"
|
|
101
115
|
};
|
|
116
|
+
var OutputArtifactVisibility = {
|
|
117
|
+
Internal: "INTERNAL",
|
|
118
|
+
External: "EXTERNAL"
|
|
119
|
+
};
|
|
120
|
+
var RunOutput = {
|
|
121
|
+
None: "NONE",
|
|
122
|
+
Partial: "PARTIAL",
|
|
123
|
+
Full: "FULL"
|
|
124
|
+
};
|
|
125
|
+
var RunState = {
|
|
126
|
+
Pending: "PENDING",
|
|
127
|
+
Processing: "PROCESSING",
|
|
128
|
+
Terminated: "TERMINATED"
|
|
129
|
+
};
|
|
130
|
+
var RunTerminationReason = {
|
|
131
|
+
AllItemsProcessed: "ALL_ITEMS_PROCESSED",
|
|
132
|
+
CanceledBySystem: "CANCELED_BY_SYSTEM",
|
|
133
|
+
CanceledByUser: "CANCELED_BY_USER"
|
|
134
|
+
};
|
|
102
135
|
var PublicApiAxiosParamCreator = function(configuration) {
|
|
103
136
|
return {
|
|
104
137
|
/**
|
|
105
|
-
*
|
|
106
|
-
* @summary
|
|
107
|
-
* @param {string}
|
|
138
|
+
* Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
|
|
139
|
+
* @summary Application Version Details
|
|
140
|
+
* @param {string} applicationId
|
|
141
|
+
* @param {string} version
|
|
142
|
+
* @param {*} [options] Override http request option.
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet: async (applicationId, version, options = {}) => {
|
|
146
|
+
assertParamExists("applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet", "applicationId", applicationId);
|
|
147
|
+
assertParamExists("applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet", "version", version);
|
|
148
|
+
const localVarPath = `/v1/applications/{application_id}/versions/{version}`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId))).replace(`{${"version"}}`, encodeURIComponent(String(version)));
|
|
149
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
150
|
+
let baseOptions;
|
|
151
|
+
if (configuration) {
|
|
152
|
+
baseOptions = configuration.baseOptions;
|
|
153
|
+
}
|
|
154
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
155
|
+
const localVarHeaderParameter = {};
|
|
156
|
+
const localVarQueryParameter = {};
|
|
157
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
158
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
159
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
160
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
161
|
+
return {
|
|
162
|
+
url: toPathString(localVarUrlObj),
|
|
163
|
+
options: localVarRequestOptions
|
|
164
|
+
};
|
|
165
|
+
},
|
|
166
|
+
/**
|
|
167
|
+
* The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
|
|
168
|
+
* @summary Cancel Run
|
|
169
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
108
170
|
* @param {*} [options] Override http request option.
|
|
109
171
|
* @throws {RequiredError}
|
|
110
172
|
*/
|
|
111
|
-
|
|
112
|
-
assertParamExists("
|
|
113
|
-
const localVarPath = `/v1/runs/{
|
|
173
|
+
cancelRunV1RunsRunIdCancelPost: async (runId, options = {}) => {
|
|
174
|
+
assertParamExists("cancelRunV1RunsRunIdCancelPost", "runId", runId);
|
|
175
|
+
const localVarPath = `/v1/runs/{run_id}/cancel`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
|
|
114
176
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
115
177
|
let baseOptions;
|
|
116
178
|
if (configuration) {
|
|
@@ -129,14 +191,14 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
129
191
|
};
|
|
130
192
|
},
|
|
131
193
|
/**
|
|
132
|
-
*
|
|
133
|
-
* @summary
|
|
194
|
+
* 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. 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\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"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 i.e. whole slide images (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 a 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), and 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 `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
195
|
+
* @summary Initiate Run
|
|
134
196
|
* @param {RunCreationRequest} runCreationRequest
|
|
135
197
|
* @param {*} [options] Override http request option.
|
|
136
198
|
* @throws {RequiredError}
|
|
137
199
|
*/
|
|
138
|
-
|
|
139
|
-
assertParamExists("
|
|
200
|
+
createRunV1RunsPost: async (runCreationRequest, options = {}) => {
|
|
201
|
+
assertParamExists("createRunV1RunsPost", "runCreationRequest", runCreationRequest);
|
|
140
202
|
const localVarPath = `/v1/runs`;
|
|
141
203
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
142
204
|
let baseOptions;
|
|
@@ -158,15 +220,15 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
158
220
|
};
|
|
159
221
|
},
|
|
160
222
|
/**
|
|
161
|
-
*
|
|
162
|
-
* @summary Delete
|
|
163
|
-
* @param {string}
|
|
223
|
+
* 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, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
224
|
+
* @summary Delete Run Items
|
|
225
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
164
226
|
* @param {*} [options] Override http request option.
|
|
165
227
|
* @throws {RequiredError}
|
|
166
228
|
*/
|
|
167
|
-
|
|
168
|
-
assertParamExists("
|
|
169
|
-
const localVarPath = `/v1/runs/{
|
|
229
|
+
deleteRunItemsV1RunsRunIdArtifactsDelete: async (runId, options = {}) => {
|
|
230
|
+
assertParamExists("deleteRunItemsV1RunsRunIdArtifactsDelete", "runId", runId);
|
|
231
|
+
const localVarPath = `/v1/runs/{run_id}/artifacts`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
|
|
170
232
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
171
233
|
let baseOptions;
|
|
172
234
|
if (configuration) {
|
|
@@ -185,13 +247,17 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
185
247
|
};
|
|
186
248
|
},
|
|
187
249
|
/**
|
|
188
|
-
*
|
|
189
|
-
* @summary Get
|
|
250
|
+
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
251
|
+
* @summary Get Item By Run
|
|
252
|
+
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
253
|
+
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
190
254
|
* @param {*} [options] Override http request option.
|
|
191
255
|
* @throws {RequiredError}
|
|
192
256
|
*/
|
|
193
|
-
|
|
194
|
-
|
|
257
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, options = {}) => {
|
|
258
|
+
assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "runId", runId);
|
|
259
|
+
assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "externalId", externalId);
|
|
260
|
+
const localVarPath = `/v1/runs/{run_id}/items/{external_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"external_id"}}`, encodeURIComponent(String(externalId)));
|
|
195
261
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
196
262
|
let baseOptions;
|
|
197
263
|
if (configuration) {
|
|
@@ -210,16 +276,13 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
210
276
|
};
|
|
211
277
|
},
|
|
212
278
|
/**
|
|
213
|
-
*
|
|
214
|
-
* @summary Get
|
|
215
|
-
* @param {string} applicationRunId Application run id, returned by `POST /runs/` endpoint
|
|
216
|
-
* @param {Array<any> | null} [include]
|
|
279
|
+
* 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)
|
|
280
|
+
* @summary Get current user
|
|
217
281
|
* @param {*} [options] Override http request option.
|
|
218
282
|
* @throws {RequiredError}
|
|
219
283
|
*/
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
const localVarPath = `/v1/runs/{application_run_id}`.replace(`{${"application_run_id"}}`, encodeURIComponent(String(applicationRunId)));
|
|
284
|
+
getMeV1MeGet: async (options = {}) => {
|
|
285
|
+
const localVarPath = `/v1/me`;
|
|
223
286
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
224
287
|
let baseOptions;
|
|
225
288
|
if (configuration) {
|
|
@@ -229,9 +292,6 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
229
292
|
const localVarHeaderParameter = {};
|
|
230
293
|
const localVarQueryParameter = {};
|
|
231
294
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
232
|
-
if (include) {
|
|
233
|
-
localVarQueryParameter["include"] = include;
|
|
234
|
-
}
|
|
235
295
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
236
296
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
237
297
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -241,19 +301,15 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
241
301
|
};
|
|
242
302
|
},
|
|
243
303
|
/**
|
|
244
|
-
*
|
|
245
|
-
* @summary
|
|
246
|
-
* @param {string
|
|
247
|
-
* @param {string | null} [applicationVersion] Optional application version filter
|
|
248
|
-
* @param {Array<any> | null} [include] Request optional output values. Used internally by the platform
|
|
249
|
-
* @param {number} [page]
|
|
250
|
-
* @param {number} [pageSize]
|
|
251
|
-
* @param {Array<string> | null} [sort]
|
|
304
|
+
* 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 /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
305
|
+
* @summary Get run details
|
|
306
|
+
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
252
307
|
* @param {*} [options] Override http request option.
|
|
253
308
|
* @throws {RequiredError}
|
|
254
309
|
*/
|
|
255
|
-
|
|
256
|
-
|
|
310
|
+
getRunV1RunsRunIdGet: async (runId, options = {}) => {
|
|
311
|
+
assertParamExists("getRunV1RunsRunIdGet", "runId", runId);
|
|
312
|
+
const localVarPath = `/v1/runs/{run_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
|
|
257
313
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
258
314
|
let baseOptions;
|
|
259
315
|
if (configuration) {
|
|
@@ -263,24 +319,6 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
263
319
|
const localVarHeaderParameter = {};
|
|
264
320
|
const localVarQueryParameter = {};
|
|
265
321
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
266
|
-
if (applicationId !== void 0) {
|
|
267
|
-
localVarQueryParameter["application_id"] = applicationId;
|
|
268
|
-
}
|
|
269
|
-
if (applicationVersion !== void 0) {
|
|
270
|
-
localVarQueryParameter["application_version"] = applicationVersion;
|
|
271
|
-
}
|
|
272
|
-
if (include) {
|
|
273
|
-
localVarQueryParameter["include"] = include;
|
|
274
|
-
}
|
|
275
|
-
if (page !== void 0) {
|
|
276
|
-
localVarQueryParameter["page"] = page;
|
|
277
|
-
}
|
|
278
|
-
if (pageSize !== void 0) {
|
|
279
|
-
localVarQueryParameter["page_size"] = pageSize;
|
|
280
|
-
}
|
|
281
|
-
if (sort) {
|
|
282
|
-
localVarQueryParameter["sort"] = sort;
|
|
283
|
-
}
|
|
284
322
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
285
323
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
286
324
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -290,11 +328,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
290
328
|
};
|
|
291
329
|
},
|
|
292
330
|
/**
|
|
293
|
-
* Returns the list of the applications, available to the caller. The application is available if any of the
|
|
294
|
-
* @summary List
|
|
331
|
+
* 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.
|
|
332
|
+
* @summary List available applications
|
|
295
333
|
* @param {number} [page]
|
|
296
334
|
* @param {number} [pageSize]
|
|
297
|
-
* @param {Array<string> | null} [sort]
|
|
335
|
+
* @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
|
|
298
336
|
* @param {*} [options] Override http request option.
|
|
299
337
|
* @throws {RequiredError}
|
|
300
338
|
*/
|
|
@@ -313,7 +351,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
313
351
|
localVarQueryParameter["page"] = page;
|
|
314
352
|
}
|
|
315
353
|
if (pageSize !== void 0) {
|
|
316
|
-
localVarQueryParameter["
|
|
354
|
+
localVarQueryParameter["page-size"] = pageSize;
|
|
317
355
|
}
|
|
318
356
|
if (sort) {
|
|
319
357
|
localVarQueryParameter["sort"] = sort;
|
|
@@ -327,21 +365,23 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
327
365
|
};
|
|
328
366
|
},
|
|
329
367
|
/**
|
|
330
|
-
*
|
|
331
|
-
* @summary List Run
|
|
332
|
-
* @param {string}
|
|
333
|
-
* @param {Array<string> | null} [itemIdIn] Filter for
|
|
334
|
-
* @param {Array<string> | null} [
|
|
335
|
-
* @param {
|
|
368
|
+
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` 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
|
|
369
|
+
* @summary List Run Items
|
|
370
|
+
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
371
|
+
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
372
|
+
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
373
|
+
* @param {ItemState | null} [state] Filter items by their state
|
|
374
|
+
* @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
|
|
375
|
+
* @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
|
|
336
376
|
* @param {number} [page]
|
|
337
377
|
* @param {number} [pageSize]
|
|
338
|
-
* @param {Array<string> | null} [sort]
|
|
378
|
+
* @param {Array<string> | null} [sort] Sort the items by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `item_id` - `external_id` - `custom_metadata` - `terminated_at` - `termination_reason` **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)
|
|
339
379
|
* @param {*} [options] Override http request option.
|
|
340
380
|
* @throws {RequiredError}
|
|
341
381
|
*/
|
|
342
|
-
|
|
343
|
-
assertParamExists("
|
|
344
|
-
const localVarPath = `/v1/runs/{
|
|
382
|
+
listRunItemsV1RunsRunIdItemsGet: async (runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
|
|
383
|
+
assertParamExists("listRunItemsV1RunsRunIdItemsGet", "runId", runId);
|
|
384
|
+
const localVarPath = `/v1/runs/{run_id}/items`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
|
|
345
385
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
346
386
|
let baseOptions;
|
|
347
387
|
if (configuration) {
|
|
@@ -354,11 +394,17 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
354
394
|
if (itemIdIn) {
|
|
355
395
|
localVarQueryParameter["item_id__in"] = itemIdIn;
|
|
356
396
|
}
|
|
357
|
-
if (
|
|
358
|
-
localVarQueryParameter["
|
|
397
|
+
if (externalIdIn) {
|
|
398
|
+
localVarQueryParameter["external_id__in"] = externalIdIn;
|
|
399
|
+
}
|
|
400
|
+
if (state !== void 0) {
|
|
401
|
+
localVarQueryParameter["state"] = state;
|
|
402
|
+
}
|
|
403
|
+
if (terminationReason !== void 0) {
|
|
404
|
+
localVarQueryParameter["termination_reason"] = terminationReason;
|
|
359
405
|
}
|
|
360
|
-
if (
|
|
361
|
-
localVarQueryParameter["
|
|
406
|
+
if (customMetadata !== void 0) {
|
|
407
|
+
localVarQueryParameter["custom_metadata"] = customMetadata;
|
|
362
408
|
}
|
|
363
409
|
if (page !== void 0) {
|
|
364
410
|
localVarQueryParameter["page"] = page;
|
|
@@ -378,20 +424,20 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
378
424
|
};
|
|
379
425
|
},
|
|
380
426
|
/**
|
|
381
|
-
*
|
|
382
|
-
* @summary List
|
|
383
|
-
* @param {string} applicationId
|
|
427
|
+
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
428
|
+
* @summary List Runs
|
|
429
|
+
* @param {string | null} [applicationId] Optional application ID filter
|
|
430
|
+
* @param {string | null} [applicationVersion] Optional Version Name
|
|
431
|
+
* @param {string | null} [externalId] Optionally filter runs by items with this external ID
|
|
432
|
+
* @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, please 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 - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
|
|
384
433
|
* @param {number} [page]
|
|
385
434
|
* @param {number} [pageSize]
|
|
386
|
-
* @param {string | null} [
|
|
387
|
-
* @param {Array<any> | null} [include]
|
|
388
|
-
* @param {Array<string> | null} [sort]
|
|
435
|
+
* @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_id` - `version_number` - `custom_metadata` - `submitted_at` - `submitted_by` - `terminated_at` - `termination_reason` **Examples:** - `?sort=submitted_at` - Sort by creation time (ascending) - `?sort=-submitted_at` - Sort by creation time (descending) - `?sort=state&sort=-submitted_at` - Sort by state, then by time (descending)
|
|
389
436
|
* @param {*} [options] Override http request option.
|
|
390
437
|
* @throws {RequiredError}
|
|
391
438
|
*/
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
const localVarPath = `/v1/applications/{application_id}/versions`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId)));
|
|
439
|
+
listRunsV1RunsGet: async (applicationId, applicationVersion, externalId, customMetadata, page, pageSize, sort, options = {}) => {
|
|
440
|
+
const localVarPath = `/v1/runs`;
|
|
395
441
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
396
442
|
let baseOptions;
|
|
397
443
|
if (configuration) {
|
|
@@ -401,18 +447,24 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
401
447
|
const localVarHeaderParameter = {};
|
|
402
448
|
const localVarQueryParameter = {};
|
|
403
449
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
450
|
+
if (applicationId !== void 0) {
|
|
451
|
+
localVarQueryParameter["application_id"] = applicationId;
|
|
452
|
+
}
|
|
453
|
+
if (applicationVersion !== void 0) {
|
|
454
|
+
localVarQueryParameter["application_version"] = applicationVersion;
|
|
455
|
+
}
|
|
456
|
+
if (externalId !== void 0) {
|
|
457
|
+
localVarQueryParameter["external_id"] = externalId;
|
|
458
|
+
}
|
|
459
|
+
if (customMetadata !== void 0) {
|
|
460
|
+
localVarQueryParameter["custom_metadata"] = customMetadata;
|
|
461
|
+
}
|
|
404
462
|
if (page !== void 0) {
|
|
405
463
|
localVarQueryParameter["page"] = page;
|
|
406
464
|
}
|
|
407
465
|
if (pageSize !== void 0) {
|
|
408
466
|
localVarQueryParameter["page_size"] = pageSize;
|
|
409
467
|
}
|
|
410
|
-
if (version !== void 0) {
|
|
411
|
-
localVarQueryParameter["version"] = version;
|
|
412
|
-
}
|
|
413
|
-
if (include) {
|
|
414
|
-
localVarQueryParameter["include"] = include;
|
|
415
|
-
}
|
|
416
468
|
if (sort) {
|
|
417
469
|
localVarQueryParameter["sort"] = sort;
|
|
418
470
|
}
|
|
@@ -423,6 +475,97 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
423
475
|
url: toPathString(localVarUrlObj),
|
|
424
476
|
options: localVarRequestOptions
|
|
425
477
|
};
|
|
478
|
+
},
|
|
479
|
+
/**
|
|
480
|
+
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
481
|
+
* @summary Put Item Custom Metadata By Run
|
|
482
|
+
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
483
|
+
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
484
|
+
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
485
|
+
* @param {*} [options] Override http request option.
|
|
486
|
+
* @throws {RequiredError}
|
|
487
|
+
*/
|
|
488
|
+
putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut: async (runId, externalId, customMetadataUpdateRequest, options = {}) => {
|
|
489
|
+
assertParamExists("putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut", "runId", runId);
|
|
490
|
+
assertParamExists("putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut", "externalId", externalId);
|
|
491
|
+
assertParamExists("putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut", "customMetadataUpdateRequest", customMetadataUpdateRequest);
|
|
492
|
+
const localVarPath = `/v1/runs/{run_id}/items/{external_id}/custom-metadata`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"external_id"}}`, encodeURIComponent(String(externalId)));
|
|
493
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
494
|
+
let baseOptions;
|
|
495
|
+
if (configuration) {
|
|
496
|
+
baseOptions = configuration.baseOptions;
|
|
497
|
+
}
|
|
498
|
+
const localVarRequestOptions = { method: "PUT", ...baseOptions, ...options };
|
|
499
|
+
const localVarHeaderParameter = {};
|
|
500
|
+
const localVarQueryParameter = {};
|
|
501
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
502
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
503
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
504
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
505
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
506
|
+
localVarRequestOptions.data = serializeDataIfNeeded(customMetadataUpdateRequest, localVarRequestOptions, configuration);
|
|
507
|
+
return {
|
|
508
|
+
url: toPathString(localVarUrlObj),
|
|
509
|
+
options: localVarRequestOptions
|
|
510
|
+
};
|
|
511
|
+
},
|
|
512
|
+
/**
|
|
513
|
+
* Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
|
|
514
|
+
* @summary Put Run Custom Metadata
|
|
515
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
516
|
+
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
517
|
+
* @param {*} [options] Override http request option.
|
|
518
|
+
* @throws {RequiredError}
|
|
519
|
+
*/
|
|
520
|
+
putRunCustomMetadataV1RunsRunIdCustomMetadataPut: async (runId, customMetadataUpdateRequest, options = {}) => {
|
|
521
|
+
assertParamExists("putRunCustomMetadataV1RunsRunIdCustomMetadataPut", "runId", runId);
|
|
522
|
+
assertParamExists("putRunCustomMetadataV1RunsRunIdCustomMetadataPut", "customMetadataUpdateRequest", customMetadataUpdateRequest);
|
|
523
|
+
const localVarPath = `/v1/runs/{run_id}/custom-metadata`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
|
|
524
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
525
|
+
let baseOptions;
|
|
526
|
+
if (configuration) {
|
|
527
|
+
baseOptions = configuration.baseOptions;
|
|
528
|
+
}
|
|
529
|
+
const localVarRequestOptions = { method: "PUT", ...baseOptions, ...options };
|
|
530
|
+
const localVarHeaderParameter = {};
|
|
531
|
+
const localVarQueryParameter = {};
|
|
532
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
533
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
534
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
535
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
536
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
537
|
+
localVarRequestOptions.data = serializeDataIfNeeded(customMetadataUpdateRequest, localVarRequestOptions, configuration);
|
|
538
|
+
return {
|
|
539
|
+
url: toPathString(localVarUrlObj),
|
|
540
|
+
options: localVarRequestOptions
|
|
541
|
+
};
|
|
542
|
+
},
|
|
543
|
+
/**
|
|
544
|
+
* Retrieve details of a specific application by its ID.
|
|
545
|
+
* @summary Read Application By Id
|
|
546
|
+
* @param {string} applicationId
|
|
547
|
+
* @param {*} [options] Override http request option.
|
|
548
|
+
* @throws {RequiredError}
|
|
549
|
+
*/
|
|
550
|
+
readApplicationByIdV1ApplicationsApplicationIdGet: async (applicationId, options = {}) => {
|
|
551
|
+
assertParamExists("readApplicationByIdV1ApplicationsApplicationIdGet", "applicationId", applicationId);
|
|
552
|
+
const localVarPath = `/v1/applications/{application_id}`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId)));
|
|
553
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
554
|
+
let baseOptions;
|
|
555
|
+
if (configuration) {
|
|
556
|
+
baseOptions = configuration.baseOptions;
|
|
557
|
+
}
|
|
558
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
559
|
+
const localVarHeaderParameter = {};
|
|
560
|
+
const localVarQueryParameter = {};
|
|
561
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
562
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
563
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
564
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
565
|
+
return {
|
|
566
|
+
url: toPathString(localVarUrlObj),
|
|
567
|
+
options: localVarRequestOptions
|
|
568
|
+
};
|
|
426
569
|
}
|
|
427
570
|
};
|
|
428
571
|
};
|
|
@@ -430,47 +573,75 @@ var PublicApiFp = function(configuration) {
|
|
|
430
573
|
const localVarAxiosParamCreator = PublicApiAxiosParamCreator(configuration);
|
|
431
574
|
return {
|
|
432
575
|
/**
|
|
433
|
-
*
|
|
434
|
-
* @summary
|
|
435
|
-
* @param {string}
|
|
576
|
+
* Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
|
|
577
|
+
* @summary Application Version Details
|
|
578
|
+
* @param {string} applicationId
|
|
579
|
+
* @param {string} version
|
|
580
|
+
* @param {*} [options] Override http request option.
|
|
581
|
+
* @throws {RequiredError}
|
|
582
|
+
*/
|
|
583
|
+
async applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(applicationId, version, options) {
|
|
584
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(applicationId, version, options);
|
|
585
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
586
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet"]?.[localVarOperationServerIndex]?.url;
|
|
587
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
588
|
+
},
|
|
589
|
+
/**
|
|
590
|
+
* The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
|
|
591
|
+
* @summary Cancel Run
|
|
592
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
436
593
|
* @param {*} [options] Override http request option.
|
|
437
594
|
* @throws {RequiredError}
|
|
438
595
|
*/
|
|
439
|
-
async
|
|
440
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
596
|
+
async cancelRunV1RunsRunIdCancelPost(runId, options) {
|
|
597
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelRunV1RunsRunIdCancelPost(runId, options);
|
|
441
598
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
442
|
-
const localVarOperationServerBasePath = operationServerMap["PublicApi.
|
|
599
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.cancelRunV1RunsRunIdCancelPost"]?.[localVarOperationServerIndex]?.url;
|
|
443
600
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
444
601
|
},
|
|
445
602
|
/**
|
|
446
|
-
*
|
|
447
|
-
* @summary
|
|
603
|
+
* 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. 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\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"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 i.e. whole slide images (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 a 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), and 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 `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
604
|
+
* @summary Initiate Run
|
|
448
605
|
* @param {RunCreationRequest} runCreationRequest
|
|
449
606
|
* @param {*} [options] Override http request option.
|
|
450
607
|
* @throws {RequiredError}
|
|
451
608
|
*/
|
|
452
|
-
async
|
|
453
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
609
|
+
async createRunV1RunsPost(runCreationRequest, options) {
|
|
610
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createRunV1RunsPost(runCreationRequest, options);
|
|
611
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
612
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.createRunV1RunsPost"]?.[localVarOperationServerIndex]?.url;
|
|
613
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
614
|
+
},
|
|
615
|
+
/**
|
|
616
|
+
* 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, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
617
|
+
* @summary Delete Run Items
|
|
618
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
619
|
+
* @param {*} [options] Override http request option.
|
|
620
|
+
* @throws {RequiredError}
|
|
621
|
+
*/
|
|
622
|
+
async deleteRunItemsV1RunsRunIdArtifactsDelete(runId, options) {
|
|
623
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRunItemsV1RunsRunIdArtifactsDelete(runId, options);
|
|
454
624
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
455
|
-
const localVarOperationServerBasePath = operationServerMap["PublicApi.
|
|
625
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.deleteRunItemsV1RunsRunIdArtifactsDelete"]?.[localVarOperationServerIndex]?.url;
|
|
456
626
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
457
627
|
},
|
|
458
628
|
/**
|
|
459
|
-
*
|
|
460
|
-
* @summary
|
|
461
|
-
* @param {string}
|
|
629
|
+
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
630
|
+
* @summary Get Item By Run
|
|
631
|
+
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
632
|
+
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
462
633
|
* @param {*} [options] Override http request option.
|
|
463
634
|
* @throws {RequiredError}
|
|
464
635
|
*/
|
|
465
|
-
async
|
|
466
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
636
|
+
async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options) {
|
|
637
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options);
|
|
467
638
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
468
|
-
const localVarOperationServerBasePath = operationServerMap["PublicApi.
|
|
639
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.getItemByRunV1RunsRunIdItemsExternalIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
469
640
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
470
641
|
},
|
|
471
642
|
/**
|
|
472
|
-
*
|
|
473
|
-
* @summary Get
|
|
643
|
+
* 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)
|
|
644
|
+
* @summary Get current user
|
|
474
645
|
* @param {*} [options] Override http request option.
|
|
475
646
|
* @throws {RequiredError}
|
|
476
647
|
*/
|
|
@@ -481,87 +652,113 @@ var PublicApiFp = function(configuration) {
|
|
|
481
652
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
482
653
|
},
|
|
483
654
|
/**
|
|
484
|
-
*
|
|
485
|
-
* @summary Get
|
|
486
|
-
* @param {string}
|
|
487
|
-
* @param {Array<any> | null} [include]
|
|
655
|
+
* 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 /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
656
|
+
* @summary Get run details
|
|
657
|
+
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
488
658
|
* @param {*} [options] Override http request option.
|
|
489
659
|
* @throws {RequiredError}
|
|
490
660
|
*/
|
|
491
|
-
async
|
|
492
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
661
|
+
async getRunV1RunsRunIdGet(runId, options) {
|
|
662
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, options);
|
|
493
663
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
494
|
-
const localVarOperationServerBasePath = operationServerMap["PublicApi.
|
|
664
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.getRunV1RunsRunIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
495
665
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
496
666
|
},
|
|
497
667
|
/**
|
|
498
|
-
*
|
|
499
|
-
* @summary List
|
|
500
|
-
* @param {string | null} [applicationId] Optional application ID filter
|
|
501
|
-
* @param {string | null} [applicationVersion] Optional application version filter
|
|
502
|
-
* @param {Array<any> | null} [include] Request optional output values. Used internally by the platform
|
|
668
|
+
* 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.
|
|
669
|
+
* @summary List available applications
|
|
503
670
|
* @param {number} [page]
|
|
504
671
|
* @param {number} [pageSize]
|
|
505
|
-
* @param {Array<string> | null} [sort]
|
|
672
|
+
* @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
|
|
506
673
|
* @param {*} [options] Override http request option.
|
|
507
674
|
* @throws {RequiredError}
|
|
508
675
|
*/
|
|
509
|
-
async
|
|
510
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
676
|
+
async listApplicationsV1ApplicationsGet(page, pageSize, sort, options) {
|
|
677
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listApplicationsV1ApplicationsGet(page, pageSize, sort, options);
|
|
511
678
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
512
|
-
const localVarOperationServerBasePath = operationServerMap["PublicApi.
|
|
679
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
|
|
513
680
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
514
681
|
},
|
|
515
682
|
/**
|
|
516
|
-
*
|
|
517
|
-
* @summary List
|
|
683
|
+
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` 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
|
|
684
|
+
* @summary List Run Items
|
|
685
|
+
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
686
|
+
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
687
|
+
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
688
|
+
* @param {ItemState | null} [state] Filter items by their state
|
|
689
|
+
* @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
|
|
690
|
+
* @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
|
|
518
691
|
* @param {number} [page]
|
|
519
692
|
* @param {number} [pageSize]
|
|
520
|
-
* @param {Array<string> | null} [sort]
|
|
693
|
+
* @param {Array<string> | null} [sort] Sort the items by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `item_id` - `external_id` - `custom_metadata` - `terminated_at` - `termination_reason` **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)
|
|
521
694
|
* @param {*} [options] Override http request option.
|
|
522
695
|
* @throws {RequiredError}
|
|
523
696
|
*/
|
|
524
|
-
async
|
|
525
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
697
|
+
async listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
|
|
698
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
|
|
526
699
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
527
|
-
const localVarOperationServerBasePath = operationServerMap["PublicApi.
|
|
700
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunItemsV1RunsRunIdItemsGet"]?.[localVarOperationServerIndex]?.url;
|
|
528
701
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
529
702
|
},
|
|
530
703
|
/**
|
|
531
|
-
*
|
|
532
|
-
* @summary List
|
|
533
|
-
* @param {string
|
|
534
|
-
* @param {
|
|
535
|
-
* @param {
|
|
536
|
-
* @param {
|
|
704
|
+
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
705
|
+
* @summary List Runs
|
|
706
|
+
* @param {string | null} [applicationId] Optional application ID filter
|
|
707
|
+
* @param {string | null} [applicationVersion] Optional Version Name
|
|
708
|
+
* @param {string | null} [externalId] Optionally filter runs by items with this external ID
|
|
709
|
+
* @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, please 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 - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
|
|
537
710
|
* @param {number} [page]
|
|
538
711
|
* @param {number} [pageSize]
|
|
539
|
-
* @param {Array<string> | null} [sort]
|
|
712
|
+
* @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_id` - `version_number` - `custom_metadata` - `submitted_at` - `submitted_by` - `terminated_at` - `termination_reason` **Examples:** - `?sort=submitted_at` - Sort by creation time (ascending) - `?sort=-submitted_at` - Sort by creation time (descending) - `?sort=state&sort=-submitted_at` - Sort by state, then by time (descending)
|
|
713
|
+
* @param {*} [options] Override http request option.
|
|
714
|
+
* @throws {RequiredError}
|
|
715
|
+
*/
|
|
716
|
+
async listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, sort, options) {
|
|
717
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, sort, options);
|
|
718
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
719
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunsV1RunsGet"]?.[localVarOperationServerIndex]?.url;
|
|
720
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
721
|
+
},
|
|
722
|
+
/**
|
|
723
|
+
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
724
|
+
* @summary Put Item Custom Metadata By Run
|
|
725
|
+
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
726
|
+
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
727
|
+
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
728
|
+
* @param {*} [options] Override http request option.
|
|
729
|
+
* @throws {RequiredError}
|
|
730
|
+
*/
|
|
731
|
+
async putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId, externalId, customMetadataUpdateRequest, options) {
|
|
732
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId, externalId, customMetadataUpdateRequest, options);
|
|
733
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
734
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut"]?.[localVarOperationServerIndex]?.url;
|
|
735
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
736
|
+
},
|
|
737
|
+
/**
|
|
738
|
+
* Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
|
|
739
|
+
* @summary Put Run Custom Metadata
|
|
740
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
741
|
+
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
540
742
|
* @param {*} [options] Override http request option.
|
|
541
743
|
* @throws {RequiredError}
|
|
542
744
|
*/
|
|
543
|
-
async
|
|
544
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
745
|
+
async putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId, customMetadataUpdateRequest, options) {
|
|
746
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId, customMetadataUpdateRequest, options);
|
|
545
747
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
546
|
-
const localVarOperationServerBasePath = operationServerMap["PublicApi.
|
|
748
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.putRunCustomMetadataV1RunsRunIdCustomMetadataPut"]?.[localVarOperationServerIndex]?.url;
|
|
547
749
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
548
750
|
},
|
|
549
751
|
/**
|
|
550
|
-
*
|
|
551
|
-
* @summary
|
|
752
|
+
* Retrieve details of a specific application by its ID.
|
|
753
|
+
* @summary Read Application By Id
|
|
552
754
|
* @param {string} applicationId
|
|
553
|
-
* @param {number} [page]
|
|
554
|
-
* @param {number} [pageSize]
|
|
555
|
-
* @param {string | null} [version]
|
|
556
|
-
* @param {Array<any> | null} [include]
|
|
557
|
-
* @param {Array<string> | null} [sort]
|
|
558
755
|
* @param {*} [options] Override http request option.
|
|
559
756
|
* @throws {RequiredError}
|
|
560
757
|
*/
|
|
561
|
-
async
|
|
562
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
758
|
+
async readApplicationByIdV1ApplicationsApplicationIdGet(applicationId, options) {
|
|
759
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.readApplicationByIdV1ApplicationsApplicationIdGet(applicationId, options);
|
|
563
760
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
564
|
-
const localVarOperationServerBasePath = operationServerMap["PublicApi.
|
|
761
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.readApplicationByIdV1ApplicationsApplicationIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
565
762
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
566
763
|
}
|
|
567
764
|
};
|
|
@@ -570,67 +767,77 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
570
767
|
const localVarFp = PublicApiFp(configuration);
|
|
571
768
|
return {
|
|
572
769
|
/**
|
|
573
|
-
*
|
|
574
|
-
* @summary
|
|
575
|
-
* @param {
|
|
770
|
+
* Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
|
|
771
|
+
* @summary Application Version Details
|
|
772
|
+
* @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
|
|
576
773
|
* @param {*} [options] Override http request option.
|
|
577
774
|
* @throws {RequiredError}
|
|
578
775
|
*/
|
|
579
|
-
|
|
580
|
-
return localVarFp.
|
|
776
|
+
applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters, options) {
|
|
777
|
+
return localVarFp.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters.applicationId, requestParameters.version, options).then((request) => request(axios, basePath));
|
|
581
778
|
},
|
|
582
779
|
/**
|
|
583
|
-
* The
|
|
584
|
-
* @summary
|
|
585
|
-
* @param {
|
|
780
|
+
* The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
|
|
781
|
+
* @summary Cancel Run
|
|
782
|
+
* @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
|
|
586
783
|
* @param {*} [options] Override http request option.
|
|
587
784
|
* @throws {RequiredError}
|
|
588
785
|
*/
|
|
589
|
-
|
|
590
|
-
return localVarFp.
|
|
786
|
+
cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
|
|
787
|
+
return localVarFp.cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(axios, basePath));
|
|
591
788
|
},
|
|
592
789
|
/**
|
|
593
|
-
*
|
|
594
|
-
* @summary
|
|
595
|
-
* @param {
|
|
790
|
+
* 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. 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\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"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 i.e. whole slide images (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 a 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), and 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 `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
791
|
+
* @summary Initiate Run
|
|
792
|
+
* @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
|
|
596
793
|
* @param {*} [options] Override http request option.
|
|
597
794
|
* @throws {RequiredError}
|
|
598
795
|
*/
|
|
599
|
-
|
|
600
|
-
return localVarFp.
|
|
796
|
+
createRunV1RunsPost(requestParameters, options) {
|
|
797
|
+
return localVarFp.createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(axios, basePath));
|
|
601
798
|
},
|
|
602
799
|
/**
|
|
603
|
-
*
|
|
604
|
-
* @summary
|
|
800
|
+
* 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, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
801
|
+
* @summary Delete Run Items
|
|
802
|
+
* @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
|
|
605
803
|
* @param {*} [options] Override http request option.
|
|
606
804
|
* @throws {RequiredError}
|
|
607
805
|
*/
|
|
608
|
-
|
|
609
|
-
return localVarFp.
|
|
806
|
+
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters, options) {
|
|
807
|
+
return localVarFp.deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters.runId, options).then((request) => request(axios, basePath));
|
|
610
808
|
},
|
|
611
809
|
/**
|
|
612
|
-
*
|
|
613
|
-
* @summary Get Run
|
|
614
|
-
* @param {
|
|
810
|
+
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
811
|
+
* @summary Get Item By Run
|
|
812
|
+
* @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
|
|
615
813
|
* @param {*} [options] Override http request option.
|
|
616
814
|
* @throws {RequiredError}
|
|
617
815
|
*/
|
|
618
|
-
|
|
619
|
-
return localVarFp.
|
|
816
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
|
|
817
|
+
return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(axios, basePath));
|
|
620
818
|
},
|
|
621
819
|
/**
|
|
622
|
-
*
|
|
623
|
-
* @summary
|
|
624
|
-
* @param {PublicApiListApplicationRunsV1RunsGetRequest} requestParameters Request parameters.
|
|
820
|
+
* 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)
|
|
821
|
+
* @summary Get current user
|
|
625
822
|
* @param {*} [options] Override http request option.
|
|
626
823
|
* @throws {RequiredError}
|
|
627
824
|
*/
|
|
628
|
-
|
|
629
|
-
return localVarFp.
|
|
825
|
+
getMeV1MeGet(options) {
|
|
826
|
+
return localVarFp.getMeV1MeGet(options).then((request) => request(axios, basePath));
|
|
630
827
|
},
|
|
631
828
|
/**
|
|
632
|
-
*
|
|
633
|
-
* @summary
|
|
829
|
+
* 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 /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
830
|
+
* @summary Get run details
|
|
831
|
+
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
832
|
+
* @param {*} [options] Override http request option.
|
|
833
|
+
* @throws {RequiredError}
|
|
834
|
+
*/
|
|
835
|
+
getRunV1RunsRunIdGet(requestParameters, options) {
|
|
836
|
+
return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(axios, basePath));
|
|
837
|
+
},
|
|
838
|
+
/**
|
|
839
|
+
* 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.
|
|
840
|
+
* @summary List available applications
|
|
634
841
|
* @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
|
|
635
842
|
* @param {*} [options] Override http request option.
|
|
636
843
|
* @throws {RequiredError}
|
|
@@ -639,96 +846,137 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
639
846
|
return localVarFp.listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
640
847
|
},
|
|
641
848
|
/**
|
|
642
|
-
*
|
|
643
|
-
* @summary List Run
|
|
644
|
-
* @param {
|
|
849
|
+
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` 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
|
|
850
|
+
* @summary List Run Items
|
|
851
|
+
* @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
|
|
645
852
|
* @param {*} [options] Override http request option.
|
|
646
853
|
* @throws {RequiredError}
|
|
647
854
|
*/
|
|
648
|
-
|
|
649
|
-
return localVarFp.
|
|
855
|
+
listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
|
|
856
|
+
return localVarFp.listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
650
857
|
},
|
|
651
858
|
/**
|
|
652
|
-
*
|
|
653
|
-
* @summary List
|
|
654
|
-
* @param {
|
|
859
|
+
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
860
|
+
* @summary List Runs
|
|
861
|
+
* @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
|
|
655
862
|
* @param {*} [options] Override http request option.
|
|
656
863
|
* @throws {RequiredError}
|
|
657
864
|
*/
|
|
658
|
-
|
|
659
|
-
return localVarFp.
|
|
865
|
+
listRunsV1RunsGet(requestParameters = {}, options) {
|
|
866
|
+
return localVarFp.listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
867
|
+
},
|
|
868
|
+
/**
|
|
869
|
+
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
870
|
+
* @summary Put Item Custom Metadata By Run
|
|
871
|
+
* @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
872
|
+
* @param {*} [options] Override http request option.
|
|
873
|
+
* @throws {RequiredError}
|
|
874
|
+
*/
|
|
875
|
+
putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters, options) {
|
|
876
|
+
return localVarFp.putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters.runId, requestParameters.externalId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(axios, basePath));
|
|
877
|
+
},
|
|
878
|
+
/**
|
|
879
|
+
* Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
|
|
880
|
+
* @summary Put Run Custom Metadata
|
|
881
|
+
* @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
882
|
+
* @param {*} [options] Override http request option.
|
|
883
|
+
* @throws {RequiredError}
|
|
884
|
+
*/
|
|
885
|
+
putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters, options) {
|
|
886
|
+
return localVarFp.putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters.runId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(axios, basePath));
|
|
887
|
+
},
|
|
888
|
+
/**
|
|
889
|
+
* Retrieve details of a specific application by its ID.
|
|
890
|
+
* @summary Read Application By Id
|
|
891
|
+
* @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
|
|
892
|
+
* @param {*} [options] Override http request option.
|
|
893
|
+
* @throws {RequiredError}
|
|
894
|
+
*/
|
|
895
|
+
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
|
|
896
|
+
return localVarFp.readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(axios, basePath));
|
|
660
897
|
}
|
|
661
898
|
};
|
|
662
899
|
};
|
|
663
900
|
var PublicApi = class extends BaseAPI {
|
|
664
901
|
/**
|
|
665
|
-
*
|
|
666
|
-
* @summary
|
|
667
|
-
* @param {
|
|
902
|
+
* Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
|
|
903
|
+
* @summary Application Version Details
|
|
904
|
+
* @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
|
|
668
905
|
* @param {*} [options] Override http request option.
|
|
669
906
|
* @throws {RequiredError}
|
|
670
907
|
* @memberof PublicApi
|
|
671
908
|
*/
|
|
672
|
-
|
|
673
|
-
return PublicApiFp(this.configuration).
|
|
909
|
+
applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters, options) {
|
|
910
|
+
return PublicApiFp(this.configuration).applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters.applicationId, requestParameters.version, options).then((request) => request(this.axios, this.basePath));
|
|
674
911
|
}
|
|
675
912
|
/**
|
|
676
|
-
* The
|
|
677
|
-
* @summary
|
|
678
|
-
* @param {
|
|
913
|
+
* The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
|
|
914
|
+
* @summary Cancel Run
|
|
915
|
+
* @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
|
|
679
916
|
* @param {*} [options] Override http request option.
|
|
680
917
|
* @throws {RequiredError}
|
|
681
918
|
* @memberof PublicApi
|
|
682
919
|
*/
|
|
683
|
-
|
|
684
|
-
return PublicApiFp(this.configuration).
|
|
920
|
+
cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
|
|
921
|
+
return PublicApiFp(this.configuration).cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
|
|
685
922
|
}
|
|
686
923
|
/**
|
|
687
|
-
*
|
|
688
|
-
* @summary
|
|
689
|
-
* @param {
|
|
924
|
+
* 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. 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\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"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 i.e. whole slide images (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 a 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), and 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 `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
925
|
+
* @summary Initiate Run
|
|
926
|
+
* @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
|
|
690
927
|
* @param {*} [options] Override http request option.
|
|
691
928
|
* @throws {RequiredError}
|
|
692
929
|
* @memberof PublicApi
|
|
693
930
|
*/
|
|
694
|
-
|
|
695
|
-
return PublicApiFp(this.configuration).
|
|
931
|
+
createRunV1RunsPost(requestParameters, options) {
|
|
932
|
+
return PublicApiFp(this.configuration).createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
696
933
|
}
|
|
697
934
|
/**
|
|
698
|
-
*
|
|
699
|
-
* @summary
|
|
935
|
+
* 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, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
936
|
+
* @summary Delete Run Items
|
|
937
|
+
* @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
|
|
700
938
|
* @param {*} [options] Override http request option.
|
|
701
939
|
* @throws {RequiredError}
|
|
702
940
|
* @memberof PublicApi
|
|
703
941
|
*/
|
|
704
|
-
|
|
705
|
-
return PublicApiFp(this.configuration).
|
|
942
|
+
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters, options) {
|
|
943
|
+
return PublicApiFp(this.configuration).deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
|
|
706
944
|
}
|
|
707
945
|
/**
|
|
708
|
-
*
|
|
709
|
-
* @summary Get Run
|
|
710
|
-
* @param {
|
|
946
|
+
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
947
|
+
* @summary Get Item By Run
|
|
948
|
+
* @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
|
|
711
949
|
* @param {*} [options] Override http request option.
|
|
712
950
|
* @throws {RequiredError}
|
|
713
951
|
* @memberof PublicApi
|
|
714
952
|
*/
|
|
715
|
-
|
|
716
|
-
return PublicApiFp(this.configuration).
|
|
953
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
|
|
954
|
+
return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(this.axios, this.basePath));
|
|
717
955
|
}
|
|
718
956
|
/**
|
|
719
|
-
*
|
|
720
|
-
* @summary
|
|
721
|
-
* @param {PublicApiListApplicationRunsV1RunsGetRequest} requestParameters Request parameters.
|
|
957
|
+
* 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)
|
|
958
|
+
* @summary Get current user
|
|
722
959
|
* @param {*} [options] Override http request option.
|
|
723
960
|
* @throws {RequiredError}
|
|
724
961
|
* @memberof PublicApi
|
|
725
962
|
*/
|
|
726
|
-
|
|
727
|
-
return PublicApiFp(this.configuration).
|
|
963
|
+
getMeV1MeGet(options) {
|
|
964
|
+
return PublicApiFp(this.configuration).getMeV1MeGet(options).then((request) => request(this.axios, this.basePath));
|
|
728
965
|
}
|
|
729
966
|
/**
|
|
730
|
-
*
|
|
731
|
-
* @summary
|
|
967
|
+
* 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 /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
968
|
+
* @summary Get run details
|
|
969
|
+
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
970
|
+
* @param {*} [options] Override http request option.
|
|
971
|
+
* @throws {RequiredError}
|
|
972
|
+
* @memberof PublicApi
|
|
973
|
+
*/
|
|
974
|
+
getRunV1RunsRunIdGet(requestParameters, options) {
|
|
975
|
+
return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
|
|
976
|
+
}
|
|
977
|
+
/**
|
|
978
|
+
* 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.
|
|
979
|
+
* @summary List available applications
|
|
732
980
|
* @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
|
|
733
981
|
* @param {*} [options] Override http request option.
|
|
734
982
|
* @throws {RequiredError}
|
|
@@ -738,26 +986,59 @@ var PublicApi = class extends BaseAPI {
|
|
|
738
986
|
return PublicApiFp(this.configuration).listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
739
987
|
}
|
|
740
988
|
/**
|
|
741
|
-
*
|
|
742
|
-
* @summary List Run
|
|
743
|
-
* @param {
|
|
989
|
+
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` 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
|
|
990
|
+
* @summary List Run Items
|
|
991
|
+
* @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
|
|
992
|
+
* @param {*} [options] Override http request option.
|
|
993
|
+
* @throws {RequiredError}
|
|
994
|
+
* @memberof PublicApi
|
|
995
|
+
*/
|
|
996
|
+
listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
|
|
997
|
+
return PublicApiFp(this.configuration).listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
998
|
+
}
|
|
999
|
+
/**
|
|
1000
|
+
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
1001
|
+
* @summary List Runs
|
|
1002
|
+
* @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
|
|
1003
|
+
* @param {*} [options] Override http request option.
|
|
1004
|
+
* @throws {RequiredError}
|
|
1005
|
+
* @memberof PublicApi
|
|
1006
|
+
*/
|
|
1007
|
+
listRunsV1RunsGet(requestParameters = {}, options) {
|
|
1008
|
+
return PublicApiFp(this.configuration).listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1009
|
+
}
|
|
1010
|
+
/**
|
|
1011
|
+
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
1012
|
+
* @summary Put Item Custom Metadata By Run
|
|
1013
|
+
* @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
1014
|
+
* @param {*} [options] Override http request option.
|
|
1015
|
+
* @throws {RequiredError}
|
|
1016
|
+
* @memberof PublicApi
|
|
1017
|
+
*/
|
|
1018
|
+
putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters, options) {
|
|
1019
|
+
return PublicApiFp(this.configuration).putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters.runId, requestParameters.externalId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1020
|
+
}
|
|
1021
|
+
/**
|
|
1022
|
+
* Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
|
|
1023
|
+
* @summary Put Run Custom Metadata
|
|
1024
|
+
* @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
744
1025
|
* @param {*} [options] Override http request option.
|
|
745
1026
|
* @throws {RequiredError}
|
|
746
1027
|
* @memberof PublicApi
|
|
747
1028
|
*/
|
|
748
|
-
|
|
749
|
-
return PublicApiFp(this.configuration).
|
|
1029
|
+
putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters, options) {
|
|
1030
|
+
return PublicApiFp(this.configuration).putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters.runId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
750
1031
|
}
|
|
751
1032
|
/**
|
|
752
|
-
*
|
|
753
|
-
* @summary
|
|
754
|
-
* @param {
|
|
1033
|
+
* Retrieve details of a specific application by its ID.
|
|
1034
|
+
* @summary Read Application By Id
|
|
1035
|
+
* @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
|
|
755
1036
|
* @param {*} [options] Override http request option.
|
|
756
1037
|
* @throws {RequiredError}
|
|
757
1038
|
* @memberof PublicApi
|
|
758
1039
|
*/
|
|
759
|
-
|
|
760
|
-
return PublicApiFp(this.configuration).
|
|
1040
|
+
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
|
|
1041
|
+
return PublicApiFp(this.configuration).readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(this.axios, this.basePath));
|
|
761
1042
|
}
|
|
762
1043
|
};
|
|
763
1044
|
|
|
@@ -1073,36 +1354,77 @@ var PlatformSDKHttp = class {
|
|
|
1073
1354
|
}
|
|
1074
1355
|
}
|
|
1075
1356
|
/**
|
|
1076
|
-
* Retrieve
|
|
1357
|
+
* Retrieve detailed information about a specific application version
|
|
1077
1358
|
*
|
|
1078
|
-
* This method fetches
|
|
1079
|
-
*
|
|
1080
|
-
*
|
|
1359
|
+
* This method fetches comprehensive details about a specific version of an
|
|
1360
|
+
* application, including its changelog, release date, and any version-specific
|
|
1361
|
+
* configurations or features.
|
|
1081
1362
|
*
|
|
1082
1363
|
* @param applicationId - The unique identifier of the application
|
|
1083
|
-
* @
|
|
1084
|
-
* @
|
|
1085
|
-
* @throws {Error} If the request fails due to network issues, invalid application ID, or API errors
|
|
1364
|
+
* @param version - The version string of the application to retrieve
|
|
1365
|
+
* @returns A promise that resolves to the application version details
|
|
1366
|
+
* @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID or version, or API errors
|
|
1086
1367
|
*
|
|
1087
1368
|
* @example
|
|
1088
1369
|
* ```typescript
|
|
1089
1370
|
* const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
|
|
1090
1371
|
*
|
|
1091
1372
|
* try {
|
|
1092
|
-
* const
|
|
1093
|
-
* console.log(`
|
|
1094
|
-
*
|
|
1095
|
-
*
|
|
1373
|
+
* const appVersion = await sdk.getApplicationVersionDetails('app-123', 'v1.2.0');
|
|
1374
|
+
* console.log(`Application Version: ${appVersion.version}`);
|
|
1375
|
+
* console.log(`Release Date: ${appVersion.release_date}`);
|
|
1376
|
+
* console.log(`Changelog: ${appVersion.changelog}`);
|
|
1377
|
+
* } catch (error) {
|
|
1378
|
+
* console.error('Failed to get application version details:', error.message);
|
|
1379
|
+
* }
|
|
1380
|
+
* ```
|
|
1381
|
+
*/
|
|
1382
|
+
async getApplicationVersionDetails(applicationId, version) {
|
|
1383
|
+
const client = await this.#getClient();
|
|
1384
|
+
try {
|
|
1385
|
+
const response = await client.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet({
|
|
1386
|
+
applicationId,
|
|
1387
|
+
version
|
|
1388
|
+
});
|
|
1389
|
+
return response.data;
|
|
1390
|
+
} catch (error) {
|
|
1391
|
+
handleRequestError(error);
|
|
1392
|
+
}
|
|
1393
|
+
}
|
|
1394
|
+
/**
|
|
1395
|
+
* Retrieve detailed information about a specific application
|
|
1396
|
+
*
|
|
1397
|
+
* This method fetches comprehensive details about an application, including
|
|
1398
|
+
* its name, description, regulatory classes, and all available versions.
|
|
1399
|
+
* This provides more detailed information compared to the summary returned
|
|
1400
|
+
* by `listApplications()`.
|
|
1401
|
+
*
|
|
1402
|
+
* @param applicationId - The unique identifier of the application to retrieve
|
|
1403
|
+
* @returns A promise that resolves to the complete application details
|
|
1404
|
+
* @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID, or API errors
|
|
1405
|
+
*
|
|
1406
|
+
* @example
|
|
1407
|
+
* ```typescript
|
|
1408
|
+
* const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
|
|
1409
|
+
*
|
|
1410
|
+
* try {
|
|
1411
|
+
* const application = await sdk.getApplication('app-123');
|
|
1412
|
+
* console.log(`Application: ${application.name}`);
|
|
1413
|
+
* console.log(`Description: ${application.description}`);
|
|
1414
|
+
* console.log(`Available versions: ${application.versions.length}`);
|
|
1415
|
+
*
|
|
1416
|
+
* application.versions.forEach(version => {
|
|
1417
|
+
* console.log(`- ${version.version} (ID: ${version.application_version_id})`);
|
|
1096
1418
|
* });
|
|
1097
1419
|
* } catch (error) {
|
|
1098
|
-
* console.error('Failed to
|
|
1420
|
+
* console.error('Failed to get application details:', error.message);
|
|
1099
1421
|
* }
|
|
1100
1422
|
* ```
|
|
1101
1423
|
*/
|
|
1102
|
-
async
|
|
1424
|
+
async getApplication(applicationId) {
|
|
1103
1425
|
const client = await this.#getClient();
|
|
1104
1426
|
try {
|
|
1105
|
-
const response = await client.
|
|
1427
|
+
const response = await client.readApplicationByIdV1ApplicationsApplicationIdGet({
|
|
1106
1428
|
applicationId
|
|
1107
1429
|
});
|
|
1108
1430
|
return response.data;
|
|
@@ -1151,9 +1473,11 @@ var PlatformSDKHttp = class {
|
|
|
1151
1473
|
async listApplicationRuns(options) {
|
|
1152
1474
|
const client = await this.#getClient();
|
|
1153
1475
|
try {
|
|
1154
|
-
const response = await client.
|
|
1476
|
+
const response = await client.listRunsV1RunsGet({
|
|
1155
1477
|
applicationId: options?.applicationId,
|
|
1156
|
-
applicationVersion: options?.applicationVersion
|
|
1478
|
+
applicationVersion: options?.applicationVersion,
|
|
1479
|
+
customMetadata: options?.customMetadata,
|
|
1480
|
+
sort: options?.sort
|
|
1157
1481
|
});
|
|
1158
1482
|
return response.data;
|
|
1159
1483
|
} catch (error) {
|
|
@@ -1201,7 +1525,7 @@ var PlatformSDKHttp = class {
|
|
|
1201
1525
|
async createApplicationRun(request) {
|
|
1202
1526
|
const client = await this.#getClient();
|
|
1203
1527
|
try {
|
|
1204
|
-
const response = await client.
|
|
1528
|
+
const response = await client.createRunV1RunsPost({
|
|
1205
1529
|
runCreationRequest: request
|
|
1206
1530
|
});
|
|
1207
1531
|
return response.data;
|
|
@@ -1237,8 +1561,8 @@ var PlatformSDKHttp = class {
|
|
|
1237
1561
|
async getRun(applicationRunId) {
|
|
1238
1562
|
const client = await this.#getClient();
|
|
1239
1563
|
try {
|
|
1240
|
-
const response = await client.
|
|
1241
|
-
applicationRunId
|
|
1564
|
+
const response = await client.getRunV1RunsRunIdGet({
|
|
1565
|
+
runId: applicationRunId
|
|
1242
1566
|
});
|
|
1243
1567
|
return response.data;
|
|
1244
1568
|
} catch (error) {
|
|
@@ -1275,8 +1599,8 @@ var PlatformSDKHttp = class {
|
|
|
1275
1599
|
async cancelApplicationRun(applicationRunId) {
|
|
1276
1600
|
const client = await this.#getClient();
|
|
1277
1601
|
try {
|
|
1278
|
-
await client.
|
|
1279
|
-
applicationRunId
|
|
1602
|
+
await client.cancelRunV1RunsRunIdCancelPost({
|
|
1603
|
+
runId: applicationRunId
|
|
1280
1604
|
});
|
|
1281
1605
|
} catch (error) {
|
|
1282
1606
|
handleRequestError(error);
|
|
@@ -1315,8 +1639,8 @@ var PlatformSDKHttp = class {
|
|
|
1315
1639
|
async listRunResults(applicationRunId) {
|
|
1316
1640
|
const client = await this.#getClient();
|
|
1317
1641
|
try {
|
|
1318
|
-
const response = await client.
|
|
1319
|
-
applicationRunId
|
|
1642
|
+
const response = await client.listRunItemsV1RunsRunIdItemsGet({
|
|
1643
|
+
runId: applicationRunId
|
|
1320
1644
|
});
|
|
1321
1645
|
return response.data;
|
|
1322
1646
|
} catch (error) {
|
|
@@ -1370,6 +1694,6 @@ var PlatformSDKHttp = class {
|
|
|
1370
1694
|
// src/index.ts
|
|
1371
1695
|
var index_default = PlatformSDKHttp;
|
|
1372
1696
|
|
|
1373
|
-
export { APIError,
|
|
1697
|
+
export { APIError, ArtifactOutput, ArtifactState, ArtifactTerminationReason, AuthenticationError, BaseError, Configuration, ConfigurationError, ItemOutput, ItemState, ItemTerminationReason, OutputArtifactScope, OutputArtifactVisibility, PlatformSDKHttp, PublicApi, PublicApiAxiosParamCreator, PublicApiFactory, PublicApiFp, RunOutput, RunState, RunTerminationReason, index_default as default };
|
|
1374
1698
|
//# sourceMappingURL=index.js.map
|
|
1375
1699
|
//# sourceMappingURL=index.js.map
|