@aignostics/sdk 3.1.0 → 3.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aignostics-sdk-3.3.0.tgz +0 -0
- package/dist/{api-CZ17GBr_.d.cts → api-CWohsFN3.d.cts} +184 -33
- package/dist/{api-CZ17GBr_.d.ts → api-CWohsFN3.d.ts} +184 -33
- package/dist/index.cjs +183 -11
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +139 -9
- package/dist/index.d.ts +139 -9
- package/dist/index.js +177 -12
- 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.1.0.tgz +0 -0
|
Binary file
|
|
@@ -5,7 +5,7 @@ import { RawAxiosRequestConfig, AxiosInstance, AxiosPromise } from 'axios';
|
|
|
5
5
|
* Aignostics Platform API
|
|
6
6
|
* The Aignostics Platform is a cloud-based service that enables organizations to access advanced computational pathology applications through a secure API. The platform provides standardized access to Aignostics\' portfolio of computational pathology solutions, with Atlas H&E-TME serving as an example of the available API endpoints. To begin using the platform, your organization must first be registered by our business support team. If you don\'t have an account yet, please contact your account manager or email support@aignostics.com to get started. More information about our applications can be found on [https://platform.aignostics.com](https://platform.aignostics.com). **How to authorize and test API endpoints:** 1. Click the \"Authorize\" button in the right corner below 3. Click \"Authorize\" button in the dialog to log in with your Aignostics Platform credentials 4. After successful login, you\'ll be redirected back and can use \"Try it out\" on any endpoint **Note**: You only need to authorize once per session. The lock icons next to endpoints will show green when authorized.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* The version of the OpenAPI document: 1.4.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -97,7 +97,7 @@ declare class Configuration {
|
|
|
97
97
|
* Aignostics Platform API
|
|
98
98
|
* The Aignostics Platform is a cloud-based service that enables organizations to access advanced computational pathology applications through a secure API. The platform provides standardized access to Aignostics\' portfolio of computational pathology solutions, with Atlas H&E-TME serving as an example of the available API endpoints. To begin using the platform, your organization must first be registered by our business support team. If you don\'t have an account yet, please contact your account manager or email support@aignostics.com to get started. More information about our applications can be found on [https://platform.aignostics.com](https://platform.aignostics.com). **How to authorize and test API endpoints:** 1. Click the \"Authorize\" button in the right corner below 3. Click \"Authorize\" button in the dialog to log in with your Aignostics Platform credentials 4. After successful login, you\'ll be redirected back and can use \"Try it out\" on any endpoint **Note**: You only need to authorize once per session. The lock icons next to endpoints will show green when authorized.
|
|
99
99
|
*
|
|
100
|
-
* The version of the OpenAPI document: 1.0
|
|
100
|
+
* The version of the OpenAPI document: 1.4.0
|
|
101
101
|
*
|
|
102
102
|
*
|
|
103
103
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -262,10 +262,12 @@ type ArtifactTerminationReason = typeof ArtifactTerminationReason[keyof typeof A
|
|
|
262
262
|
interface CustomMetadataUpdateRequest {
|
|
263
263
|
/**
|
|
264
264
|
*
|
|
265
|
-
* @type {
|
|
265
|
+
* @type {{ [key: string]: any; }}
|
|
266
266
|
* @memberof CustomMetadataUpdateRequest
|
|
267
267
|
*/
|
|
268
|
-
'custom_metadata'?:
|
|
268
|
+
'custom_metadata'?: {
|
|
269
|
+
[key: string]: any;
|
|
270
|
+
} | null;
|
|
269
271
|
/**
|
|
270
272
|
*
|
|
271
273
|
* @type {string}
|
|
@@ -319,10 +321,12 @@ interface InputArtifact {
|
|
|
319
321
|
'mime_type': string;
|
|
320
322
|
/**
|
|
321
323
|
*
|
|
322
|
-
* @type {
|
|
324
|
+
* @type {{ [key: string]: any; }}
|
|
323
325
|
* @memberof InputArtifact
|
|
324
326
|
*/
|
|
325
|
-
'metadata_schema':
|
|
327
|
+
'metadata_schema': {
|
|
328
|
+
[key: string]: any;
|
|
329
|
+
};
|
|
326
330
|
}
|
|
327
331
|
/**
|
|
328
332
|
* Input artifact containing the slide image and associated metadata.
|
|
@@ -344,10 +348,12 @@ interface InputArtifactCreationRequest {
|
|
|
344
348
|
'download_url': string;
|
|
345
349
|
/**
|
|
346
350
|
* The metadata of the artifact, required by the application version. The JSON schema of the metadata can be requested by `/v1/versions/{application_version_id}`. The schema is located in `input_artifacts.[].metadata_schema`
|
|
347
|
-
* @type {
|
|
351
|
+
* @type {{ [key: string]: any; }}
|
|
348
352
|
* @memberof InputArtifactCreationRequest
|
|
349
353
|
*/
|
|
350
|
-
'metadata':
|
|
354
|
+
'metadata': {
|
|
355
|
+
[key: string]: any;
|
|
356
|
+
};
|
|
351
357
|
}
|
|
352
358
|
/**
|
|
353
359
|
* Individual item (slide) to be processed in a run.
|
|
@@ -363,10 +369,12 @@ interface ItemCreationRequest {
|
|
|
363
369
|
'external_id': string;
|
|
364
370
|
/**
|
|
365
371
|
*
|
|
366
|
-
* @type {
|
|
372
|
+
* @type {{ [key: string]: any; }}
|
|
367
373
|
* @memberof ItemCreationRequest
|
|
368
374
|
*/
|
|
369
|
-
'custom_metadata'?:
|
|
375
|
+
'custom_metadata'?: {
|
|
376
|
+
[key: string]: any;
|
|
377
|
+
} | null;
|
|
370
378
|
/**
|
|
371
379
|
* List of input artifacts for this item. For Atlas H&E-TME, typically contains one artifact (the slide image)
|
|
372
380
|
* @type {Array<InputArtifactCreationRequest>}
|
|
@@ -404,10 +412,12 @@ interface ItemResultReadResponse {
|
|
|
404
412
|
'external_id': string;
|
|
405
413
|
/**
|
|
406
414
|
*
|
|
407
|
-
* @type {
|
|
415
|
+
* @type {{ [key: string]: any; }}
|
|
408
416
|
* @memberof ItemResultReadResponse
|
|
409
417
|
*/
|
|
410
|
-
'custom_metadata':
|
|
418
|
+
'custom_metadata': {
|
|
419
|
+
[key: string]: any;
|
|
420
|
+
} | null;
|
|
411
421
|
/**
|
|
412
422
|
*
|
|
413
423
|
* @type {string}
|
|
@@ -444,6 +454,12 @@ interface ItemResultReadResponse {
|
|
|
444
454
|
* @memberof ItemResultReadResponse
|
|
445
455
|
*/
|
|
446
456
|
'termination_reason'?: ItemTerminationReason | null;
|
|
457
|
+
/**
|
|
458
|
+
*
|
|
459
|
+
* @type {string}
|
|
460
|
+
* @memberof ItemResultReadResponse
|
|
461
|
+
*/
|
|
462
|
+
'error_code'?: string | null;
|
|
447
463
|
/**
|
|
448
464
|
*
|
|
449
465
|
* @type {string}
|
|
@@ -462,12 +478,6 @@ interface ItemResultReadResponse {
|
|
|
462
478
|
* @memberof ItemResultReadResponse
|
|
463
479
|
*/
|
|
464
480
|
'output_artifacts': Array<OutputArtifactResultReadResponse>;
|
|
465
|
-
/**
|
|
466
|
-
*
|
|
467
|
-
* @type {string}
|
|
468
|
-
* @memberof ItemResultReadResponse
|
|
469
|
-
*/
|
|
470
|
-
'error_code': string | null;
|
|
471
481
|
}
|
|
472
482
|
/**
|
|
473
483
|
*
|
|
@@ -592,10 +602,12 @@ interface OutputArtifact {
|
|
|
592
602
|
'mime_type': string;
|
|
593
603
|
/**
|
|
594
604
|
*
|
|
595
|
-
* @type {
|
|
605
|
+
* @type {{ [key: string]: any; }}
|
|
596
606
|
* @memberof OutputArtifact
|
|
597
607
|
*/
|
|
598
|
-
'metadata_schema':
|
|
608
|
+
'metadata_schema': {
|
|
609
|
+
[key: string]: any;
|
|
610
|
+
};
|
|
599
611
|
/**
|
|
600
612
|
*
|
|
601
613
|
* @type {OutputArtifactScope}
|
|
@@ -629,10 +641,12 @@ interface OutputArtifactResultReadResponse {
|
|
|
629
641
|
'name': string;
|
|
630
642
|
/**
|
|
631
643
|
*
|
|
632
|
-
* @type {
|
|
644
|
+
* @type {{ [key: string]: any; }}
|
|
633
645
|
* @memberof OutputArtifactResultReadResponse
|
|
634
646
|
*/
|
|
635
|
-
'metadata'?:
|
|
647
|
+
'metadata'?: {
|
|
648
|
+
[key: string]: any;
|
|
649
|
+
} | null;
|
|
636
650
|
/**
|
|
637
651
|
* The current state of the artifact (PENDING, PROCESSING, TERMINATED)
|
|
638
652
|
* @type {ArtifactState}
|
|
@@ -656,19 +670,19 @@ interface OutputArtifactResultReadResponse {
|
|
|
656
670
|
* @type {string}
|
|
657
671
|
* @memberof OutputArtifactResultReadResponse
|
|
658
672
|
*/
|
|
659
|
-
'
|
|
673
|
+
'error_code'?: string | null;
|
|
660
674
|
/**
|
|
661
675
|
*
|
|
662
676
|
* @type {string}
|
|
663
677
|
* @memberof OutputArtifactResultReadResponse
|
|
664
678
|
*/
|
|
665
|
-
'
|
|
679
|
+
'error_message'?: string | null;
|
|
666
680
|
/**
|
|
667
681
|
*
|
|
668
682
|
* @type {string}
|
|
669
683
|
* @memberof OutputArtifactResultReadResponse
|
|
670
684
|
*/
|
|
671
|
-
'
|
|
685
|
+
'download_url'?: string | null;
|
|
672
686
|
}
|
|
673
687
|
/**
|
|
674
688
|
*
|
|
@@ -710,10 +724,18 @@ interface RunCreationRequest {
|
|
|
710
724
|
'version_number'?: string | null;
|
|
711
725
|
/**
|
|
712
726
|
*
|
|
713
|
-
* @type {
|
|
727
|
+
* @type {{ [key: string]: any; }}
|
|
728
|
+
* @memberof RunCreationRequest
|
|
729
|
+
*/
|
|
730
|
+
'custom_metadata'?: {
|
|
731
|
+
[key: string]: any;
|
|
732
|
+
} | null;
|
|
733
|
+
/**
|
|
734
|
+
*
|
|
735
|
+
* @type {SchedulingRequest}
|
|
714
736
|
* @memberof RunCreationRequest
|
|
715
737
|
*/
|
|
716
|
-
'
|
|
738
|
+
'scheduling'?: SchedulingRequest | null;
|
|
717
739
|
/**
|
|
718
740
|
* List of items (slides) to process. Each item represents a whole slide image (WSI) with its associated metadata and artifacts
|
|
719
741
|
* @type {Array<ItemCreationRequest>}
|
|
@@ -732,7 +754,7 @@ interface RunCreationResponse {
|
|
|
732
754
|
* @type {string}
|
|
733
755
|
* @memberof RunCreationResponse
|
|
734
756
|
*/
|
|
735
|
-
'run_id'
|
|
757
|
+
'run_id': string;
|
|
736
758
|
}
|
|
737
759
|
/**
|
|
738
760
|
*
|
|
@@ -856,10 +878,12 @@ interface RunReadResponse {
|
|
|
856
878
|
'statistics': RunItemStatistics;
|
|
857
879
|
/**
|
|
858
880
|
*
|
|
859
|
-
* @type {
|
|
881
|
+
* @type {{ [key: string]: any; }}
|
|
860
882
|
* @memberof RunReadResponse
|
|
861
883
|
*/
|
|
862
|
-
'custom_metadata'?:
|
|
884
|
+
'custom_metadata'?: {
|
|
885
|
+
[key: string]: any;
|
|
886
|
+
} | null;
|
|
863
887
|
/**
|
|
864
888
|
*
|
|
865
889
|
* @type {string}
|
|
@@ -896,6 +920,12 @@ interface RunReadResponse {
|
|
|
896
920
|
* @memberof RunReadResponse
|
|
897
921
|
*/
|
|
898
922
|
'num_preceding_items_platform'?: number | null;
|
|
923
|
+
/**
|
|
924
|
+
*
|
|
925
|
+
* @type {SchedulingResponse}
|
|
926
|
+
* @memberof RunReadResponse
|
|
927
|
+
*/
|
|
928
|
+
'scheduling'?: SchedulingResponse | null;
|
|
899
929
|
}
|
|
900
930
|
/**
|
|
901
931
|
*
|
|
@@ -919,6 +949,44 @@ declare const RunTerminationReason: {
|
|
|
919
949
|
readonly CanceledByUser: "CANCELED_BY_USER";
|
|
920
950
|
};
|
|
921
951
|
type RunTerminationReason = typeof RunTerminationReason[keyof typeof RunTerminationReason];
|
|
952
|
+
/**
|
|
953
|
+
* Scheduling constraints for a run.
|
|
954
|
+
* @export
|
|
955
|
+
* @interface SchedulingRequest
|
|
956
|
+
*/
|
|
957
|
+
interface SchedulingRequest {
|
|
958
|
+
/**
|
|
959
|
+
*
|
|
960
|
+
* @type {string}
|
|
961
|
+
* @memberof SchedulingRequest
|
|
962
|
+
*/
|
|
963
|
+
'due_date'?: string | null;
|
|
964
|
+
/**
|
|
965
|
+
*
|
|
966
|
+
* @type {string}
|
|
967
|
+
* @memberof SchedulingRequest
|
|
968
|
+
*/
|
|
969
|
+
'deadline'?: string | null;
|
|
970
|
+
}
|
|
971
|
+
/**
|
|
972
|
+
* Scheduling fields returned in run responses.
|
|
973
|
+
* @export
|
|
974
|
+
* @interface SchedulingResponse
|
|
975
|
+
*/
|
|
976
|
+
interface SchedulingResponse {
|
|
977
|
+
/**
|
|
978
|
+
*
|
|
979
|
+
* @type {string}
|
|
980
|
+
* @memberof SchedulingResponse
|
|
981
|
+
*/
|
|
982
|
+
'due_date'?: string | null;
|
|
983
|
+
/**
|
|
984
|
+
*
|
|
985
|
+
* @type {string}
|
|
986
|
+
* @memberof SchedulingResponse
|
|
987
|
+
*/
|
|
988
|
+
'deadline'?: string | null;
|
|
989
|
+
}
|
|
922
990
|
/**
|
|
923
991
|
* Part of response schema for User object in `Get current user` endpoint. This model corresponds to the response schema returned from Auth0 GET /v2/users/{id} endpoint. For details, see: https://auth0.com/docs/api/management/v2/users/get-users-by-id
|
|
924
992
|
* @export
|
|
@@ -1004,6 +1072,18 @@ interface ValidationError {
|
|
|
1004
1072
|
* @memberof ValidationError
|
|
1005
1073
|
*/
|
|
1006
1074
|
'type': string;
|
|
1075
|
+
/**
|
|
1076
|
+
*
|
|
1077
|
+
* @type {any}
|
|
1078
|
+
* @memberof ValidationError
|
|
1079
|
+
*/
|
|
1080
|
+
'input'?: any;
|
|
1081
|
+
/**
|
|
1082
|
+
*
|
|
1083
|
+
* @type {object}
|
|
1084
|
+
* @memberof ValidationError
|
|
1085
|
+
*/
|
|
1086
|
+
'ctx'?: object;
|
|
1007
1087
|
}
|
|
1008
1088
|
/**
|
|
1009
1089
|
*
|
|
@@ -1087,6 +1167,15 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1087
1167
|
* @throws {RequiredError}
|
|
1088
1168
|
*/
|
|
1089
1169
|
deleteRunItemsV1RunsRunIdArtifactsDelete: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1170
|
+
/**
|
|
1171
|
+
* Download the artifact file with the specified artifact_id, belonging to the specified run. The artifact_is is returned by the `GET /v1/runs/{run_id}/items` endpoint as part of the item results, and can also be retrieved via `GET /v1/runs/{run_id}/items/{external_id}`. The endpoint may return a redirect response with a presigned URL to download the artifact file from the storage bucket. The presigned URL is valid for a limited time, so it should be used immediately after receiving the response.
|
|
1172
|
+
* @summary Get Artifact Url
|
|
1173
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1174
|
+
* @param {string} artifactId The artifact id to download
|
|
1175
|
+
* @param {*} [options] Override http request option.
|
|
1176
|
+
* @throws {RequiredError}
|
|
1177
|
+
*/
|
|
1178
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: (runId: string, artifactId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1090
1179
|
/**
|
|
1091
1180
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1092
1181
|
* @summary Get Item By Run
|
|
@@ -1146,11 +1235,12 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1146
1235
|
* @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**
|
|
1147
1236
|
* @param {number} [page]
|
|
1148
1237
|
* @param {number} [pageSize]
|
|
1238
|
+
* @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.
|
|
1149
1239
|
* @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)
|
|
1150
1240
|
* @param {*} [options] Override http request option.
|
|
1151
1241
|
* @throws {RequiredError}
|
|
1152
1242
|
*/
|
|
1153
|
-
listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1243
|
+
listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1154
1244
|
/**
|
|
1155
1245
|
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
1156
1246
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1217,6 +1307,15 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1217
1307
|
* @throws {RequiredError}
|
|
1218
1308
|
*/
|
|
1219
1309
|
deleteRunItemsV1RunsRunIdArtifactsDelete(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1310
|
+
/**
|
|
1311
|
+
* Download the artifact file with the specified artifact_id, belonging to the specified run. The artifact_is is returned by the `GET /v1/runs/{run_id}/items` endpoint as part of the item results, and can also be retrieved via `GET /v1/runs/{run_id}/items/{external_id}`. The endpoint may return a redirect response with a presigned URL to download the artifact file from the storage bucket. The presigned URL is valid for a limited time, so it should be used immediately after receiving the response.
|
|
1312
|
+
* @summary Get Artifact Url
|
|
1313
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1314
|
+
* @param {string} artifactId The artifact id to download
|
|
1315
|
+
* @param {*} [options] Override http request option.
|
|
1316
|
+
* @throws {RequiredError}
|
|
1317
|
+
*/
|
|
1318
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId: string, artifactId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1220
1319
|
/**
|
|
1221
1320
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1222
1321
|
* @summary Get Item By Run
|
|
@@ -1276,11 +1375,12 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1276
1375
|
* @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**
|
|
1277
1376
|
* @param {number} [page]
|
|
1278
1377
|
* @param {number} [pageSize]
|
|
1378
|
+
* @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.
|
|
1279
1379
|
* @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)
|
|
1280
1380
|
* @param {*} [options] Override http request option.
|
|
1281
1381
|
* @throws {RequiredError}
|
|
1282
1382
|
*/
|
|
1283
|
-
listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
|
|
1383
|
+
listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
|
|
1284
1384
|
/**
|
|
1285
1385
|
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
1286
1386
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1346,6 +1446,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1346
1446
|
* @throws {RequiredError}
|
|
1347
1447
|
*/
|
|
1348
1448
|
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1449
|
+
/**
|
|
1450
|
+
* Download the artifact file with the specified artifact_id, belonging to the specified run. The artifact_is is returned by the `GET /v1/runs/{run_id}/items` endpoint as part of the item results, and can also be retrieved via `GET /v1/runs/{run_id}/items/{external_id}`. The endpoint may return a redirect response with a presigned URL to download the artifact file from the storage bucket. The presigned URL is valid for a limited time, so it should be used immediately after receiving the response.
|
|
1451
|
+
* @summary Get Artifact Url
|
|
1452
|
+
* @param {PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest} requestParameters Request parameters.
|
|
1453
|
+
* @param {*} [options] Override http request option.
|
|
1454
|
+
* @throws {RequiredError}
|
|
1455
|
+
*/
|
|
1456
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1349
1457
|
/**
|
|
1350
1458
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1351
1459
|
* @summary Get Item By Run
|
|
@@ -1460,6 +1568,15 @@ interface PublicApiInterface {
|
|
|
1460
1568
|
* @memberof PublicApiInterface
|
|
1461
1569
|
*/
|
|
1462
1570
|
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1571
|
+
/**
|
|
1572
|
+
* Download the artifact file with the specified artifact_id, belonging to the specified run. The artifact_is is returned by the `GET /v1/runs/{run_id}/items` endpoint as part of the item results, and can also be retrieved via `GET /v1/runs/{run_id}/items/{external_id}`. The endpoint may return a redirect response with a presigned URL to download the artifact file from the storage bucket. The presigned URL is valid for a limited time, so it should be used immediately after receiving the response.
|
|
1573
|
+
* @summary Get Artifact Url
|
|
1574
|
+
* @param {PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest} requestParameters Request parameters.
|
|
1575
|
+
* @param {*} [options] Override http request option.
|
|
1576
|
+
* @throws {RequiredError}
|
|
1577
|
+
* @memberof PublicApiInterface
|
|
1578
|
+
*/
|
|
1579
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1463
1580
|
/**
|
|
1464
1581
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1465
1582
|
* @summary Get Item By Run
|
|
@@ -1599,6 +1716,25 @@ interface PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest {
|
|
|
1599
1716
|
*/
|
|
1600
1717
|
readonly runId: string;
|
|
1601
1718
|
}
|
|
1719
|
+
/**
|
|
1720
|
+
* Request parameters for getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet operation in PublicApi.
|
|
1721
|
+
* @export
|
|
1722
|
+
* @interface PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest
|
|
1723
|
+
*/
|
|
1724
|
+
interface PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest {
|
|
1725
|
+
/**
|
|
1726
|
+
* Run id, returned by `POST /runs/` endpoint
|
|
1727
|
+
* @type {string}
|
|
1728
|
+
* @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
|
|
1729
|
+
*/
|
|
1730
|
+
readonly runId: string;
|
|
1731
|
+
/**
|
|
1732
|
+
* The artifact id to download
|
|
1733
|
+
* @type {string}
|
|
1734
|
+
* @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
|
|
1735
|
+
*/
|
|
1736
|
+
readonly artifactId: string;
|
|
1737
|
+
}
|
|
1602
1738
|
/**
|
|
1603
1739
|
* Request parameters for getItemByRunV1RunsRunIdItemsExternalIdGet operation in PublicApi.
|
|
1604
1740
|
* @export
|
|
@@ -1759,6 +1895,12 @@ interface PublicApiListRunsV1RunsGetRequest {
|
|
|
1759
1895
|
* @memberof PublicApiListRunsV1RunsGet
|
|
1760
1896
|
*/
|
|
1761
1897
|
readonly pageSize?: number;
|
|
1898
|
+
/**
|
|
1899
|
+
* 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.
|
|
1900
|
+
* @type {string}
|
|
1901
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
1902
|
+
*/
|
|
1903
|
+
readonly forOrganization?: string | null;
|
|
1762
1904
|
/**
|
|
1763
1905
|
* 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)
|
|
1764
1906
|
* @type {Array<string>}
|
|
@@ -1866,6 +2008,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
1866
2008
|
* @memberof PublicApi
|
|
1867
2009
|
*/
|
|
1868
2010
|
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
2011
|
+
/**
|
|
2012
|
+
* Download the artifact file with the specified artifact_id, belonging to the specified run. The artifact_is is returned by the `GET /v1/runs/{run_id}/items` endpoint as part of the item results, and can also be retrieved via `GET /v1/runs/{run_id}/items/{external_id}`. The endpoint may return a redirect response with a presigned URL to download the artifact file from the storage bucket. The presigned URL is valid for a limited time, so it should be used immediately after receiving the response.
|
|
2013
|
+
* @summary Get Artifact Url
|
|
2014
|
+
* @param {PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest} requestParameters Request parameters.
|
|
2015
|
+
* @param {*} [options] Override http request option.
|
|
2016
|
+
* @throws {RequiredError}
|
|
2017
|
+
* @memberof PublicApi
|
|
2018
|
+
*/
|
|
2019
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
1869
2020
|
/**
|
|
1870
2021
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1871
2022
|
* @summary Get Item By Run
|
|
@@ -1948,4 +2099,4 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
1948
2099
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadResponse, any, {}>>;
|
|
1949
2100
|
}
|
|
1950
2101
|
|
|
1951
|
-
export { type ApplicationReadShortResponse as A,
|
|
2102
|
+
export { type ConfigurationParameters as $, type ApplicationReadShortResponse as A, PublicApiFactory as B, type CustomMetadataUpdateRequest as C, type PublicApiInterface as D, type PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest as E, type PublicApiCancelRunV1RunsRunIdCancelPostRequest as F, type PublicApiCreateRunV1RunsPostRequest as G, type HTTPValidationError as H, type ItemResultReadResponse as I, type PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest as J, type PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest as K, type PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest as L, type MeReadResponse as M, type PublicApiGetRunV1RunsRunIdGetRequest as N, type OrganizationReadResponse as O, PublicApiAxiosParamCreator as P, type PublicApiListApplicationsV1ApplicationsGetRequest as Q, type RunReadResponse as R, type SchedulingRequest as S, type PublicApiListRunItemsV1RunsRunIdItemsGetRequest as T, type UserReadResponse as U, type VersionReadResponse as V, type PublicApiListRunsV1RunsGetRequest as W, type PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest as X, type PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest as Y, type PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest as Z, PublicApi as _, type ApplicationReadResponse as a, Configuration as a0, type RunCreationRequest as b, type RunCreationResponse as c, ItemState as d, ItemTerminationReason as e, type ApplicationVersion as f, ArtifactOutput as g, ArtifactState as h, ArtifactTerminationReason as i, type CustomMetadataUpdateResponse as j, type InputArtifact as k, type InputArtifactCreationRequest as l, type ItemCreationRequest as m, ItemOutput as n, type OutputArtifact as o, type OutputArtifactResultReadResponse as p, OutputArtifactScope as q, OutputArtifactVisibility as r, type RunItemStatistics as s, RunOutput as t, RunState as u, RunTerminationReason as v, type SchedulingResponse as w, type ValidationError as x, type ValidationErrorLocInner as y, PublicApiFp as z };
|