@aignostics/sdk 3.0.0 → 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-3iWGLFaA.d.cts → api-CZ17GBr_.d.cts} +108 -71
- package/dist/{api-3iWGLFaA.d.ts → api-CZ17GBr_.d.ts} +108 -71
- package/dist/index.cjs +87 -47
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +33 -3
- package/dist/index.d.ts +33 -3
- package/dist/index.js +87 -47
- package/dist/index.js.map +1 -1
- package/dist/test-utils/http-mocks.cjs +58 -0
- package/dist/test-utils/http-mocks.cjs.map +1 -1
- package/dist/test-utils/http-mocks.d.cts +5 -1
- package/dist/test-utils/http-mocks.d.ts +5 -1
- package/dist/test-utils/http-mocks.js +58 -0
- package/dist/test-utils/http-mocks.js.map +1 -1
- package/package.json +1 -1
- package/dist/aignostics-sdk-3.0.0.tgz +0 -0
package/dist/index.cjs
CHANGED
|
@@ -144,7 +144,7 @@ var RunTerminationReason = {
|
|
|
144
144
|
var PublicApiAxiosParamCreator = function(configuration) {
|
|
145
145
|
return {
|
|
146
146
|
/**
|
|
147
|
-
* Get the application version details Allows caller to
|
|
147
|
+
* Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
|
|
148
148
|
* @summary Application Version Details
|
|
149
149
|
* @param {string} applicationId
|
|
150
150
|
* @param {string} version
|
|
@@ -173,7 +173,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
173
173
|
};
|
|
174
174
|
},
|
|
175
175
|
/**
|
|
176
|
-
* The run can be canceled by the user who created the run. The execution can be canceled any time while the
|
|
176
|
+
* 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.
|
|
177
177
|
* @summary Cancel Run
|
|
178
178
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
179
179
|
* @param {*} [options] Override http request option.
|
|
@@ -200,7 +200,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
200
200
|
};
|
|
201
201
|
},
|
|
202
202
|
/**
|
|
203
|
-
* 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
|
|
203
|
+
* 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
|
|
204
204
|
* @summary Initiate Run
|
|
205
205
|
* @param {RunCreationRequest} runCreationRequest
|
|
206
206
|
* @param {*} [options] Override http request option.
|
|
@@ -229,7 +229,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
229
229
|
};
|
|
230
230
|
},
|
|
231
231
|
/**
|
|
232
|
-
* 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
|
|
232
|
+
* 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.
|
|
233
233
|
* @summary Delete Run Items
|
|
234
234
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
235
235
|
* @param {*} [options] Override http request option.
|
|
@@ -310,9 +310,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
310
310
|
};
|
|
311
311
|
},
|
|
312
312
|
/**
|
|
313
|
-
* 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
|
|
313
|
+
* 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.
|
|
314
314
|
* @summary Get run details
|
|
315
|
-
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
315
|
+
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
316
316
|
* @param {*} [options] Override http request option.
|
|
317
317
|
* @throws {RequiredError}
|
|
318
318
|
*/
|
|
@@ -337,7 +337,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
337
337
|
};
|
|
338
338
|
},
|
|
339
339
|
/**
|
|
340
|
-
* 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
|
|
340
|
+
* 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.
|
|
341
341
|
* @summary List available applications
|
|
342
342
|
* @param {number} [page]
|
|
343
343
|
* @param {number} [pageSize]
|
|
@@ -374,9 +374,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
374
374
|
};
|
|
375
375
|
},
|
|
376
376
|
/**
|
|
377
|
-
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by
|
|
377
|
+
* 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
|
|
378
378
|
* @summary List Run Items
|
|
379
|
-
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
379
|
+
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
380
380
|
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
381
381
|
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
382
382
|
* @param {ItemState | null} [state] Filter items by their state
|
|
@@ -384,7 +384,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
384
384
|
* @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
|
|
385
385
|
* @param {number} [page]
|
|
386
386
|
* @param {number} [pageSize]
|
|
387
|
-
* @param {Array<string> | null} [sort] Sort the items by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `item_id` - `
|
|
387
|
+
* @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)
|
|
388
388
|
* @param {*} [options] Override http request option.
|
|
389
389
|
* @throws {RequiredError}
|
|
390
390
|
*/
|
|
@@ -438,10 +438,10 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
438
438
|
* @param {string | null} [applicationId] Optional application ID filter
|
|
439
439
|
* @param {string | null} [applicationVersion] Optional Version Name
|
|
440
440
|
* @param {string | null} [externalId] Optionally filter runs by items with this external ID
|
|
441
|
-
* @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, ensure proper encoding. #### Examples (Clear Format): - **Field existence**: `$.study` - Runs that have a study field defined - **Exact value match**: `$.study ? (@ == \"high\")` - Runs with specific study value - **Numeric comparison**: `$.confidence_score ? (@ > 0.75)` - Runs with confidence score greater than 0.75 - **Array operations**: `$.tags[*] ? (@ == \"draft\")` - Runs with tags array containing \"draft\" - **Complex conditions**: `$.resources ? (@.gpu_count > 2 && @.memory_gb >= 16)` - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: `%24.study` - **Exact value match**: `%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)` - **Numeric comparison**: `%24.confidence_score%20%3F%20(%40%20%3E%200.75)` - **Array operations**: `%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)` - **Complex conditions**: `%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)` #### Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations - Regular expressions use `like_regex` with standard regex syntax - **
|
|
441
|
+
* @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**
|
|
442
442
|
* @param {number} [page]
|
|
443
443
|
* @param {number} [pageSize]
|
|
444
|
-
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `run_id` - `
|
|
444
|
+
* @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)
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
446
446
|
* @throws {RequiredError}
|
|
447
447
|
*/
|
|
@@ -486,7 +486,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
486
486
|
};
|
|
487
487
|
},
|
|
488
488
|
/**
|
|
489
|
-
*
|
|
489
|
+
* 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`.
|
|
490
490
|
* @summary Put Item Custom Metadata By Run
|
|
491
491
|
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
492
492
|
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
@@ -519,7 +519,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
519
519
|
};
|
|
520
520
|
},
|
|
521
521
|
/**
|
|
522
|
-
*
|
|
522
|
+
* 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.
|
|
523
523
|
* @summary Put Run Custom Metadata
|
|
524
524
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
525
525
|
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
@@ -582,7 +582,7 @@ var PublicApiFp = function(configuration) {
|
|
|
582
582
|
const localVarAxiosParamCreator = PublicApiAxiosParamCreator(configuration);
|
|
583
583
|
return {
|
|
584
584
|
/**
|
|
585
|
-
* Get the application version details Allows caller to
|
|
585
|
+
* Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
|
|
586
586
|
* @summary Application Version Details
|
|
587
587
|
* @param {string} applicationId
|
|
588
588
|
* @param {string} version
|
|
@@ -596,7 +596,7 @@ var PublicApiFp = function(configuration) {
|
|
|
596
596
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
597
597
|
},
|
|
598
598
|
/**
|
|
599
|
-
* The run can be canceled by the user who created the run. The execution can be canceled any time while the
|
|
599
|
+
* 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.
|
|
600
600
|
* @summary Cancel Run
|
|
601
601
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
602
602
|
* @param {*} [options] Override http request option.
|
|
@@ -609,7 +609,7 @@ var PublicApiFp = function(configuration) {
|
|
|
609
609
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
610
610
|
},
|
|
611
611
|
/**
|
|
612
|
-
* 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
|
|
612
|
+
* 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
|
|
613
613
|
* @summary Initiate Run
|
|
614
614
|
* @param {RunCreationRequest} runCreationRequest
|
|
615
615
|
* @param {*} [options] Override http request option.
|
|
@@ -622,7 +622,7 @@ var PublicApiFp = function(configuration) {
|
|
|
622
622
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
623
623
|
},
|
|
624
624
|
/**
|
|
625
|
-
* 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
|
|
625
|
+
* 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.
|
|
626
626
|
* @summary Delete Run Items
|
|
627
627
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
628
628
|
* @param {*} [options] Override http request option.
|
|
@@ -661,9 +661,9 @@ var PublicApiFp = function(configuration) {
|
|
|
661
661
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
662
662
|
},
|
|
663
663
|
/**
|
|
664
|
-
* 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
|
|
664
|
+
* 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.
|
|
665
665
|
* @summary Get run details
|
|
666
|
-
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
666
|
+
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
667
667
|
* @param {*} [options] Override http request option.
|
|
668
668
|
* @throws {RequiredError}
|
|
669
669
|
*/
|
|
@@ -674,7 +674,7 @@ var PublicApiFp = function(configuration) {
|
|
|
674
674
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
675
675
|
},
|
|
676
676
|
/**
|
|
677
|
-
* 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
|
|
677
|
+
* 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.
|
|
678
678
|
* @summary List available applications
|
|
679
679
|
* @param {number} [page]
|
|
680
680
|
* @param {number} [pageSize]
|
|
@@ -689,9 +689,9 @@ var PublicApiFp = function(configuration) {
|
|
|
689
689
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
690
690
|
},
|
|
691
691
|
/**
|
|
692
|
-
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by
|
|
692
|
+
* 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
|
|
693
693
|
* @summary List Run Items
|
|
694
|
-
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
694
|
+
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
695
695
|
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
696
696
|
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
697
697
|
* @param {ItemState | null} [state] Filter items by their state
|
|
@@ -699,7 +699,7 @@ var PublicApiFp = function(configuration) {
|
|
|
699
699
|
* @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
|
|
700
700
|
* @param {number} [page]
|
|
701
701
|
* @param {number} [pageSize]
|
|
702
|
-
* @param {Array<string> | null} [sort] Sort the items by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `item_id` - `
|
|
702
|
+
* @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)
|
|
703
703
|
* @param {*} [options] Override http request option.
|
|
704
704
|
* @throws {RequiredError}
|
|
705
705
|
*/
|
|
@@ -715,10 +715,10 @@ var PublicApiFp = function(configuration) {
|
|
|
715
715
|
* @param {string | null} [applicationId] Optional application ID filter
|
|
716
716
|
* @param {string | null} [applicationVersion] Optional Version Name
|
|
717
717
|
* @param {string | null} [externalId] Optionally filter runs by items with this external ID
|
|
718
|
-
* @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, ensure proper encoding. #### Examples (Clear Format): - **Field existence**: `$.study` - Runs that have a study field defined - **Exact value match**: `$.study ? (@ == \"high\")` - Runs with specific study value - **Numeric comparison**: `$.confidence_score ? (@ > 0.75)` - Runs with confidence score greater than 0.75 - **Array operations**: `$.tags[*] ? (@ == \"draft\")` - Runs with tags array containing \"draft\" - **Complex conditions**: `$.resources ? (@.gpu_count > 2 && @.memory_gb >= 16)` - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: `%24.study` - **Exact value match**: `%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)` - **Numeric comparison**: `%24.confidence_score%20%3F%20(%40%20%3E%200.75)` - **Array operations**: `%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)` - **Complex conditions**: `%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)` #### Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations - Regular expressions use `like_regex` with standard regex syntax - **
|
|
718
|
+
* @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**
|
|
719
719
|
* @param {number} [page]
|
|
720
720
|
* @param {number} [pageSize]
|
|
721
|
-
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `run_id` - `
|
|
721
|
+
* @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)
|
|
722
722
|
* @param {*} [options] Override http request option.
|
|
723
723
|
* @throws {RequiredError}
|
|
724
724
|
*/
|
|
@@ -729,7 +729,7 @@ var PublicApiFp = function(configuration) {
|
|
|
729
729
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
730
730
|
},
|
|
731
731
|
/**
|
|
732
|
-
*
|
|
732
|
+
* 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`.
|
|
733
733
|
* @summary Put Item Custom Metadata By Run
|
|
734
734
|
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
735
735
|
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
@@ -744,7 +744,7 @@ var PublicApiFp = function(configuration) {
|
|
|
744
744
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
745
745
|
},
|
|
746
746
|
/**
|
|
747
|
-
*
|
|
747
|
+
* 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.
|
|
748
748
|
* @summary Put Run Custom Metadata
|
|
749
749
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
750
750
|
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
@@ -776,7 +776,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
776
776
|
const localVarFp = PublicApiFp(configuration);
|
|
777
777
|
return {
|
|
778
778
|
/**
|
|
779
|
-
* Get the application version details Allows caller to
|
|
779
|
+
* Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
|
|
780
780
|
* @summary Application Version Details
|
|
781
781
|
* @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
|
|
782
782
|
* @param {*} [options] Override http request option.
|
|
@@ -786,7 +786,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
786
786
|
return localVarFp.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters.applicationId, requestParameters.version, options).then((request) => request(axios, basePath));
|
|
787
787
|
},
|
|
788
788
|
/**
|
|
789
|
-
* The run can be canceled by the user who created the run. The execution can be canceled any time while the
|
|
789
|
+
* 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.
|
|
790
790
|
* @summary Cancel Run
|
|
791
791
|
* @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
|
|
792
792
|
* @param {*} [options] Override http request option.
|
|
@@ -796,7 +796,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
796
796
|
return localVarFp.cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(axios, basePath));
|
|
797
797
|
},
|
|
798
798
|
/**
|
|
799
|
-
* 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
|
|
799
|
+
* 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
|
|
800
800
|
* @summary Initiate Run
|
|
801
801
|
* @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
|
|
802
802
|
* @param {*} [options] Override http request option.
|
|
@@ -806,7 +806,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
806
806
|
return localVarFp.createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(axios, basePath));
|
|
807
807
|
},
|
|
808
808
|
/**
|
|
809
|
-
* 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
|
|
809
|
+
* 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.
|
|
810
810
|
* @summary Delete Run Items
|
|
811
811
|
* @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
|
|
812
812
|
* @param {*} [options] Override http request option.
|
|
@@ -835,7 +835,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
835
835
|
return localVarFp.getMeV1MeGet(options).then((request) => request(axios, basePath));
|
|
836
836
|
},
|
|
837
837
|
/**
|
|
838
|
-
* 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
|
|
838
|
+
* 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.
|
|
839
839
|
* @summary Get run details
|
|
840
840
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
841
841
|
* @param {*} [options] Override http request option.
|
|
@@ -845,7 +845,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
845
845
|
return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(axios, basePath));
|
|
846
846
|
},
|
|
847
847
|
/**
|
|
848
|
-
* 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
|
|
848
|
+
* 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.
|
|
849
849
|
* @summary List available applications
|
|
850
850
|
* @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
|
|
851
851
|
* @param {*} [options] Override http request option.
|
|
@@ -855,7 +855,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
855
855
|
return localVarFp.listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
856
856
|
},
|
|
857
857
|
/**
|
|
858
|
-
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by
|
|
858
|
+
* 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
|
|
859
859
|
* @summary List Run Items
|
|
860
860
|
* @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
|
|
861
861
|
* @param {*} [options] Override http request option.
|
|
@@ -875,7 +875,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
875
875
|
return localVarFp.listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
876
876
|
},
|
|
877
877
|
/**
|
|
878
|
-
*
|
|
878
|
+
* 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`.
|
|
879
879
|
* @summary Put Item Custom Metadata By Run
|
|
880
880
|
* @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
881
881
|
* @param {*} [options] Override http request option.
|
|
@@ -885,7 +885,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
885
885
|
return localVarFp.putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters.runId, requestParameters.externalId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(axios, basePath));
|
|
886
886
|
},
|
|
887
887
|
/**
|
|
888
|
-
*
|
|
888
|
+
* 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.
|
|
889
889
|
* @summary Put Run Custom Metadata
|
|
890
890
|
* @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
891
891
|
* @param {*} [options] Override http request option.
|
|
@@ -908,7 +908,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
908
908
|
};
|
|
909
909
|
var PublicApi = class extends BaseAPI {
|
|
910
910
|
/**
|
|
911
|
-
* Get the application version details Allows caller to
|
|
911
|
+
* Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
|
|
912
912
|
* @summary Application Version Details
|
|
913
913
|
* @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
|
|
914
914
|
* @param {*} [options] Override http request option.
|
|
@@ -919,7 +919,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
919
919
|
return PublicApiFp(this.configuration).applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters.applicationId, requestParameters.version, options).then((request) => request(this.axios, this.basePath));
|
|
920
920
|
}
|
|
921
921
|
/**
|
|
922
|
-
* The run can be canceled by the user who created the run. The execution can be canceled any time while the
|
|
922
|
+
* 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.
|
|
923
923
|
* @summary Cancel Run
|
|
924
924
|
* @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
|
|
925
925
|
* @param {*} [options] Override http request option.
|
|
@@ -930,7 +930,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
930
930
|
return PublicApiFp(this.configuration).cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
|
|
931
931
|
}
|
|
932
932
|
/**
|
|
933
|
-
* 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
|
|
933
|
+
* 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
|
|
934
934
|
* @summary Initiate Run
|
|
935
935
|
* @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
|
|
936
936
|
* @param {*} [options] Override http request option.
|
|
@@ -941,7 +941,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
941
941
|
return PublicApiFp(this.configuration).createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
942
942
|
}
|
|
943
943
|
/**
|
|
944
|
-
* 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
|
|
944
|
+
* 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.
|
|
945
945
|
* @summary Delete Run Items
|
|
946
946
|
* @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
|
|
947
947
|
* @param {*} [options] Override http request option.
|
|
@@ -973,7 +973,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
973
973
|
return PublicApiFp(this.configuration).getMeV1MeGet(options).then((request) => request(this.axios, this.basePath));
|
|
974
974
|
}
|
|
975
975
|
/**
|
|
976
|
-
* 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
|
|
976
|
+
* 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.
|
|
977
977
|
* @summary Get run details
|
|
978
978
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
979
979
|
* @param {*} [options] Override http request option.
|
|
@@ -984,7 +984,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
984
984
|
return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
|
|
985
985
|
}
|
|
986
986
|
/**
|
|
987
|
-
* 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
|
|
987
|
+
* 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.
|
|
988
988
|
* @summary List available applications
|
|
989
989
|
* @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
|
|
990
990
|
* @param {*} [options] Override http request option.
|
|
@@ -995,7 +995,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
995
995
|
return PublicApiFp(this.configuration).listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
996
996
|
}
|
|
997
997
|
/**
|
|
998
|
-
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by
|
|
998
|
+
* 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
|
|
999
999
|
* @summary List Run Items
|
|
1000
1000
|
* @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
|
|
1001
1001
|
* @param {*} [options] Override http request option.
|
|
@@ -1017,7 +1017,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
1017
1017
|
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));
|
|
1018
1018
|
}
|
|
1019
1019
|
/**
|
|
1020
|
-
*
|
|
1020
|
+
* 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`.
|
|
1021
1021
|
* @summary Put Item Custom Metadata By Run
|
|
1022
1022
|
* @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
1023
1023
|
* @param {*} [options] Override http request option.
|
|
@@ -1028,7 +1028,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
1028
1028
|
return PublicApiFp(this.configuration).putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters.runId, requestParameters.externalId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1029
1029
|
}
|
|
1030
1030
|
/**
|
|
1031
|
-
*
|
|
1031
|
+
* 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.
|
|
1032
1032
|
* @summary Put Run Custom Metadata
|
|
1033
1033
|
* @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
|
|
1034
1034
|
* @param {*} [options] Override http request option.
|
|
@@ -1362,6 +1362,44 @@ var PlatformSDKHttp = class {
|
|
|
1362
1362
|
handleRequestError(error);
|
|
1363
1363
|
}
|
|
1364
1364
|
}
|
|
1365
|
+
/**
|
|
1366
|
+
* Retrieve detailed information about a specific application version
|
|
1367
|
+
*
|
|
1368
|
+
* This method fetches comprehensive details about a specific version of an
|
|
1369
|
+
* application, including its changelog, release date, and any version-specific
|
|
1370
|
+
* configurations or features.
|
|
1371
|
+
*
|
|
1372
|
+
* @param applicationId - The unique identifier of the application
|
|
1373
|
+
* @param version - The version string of the application to retrieve
|
|
1374
|
+
* @returns A promise that resolves to the application version details
|
|
1375
|
+
* @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID or version, or API errors
|
|
1376
|
+
*
|
|
1377
|
+
* @example
|
|
1378
|
+
* ```typescript
|
|
1379
|
+
* const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
|
|
1380
|
+
*
|
|
1381
|
+
* try {
|
|
1382
|
+
* const appVersion = await sdk.getApplicationVersionDetails('app-123', 'v1.2.0');
|
|
1383
|
+
* console.log(`Application Version: ${appVersion.version}`);
|
|
1384
|
+
* console.log(`Release Date: ${appVersion.release_date}`);
|
|
1385
|
+
* console.log(`Changelog: ${appVersion.changelog}`);
|
|
1386
|
+
* } catch (error) {
|
|
1387
|
+
* console.error('Failed to get application version details:', error.message);
|
|
1388
|
+
* }
|
|
1389
|
+
* ```
|
|
1390
|
+
*/
|
|
1391
|
+
async getApplicationVersionDetails(applicationId, version) {
|
|
1392
|
+
const client = await this.#getClient();
|
|
1393
|
+
try {
|
|
1394
|
+
const response = await client.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet({
|
|
1395
|
+
applicationId,
|
|
1396
|
+
version
|
|
1397
|
+
});
|
|
1398
|
+
return response.data;
|
|
1399
|
+
} catch (error) {
|
|
1400
|
+
handleRequestError(error);
|
|
1401
|
+
}
|
|
1402
|
+
}
|
|
1365
1403
|
/**
|
|
1366
1404
|
* Retrieve detailed information about a specific application
|
|
1367
1405
|
*
|
|
@@ -1446,7 +1484,9 @@ var PlatformSDKHttp = class {
|
|
|
1446
1484
|
try {
|
|
1447
1485
|
const response = await client.listRunsV1RunsGet({
|
|
1448
1486
|
applicationId: options?.applicationId,
|
|
1449
|
-
applicationVersion: options?.applicationVersion
|
|
1487
|
+
applicationVersion: options?.applicationVersion,
|
|
1488
|
+
customMetadata: options?.customMetadata,
|
|
1489
|
+
sort: options?.sort
|
|
1450
1490
|
});
|
|
1451
1491
|
return response.data;
|
|
1452
1492
|
} catch (error) {
|