@aignostics/sdk 3.4.0 → 3.5.1
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.5.1.tgz +0 -0
- package/dist/{api-DXw7V8bK.d.cts → api-B0sQ1mLM.d.cts} +844 -18
- package/dist/{api-DXw7V8bK.d.ts → api-B0sQ1mLM.d.ts} +844 -18
- package/dist/index.cjs +674 -41
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +16 -10
- package/dist/index.d.ts +16 -10
- package/dist/index.js +672 -42
- package/dist/index.js.map +1 -1
- package/dist/test-utils/http-mocks.d.cts +1 -1
- package/dist/test-utils/http-mocks.d.ts +1 -1
- package/package.json +1 -1
- package/dist/aignostics-sdk-3.4.0.tgz +0 -0
package/dist/index.cjs
CHANGED
|
@@ -103,6 +103,11 @@ var ArtifactTerminationReason = {
|
|
|
103
103
|
SystemError: "SYSTEM_ERROR",
|
|
104
104
|
Skipped: "SKIPPED"
|
|
105
105
|
};
|
|
106
|
+
var GrantRelation = {
|
|
107
|
+
Owner: "owner",
|
|
108
|
+
Editor: "editor",
|
|
109
|
+
Viewer: "viewer"
|
|
110
|
+
};
|
|
106
111
|
var ItemOutput = {
|
|
107
112
|
None: "NONE",
|
|
108
113
|
Full: "FULL"
|
|
@@ -126,6 +131,12 @@ var OutputArtifactVisibility = {
|
|
|
126
131
|
Internal: "INTERNAL",
|
|
127
132
|
External: "EXTERNAL"
|
|
128
133
|
};
|
|
134
|
+
var ResourceType = {
|
|
135
|
+
Run: "run",
|
|
136
|
+
Item: "item",
|
|
137
|
+
OutputArtifact: "output_artifact",
|
|
138
|
+
ShareToken: "share_token"
|
|
139
|
+
};
|
|
129
140
|
var RunOutput = {
|
|
130
141
|
None: "NONE",
|
|
131
142
|
Partial: "PARTIAL",
|
|
@@ -141,6 +152,12 @@ var RunTerminationReason = {
|
|
|
141
152
|
CanceledBySystem: "CANCELED_BY_SYSTEM",
|
|
142
153
|
CanceledByUser: "CANCELED_BY_USER"
|
|
143
154
|
};
|
|
155
|
+
var SubjectType = {
|
|
156
|
+
User: "user",
|
|
157
|
+
OrganizationAdmin: "organization_admin",
|
|
158
|
+
OrganizationUser: "organization_user",
|
|
159
|
+
ShareToken: "share_token"
|
|
160
|
+
};
|
|
144
161
|
var VersionDocumentVisibility = {
|
|
145
162
|
Public: "public",
|
|
146
163
|
Internal: "internal"
|
|
@@ -203,6 +220,35 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
203
220
|
options: localVarRequestOptions
|
|
204
221
|
};
|
|
205
222
|
},
|
|
223
|
+
/**
|
|
224
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
225
|
+
* @summary Create Grant
|
|
226
|
+
* @param {GrantCreateRequest} grantCreateRequest
|
|
227
|
+
* @param {*} [options] Override http request option.
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
*/
|
|
230
|
+
createGrantV1AccessGrantsPost: async (grantCreateRequest, options = {}) => {
|
|
231
|
+
assertParamExists("createGrantV1AccessGrantsPost", "grantCreateRequest", grantCreateRequest);
|
|
232
|
+
const localVarPath = `/v1/access/grants`;
|
|
233
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
234
|
+
let baseOptions;
|
|
235
|
+
if (configuration) {
|
|
236
|
+
baseOptions = configuration.baseOptions;
|
|
237
|
+
}
|
|
238
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
239
|
+
const localVarHeaderParameter = {};
|
|
240
|
+
const localVarQueryParameter = {};
|
|
241
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
242
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
243
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
244
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
245
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
246
|
+
localVarRequestOptions.data = serializeDataIfNeeded(grantCreateRequest, localVarRequestOptions, configuration);
|
|
247
|
+
return {
|
|
248
|
+
url: toPathString(localVarUrlObj),
|
|
249
|
+
options: localVarRequestOptions
|
|
250
|
+
};
|
|
251
|
+
},
|
|
206
252
|
/**
|
|
207
253
|
* 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
|
|
208
254
|
* @summary Initiate Run
|
|
@@ -232,6 +278,35 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
232
278
|
options: localVarRequestOptions
|
|
233
279
|
};
|
|
234
280
|
},
|
|
281
|
+
/**
|
|
282
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
283
|
+
* @summary Create Share Token
|
|
284
|
+
* @param {ShareTokenCreateRequest} shareTokenCreateRequest
|
|
285
|
+
* @param {*} [options] Override http request option.
|
|
286
|
+
* @throws {RequiredError}
|
|
287
|
+
*/
|
|
288
|
+
createShareTokenV1AccessShareTokensPost: async (shareTokenCreateRequest, options = {}) => {
|
|
289
|
+
assertParamExists("createShareTokenV1AccessShareTokensPost", "shareTokenCreateRequest", shareTokenCreateRequest);
|
|
290
|
+
const localVarPath = `/v1/access/share-tokens`;
|
|
291
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
292
|
+
let baseOptions;
|
|
293
|
+
if (configuration) {
|
|
294
|
+
baseOptions = configuration.baseOptions;
|
|
295
|
+
}
|
|
296
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
297
|
+
const localVarHeaderParameter = {};
|
|
298
|
+
const localVarQueryParameter = {};
|
|
299
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
300
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
301
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
302
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
303
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
304
|
+
localVarRequestOptions.data = serializeDataIfNeeded(shareTokenCreateRequest, localVarRequestOptions, configuration);
|
|
305
|
+
return {
|
|
306
|
+
url: toPathString(localVarUrlObj),
|
|
307
|
+
options: localVarRequestOptions
|
|
308
|
+
};
|
|
309
|
+
},
|
|
235
310
|
/**
|
|
236
311
|
* 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.
|
|
237
312
|
* @summary Delete Run Items
|
|
@@ -264,10 +339,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
264
339
|
* @summary Get Artifact Url
|
|
265
340
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
266
341
|
* @param {string} artifactId The artifact id to download
|
|
342
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
267
343
|
* @param {*} [options] Override http request option.
|
|
268
344
|
* @throws {RequiredError}
|
|
269
345
|
*/
|
|
270
|
-
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: async (runId, artifactId, options = {}) => {
|
|
346
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: async (runId, artifactId, shareToken, options = {}) => {
|
|
271
347
|
assertParamExists("getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet", "runId", runId);
|
|
272
348
|
assertParamExists("getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet", "artifactId", artifactId);
|
|
273
349
|
const localVarPath = `/v1/runs/{run_id}/artifacts/{artifact_id}/file`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"artifact_id"}}`, encodeURIComponent(String(artifactId)));
|
|
@@ -280,6 +356,36 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
280
356
|
const localVarHeaderParameter = {};
|
|
281
357
|
const localVarQueryParameter = {};
|
|
282
358
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
359
|
+
if (shareToken !== void 0) {
|
|
360
|
+
localVarQueryParameter["share_token"] = shareToken;
|
|
361
|
+
}
|
|
362
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
363
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
364
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
365
|
+
return {
|
|
366
|
+
url: toPathString(localVarUrlObj),
|
|
367
|
+
options: localVarRequestOptions
|
|
368
|
+
};
|
|
369
|
+
},
|
|
370
|
+
/**
|
|
371
|
+
* Get a grant by its ID.
|
|
372
|
+
* @summary Get Grant
|
|
373
|
+
* @param {string} grantId Grant ID
|
|
374
|
+
* @param {*} [options] Override http request option.
|
|
375
|
+
* @throws {RequiredError}
|
|
376
|
+
*/
|
|
377
|
+
getGrantV1AccessGrantsGrantIdGet: async (grantId, options = {}) => {
|
|
378
|
+
assertParamExists("getGrantV1AccessGrantsGrantIdGet", "grantId", grantId);
|
|
379
|
+
const localVarPath = `/v1/access/grants/{grant_id}`.replace(`{${"grant_id"}}`, encodeURIComponent(String(grantId)));
|
|
380
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
381
|
+
let baseOptions;
|
|
382
|
+
if (configuration) {
|
|
383
|
+
baseOptions = configuration.baseOptions;
|
|
384
|
+
}
|
|
385
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
386
|
+
const localVarHeaderParameter = {};
|
|
387
|
+
const localVarQueryParameter = {};
|
|
388
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
283
389
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
284
390
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
285
391
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -293,10 +399,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
293
399
|
* @summary Get Item By Run
|
|
294
400
|
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
295
401
|
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
402
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
296
403
|
* @param {*} [options] Override http request option.
|
|
297
404
|
* @throws {RequiredError}
|
|
298
405
|
*/
|
|
299
|
-
getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, options = {}) => {
|
|
406
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, shareToken, options = {}) => {
|
|
300
407
|
assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "runId", runId);
|
|
301
408
|
assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "externalId", externalId);
|
|
302
409
|
const localVarPath = `/v1/runs/{run_id}/items/{external_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"external_id"}}`, encodeURIComponent(String(externalId)));
|
|
@@ -309,6 +416,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
309
416
|
const localVarHeaderParameter = {};
|
|
310
417
|
const localVarQueryParameter = {};
|
|
311
418
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
419
|
+
if (shareToken !== void 0) {
|
|
420
|
+
localVarQueryParameter["share_token"] = shareToken;
|
|
421
|
+
}
|
|
312
422
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
313
423
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
314
424
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -343,13 +453,14 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
343
453
|
};
|
|
344
454
|
},
|
|
345
455
|
/**
|
|
346
|
-
* 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.
|
|
456
|
+
* 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, or users with an active grant or valid share token.
|
|
347
457
|
* @summary Get run details
|
|
348
458
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
459
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
349
460
|
* @param {*} [options] Override http request option.
|
|
350
461
|
* @throws {RequiredError}
|
|
351
462
|
*/
|
|
352
|
-
getRunV1RunsRunIdGet: async (runId, options = {}) => {
|
|
463
|
+
getRunV1RunsRunIdGet: async (runId, shareToken, options = {}) => {
|
|
353
464
|
assertParamExists("getRunV1RunsRunIdGet", "runId", runId);
|
|
354
465
|
const localVarPath = `/v1/runs/{run_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
|
|
355
466
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -361,6 +472,36 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
361
472
|
const localVarHeaderParameter = {};
|
|
362
473
|
const localVarQueryParameter = {};
|
|
363
474
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
475
|
+
if (shareToken !== void 0) {
|
|
476
|
+
localVarQueryParameter["share_token"] = shareToken;
|
|
477
|
+
}
|
|
478
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
479
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
480
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
481
|
+
return {
|
|
482
|
+
url: toPathString(localVarUrlObj),
|
|
483
|
+
options: localVarRequestOptions
|
|
484
|
+
};
|
|
485
|
+
},
|
|
486
|
+
/**
|
|
487
|
+
* Get a share token by its ID.
|
|
488
|
+
* @summary Get Share Token
|
|
489
|
+
* @param {string} shareTokenId Share token ID
|
|
490
|
+
* @param {*} [options] Override http request option.
|
|
491
|
+
* @throws {RequiredError}
|
|
492
|
+
*/
|
|
493
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet: async (shareTokenId, options = {}) => {
|
|
494
|
+
assertParamExists("getShareTokenV1AccessShareTokensShareTokenIdGet", "shareTokenId", shareTokenId);
|
|
495
|
+
const localVarPath = `/v1/access/share-tokens/{share_token_id}`.replace(`{${"share_token_id"}}`, encodeURIComponent(String(shareTokenId)));
|
|
496
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
497
|
+
let baseOptions;
|
|
498
|
+
if (configuration) {
|
|
499
|
+
baseOptions = configuration.baseOptions;
|
|
500
|
+
}
|
|
501
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
502
|
+
const localVarHeaderParameter = {};
|
|
503
|
+
const localVarQueryParameter = {};
|
|
504
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
364
505
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
365
506
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
366
507
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -499,10 +640,72 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
499
640
|
options: localVarRequestOptions
|
|
500
641
|
};
|
|
501
642
|
},
|
|
643
|
+
/**
|
|
644
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
645
|
+
* @summary List Grants
|
|
646
|
+
* @param {ResourceType | null} [resourceType]
|
|
647
|
+
* @param {string | null} [resourceId]
|
|
648
|
+
* @param {SubjectType | null} [subjectType]
|
|
649
|
+
* @param {string | null} [subjectId]
|
|
650
|
+
* @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
|
|
651
|
+
* @param {boolean | null} [revoked]
|
|
652
|
+
* @param {number} [page]
|
|
653
|
+
* @param {number} [pageSize]
|
|
654
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
655
|
+
* @param {*} [options] Override http request option.
|
|
656
|
+
* @throws {RequiredError}
|
|
657
|
+
*/
|
|
658
|
+
listGrantsV1AccessGrantsGet: async (resourceType, resourceId, subjectType, subjectId, relation, revoked, page, pageSize, sort, options = {}) => {
|
|
659
|
+
const localVarPath = `/v1/access/grants`;
|
|
660
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
661
|
+
let baseOptions;
|
|
662
|
+
if (configuration) {
|
|
663
|
+
baseOptions = configuration.baseOptions;
|
|
664
|
+
}
|
|
665
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
666
|
+
const localVarHeaderParameter = {};
|
|
667
|
+
const localVarQueryParameter = {};
|
|
668
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
669
|
+
if (resourceType !== void 0) {
|
|
670
|
+
localVarQueryParameter["resource_type"] = resourceType;
|
|
671
|
+
}
|
|
672
|
+
if (resourceId !== void 0) {
|
|
673
|
+
localVarQueryParameter["resource_id"] = resourceId;
|
|
674
|
+
}
|
|
675
|
+
if (subjectType !== void 0) {
|
|
676
|
+
localVarQueryParameter["subject_type"] = subjectType;
|
|
677
|
+
}
|
|
678
|
+
if (subjectId !== void 0) {
|
|
679
|
+
localVarQueryParameter["subject_id"] = subjectId;
|
|
680
|
+
}
|
|
681
|
+
if (relation) {
|
|
682
|
+
localVarQueryParameter["relation"] = relation;
|
|
683
|
+
}
|
|
684
|
+
if (revoked !== void 0) {
|
|
685
|
+
localVarQueryParameter["revoked"] = revoked;
|
|
686
|
+
}
|
|
687
|
+
if (page !== void 0) {
|
|
688
|
+
localVarQueryParameter["page"] = page;
|
|
689
|
+
}
|
|
690
|
+
if (pageSize !== void 0) {
|
|
691
|
+
localVarQueryParameter["page_size"] = pageSize;
|
|
692
|
+
}
|
|
693
|
+
if (sort) {
|
|
694
|
+
localVarQueryParameter["sort"] = sort;
|
|
695
|
+
}
|
|
696
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
697
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
698
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
699
|
+
return {
|
|
700
|
+
url: toPathString(localVarUrlObj),
|
|
701
|
+
options: localVarRequestOptions
|
|
702
|
+
};
|
|
703
|
+
},
|
|
502
704
|
/**
|
|
503
705
|
* 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
|
|
504
706
|
* @summary List Run Items
|
|
505
707
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
708
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
506
709
|
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
507
710
|
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
508
711
|
* @param {ItemState | null} [state] Filter items by their state
|
|
@@ -514,7 +717,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
514
717
|
* @param {*} [options] Override http request option.
|
|
515
718
|
* @throws {RequiredError}
|
|
516
719
|
*/
|
|
517
|
-
listRunItemsV1RunsRunIdItemsGet: async (runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
|
|
720
|
+
listRunItemsV1RunsRunIdItemsGet: async (runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
|
|
518
721
|
assertParamExists("listRunItemsV1RunsRunIdItemsGet", "runId", runId);
|
|
519
722
|
const localVarPath = `/v1/runs/{run_id}/items`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
|
|
520
723
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -526,6 +729,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
526
729
|
const localVarHeaderParameter = {};
|
|
527
730
|
const localVarQueryParameter = {};
|
|
528
731
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
732
|
+
if (shareToken !== void 0) {
|
|
733
|
+
localVarQueryParameter["share_token"] = shareToken;
|
|
734
|
+
}
|
|
529
735
|
if (itemIdIn) {
|
|
530
736
|
localVarQueryParameter["item_id__in"] = itemIdIn;
|
|
531
737
|
}
|
|
@@ -567,12 +773,14 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
567
773
|
* @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**
|
|
568
774
|
* @param {number} [page]
|
|
569
775
|
* @param {number} [pageSize]
|
|
776
|
+
* @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
777
|
+
* @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
570
778
|
* @param {string | null} [forOrganization] Filter runs by organization ID. Available for superadmins (any org) and admins (own org only). When provided, returns all runs for the specified organization instead of only the caller\'s own runs.
|
|
571
779
|
* @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)
|
|
572
780
|
* @param {*} [options] Override http request option.
|
|
573
781
|
* @throws {RequiredError}
|
|
574
782
|
*/
|
|
575
|
-
listRunsV1RunsGet: async (applicationId, applicationVersion, externalId, customMetadata, page, pageSize, forOrganization, sort, options = {}) => {
|
|
783
|
+
listRunsV1RunsGet: async (applicationId, applicationVersion, externalId, customMetadata, page, pageSize, submittedBy, organizationId, forOrganization, sort, options = {}) => {
|
|
576
784
|
const localVarPath = `/v1/runs`;
|
|
577
785
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
578
786
|
let baseOptions;
|
|
@@ -601,6 +809,12 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
601
809
|
if (pageSize !== void 0) {
|
|
602
810
|
localVarQueryParameter["page_size"] = pageSize;
|
|
603
811
|
}
|
|
812
|
+
if (submittedBy !== void 0) {
|
|
813
|
+
localVarQueryParameter["submitted_by"] = submittedBy;
|
|
814
|
+
}
|
|
815
|
+
if (organizationId !== void 0) {
|
|
816
|
+
localVarQueryParameter["organization_id"] = organizationId;
|
|
817
|
+
}
|
|
604
818
|
if (forOrganization !== void 0) {
|
|
605
819
|
localVarQueryParameter["for_organization"] = forOrganization;
|
|
606
820
|
}
|
|
@@ -615,6 +829,55 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
615
829
|
options: localVarRequestOptions
|
|
616
830
|
};
|
|
617
831
|
},
|
|
832
|
+
/**
|
|
833
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
834
|
+
* @summary List Share Tokens
|
|
835
|
+
* @param {string | null} [runId] Filter by run ID
|
|
836
|
+
* @param {string | null} [createdBy] Filter by share token creator
|
|
837
|
+
* @param {boolean | null} [revoked]
|
|
838
|
+
* @param {number} [page]
|
|
839
|
+
* @param {number} [pageSize]
|
|
840
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
841
|
+
* @param {*} [options] Override http request option.
|
|
842
|
+
* @throws {RequiredError}
|
|
843
|
+
*/
|
|
844
|
+
listShareTokensV1AccessShareTokensGet: async (runId, createdBy, revoked, page, pageSize, sort, options = {}) => {
|
|
845
|
+
const localVarPath = `/v1/access/share-tokens`;
|
|
846
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
847
|
+
let baseOptions;
|
|
848
|
+
if (configuration) {
|
|
849
|
+
baseOptions = configuration.baseOptions;
|
|
850
|
+
}
|
|
851
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
852
|
+
const localVarHeaderParameter = {};
|
|
853
|
+
const localVarQueryParameter = {};
|
|
854
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
855
|
+
if (runId !== void 0) {
|
|
856
|
+
localVarQueryParameter["run_id"] = runId;
|
|
857
|
+
}
|
|
858
|
+
if (createdBy !== void 0) {
|
|
859
|
+
localVarQueryParameter["created_by"] = createdBy;
|
|
860
|
+
}
|
|
861
|
+
if (revoked !== void 0) {
|
|
862
|
+
localVarQueryParameter["revoked"] = revoked;
|
|
863
|
+
}
|
|
864
|
+
if (page !== void 0) {
|
|
865
|
+
localVarQueryParameter["page"] = page;
|
|
866
|
+
}
|
|
867
|
+
if (pageSize !== void 0) {
|
|
868
|
+
localVarQueryParameter["page_size"] = pageSize;
|
|
869
|
+
}
|
|
870
|
+
if (sort) {
|
|
871
|
+
localVarQueryParameter["sort"] = sort;
|
|
872
|
+
}
|
|
873
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
874
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
875
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
876
|
+
return {
|
|
877
|
+
url: toPathString(localVarUrlObj),
|
|
878
|
+
options: localVarRequestOptions
|
|
879
|
+
};
|
|
880
|
+
},
|
|
618
881
|
/**
|
|
619
882
|
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
620
883
|
* @summary List version documents
|
|
@@ -734,6 +997,60 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
734
997
|
url: toPathString(localVarUrlObj),
|
|
735
998
|
options: localVarRequestOptions
|
|
736
999
|
};
|
|
1000
|
+
},
|
|
1001
|
+
/**
|
|
1002
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1003
|
+
* @summary Revoke Grant
|
|
1004
|
+
* @param {string} grantId Grant ID
|
|
1005
|
+
* @param {*} [options] Override http request option.
|
|
1006
|
+
* @throws {RequiredError}
|
|
1007
|
+
*/
|
|
1008
|
+
revokeGrantV1AccessGrantsGrantIdDelete: async (grantId, options = {}) => {
|
|
1009
|
+
assertParamExists("revokeGrantV1AccessGrantsGrantIdDelete", "grantId", grantId);
|
|
1010
|
+
const localVarPath = `/v1/access/grants/{grant_id}`.replace(`{${"grant_id"}}`, encodeURIComponent(String(grantId)));
|
|
1011
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1012
|
+
let baseOptions;
|
|
1013
|
+
if (configuration) {
|
|
1014
|
+
baseOptions = configuration.baseOptions;
|
|
1015
|
+
}
|
|
1016
|
+
const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
|
|
1017
|
+
const localVarHeaderParameter = {};
|
|
1018
|
+
const localVarQueryParameter = {};
|
|
1019
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
1020
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1021
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1022
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1023
|
+
return {
|
|
1024
|
+
url: toPathString(localVarUrlObj),
|
|
1025
|
+
options: localVarRequestOptions
|
|
1026
|
+
};
|
|
1027
|
+
},
|
|
1028
|
+
/**
|
|
1029
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1030
|
+
* @summary Revoke Share Token
|
|
1031
|
+
* @param {string} shareTokenId Share token ID
|
|
1032
|
+
* @param {*} [options] Override http request option.
|
|
1033
|
+
* @throws {RequiredError}
|
|
1034
|
+
*/
|
|
1035
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete: async (shareTokenId, options = {}) => {
|
|
1036
|
+
assertParamExists("revokeShareTokenV1AccessShareTokensShareTokenIdDelete", "shareTokenId", shareTokenId);
|
|
1037
|
+
const localVarPath = `/v1/access/share-tokens/{share_token_id}`.replace(`{${"share_token_id"}}`, encodeURIComponent(String(shareTokenId)));
|
|
1038
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1039
|
+
let baseOptions;
|
|
1040
|
+
if (configuration) {
|
|
1041
|
+
baseOptions = configuration.baseOptions;
|
|
1042
|
+
}
|
|
1043
|
+
const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
|
|
1044
|
+
const localVarHeaderParameter = {};
|
|
1045
|
+
const localVarQueryParameter = {};
|
|
1046
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
1047
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1048
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1049
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1050
|
+
return {
|
|
1051
|
+
url: toPathString(localVarUrlObj),
|
|
1052
|
+
options: localVarRequestOptions
|
|
1053
|
+
};
|
|
737
1054
|
}
|
|
738
1055
|
};
|
|
739
1056
|
};
|
|
@@ -767,6 +1084,19 @@ var PublicApiFp = function(configuration) {
|
|
|
767
1084
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.cancelRunV1RunsRunIdCancelPost"]?.[localVarOperationServerIndex]?.url;
|
|
768
1085
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
769
1086
|
},
|
|
1087
|
+
/**
|
|
1088
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1089
|
+
* @summary Create Grant
|
|
1090
|
+
* @param {GrantCreateRequest} grantCreateRequest
|
|
1091
|
+
* @param {*} [options] Override http request option.
|
|
1092
|
+
* @throws {RequiredError}
|
|
1093
|
+
*/
|
|
1094
|
+
async createGrantV1AccessGrantsPost(grantCreateRequest, options) {
|
|
1095
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createGrantV1AccessGrantsPost(grantCreateRequest, options);
|
|
1096
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1097
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.createGrantV1AccessGrantsPost"]?.[localVarOperationServerIndex]?.url;
|
|
1098
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1099
|
+
},
|
|
770
1100
|
/**
|
|
771
1101
|
* 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
|
|
772
1102
|
* @summary Initiate Run
|
|
@@ -780,6 +1110,19 @@ var PublicApiFp = function(configuration) {
|
|
|
780
1110
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.createRunV1RunsPost"]?.[localVarOperationServerIndex]?.url;
|
|
781
1111
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
782
1112
|
},
|
|
1113
|
+
/**
|
|
1114
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
1115
|
+
* @summary Create Share Token
|
|
1116
|
+
* @param {ShareTokenCreateRequest} shareTokenCreateRequest
|
|
1117
|
+
* @param {*} [options] Override http request option.
|
|
1118
|
+
* @throws {RequiredError}
|
|
1119
|
+
*/
|
|
1120
|
+
async createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest, options) {
|
|
1121
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest, options);
|
|
1122
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1123
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.createShareTokenV1AccessShareTokensPost"]?.[localVarOperationServerIndex]?.url;
|
|
1124
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1125
|
+
},
|
|
783
1126
|
/**
|
|
784
1127
|
* 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.
|
|
785
1128
|
* @summary Delete Run Items
|
|
@@ -798,25 +1141,40 @@ var PublicApiFp = function(configuration) {
|
|
|
798
1141
|
* @summary Get Artifact Url
|
|
799
1142
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
800
1143
|
* @param {string} artifactId The artifact id to download
|
|
1144
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
801
1145
|
* @param {*} [options] Override http request option.
|
|
802
1146
|
* @throws {RequiredError}
|
|
803
1147
|
*/
|
|
804
|
-
async getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, options) {
|
|
805
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, options);
|
|
1148
|
+
async getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, shareToken, options) {
|
|
1149
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, shareToken, options);
|
|
806
1150
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
807
1151
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet"]?.[localVarOperationServerIndex]?.url;
|
|
808
1152
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
809
1153
|
},
|
|
1154
|
+
/**
|
|
1155
|
+
* Get a grant by its ID.
|
|
1156
|
+
* @summary Get Grant
|
|
1157
|
+
* @param {string} grantId Grant ID
|
|
1158
|
+
* @param {*} [options] Override http request option.
|
|
1159
|
+
* @throws {RequiredError}
|
|
1160
|
+
*/
|
|
1161
|
+
async getGrantV1AccessGrantsGrantIdGet(grantId, options) {
|
|
1162
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGrantV1AccessGrantsGrantIdGet(grantId, options);
|
|
1163
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1164
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.getGrantV1AccessGrantsGrantIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
1165
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1166
|
+
},
|
|
810
1167
|
/**
|
|
811
1168
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
812
1169
|
* @summary Get Item By Run
|
|
813
1170
|
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
814
1171
|
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1172
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
815
1173
|
* @param {*} [options] Override http request option.
|
|
816
1174
|
* @throws {RequiredError}
|
|
817
1175
|
*/
|
|
818
|
-
async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options) {
|
|
819
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options);
|
|
1176
|
+
async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, shareToken, options) {
|
|
1177
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, shareToken, options);
|
|
820
1178
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
821
1179
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.getItemByRunV1RunsRunIdItemsExternalIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
822
1180
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -834,18 +1192,32 @@ var PublicApiFp = function(configuration) {
|
|
|
834
1192
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
835
1193
|
},
|
|
836
1194
|
/**
|
|
837
|
-
* 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.
|
|
1195
|
+
* 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, or users with an active grant or valid share token.
|
|
838
1196
|
* @summary Get run details
|
|
839
1197
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1198
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
840
1199
|
* @param {*} [options] Override http request option.
|
|
841
1200
|
* @throws {RequiredError}
|
|
842
1201
|
*/
|
|
843
|
-
async getRunV1RunsRunIdGet(runId, options) {
|
|
844
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, options);
|
|
1202
|
+
async getRunV1RunsRunIdGet(runId, shareToken, options) {
|
|
1203
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, shareToken, options);
|
|
845
1204
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
846
1205
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.getRunV1RunsRunIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
847
1206
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
848
1207
|
},
|
|
1208
|
+
/**
|
|
1209
|
+
* Get a share token by its ID.
|
|
1210
|
+
* @summary Get Share Token
|
|
1211
|
+
* @param {string} shareTokenId Share token ID
|
|
1212
|
+
* @param {*} [options] Override http request option.
|
|
1213
|
+
* @throws {RequiredError}
|
|
1214
|
+
*/
|
|
1215
|
+
async getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId, options) {
|
|
1216
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId, options);
|
|
1217
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1218
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.getShareTokenV1AccessShareTokensShareTokenIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
1219
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1220
|
+
},
|
|
849
1221
|
/**
|
|
850
1222
|
* Return metadata for a single public document attached to an application version.
|
|
851
1223
|
* @summary Get version document metadata
|
|
@@ -906,10 +1278,32 @@ var PublicApiFp = function(configuration) {
|
|
|
906
1278
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
|
|
907
1279
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
908
1280
|
},
|
|
1281
|
+
/**
|
|
1282
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
1283
|
+
* @summary List Grants
|
|
1284
|
+
* @param {ResourceType | null} [resourceType]
|
|
1285
|
+
* @param {string | null} [resourceId]
|
|
1286
|
+
* @param {SubjectType | null} [subjectType]
|
|
1287
|
+
* @param {string | null} [subjectId]
|
|
1288
|
+
* @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
|
|
1289
|
+
* @param {boolean | null} [revoked]
|
|
1290
|
+
* @param {number} [page]
|
|
1291
|
+
* @param {number} [pageSize]
|
|
1292
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1293
|
+
* @param {*} [options] Override http request option.
|
|
1294
|
+
* @throws {RequiredError}
|
|
1295
|
+
*/
|
|
1296
|
+
async listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, relation, revoked, page, pageSize, sort, options) {
|
|
1297
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, relation, revoked, page, pageSize, sort, options);
|
|
1298
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1299
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.listGrantsV1AccessGrantsGet"]?.[localVarOperationServerIndex]?.url;
|
|
1300
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1301
|
+
},
|
|
909
1302
|
/**
|
|
910
1303
|
* 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
|
|
911
1304
|
* @summary List Run Items
|
|
912
1305
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1306
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
913
1307
|
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
914
1308
|
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
915
1309
|
* @param {ItemState | null} [state] Filter items by their state
|
|
@@ -921,8 +1315,8 @@ var PublicApiFp = function(configuration) {
|
|
|
921
1315
|
* @param {*} [options] Override http request option.
|
|
922
1316
|
* @throws {RequiredError}
|
|
923
1317
|
*/
|
|
924
|
-
async listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
|
|
925
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
|
|
1318
|
+
async listRunItemsV1RunsRunIdItemsGet(runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
|
|
1319
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
|
|
926
1320
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
927
1321
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunItemsV1RunsRunIdItemsGet"]?.[localVarOperationServerIndex]?.url;
|
|
928
1322
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -936,17 +1330,37 @@ var PublicApiFp = function(configuration) {
|
|
|
936
1330
|
* @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**
|
|
937
1331
|
* @param {number} [page]
|
|
938
1332
|
* @param {number} [pageSize]
|
|
1333
|
+
* @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
1334
|
+
* @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
939
1335
|
* @param {string | null} [forOrganization] Filter runs by organization ID. Available for superadmins (any org) and admins (own org only). When provided, returns all runs for the specified organization instead of only the caller\'s own runs.
|
|
940
1336
|
* @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)
|
|
941
1337
|
* @param {*} [options] Override http request option.
|
|
942
1338
|
* @throws {RequiredError}
|
|
943
1339
|
*/
|
|
944
|
-
async listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, forOrganization, sort, options) {
|
|
945
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, forOrganization, sort, options);
|
|
1340
|
+
async listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, submittedBy, organizationId, forOrganization, sort, options) {
|
|
1341
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, submittedBy, organizationId, forOrganization, sort, options);
|
|
946
1342
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
947
1343
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunsV1RunsGet"]?.[localVarOperationServerIndex]?.url;
|
|
948
1344
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
949
1345
|
},
|
|
1346
|
+
/**
|
|
1347
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1348
|
+
* @summary List Share Tokens
|
|
1349
|
+
* @param {string | null} [runId] Filter by run ID
|
|
1350
|
+
* @param {string | null} [createdBy] Filter by share token creator
|
|
1351
|
+
* @param {boolean | null} [revoked]
|
|
1352
|
+
* @param {number} [page]
|
|
1353
|
+
* @param {number} [pageSize]
|
|
1354
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1355
|
+
* @param {*} [options] Override http request option.
|
|
1356
|
+
* @throws {RequiredError}
|
|
1357
|
+
*/
|
|
1358
|
+
async listShareTokensV1AccessShareTokensGet(runId, createdBy, revoked, page, pageSize, sort, options) {
|
|
1359
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listShareTokensV1AccessShareTokensGet(runId, createdBy, revoked, page, pageSize, sort, options);
|
|
1360
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1361
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.listShareTokensV1AccessShareTokensGet"]?.[localVarOperationServerIndex]?.url;
|
|
1362
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1363
|
+
},
|
|
950
1364
|
/**
|
|
951
1365
|
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
952
1366
|
* @summary List version documents
|
|
@@ -1002,6 +1416,32 @@ var PublicApiFp = function(configuration) {
|
|
|
1002
1416
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1003
1417
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.readApplicationByIdV1ApplicationsApplicationIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
1004
1418
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1419
|
+
},
|
|
1420
|
+
/**
|
|
1421
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1422
|
+
* @summary Revoke Grant
|
|
1423
|
+
* @param {string} grantId Grant ID
|
|
1424
|
+
* @param {*} [options] Override http request option.
|
|
1425
|
+
* @throws {RequiredError}
|
|
1426
|
+
*/
|
|
1427
|
+
async revokeGrantV1AccessGrantsGrantIdDelete(grantId, options) {
|
|
1428
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.revokeGrantV1AccessGrantsGrantIdDelete(grantId, options);
|
|
1429
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1430
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.revokeGrantV1AccessGrantsGrantIdDelete"]?.[localVarOperationServerIndex]?.url;
|
|
1431
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1432
|
+
},
|
|
1433
|
+
/**
|
|
1434
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1435
|
+
* @summary Revoke Share Token
|
|
1436
|
+
* @param {string} shareTokenId Share token ID
|
|
1437
|
+
* @param {*} [options] Override http request option.
|
|
1438
|
+
* @throws {RequiredError}
|
|
1439
|
+
*/
|
|
1440
|
+
async revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId, options) {
|
|
1441
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId, options);
|
|
1442
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1443
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.revokeShareTokenV1AccessShareTokensShareTokenIdDelete"]?.[localVarOperationServerIndex]?.url;
|
|
1444
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1005
1445
|
}
|
|
1006
1446
|
};
|
|
1007
1447
|
};
|
|
@@ -1028,6 +1468,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1028
1468
|
cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
|
|
1029
1469
|
return localVarFp.cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(axios, basePath));
|
|
1030
1470
|
},
|
|
1471
|
+
/**
|
|
1472
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1473
|
+
* @summary Create Grant
|
|
1474
|
+
* @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
|
|
1475
|
+
* @param {*} [options] Override http request option.
|
|
1476
|
+
* @throws {RequiredError}
|
|
1477
|
+
*/
|
|
1478
|
+
createGrantV1AccessGrantsPost(requestParameters, options) {
|
|
1479
|
+
return localVarFp.createGrantV1AccessGrantsPost(requestParameters.grantCreateRequest, options).then((request) => request(axios, basePath));
|
|
1480
|
+
},
|
|
1031
1481
|
/**
|
|
1032
1482
|
* 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
|
|
1033
1483
|
* @summary Initiate Run
|
|
@@ -1038,6 +1488,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1038
1488
|
createRunV1RunsPost(requestParameters, options) {
|
|
1039
1489
|
return localVarFp.createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(axios, basePath));
|
|
1040
1490
|
},
|
|
1491
|
+
/**
|
|
1492
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
1493
|
+
* @summary Create Share Token
|
|
1494
|
+
* @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
|
|
1495
|
+
* @param {*} [options] Override http request option.
|
|
1496
|
+
* @throws {RequiredError}
|
|
1497
|
+
*/
|
|
1498
|
+
createShareTokenV1AccessShareTokensPost(requestParameters, options) {
|
|
1499
|
+
return localVarFp.createShareTokenV1AccessShareTokensPost(requestParameters.shareTokenCreateRequest, options).then((request) => request(axios, basePath));
|
|
1500
|
+
},
|
|
1041
1501
|
/**
|
|
1042
1502
|
* 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.
|
|
1043
1503
|
* @summary Delete Run Items
|
|
@@ -1056,7 +1516,17 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1056
1516
|
* @throws {RequiredError}
|
|
1057
1517
|
*/
|
|
1058
1518
|
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters, options) {
|
|
1059
|
-
return localVarFp.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, options).then((request) => request(axios, basePath));
|
|
1519
|
+
return localVarFp.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
|
|
1520
|
+
},
|
|
1521
|
+
/**
|
|
1522
|
+
* Get a grant by its ID.
|
|
1523
|
+
* @summary Get Grant
|
|
1524
|
+
* @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
|
|
1525
|
+
* @param {*} [options] Override http request option.
|
|
1526
|
+
* @throws {RequiredError}
|
|
1527
|
+
*/
|
|
1528
|
+
getGrantV1AccessGrantsGrantIdGet(requestParameters, options) {
|
|
1529
|
+
return localVarFp.getGrantV1AccessGrantsGrantIdGet(requestParameters.grantId, options).then((request) => request(axios, basePath));
|
|
1060
1530
|
},
|
|
1061
1531
|
/**
|
|
1062
1532
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
@@ -1066,7 +1536,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1066
1536
|
* @throws {RequiredError}
|
|
1067
1537
|
*/
|
|
1068
1538
|
getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
|
|
1069
|
-
return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(axios, basePath));
|
|
1539
|
+
return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
|
|
1070
1540
|
},
|
|
1071
1541
|
/**
|
|
1072
1542
|
* 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)
|
|
@@ -1078,14 +1548,24 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1078
1548
|
return localVarFp.getMeV1MeGet(options).then((request) => request(axios, basePath));
|
|
1079
1549
|
},
|
|
1080
1550
|
/**
|
|
1081
|
-
* 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.
|
|
1551
|
+
* 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, or users with an active grant or valid share token.
|
|
1082
1552
|
* @summary Get run details
|
|
1083
1553
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
1084
1554
|
* @param {*} [options] Override http request option.
|
|
1085
1555
|
* @throws {RequiredError}
|
|
1086
1556
|
*/
|
|
1087
1557
|
getRunV1RunsRunIdGet(requestParameters, options) {
|
|
1088
|
-
return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(axios, basePath));
|
|
1558
|
+
return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
|
|
1559
|
+
},
|
|
1560
|
+
/**
|
|
1561
|
+
* Get a share token by its ID.
|
|
1562
|
+
* @summary Get Share Token
|
|
1563
|
+
* @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
|
|
1564
|
+
* @param {*} [options] Override http request option.
|
|
1565
|
+
* @throws {RequiredError}
|
|
1566
|
+
*/
|
|
1567
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters, options) {
|
|
1568
|
+
return localVarFp.getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters.shareTokenId, options).then((request) => request(axios, basePath));
|
|
1089
1569
|
},
|
|
1090
1570
|
/**
|
|
1091
1571
|
* Return metadata for a single public document attached to an application version.
|
|
@@ -1127,6 +1607,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1127
1607
|
listApplicationsV1ApplicationsGet(requestParameters = {}, options) {
|
|
1128
1608
|
return localVarFp.listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1129
1609
|
},
|
|
1610
|
+
/**
|
|
1611
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
1612
|
+
* @summary List Grants
|
|
1613
|
+
* @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
|
|
1614
|
+
* @param {*} [options] Override http request option.
|
|
1615
|
+
* @throws {RequiredError}
|
|
1616
|
+
*/
|
|
1617
|
+
listGrantsV1AccessGrantsGet(requestParameters = {}, options) {
|
|
1618
|
+
return localVarFp.listGrantsV1AccessGrantsGet(requestParameters.resourceType, requestParameters.resourceId, requestParameters.subjectType, requestParameters.subjectId, requestParameters.relation, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1619
|
+
},
|
|
1130
1620
|
/**
|
|
1131
1621
|
* 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
|
|
1132
1622
|
* @summary List Run Items
|
|
@@ -1135,7 +1625,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1135
1625
|
* @throws {RequiredError}
|
|
1136
1626
|
*/
|
|
1137
1627
|
listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
|
|
1138
|
-
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));
|
|
1628
|
+
return localVarFp.listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.shareToken, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1139
1629
|
},
|
|
1140
1630
|
/**
|
|
1141
1631
|
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
@@ -1145,7 +1635,17 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1145
1635
|
* @throws {RequiredError}
|
|
1146
1636
|
*/
|
|
1147
1637
|
listRunsV1RunsGet(requestParameters = {}, options) {
|
|
1148
|
-
return localVarFp.listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1638
|
+
return localVarFp.listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.submittedBy, requestParameters.organizationId, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1639
|
+
},
|
|
1640
|
+
/**
|
|
1641
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1642
|
+
* @summary List Share Tokens
|
|
1643
|
+
* @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
|
|
1644
|
+
* @param {*} [options] Override http request option.
|
|
1645
|
+
* @throws {RequiredError}
|
|
1646
|
+
*/
|
|
1647
|
+
listShareTokensV1AccessShareTokensGet(requestParameters = {}, options) {
|
|
1648
|
+
return localVarFp.listShareTokensV1AccessShareTokensGet(requestParameters.runId, requestParameters.createdBy, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1149
1649
|
},
|
|
1150
1650
|
/**
|
|
1151
1651
|
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
@@ -1186,6 +1686,26 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1186
1686
|
*/
|
|
1187
1687
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
|
|
1188
1688
|
return localVarFp.readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(axios, basePath));
|
|
1689
|
+
},
|
|
1690
|
+
/**
|
|
1691
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1692
|
+
* @summary Revoke Grant
|
|
1693
|
+
* @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
|
|
1694
|
+
* @param {*} [options] Override http request option.
|
|
1695
|
+
* @throws {RequiredError}
|
|
1696
|
+
*/
|
|
1697
|
+
revokeGrantV1AccessGrantsGrantIdDelete(requestParameters, options) {
|
|
1698
|
+
return localVarFp.revokeGrantV1AccessGrantsGrantIdDelete(requestParameters.grantId, options).then((request) => request(axios, basePath));
|
|
1699
|
+
},
|
|
1700
|
+
/**
|
|
1701
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1702
|
+
* @summary Revoke Share Token
|
|
1703
|
+
* @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
|
|
1704
|
+
* @param {*} [options] Override http request option.
|
|
1705
|
+
* @throws {RequiredError}
|
|
1706
|
+
*/
|
|
1707
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters, options) {
|
|
1708
|
+
return localVarFp.revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters.shareTokenId, options).then((request) => request(axios, basePath));
|
|
1189
1709
|
}
|
|
1190
1710
|
};
|
|
1191
1711
|
};
|
|
@@ -1212,6 +1732,17 @@ var PublicApi = class extends BaseAPI {
|
|
|
1212
1732
|
cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
|
|
1213
1733
|
return PublicApiFp(this.configuration).cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
|
|
1214
1734
|
}
|
|
1735
|
+
/**
|
|
1736
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1737
|
+
* @summary Create Grant
|
|
1738
|
+
* @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
|
|
1739
|
+
* @param {*} [options] Override http request option.
|
|
1740
|
+
* @throws {RequiredError}
|
|
1741
|
+
* @memberof PublicApi
|
|
1742
|
+
*/
|
|
1743
|
+
createGrantV1AccessGrantsPost(requestParameters, options) {
|
|
1744
|
+
return PublicApiFp(this.configuration).createGrantV1AccessGrantsPost(requestParameters.grantCreateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1745
|
+
}
|
|
1215
1746
|
/**
|
|
1216
1747
|
* 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
|
|
1217
1748
|
* @summary Initiate Run
|
|
@@ -1223,6 +1754,17 @@ var PublicApi = class extends BaseAPI {
|
|
|
1223
1754
|
createRunV1RunsPost(requestParameters, options) {
|
|
1224
1755
|
return PublicApiFp(this.configuration).createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1225
1756
|
}
|
|
1757
|
+
/**
|
|
1758
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
1759
|
+
* @summary Create Share Token
|
|
1760
|
+
* @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
|
|
1761
|
+
* @param {*} [options] Override http request option.
|
|
1762
|
+
* @throws {RequiredError}
|
|
1763
|
+
* @memberof PublicApi
|
|
1764
|
+
*/
|
|
1765
|
+
createShareTokenV1AccessShareTokensPost(requestParameters, options) {
|
|
1766
|
+
return PublicApiFp(this.configuration).createShareTokenV1AccessShareTokensPost(requestParameters.shareTokenCreateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1767
|
+
}
|
|
1226
1768
|
/**
|
|
1227
1769
|
* 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.
|
|
1228
1770
|
* @summary Delete Run Items
|
|
@@ -1243,7 +1785,18 @@ var PublicApi = class extends BaseAPI {
|
|
|
1243
1785
|
* @memberof PublicApi
|
|
1244
1786
|
*/
|
|
1245
1787
|
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters, options) {
|
|
1246
|
-
return PublicApiFp(this.configuration).getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, options).then((request) => request(this.axios, this.basePath));
|
|
1788
|
+
return PublicApiFp(this.configuration).getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
|
|
1789
|
+
}
|
|
1790
|
+
/**
|
|
1791
|
+
* Get a grant by its ID.
|
|
1792
|
+
* @summary Get Grant
|
|
1793
|
+
* @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
|
|
1794
|
+
* @param {*} [options] Override http request option.
|
|
1795
|
+
* @throws {RequiredError}
|
|
1796
|
+
* @memberof PublicApi
|
|
1797
|
+
*/
|
|
1798
|
+
getGrantV1AccessGrantsGrantIdGet(requestParameters, options) {
|
|
1799
|
+
return PublicApiFp(this.configuration).getGrantV1AccessGrantsGrantIdGet(requestParameters.grantId, options).then((request) => request(this.axios, this.basePath));
|
|
1247
1800
|
}
|
|
1248
1801
|
/**
|
|
1249
1802
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
@@ -1254,7 +1807,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
1254
1807
|
* @memberof PublicApi
|
|
1255
1808
|
*/
|
|
1256
1809
|
getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
|
|
1257
|
-
return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(this.axios, this.basePath));
|
|
1810
|
+
return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
|
|
1258
1811
|
}
|
|
1259
1812
|
/**
|
|
1260
1813
|
* 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)
|
|
@@ -1267,7 +1820,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
1267
1820
|
return PublicApiFp(this.configuration).getMeV1MeGet(options).then((request) => request(this.axios, this.basePath));
|
|
1268
1821
|
}
|
|
1269
1822
|
/**
|
|
1270
|
-
* 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.
|
|
1823
|
+
* 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, or users with an active grant or valid share token.
|
|
1271
1824
|
* @summary Get run details
|
|
1272
1825
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
1273
1826
|
* @param {*} [options] Override http request option.
|
|
@@ -1275,7 +1828,18 @@ var PublicApi = class extends BaseAPI {
|
|
|
1275
1828
|
* @memberof PublicApi
|
|
1276
1829
|
*/
|
|
1277
1830
|
getRunV1RunsRunIdGet(requestParameters, options) {
|
|
1278
|
-
return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
|
|
1831
|
+
return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
|
|
1832
|
+
}
|
|
1833
|
+
/**
|
|
1834
|
+
* Get a share token by its ID.
|
|
1835
|
+
* @summary Get Share Token
|
|
1836
|
+
* @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
|
|
1837
|
+
* @param {*} [options] Override http request option.
|
|
1838
|
+
* @throws {RequiredError}
|
|
1839
|
+
* @memberof PublicApi
|
|
1840
|
+
*/
|
|
1841
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters, options) {
|
|
1842
|
+
return PublicApiFp(this.configuration).getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters.shareTokenId, options).then((request) => request(this.axios, this.basePath));
|
|
1279
1843
|
}
|
|
1280
1844
|
/**
|
|
1281
1845
|
* Return metadata for a single public document attached to an application version.
|
|
@@ -1321,6 +1885,17 @@ var PublicApi = class extends BaseAPI {
|
|
|
1321
1885
|
listApplicationsV1ApplicationsGet(requestParameters = {}, options) {
|
|
1322
1886
|
return PublicApiFp(this.configuration).listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1323
1887
|
}
|
|
1888
|
+
/**
|
|
1889
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
1890
|
+
* @summary List Grants
|
|
1891
|
+
* @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
|
|
1892
|
+
* @param {*} [options] Override http request option.
|
|
1893
|
+
* @throws {RequiredError}
|
|
1894
|
+
* @memberof PublicApi
|
|
1895
|
+
*/
|
|
1896
|
+
listGrantsV1AccessGrantsGet(requestParameters = {}, options) {
|
|
1897
|
+
return PublicApiFp(this.configuration).listGrantsV1AccessGrantsGet(requestParameters.resourceType, requestParameters.resourceId, requestParameters.subjectType, requestParameters.subjectId, requestParameters.relation, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1898
|
+
}
|
|
1324
1899
|
/**
|
|
1325
1900
|
* 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
|
|
1326
1901
|
* @summary List Run Items
|
|
@@ -1330,7 +1905,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
1330
1905
|
* @memberof PublicApi
|
|
1331
1906
|
*/
|
|
1332
1907
|
listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
|
|
1333
|
-
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));
|
|
1908
|
+
return PublicApiFp(this.configuration).listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.shareToken, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1334
1909
|
}
|
|
1335
1910
|
/**
|
|
1336
1911
|
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
@@ -1341,7 +1916,18 @@ var PublicApi = class extends BaseAPI {
|
|
|
1341
1916
|
* @memberof PublicApi
|
|
1342
1917
|
*/
|
|
1343
1918
|
listRunsV1RunsGet(requestParameters = {}, options) {
|
|
1344
|
-
return PublicApiFp(this.configuration).listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1919
|
+
return PublicApiFp(this.configuration).listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.submittedBy, requestParameters.organizationId, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1920
|
+
}
|
|
1921
|
+
/**
|
|
1922
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1923
|
+
* @summary List Share Tokens
|
|
1924
|
+
* @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
|
|
1925
|
+
* @param {*} [options] Override http request option.
|
|
1926
|
+
* @throws {RequiredError}
|
|
1927
|
+
* @memberof PublicApi
|
|
1928
|
+
*/
|
|
1929
|
+
listShareTokensV1AccessShareTokensGet(requestParameters = {}, options) {
|
|
1930
|
+
return PublicApiFp(this.configuration).listShareTokensV1AccessShareTokensGet(requestParameters.runId, requestParameters.createdBy, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1345
1931
|
}
|
|
1346
1932
|
/**
|
|
1347
1933
|
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
@@ -1387,6 +1973,28 @@ var PublicApi = class extends BaseAPI {
|
|
|
1387
1973
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
|
|
1388
1974
|
return PublicApiFp(this.configuration).readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(this.axios, this.basePath));
|
|
1389
1975
|
}
|
|
1976
|
+
/**
|
|
1977
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1978
|
+
* @summary Revoke Grant
|
|
1979
|
+
* @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
|
|
1980
|
+
* @param {*} [options] Override http request option.
|
|
1981
|
+
* @throws {RequiredError}
|
|
1982
|
+
* @memberof PublicApi
|
|
1983
|
+
*/
|
|
1984
|
+
revokeGrantV1AccessGrantsGrantIdDelete(requestParameters, options) {
|
|
1985
|
+
return PublicApiFp(this.configuration).revokeGrantV1AccessGrantsGrantIdDelete(requestParameters.grantId, options).then((request) => request(this.axios, this.basePath));
|
|
1986
|
+
}
|
|
1987
|
+
/**
|
|
1988
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1989
|
+
* @summary Revoke Share Token
|
|
1990
|
+
* @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
|
|
1991
|
+
* @param {*} [options] Override http request option.
|
|
1992
|
+
* @throws {RequiredError}
|
|
1993
|
+
* @memberof PublicApi
|
|
1994
|
+
*/
|
|
1995
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters, options) {
|
|
1996
|
+
return PublicApiFp(this.configuration).revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters.shareTokenId, options).then((request) => request(this.axios, this.basePath));
|
|
1997
|
+
}
|
|
1390
1998
|
};
|
|
1391
1999
|
|
|
1392
2000
|
// src/generated/configuration.ts
|
|
@@ -1577,23 +2185,33 @@ function getRunProgress(run) {
|
|
|
1577
2185
|
return Math.round(processed / item_count * 100);
|
|
1578
2186
|
}
|
|
1579
2187
|
function getRunStatus(run) {
|
|
1580
|
-
const { state,
|
|
2188
|
+
const { state, termination_reason, output } = run;
|
|
1581
2189
|
switch (state) {
|
|
1582
2190
|
case "PENDING":
|
|
1583
2191
|
return "PENDING";
|
|
1584
2192
|
case "PROCESSING":
|
|
1585
2193
|
return "PROCESSING";
|
|
1586
2194
|
case "TERMINATED":
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
2195
|
+
switch (termination_reason) {
|
|
2196
|
+
case "CANCELED_BY_USER":
|
|
2197
|
+
return "CANCELED";
|
|
2198
|
+
case "CANCELED_BY_SYSTEM":
|
|
2199
|
+
case "ALL_ITEMS_PROCESSED":
|
|
2200
|
+
switch (output) {
|
|
2201
|
+
case "NONE":
|
|
2202
|
+
return "FAILED";
|
|
2203
|
+
case "PARTIAL":
|
|
2204
|
+
return "COMPLETED_WITH_ERRORS";
|
|
2205
|
+
case "FULL":
|
|
2206
|
+
return "COMPLETED";
|
|
2207
|
+
default:
|
|
2208
|
+
return "UNKNOWN";
|
|
2209
|
+
}
|
|
2210
|
+
default:
|
|
2211
|
+
return "UNKNOWN";
|
|
1595
2212
|
}
|
|
1596
|
-
|
|
2213
|
+
default:
|
|
2214
|
+
return "UNKNOWN";
|
|
1597
2215
|
}
|
|
1598
2216
|
}
|
|
1599
2217
|
var canDownloadRunItems = (run) => {
|
|
@@ -1615,6 +2233,12 @@ var processApplicationRun = (run) => {
|
|
|
1615
2233
|
var canDownloadItem = (item) => {
|
|
1616
2234
|
return getItemStatus(item) === "COMPLETED";
|
|
1617
2235
|
};
|
|
2236
|
+
var ERROR_TERMINATION_REASONS = /* @__PURE__ */ new Set([
|
|
2237
|
+
"CANCELED_BY_SYSTEM",
|
|
2238
|
+
"CANCELED_BY_USER",
|
|
2239
|
+
"SYSTEM_ERROR",
|
|
2240
|
+
"USER_ERROR"
|
|
2241
|
+
]);
|
|
1618
2242
|
function getItemStatus(item) {
|
|
1619
2243
|
const { state, termination_reason } = item;
|
|
1620
2244
|
switch (state) {
|
|
@@ -1623,13 +2247,19 @@ function getItemStatus(item) {
|
|
|
1623
2247
|
case "PROCESSING":
|
|
1624
2248
|
return "PROCESSING";
|
|
1625
2249
|
case "TERMINATED":
|
|
1626
|
-
if (termination_reason
|
|
2250
|
+
if (!termination_reason) {
|
|
2251
|
+
return "UNKNOWN";
|
|
2252
|
+
}
|
|
2253
|
+
if (ERROR_TERMINATION_REASONS.has(termination_reason)) {
|
|
1627
2254
|
return "FAILED";
|
|
1628
2255
|
}
|
|
1629
2256
|
if (termination_reason === "SKIPPED") {
|
|
1630
2257
|
return "SKIPPED";
|
|
1631
2258
|
}
|
|
1632
|
-
|
|
2259
|
+
if (termination_reason === "SUCCEEDED") {
|
|
2260
|
+
return "COMPLETED";
|
|
2261
|
+
}
|
|
2262
|
+
return "UNKNOWN";
|
|
1633
2263
|
}
|
|
1634
2264
|
}
|
|
1635
2265
|
|
|
@@ -2465,6 +3095,7 @@ exports.AuthenticationError = AuthenticationError;
|
|
|
2465
3095
|
exports.BaseError = BaseError;
|
|
2466
3096
|
exports.Configuration = Configuration;
|
|
2467
3097
|
exports.ConfigurationError = ConfigurationError;
|
|
3098
|
+
exports.GrantRelation = GrantRelation;
|
|
2468
3099
|
exports.ItemOutput = ItemOutput;
|
|
2469
3100
|
exports.ItemState = ItemState;
|
|
2470
3101
|
exports.ItemTerminationReason = ItemTerminationReason;
|
|
@@ -2475,9 +3106,11 @@ exports.PublicApi = PublicApi;
|
|
|
2475
3106
|
exports.PublicApiAxiosParamCreator = PublicApiAxiosParamCreator;
|
|
2476
3107
|
exports.PublicApiFactory = PublicApiFactory;
|
|
2477
3108
|
exports.PublicApiFp = PublicApiFp;
|
|
3109
|
+
exports.ResourceType = ResourceType;
|
|
2478
3110
|
exports.RunOutput = RunOutput;
|
|
2479
3111
|
exports.RunState = RunState;
|
|
2480
3112
|
exports.RunTerminationReason = RunTerminationReason;
|
|
3113
|
+
exports.SubjectType = SubjectType;
|
|
2481
3114
|
exports.VersionDocumentVisibility = VersionDocumentVisibility;
|
|
2482
3115
|
exports.canDownloadItem = canDownloadItem;
|
|
2483
3116
|
exports.canDownloadRunItems = canDownloadRunItems;
|