@aignostics/sdk 3.2.0 → 3.4.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.4.0.tgz +0 -0
- package/dist/{api-Ce-0fPc3.d.cts → api-DXw7V8bK.d.cts} +552 -33
- package/dist/{api-Ce-0fPc3.d.ts → api-DXw7V8bK.d.ts} +552 -33
- package/dist/index.cjs +755 -8
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +153 -9
- package/dist/index.d.ts +153 -9
- package/dist/index.js +748 -9
- package/dist/index.js.map +1 -1
- package/dist/test-utils/http-mocks.cjs +26 -1
- package/dist/test-utils/http-mocks.cjs.map +1 -1
- package/dist/test-utils/http-mocks.d.cts +1 -1
- package/dist/test-utils/http-mocks.d.ts +1 -1
- package/dist/test-utils/http-mocks.js +26 -1
- package/dist/test-utils/http-mocks.js.map +1 -1
- package/package.json +2 -1
- package/dist/aignostics-sdk-3.2.0.tgz +0 -0
|
@@ -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.5.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.5.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,45 @@ 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
|
+
};
|
|
357
|
+
}
|
|
358
|
+
/**
|
|
359
|
+
*
|
|
360
|
+
* @export
|
|
361
|
+
* @interface InputArtifactResultReadResponse
|
|
362
|
+
*/
|
|
363
|
+
interface InputArtifactResultReadResponse {
|
|
364
|
+
/**
|
|
365
|
+
* The Id of the artifact. Used internally
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof InputArtifactResultReadResponse
|
|
368
|
+
*/
|
|
369
|
+
'input_artifact_id': string;
|
|
370
|
+
/**
|
|
371
|
+
* Name of the input from the schema from the `/v1/versions/{version_id}` endpoint.
|
|
372
|
+
* @type {string}
|
|
373
|
+
* @memberof InputArtifactResultReadResponse
|
|
374
|
+
*/
|
|
375
|
+
'name': string;
|
|
376
|
+
/**
|
|
377
|
+
*
|
|
378
|
+
* @type {{ [key: string]: any; }}
|
|
379
|
+
* @memberof InputArtifactResultReadResponse
|
|
380
|
+
*/
|
|
381
|
+
'metadata'?: {
|
|
382
|
+
[key: string]: any;
|
|
383
|
+
} | null;
|
|
384
|
+
/**
|
|
385
|
+
*
|
|
386
|
+
* @type {string}
|
|
387
|
+
* @memberof InputArtifactResultReadResponse
|
|
388
|
+
*/
|
|
389
|
+
'download_url'?: string | null;
|
|
351
390
|
}
|
|
352
391
|
/**
|
|
353
392
|
* Individual item (slide) to be processed in a run.
|
|
@@ -363,10 +402,12 @@ interface ItemCreationRequest {
|
|
|
363
402
|
'external_id': string;
|
|
364
403
|
/**
|
|
365
404
|
*
|
|
366
|
-
* @type {
|
|
405
|
+
* @type {{ [key: string]: any; }}
|
|
367
406
|
* @memberof ItemCreationRequest
|
|
368
407
|
*/
|
|
369
|
-
'custom_metadata'?:
|
|
408
|
+
'custom_metadata'?: {
|
|
409
|
+
[key: string]: any;
|
|
410
|
+
} | null;
|
|
370
411
|
/**
|
|
371
412
|
* List of input artifacts for this item. For Atlas H&E-TME, typically contains one artifact (the slide image)
|
|
372
413
|
* @type {Array<InputArtifactCreationRequest>}
|
|
@@ -404,10 +445,12 @@ interface ItemResultReadResponse {
|
|
|
404
445
|
'external_id': string;
|
|
405
446
|
/**
|
|
406
447
|
*
|
|
407
|
-
* @type {
|
|
448
|
+
* @type {{ [key: string]: any; }}
|
|
408
449
|
* @memberof ItemResultReadResponse
|
|
409
450
|
*/
|
|
410
|
-
'custom_metadata':
|
|
451
|
+
'custom_metadata': {
|
|
452
|
+
[key: string]: any;
|
|
453
|
+
} | null;
|
|
411
454
|
/**
|
|
412
455
|
*
|
|
413
456
|
* @type {string}
|
|
@@ -444,6 +487,12 @@ interface ItemResultReadResponse {
|
|
|
444
487
|
* @memberof ItemResultReadResponse
|
|
445
488
|
*/
|
|
446
489
|
'termination_reason'?: ItemTerminationReason | null;
|
|
490
|
+
/**
|
|
491
|
+
*
|
|
492
|
+
* @type {string}
|
|
493
|
+
* @memberof ItemResultReadResponse
|
|
494
|
+
*/
|
|
495
|
+
'error_code'?: string | null;
|
|
447
496
|
/**
|
|
448
497
|
*
|
|
449
498
|
* @type {string}
|
|
@@ -457,17 +506,17 @@ interface ItemResultReadResponse {
|
|
|
457
506
|
*/
|
|
458
507
|
'terminated_at'?: string | null;
|
|
459
508
|
/**
|
|
460
|
-
* The
|
|
461
|
-
* @type {Array<
|
|
509
|
+
* The input artifact(s) provided by the user. For most applications, this will be one artifact that defines the whole slide image to be processed.
|
|
510
|
+
* @type {Array<InputArtifactResultReadResponse>}
|
|
462
511
|
* @memberof ItemResultReadResponse
|
|
463
512
|
*/
|
|
464
|
-
'
|
|
513
|
+
'input_artifacts': Array<InputArtifactResultReadResponse>;
|
|
465
514
|
/**
|
|
466
|
-
*
|
|
467
|
-
* @type {
|
|
515
|
+
* The list of the results generated by the application algorithm. The number of files and their types depend on the particular application version, call `/v1/versions/{version_id}` to get the details.
|
|
516
|
+
* @type {Array<OutputArtifactResultReadResponse>}
|
|
468
517
|
* @memberof ItemResultReadResponse
|
|
469
518
|
*/
|
|
470
|
-
'
|
|
519
|
+
'output_artifacts': Array<OutputArtifactResultReadResponse>;
|
|
471
520
|
}
|
|
472
521
|
/**
|
|
473
522
|
*
|
|
@@ -592,10 +641,12 @@ interface OutputArtifact {
|
|
|
592
641
|
'mime_type': string;
|
|
593
642
|
/**
|
|
594
643
|
*
|
|
595
|
-
* @type {
|
|
644
|
+
* @type {{ [key: string]: any; }}
|
|
596
645
|
* @memberof OutputArtifact
|
|
597
646
|
*/
|
|
598
|
-
'metadata_schema':
|
|
647
|
+
'metadata_schema': {
|
|
648
|
+
[key: string]: any;
|
|
649
|
+
};
|
|
599
650
|
/**
|
|
600
651
|
*
|
|
601
652
|
* @type {OutputArtifactScope}
|
|
@@ -629,10 +680,12 @@ interface OutputArtifactResultReadResponse {
|
|
|
629
680
|
'name': string;
|
|
630
681
|
/**
|
|
631
682
|
*
|
|
632
|
-
* @type {
|
|
683
|
+
* @type {{ [key: string]: any; }}
|
|
633
684
|
* @memberof OutputArtifactResultReadResponse
|
|
634
685
|
*/
|
|
635
|
-
'metadata'?:
|
|
686
|
+
'metadata'?: {
|
|
687
|
+
[key: string]: any;
|
|
688
|
+
} | null;
|
|
636
689
|
/**
|
|
637
690
|
* The current state of the artifact (PENDING, PROCESSING, TERMINATED)
|
|
638
691
|
* @type {ArtifactState}
|
|
@@ -656,19 +709,19 @@ interface OutputArtifactResultReadResponse {
|
|
|
656
709
|
* @type {string}
|
|
657
710
|
* @memberof OutputArtifactResultReadResponse
|
|
658
711
|
*/
|
|
659
|
-
'
|
|
712
|
+
'error_code'?: string | null;
|
|
660
713
|
/**
|
|
661
714
|
*
|
|
662
715
|
* @type {string}
|
|
663
716
|
* @memberof OutputArtifactResultReadResponse
|
|
664
717
|
*/
|
|
665
|
-
'
|
|
718
|
+
'error_message'?: string | null;
|
|
666
719
|
/**
|
|
667
720
|
*
|
|
668
721
|
* @type {string}
|
|
669
722
|
* @memberof OutputArtifactResultReadResponse
|
|
670
723
|
*/
|
|
671
|
-
'
|
|
724
|
+
'download_url'?: string | null;
|
|
672
725
|
}
|
|
673
726
|
/**
|
|
674
727
|
*
|
|
@@ -710,10 +763,18 @@ interface RunCreationRequest {
|
|
|
710
763
|
'version_number'?: string | null;
|
|
711
764
|
/**
|
|
712
765
|
*
|
|
713
|
-
* @type {
|
|
766
|
+
* @type {{ [key: string]: any; }}
|
|
767
|
+
* @memberof RunCreationRequest
|
|
768
|
+
*/
|
|
769
|
+
'custom_metadata'?: {
|
|
770
|
+
[key: string]: any;
|
|
771
|
+
} | null;
|
|
772
|
+
/**
|
|
773
|
+
*
|
|
774
|
+
* @type {SchedulingRequest}
|
|
714
775
|
* @memberof RunCreationRequest
|
|
715
776
|
*/
|
|
716
|
-
'
|
|
777
|
+
'scheduling'?: SchedulingRequest | null;
|
|
717
778
|
/**
|
|
718
779
|
* List of items (slides) to process. Each item represents a whole slide image (WSI) with its associated metadata and artifacts
|
|
719
780
|
* @type {Array<ItemCreationRequest>}
|
|
@@ -732,7 +793,7 @@ interface RunCreationResponse {
|
|
|
732
793
|
* @type {string}
|
|
733
794
|
* @memberof RunCreationResponse
|
|
734
795
|
*/
|
|
735
|
-
'run_id'
|
|
796
|
+
'run_id': string;
|
|
736
797
|
}
|
|
737
798
|
/**
|
|
738
799
|
*
|
|
@@ -856,10 +917,12 @@ interface RunReadResponse {
|
|
|
856
917
|
'statistics': RunItemStatistics;
|
|
857
918
|
/**
|
|
858
919
|
*
|
|
859
|
-
* @type {
|
|
920
|
+
* @type {{ [key: string]: any; }}
|
|
860
921
|
* @memberof RunReadResponse
|
|
861
922
|
*/
|
|
862
|
-
'custom_metadata'?:
|
|
923
|
+
'custom_metadata'?: {
|
|
924
|
+
[key: string]: any;
|
|
925
|
+
} | null;
|
|
863
926
|
/**
|
|
864
927
|
*
|
|
865
928
|
* @type {string}
|
|
@@ -896,6 +959,12 @@ interface RunReadResponse {
|
|
|
896
959
|
* @memberof RunReadResponse
|
|
897
960
|
*/
|
|
898
961
|
'num_preceding_items_platform'?: number | null;
|
|
962
|
+
/**
|
|
963
|
+
*
|
|
964
|
+
* @type {SchedulingResponse}
|
|
965
|
+
* @memberof RunReadResponse
|
|
966
|
+
*/
|
|
967
|
+
'scheduling'?: SchedulingResponse | null;
|
|
899
968
|
}
|
|
900
969
|
/**
|
|
901
970
|
*
|
|
@@ -919,6 +988,44 @@ declare const RunTerminationReason: {
|
|
|
919
988
|
readonly CanceledByUser: "CANCELED_BY_USER";
|
|
920
989
|
};
|
|
921
990
|
type RunTerminationReason = typeof RunTerminationReason[keyof typeof RunTerminationReason];
|
|
991
|
+
/**
|
|
992
|
+
* Scheduling constraints for a run.
|
|
993
|
+
* @export
|
|
994
|
+
* @interface SchedulingRequest
|
|
995
|
+
*/
|
|
996
|
+
interface SchedulingRequest {
|
|
997
|
+
/**
|
|
998
|
+
*
|
|
999
|
+
* @type {string}
|
|
1000
|
+
* @memberof SchedulingRequest
|
|
1001
|
+
*/
|
|
1002
|
+
'due_date'?: string | null;
|
|
1003
|
+
/**
|
|
1004
|
+
*
|
|
1005
|
+
* @type {string}
|
|
1006
|
+
* @memberof SchedulingRequest
|
|
1007
|
+
*/
|
|
1008
|
+
'deadline'?: string | null;
|
|
1009
|
+
}
|
|
1010
|
+
/**
|
|
1011
|
+
* Scheduling fields returned in run responses.
|
|
1012
|
+
* @export
|
|
1013
|
+
* @interface SchedulingResponse
|
|
1014
|
+
*/
|
|
1015
|
+
interface SchedulingResponse {
|
|
1016
|
+
/**
|
|
1017
|
+
*
|
|
1018
|
+
* @type {string}
|
|
1019
|
+
* @memberof SchedulingResponse
|
|
1020
|
+
*/
|
|
1021
|
+
'due_date'?: string | null;
|
|
1022
|
+
/**
|
|
1023
|
+
*
|
|
1024
|
+
* @type {string}
|
|
1025
|
+
* @memberof SchedulingResponse
|
|
1026
|
+
*/
|
|
1027
|
+
'deadline'?: string | null;
|
|
1028
|
+
}
|
|
922
1029
|
/**
|
|
923
1030
|
* 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
1031
|
* @export
|
|
@@ -1004,6 +1111,18 @@ interface ValidationError {
|
|
|
1004
1111
|
* @memberof ValidationError
|
|
1005
1112
|
*/
|
|
1006
1113
|
'type': string;
|
|
1114
|
+
/**
|
|
1115
|
+
*
|
|
1116
|
+
* @type {any}
|
|
1117
|
+
* @memberof ValidationError
|
|
1118
|
+
*/
|
|
1119
|
+
'input'?: any;
|
|
1120
|
+
/**
|
|
1121
|
+
*
|
|
1122
|
+
* @type {object}
|
|
1123
|
+
* @memberof ValidationError
|
|
1124
|
+
*/
|
|
1125
|
+
'ctx'?: object;
|
|
1007
1126
|
}
|
|
1008
1127
|
/**
|
|
1009
1128
|
*
|
|
@@ -1012,6 +1131,59 @@ interface ValidationError {
|
|
|
1012
1131
|
*/
|
|
1013
1132
|
interface ValidationErrorLocInner {
|
|
1014
1133
|
}
|
|
1134
|
+
/**
|
|
1135
|
+
*
|
|
1136
|
+
* @export
|
|
1137
|
+
* @interface VersionDocumentResponse
|
|
1138
|
+
*/
|
|
1139
|
+
interface VersionDocumentResponse {
|
|
1140
|
+
/**
|
|
1141
|
+
*
|
|
1142
|
+
* @type {string}
|
|
1143
|
+
* @memberof VersionDocumentResponse
|
|
1144
|
+
*/
|
|
1145
|
+
'id': string;
|
|
1146
|
+
/**
|
|
1147
|
+
*
|
|
1148
|
+
* @type {string}
|
|
1149
|
+
* @memberof VersionDocumentResponse
|
|
1150
|
+
*/
|
|
1151
|
+
'name': string;
|
|
1152
|
+
/**
|
|
1153
|
+
*
|
|
1154
|
+
* @type {string}
|
|
1155
|
+
* @memberof VersionDocumentResponse
|
|
1156
|
+
*/
|
|
1157
|
+
'mime_type': string;
|
|
1158
|
+
/**
|
|
1159
|
+
*
|
|
1160
|
+
* @type {VersionDocumentVisibility}
|
|
1161
|
+
* @memberof VersionDocumentResponse
|
|
1162
|
+
*/
|
|
1163
|
+
'visibility': VersionDocumentVisibility;
|
|
1164
|
+
/**
|
|
1165
|
+
*
|
|
1166
|
+
* @type {string}
|
|
1167
|
+
* @memberof VersionDocumentResponse
|
|
1168
|
+
*/
|
|
1169
|
+
'created_at': string;
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
* @type {string}
|
|
1173
|
+
* @memberof VersionDocumentResponse
|
|
1174
|
+
*/
|
|
1175
|
+
'updated_at': string;
|
|
1176
|
+
}
|
|
1177
|
+
/**
|
|
1178
|
+
*
|
|
1179
|
+
* @export
|
|
1180
|
+
* @enum {string}
|
|
1181
|
+
*/
|
|
1182
|
+
declare const VersionDocumentVisibility: {
|
|
1183
|
+
readonly Public: "public";
|
|
1184
|
+
readonly Internal: "internal";
|
|
1185
|
+
};
|
|
1186
|
+
type VersionDocumentVisibility = typeof VersionDocumentVisibility[keyof typeof VersionDocumentVisibility];
|
|
1015
1187
|
/**
|
|
1016
1188
|
* Base Response schema for the `Application Version Details` endpoint
|
|
1017
1189
|
* @export
|
|
@@ -1087,6 +1259,15 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1087
1259
|
* @throws {RequiredError}
|
|
1088
1260
|
*/
|
|
1089
1261
|
deleteRunItemsV1RunsRunIdArtifactsDelete: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1262
|
+
/**
|
|
1263
|
+
* 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.
|
|
1264
|
+
* @summary Get Artifact Url
|
|
1265
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1266
|
+
* @param {string} artifactId The artifact id to download
|
|
1267
|
+
* @param {*} [options] Override http request option.
|
|
1268
|
+
* @throws {RequiredError}
|
|
1269
|
+
*/
|
|
1270
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: (runId: string, artifactId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1090
1271
|
/**
|
|
1091
1272
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1092
1273
|
* @summary Get Item By Run
|
|
@@ -1111,6 +1292,36 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1111
1292
|
* @throws {RequiredError}
|
|
1112
1293
|
*/
|
|
1113
1294
|
getRunV1RunsRunIdGet: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1295
|
+
/**
|
|
1296
|
+
* Return metadata for a single public document attached to an application version.
|
|
1297
|
+
* @summary Get version document metadata
|
|
1298
|
+
* @param {string} applicationId
|
|
1299
|
+
* @param {string} version
|
|
1300
|
+
* @param {string} name
|
|
1301
|
+
* @param {*} [options] Override http request option.
|
|
1302
|
+
* @throws {RequiredError}
|
|
1303
|
+
*/
|
|
1304
|
+
getVersionDocument: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1305
|
+
/**
|
|
1306
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
1307
|
+
* @summary Stream version document content (programmatic)
|
|
1308
|
+
* @param {string} applicationId
|
|
1309
|
+
* @param {string} version
|
|
1310
|
+
* @param {string} name
|
|
1311
|
+
* @param {*} [options] Override http request option.
|
|
1312
|
+
* @throws {RequiredError}
|
|
1313
|
+
*/
|
|
1314
|
+
getVersionDocumentContent: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1315
|
+
/**
|
|
1316
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
1317
|
+
* @summary Download version document (browser)
|
|
1318
|
+
* @param {string} applicationId
|
|
1319
|
+
* @param {string} version
|
|
1320
|
+
* @param {string} name
|
|
1321
|
+
* @param {*} [options] Override http request option.
|
|
1322
|
+
* @throws {RequiredError}
|
|
1323
|
+
*/
|
|
1324
|
+
getVersionDocumentFile: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1114
1325
|
/**
|
|
1115
1326
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
1116
1327
|
* @summary List available applications
|
|
@@ -1146,11 +1357,21 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1146
1357
|
* @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
1358
|
* @param {number} [page]
|
|
1148
1359
|
* @param {number} [pageSize]
|
|
1360
|
+
* @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
1361
|
* @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
1362
|
* @param {*} [options] Override http request option.
|
|
1151
1363
|
* @throws {RequiredError}
|
|
1152
1364
|
*/
|
|
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>;
|
|
1365
|
+
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>;
|
|
1366
|
+
/**
|
|
1367
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1368
|
+
* @summary List version documents
|
|
1369
|
+
* @param {string} applicationId
|
|
1370
|
+
* @param {string} version
|
|
1371
|
+
* @param {*} [options] Override http request option.
|
|
1372
|
+
* @throws {RequiredError}
|
|
1373
|
+
*/
|
|
1374
|
+
listVersionDocuments: (applicationId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1154
1375
|
/**
|
|
1155
1376
|
* 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
1377
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1217,6 +1438,15 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1217
1438
|
* @throws {RequiredError}
|
|
1218
1439
|
*/
|
|
1219
1440
|
deleteRunItemsV1RunsRunIdArtifactsDelete(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1441
|
+
/**
|
|
1442
|
+
* 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.
|
|
1443
|
+
* @summary Get Artifact Url
|
|
1444
|
+
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1445
|
+
* @param {string} artifactId The artifact id to download
|
|
1446
|
+
* @param {*} [options] Override http request option.
|
|
1447
|
+
* @throws {RequiredError}
|
|
1448
|
+
*/
|
|
1449
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId: string, artifactId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1220
1450
|
/**
|
|
1221
1451
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1222
1452
|
* @summary Get Item By Run
|
|
@@ -1241,6 +1471,36 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1241
1471
|
* @throws {RequiredError}
|
|
1242
1472
|
*/
|
|
1243
1473
|
getRunV1RunsRunIdGet(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunReadResponse>>;
|
|
1474
|
+
/**
|
|
1475
|
+
* Return metadata for a single public document attached to an application version.
|
|
1476
|
+
* @summary Get version document metadata
|
|
1477
|
+
* @param {string} applicationId
|
|
1478
|
+
* @param {string} version
|
|
1479
|
+
* @param {string} name
|
|
1480
|
+
* @param {*} [options] Override http request option.
|
|
1481
|
+
* @throws {RequiredError}
|
|
1482
|
+
*/
|
|
1483
|
+
getVersionDocument(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VersionDocumentResponse>>;
|
|
1484
|
+
/**
|
|
1485
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
1486
|
+
* @summary Stream version document content (programmatic)
|
|
1487
|
+
* @param {string} applicationId
|
|
1488
|
+
* @param {string} version
|
|
1489
|
+
* @param {string} name
|
|
1490
|
+
* @param {*} [options] Override http request option.
|
|
1491
|
+
* @throws {RequiredError}
|
|
1492
|
+
*/
|
|
1493
|
+
getVersionDocumentContent(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1494
|
+
/**
|
|
1495
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
1496
|
+
* @summary Download version document (browser)
|
|
1497
|
+
* @param {string} applicationId
|
|
1498
|
+
* @param {string} version
|
|
1499
|
+
* @param {string} name
|
|
1500
|
+
* @param {*} [options] Override http request option.
|
|
1501
|
+
* @throws {RequiredError}
|
|
1502
|
+
*/
|
|
1503
|
+
getVersionDocumentFile(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1244
1504
|
/**
|
|
1245
1505
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
1246
1506
|
* @summary List available applications
|
|
@@ -1276,11 +1536,21 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1276
1536
|
* @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
1537
|
* @param {number} [page]
|
|
1278
1538
|
* @param {number} [pageSize]
|
|
1539
|
+
* @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
1540
|
* @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
1541
|
* @param {*} [options] Override http request option.
|
|
1281
1542
|
* @throws {RequiredError}
|
|
1282
1543
|
*/
|
|
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>>>;
|
|
1544
|
+
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>>>;
|
|
1545
|
+
/**
|
|
1546
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1547
|
+
* @summary List version documents
|
|
1548
|
+
* @param {string} applicationId
|
|
1549
|
+
* @param {string} version
|
|
1550
|
+
* @param {*} [options] Override http request option.
|
|
1551
|
+
* @throws {RequiredError}
|
|
1552
|
+
*/
|
|
1553
|
+
listVersionDocuments(applicationId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VersionDocumentResponse>>>;
|
|
1284
1554
|
/**
|
|
1285
1555
|
* 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
1556
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1346,6 +1616,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1346
1616
|
* @throws {RequiredError}
|
|
1347
1617
|
*/
|
|
1348
1618
|
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1619
|
+
/**
|
|
1620
|
+
* 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.
|
|
1621
|
+
* @summary Get Artifact Url
|
|
1622
|
+
* @param {PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest} requestParameters Request parameters.
|
|
1623
|
+
* @param {*} [options] Override http request option.
|
|
1624
|
+
* @throws {RequiredError}
|
|
1625
|
+
*/
|
|
1626
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1349
1627
|
/**
|
|
1350
1628
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1351
1629
|
* @summary Get Item By Run
|
|
@@ -1369,6 +1647,30 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1369
1647
|
* @throws {RequiredError}
|
|
1370
1648
|
*/
|
|
1371
1649
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
|
|
1650
|
+
/**
|
|
1651
|
+
* Return metadata for a single public document attached to an application version.
|
|
1652
|
+
* @summary Get version document metadata
|
|
1653
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
1654
|
+
* @param {*} [options] Override http request option.
|
|
1655
|
+
* @throws {RequiredError}
|
|
1656
|
+
*/
|
|
1657
|
+
getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionDocumentResponse>;
|
|
1658
|
+
/**
|
|
1659
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
1660
|
+
* @summary Stream version document content (programmatic)
|
|
1661
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
1662
|
+
* @param {*} [options] Override http request option.
|
|
1663
|
+
* @throws {RequiredError}
|
|
1664
|
+
*/
|
|
1665
|
+
getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1666
|
+
/**
|
|
1667
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
1668
|
+
* @summary Download version document (browser)
|
|
1669
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
1670
|
+
* @param {*} [options] Override http request option.
|
|
1671
|
+
* @throws {RequiredError}
|
|
1672
|
+
*/
|
|
1673
|
+
getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1372
1674
|
/**
|
|
1373
1675
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
1374
1676
|
* @summary List available applications
|
|
@@ -1393,6 +1695,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1393
1695
|
* @throws {RequiredError}
|
|
1394
1696
|
*/
|
|
1395
1697
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
|
|
1698
|
+
/**
|
|
1699
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1700
|
+
* @summary List version documents
|
|
1701
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
1702
|
+
* @param {*} [options] Override http request option.
|
|
1703
|
+
* @throws {RequiredError}
|
|
1704
|
+
*/
|
|
1705
|
+
listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<VersionDocumentResponse>>;
|
|
1396
1706
|
/**
|
|
1397
1707
|
* 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`.
|
|
1398
1708
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1460,6 +1770,15 @@ interface PublicApiInterface {
|
|
|
1460
1770
|
* @memberof PublicApiInterface
|
|
1461
1771
|
*/
|
|
1462
1772
|
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1773
|
+
/**
|
|
1774
|
+
* 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.
|
|
1775
|
+
* @summary Get Artifact Url
|
|
1776
|
+
* @param {PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest} requestParameters Request parameters.
|
|
1777
|
+
* @param {*} [options] Override http request option.
|
|
1778
|
+
* @throws {RequiredError}
|
|
1779
|
+
* @memberof PublicApiInterface
|
|
1780
|
+
*/
|
|
1781
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1463
1782
|
/**
|
|
1464
1783
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1465
1784
|
* @summary Get Item By Run
|
|
@@ -1486,6 +1805,33 @@ interface PublicApiInterface {
|
|
|
1486
1805
|
* @memberof PublicApiInterface
|
|
1487
1806
|
*/
|
|
1488
1807
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
|
|
1808
|
+
/**
|
|
1809
|
+
* Return metadata for a single public document attached to an application version.
|
|
1810
|
+
* @summary Get version document metadata
|
|
1811
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
1812
|
+
* @param {*} [options] Override http request option.
|
|
1813
|
+
* @throws {RequiredError}
|
|
1814
|
+
* @memberof PublicApiInterface
|
|
1815
|
+
*/
|
|
1816
|
+
getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionDocumentResponse>;
|
|
1817
|
+
/**
|
|
1818
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
1819
|
+
* @summary Stream version document content (programmatic)
|
|
1820
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
1821
|
+
* @param {*} [options] Override http request option.
|
|
1822
|
+
* @throws {RequiredError}
|
|
1823
|
+
* @memberof PublicApiInterface
|
|
1824
|
+
*/
|
|
1825
|
+
getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1826
|
+
/**
|
|
1827
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
1828
|
+
* @summary Download version document (browser)
|
|
1829
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
1830
|
+
* @param {*} [options] Override http request option.
|
|
1831
|
+
* @throws {RequiredError}
|
|
1832
|
+
* @memberof PublicApiInterface
|
|
1833
|
+
*/
|
|
1834
|
+
getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1489
1835
|
/**
|
|
1490
1836
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
1491
1837
|
* @summary List available applications
|
|
@@ -1513,6 +1859,15 @@ interface PublicApiInterface {
|
|
|
1513
1859
|
* @memberof PublicApiInterface
|
|
1514
1860
|
*/
|
|
1515
1861
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
|
|
1862
|
+
/**
|
|
1863
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1864
|
+
* @summary List version documents
|
|
1865
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
1866
|
+
* @param {*} [options] Override http request option.
|
|
1867
|
+
* @throws {RequiredError}
|
|
1868
|
+
* @memberof PublicApiInterface
|
|
1869
|
+
*/
|
|
1870
|
+
listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<VersionDocumentResponse>>;
|
|
1516
1871
|
/**
|
|
1517
1872
|
* 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`.
|
|
1518
1873
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1599,6 +1954,25 @@ interface PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest {
|
|
|
1599
1954
|
*/
|
|
1600
1955
|
readonly runId: string;
|
|
1601
1956
|
}
|
|
1957
|
+
/**
|
|
1958
|
+
* Request parameters for getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet operation in PublicApi.
|
|
1959
|
+
* @export
|
|
1960
|
+
* @interface PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest
|
|
1961
|
+
*/
|
|
1962
|
+
interface PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest {
|
|
1963
|
+
/**
|
|
1964
|
+
* Run id, returned by `POST /runs/` endpoint
|
|
1965
|
+
* @type {string}
|
|
1966
|
+
* @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
|
|
1967
|
+
*/
|
|
1968
|
+
readonly runId: string;
|
|
1969
|
+
/**
|
|
1970
|
+
* The artifact id to download
|
|
1971
|
+
* @type {string}
|
|
1972
|
+
* @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
|
|
1973
|
+
*/
|
|
1974
|
+
readonly artifactId: string;
|
|
1975
|
+
}
|
|
1602
1976
|
/**
|
|
1603
1977
|
* Request parameters for getItemByRunV1RunsRunIdItemsExternalIdGet operation in PublicApi.
|
|
1604
1978
|
* @export
|
|
@@ -1631,6 +2005,81 @@ interface PublicApiGetRunV1RunsRunIdGetRequest {
|
|
|
1631
2005
|
*/
|
|
1632
2006
|
readonly runId: string;
|
|
1633
2007
|
}
|
|
2008
|
+
/**
|
|
2009
|
+
* Request parameters for getVersionDocument operation in PublicApi.
|
|
2010
|
+
* @export
|
|
2011
|
+
* @interface PublicApiGetVersionDocumentRequest
|
|
2012
|
+
*/
|
|
2013
|
+
interface PublicApiGetVersionDocumentRequest {
|
|
2014
|
+
/**
|
|
2015
|
+
*
|
|
2016
|
+
* @type {string}
|
|
2017
|
+
* @memberof PublicApiGetVersionDocument
|
|
2018
|
+
*/
|
|
2019
|
+
readonly applicationId: string;
|
|
2020
|
+
/**
|
|
2021
|
+
*
|
|
2022
|
+
* @type {string}
|
|
2023
|
+
* @memberof PublicApiGetVersionDocument
|
|
2024
|
+
*/
|
|
2025
|
+
readonly version: string;
|
|
2026
|
+
/**
|
|
2027
|
+
*
|
|
2028
|
+
* @type {string}
|
|
2029
|
+
* @memberof PublicApiGetVersionDocument
|
|
2030
|
+
*/
|
|
2031
|
+
readonly name: string;
|
|
2032
|
+
}
|
|
2033
|
+
/**
|
|
2034
|
+
* Request parameters for getVersionDocumentContent operation in PublicApi.
|
|
2035
|
+
* @export
|
|
2036
|
+
* @interface PublicApiGetVersionDocumentContentRequest
|
|
2037
|
+
*/
|
|
2038
|
+
interface PublicApiGetVersionDocumentContentRequest {
|
|
2039
|
+
/**
|
|
2040
|
+
*
|
|
2041
|
+
* @type {string}
|
|
2042
|
+
* @memberof PublicApiGetVersionDocumentContent
|
|
2043
|
+
*/
|
|
2044
|
+
readonly applicationId: string;
|
|
2045
|
+
/**
|
|
2046
|
+
*
|
|
2047
|
+
* @type {string}
|
|
2048
|
+
* @memberof PublicApiGetVersionDocumentContent
|
|
2049
|
+
*/
|
|
2050
|
+
readonly version: string;
|
|
2051
|
+
/**
|
|
2052
|
+
*
|
|
2053
|
+
* @type {string}
|
|
2054
|
+
* @memberof PublicApiGetVersionDocumentContent
|
|
2055
|
+
*/
|
|
2056
|
+
readonly name: string;
|
|
2057
|
+
}
|
|
2058
|
+
/**
|
|
2059
|
+
* Request parameters for getVersionDocumentFile operation in PublicApi.
|
|
2060
|
+
* @export
|
|
2061
|
+
* @interface PublicApiGetVersionDocumentFileRequest
|
|
2062
|
+
*/
|
|
2063
|
+
interface PublicApiGetVersionDocumentFileRequest {
|
|
2064
|
+
/**
|
|
2065
|
+
*
|
|
2066
|
+
* @type {string}
|
|
2067
|
+
* @memberof PublicApiGetVersionDocumentFile
|
|
2068
|
+
*/
|
|
2069
|
+
readonly applicationId: string;
|
|
2070
|
+
/**
|
|
2071
|
+
*
|
|
2072
|
+
* @type {string}
|
|
2073
|
+
* @memberof PublicApiGetVersionDocumentFile
|
|
2074
|
+
*/
|
|
2075
|
+
readonly version: string;
|
|
2076
|
+
/**
|
|
2077
|
+
*
|
|
2078
|
+
* @type {string}
|
|
2079
|
+
* @memberof PublicApiGetVersionDocumentFile
|
|
2080
|
+
*/
|
|
2081
|
+
readonly name: string;
|
|
2082
|
+
}
|
|
1634
2083
|
/**
|
|
1635
2084
|
* Request parameters for listApplicationsV1ApplicationsGet operation in PublicApi.
|
|
1636
2085
|
* @export
|
|
@@ -1759,6 +2208,12 @@ interface PublicApiListRunsV1RunsGetRequest {
|
|
|
1759
2208
|
* @memberof PublicApiListRunsV1RunsGet
|
|
1760
2209
|
*/
|
|
1761
2210
|
readonly pageSize?: number;
|
|
2211
|
+
/**
|
|
2212
|
+
* 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.
|
|
2213
|
+
* @type {string}
|
|
2214
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
2215
|
+
*/
|
|
2216
|
+
readonly forOrganization?: string | null;
|
|
1762
2217
|
/**
|
|
1763
2218
|
* 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
2219
|
* @type {Array<string>}
|
|
@@ -1766,6 +2221,25 @@ interface PublicApiListRunsV1RunsGetRequest {
|
|
|
1766
2221
|
*/
|
|
1767
2222
|
readonly sort?: Array<string> | null;
|
|
1768
2223
|
}
|
|
2224
|
+
/**
|
|
2225
|
+
* Request parameters for listVersionDocuments operation in PublicApi.
|
|
2226
|
+
* @export
|
|
2227
|
+
* @interface PublicApiListVersionDocumentsRequest
|
|
2228
|
+
*/
|
|
2229
|
+
interface PublicApiListVersionDocumentsRequest {
|
|
2230
|
+
/**
|
|
2231
|
+
*
|
|
2232
|
+
* @type {string}
|
|
2233
|
+
* @memberof PublicApiListVersionDocuments
|
|
2234
|
+
*/
|
|
2235
|
+
readonly applicationId: string;
|
|
2236
|
+
/**
|
|
2237
|
+
*
|
|
2238
|
+
* @type {string}
|
|
2239
|
+
* @memberof PublicApiListVersionDocuments
|
|
2240
|
+
*/
|
|
2241
|
+
readonly version: string;
|
|
2242
|
+
}
|
|
1769
2243
|
/**
|
|
1770
2244
|
* Request parameters for putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut operation in PublicApi.
|
|
1771
2245
|
* @export
|
|
@@ -1866,6 +2340,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
1866
2340
|
* @memberof PublicApi
|
|
1867
2341
|
*/
|
|
1868
2342
|
deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
2343
|
+
/**
|
|
2344
|
+
* 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.
|
|
2345
|
+
* @summary Get Artifact Url
|
|
2346
|
+
* @param {PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest} requestParameters Request parameters.
|
|
2347
|
+
* @param {*} [options] Override http request option.
|
|
2348
|
+
* @throws {RequiredError}
|
|
2349
|
+
* @memberof PublicApi
|
|
2350
|
+
*/
|
|
2351
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
1869
2352
|
/**
|
|
1870
2353
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1871
2354
|
* @summary Get Item By Run
|
|
@@ -1892,6 +2375,33 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
1892
2375
|
* @memberof PublicApi
|
|
1893
2376
|
*/
|
|
1894
2377
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse, any, {}>>;
|
|
2378
|
+
/**
|
|
2379
|
+
* Return metadata for a single public document attached to an application version.
|
|
2380
|
+
* @summary Get version document metadata
|
|
2381
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
2382
|
+
* @param {*} [options] Override http request option.
|
|
2383
|
+
* @throws {RequiredError}
|
|
2384
|
+
* @memberof PublicApi
|
|
2385
|
+
*/
|
|
2386
|
+
getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionDocumentResponse, any, {}>>;
|
|
2387
|
+
/**
|
|
2388
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
2389
|
+
* @summary Stream version document content (programmatic)
|
|
2390
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
2391
|
+
* @param {*} [options] Override http request option.
|
|
2392
|
+
* @throws {RequiredError}
|
|
2393
|
+
* @memberof PublicApi
|
|
2394
|
+
*/
|
|
2395
|
+
getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
|
|
2396
|
+
/**
|
|
2397
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
2398
|
+
* @summary Download version document (browser)
|
|
2399
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
2400
|
+
* @param {*} [options] Override http request option.
|
|
2401
|
+
* @throws {RequiredError}
|
|
2402
|
+
* @memberof PublicApi
|
|
2403
|
+
*/
|
|
2404
|
+
getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
|
|
1895
2405
|
/**
|
|
1896
2406
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
1897
2407
|
* @summary List available applications
|
|
@@ -1919,6 +2429,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
1919
2429
|
* @memberof PublicApi
|
|
1920
2430
|
*/
|
|
1921
2431
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse[], any, {}>>;
|
|
2432
|
+
/**
|
|
2433
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
2434
|
+
* @summary List version documents
|
|
2435
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
2436
|
+
* @param {*} [options] Override http request option.
|
|
2437
|
+
* @throws {RequiredError}
|
|
2438
|
+
* @memberof PublicApi
|
|
2439
|
+
*/
|
|
2440
|
+
listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionDocumentResponse[], any, {}>>;
|
|
1922
2441
|
/**
|
|
1923
2442
|
* 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`.
|
|
1924
2443
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1948,4 +2467,4 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
1948
2467
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadResponse, any, {}>>;
|
|
1949
2468
|
}
|
|
1950
2469
|
|
|
1951
|
-
export { type ApplicationReadShortResponse as A, type
|
|
2470
|
+
export { type PublicApiListRunItemsV1RunsRunIdItemsGetRequest as $, type ApplicationReadShortResponse as A, type VersionDocumentResponse as B, type CustomMetadataUpdateRequest as C, VersionDocumentVisibility as D, PublicApiFp as E, PublicApiFactory as F, type PublicApiInterface as G, type HTTPValidationError as H, type ItemResultReadResponse as I, type PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest as J, type PublicApiCancelRunV1RunsRunIdCancelPostRequest as K, type PublicApiCreateRunV1RunsPostRequest as L, type MeReadResponse as M, type PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest as N, type OrganizationReadResponse as O, PublicApiAxiosParamCreator as P, type PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest as Q, type RunReadResponse as R, type SchedulingRequest as S, type PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest as T, type UserReadResponse as U, type VersionReadResponse as V, type PublicApiGetRunV1RunsRunIdGetRequest as W, type PublicApiGetVersionDocumentRequest as X, type PublicApiGetVersionDocumentContentRequest as Y, type PublicApiGetVersionDocumentFileRequest as Z, type PublicApiListApplicationsV1ApplicationsGetRequest as _, type ApplicationReadResponse as a, type PublicApiListRunsV1RunsGetRequest as a0, type PublicApiListVersionDocumentsRequest as a1, type PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest as a2, type PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest as a3, type PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest as a4, PublicApi as a5, type ConfigurationParameters as a6, Configuration as a7, 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 InputArtifactResultReadResponse as m, type ItemCreationRequest as n, ItemOutput as o, type OutputArtifact as p, type OutputArtifactResultReadResponse as q, OutputArtifactScope as r, OutputArtifactVisibility as s, type RunItemStatistics as t, RunOutput as u, RunState as v, RunTerminationReason as w, type SchedulingResponse as x, type ValidationError as y, type ValidationErrorLocInner as z };
|