@aignostics/sdk 3.5.0 → 3.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aignostics-sdk-3.5.1.tgz +0 -0
- package/dist/{api-CrZaHZZr.d.cts → api-B0sQ1mLM.d.cts} +36 -6
- package/dist/{api-CrZaHZZr.d.ts → api-B0sQ1mLM.d.ts} +36 -6
- package/dist/index.cjs +59 -22
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +16 -10
- package/dist/index.d.ts +16 -10
- package/dist/index.js +59 -22
- 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.5.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.
|
|
8
|
+
* The version of the OpenAPI document: 1.7.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.
|
|
100
|
+
* The version of the OpenAPI document: 1.7.0
|
|
101
101
|
*
|
|
102
102
|
*
|
|
103
103
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1076,6 +1076,12 @@ interface RunReadResponse {
|
|
|
1076
1076
|
* @memberof RunReadResponse
|
|
1077
1077
|
*/
|
|
1078
1078
|
'submitted_by': string;
|
|
1079
|
+
/**
|
|
1080
|
+
*
|
|
1081
|
+
* @type {string}
|
|
1082
|
+
* @memberof RunReadResponse
|
|
1083
|
+
*/
|
|
1084
|
+
'organization_id'?: string | null;
|
|
1079
1085
|
/**
|
|
1080
1086
|
*
|
|
1081
1087
|
* @type {string}
|
|
@@ -1602,6 +1608,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1602
1608
|
* @param {string | null} [resourceId]
|
|
1603
1609
|
* @param {SubjectType | null} [subjectType]
|
|
1604
1610
|
* @param {string | null} [subjectId]
|
|
1611
|
+
* @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
|
|
1605
1612
|
* @param {boolean | null} [revoked]
|
|
1606
1613
|
* @param {number} [page]
|
|
1607
1614
|
* @param {number} [pageSize]
|
|
@@ -1609,7 +1616,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1609
1616
|
* @param {*} [options] Override http request option.
|
|
1610
1617
|
* @throws {RequiredError}
|
|
1611
1618
|
*/
|
|
1612
|
-
listGrantsV1AccessGrantsGet: (resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1619
|
+
listGrantsV1AccessGrantsGet: (resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, relation?: Array<GrantRelation> | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1613
1620
|
/**
|
|
1614
1621
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1615
1622
|
* @summary List Run Items
|
|
@@ -1636,12 +1643,14 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1636
1643
|
* @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**
|
|
1637
1644
|
* @param {number} [page]
|
|
1638
1645
|
* @param {number} [pageSize]
|
|
1646
|
+
* @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
1647
|
+
* @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
1639
1648
|
* @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.
|
|
1640
1649
|
* @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)
|
|
1641
1650
|
* @param {*} [options] Override http request option.
|
|
1642
1651
|
* @throws {RequiredError}
|
|
1643
1652
|
*/
|
|
1644
|
-
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>;
|
|
1653
|
+
listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, submittedBy?: string | null, organizationId?: string | null, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1645
1654
|
/**
|
|
1646
1655
|
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1647
1656
|
* @summary List Share Tokens
|
|
@@ -1861,6 +1870,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1861
1870
|
* @param {string | null} [resourceId]
|
|
1862
1871
|
* @param {SubjectType | null} [subjectType]
|
|
1863
1872
|
* @param {string | null} [subjectId]
|
|
1873
|
+
* @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
|
|
1864
1874
|
* @param {boolean | null} [revoked]
|
|
1865
1875
|
* @param {number} [page]
|
|
1866
1876
|
* @param {number} [pageSize]
|
|
@@ -1868,7 +1878,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1868
1878
|
* @param {*} [options] Override http request option.
|
|
1869
1879
|
* @throws {RequiredError}
|
|
1870
1880
|
*/
|
|
1871
|
-
listGrantsV1AccessGrantsGet(resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GrantReadResponse>>>;
|
|
1881
|
+
listGrantsV1AccessGrantsGet(resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, relation?: Array<GrantRelation> | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GrantReadResponse>>>;
|
|
1872
1882
|
/**
|
|
1873
1883
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1874
1884
|
* @summary List Run Items
|
|
@@ -1895,12 +1905,14 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1895
1905
|
* @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**
|
|
1896
1906
|
* @param {number} [page]
|
|
1897
1907
|
* @param {number} [pageSize]
|
|
1908
|
+
* @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
1909
|
+
* @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
1898
1910
|
* @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.
|
|
1899
1911
|
* @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)
|
|
1900
1912
|
* @param {*} [options] Override http request option.
|
|
1901
1913
|
* @throws {RequiredError}
|
|
1902
1914
|
*/
|
|
1903
|
-
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>>>;
|
|
1915
|
+
listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, submittedBy?: string | null, organizationId?: string | null, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
|
|
1904
1916
|
/**
|
|
1905
1917
|
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1906
1918
|
* @summary List Share Tokens
|
|
@@ -2729,6 +2741,12 @@ interface PublicApiListGrantsV1AccessGrantsGetRequest {
|
|
|
2729
2741
|
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2730
2742
|
*/
|
|
2731
2743
|
readonly subjectId?: string | null;
|
|
2744
|
+
/**
|
|
2745
|
+
* Filter grants by relation type. Can be specified multiple times.
|
|
2746
|
+
* @type {Array<GrantRelation>}
|
|
2747
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2748
|
+
*/
|
|
2749
|
+
readonly relation?: Array<GrantRelation> | null;
|
|
2732
2750
|
/**
|
|
2733
2751
|
*
|
|
2734
2752
|
* @type {boolean}
|
|
@@ -2863,6 +2881,18 @@ interface PublicApiListRunsV1RunsGetRequest {
|
|
|
2863
2881
|
* @memberof PublicApiListRunsV1RunsGet
|
|
2864
2882
|
*/
|
|
2865
2883
|
readonly pageSize?: number;
|
|
2884
|
+
/**
|
|
2885
|
+
* Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
2886
|
+
* @type {string}
|
|
2887
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
2888
|
+
*/
|
|
2889
|
+
readonly submittedBy?: string | null;
|
|
2890
|
+
/**
|
|
2891
|
+
* Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
2892
|
+
* @type {string}
|
|
2893
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
2894
|
+
*/
|
|
2895
|
+
readonly organizationId?: string | null;
|
|
2866
2896
|
/**
|
|
2867
2897
|
* 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.
|
|
2868
2898
|
* @type {string}
|
|
@@ -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.
|
|
8
|
+
* The version of the OpenAPI document: 1.7.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.
|
|
100
|
+
* The version of the OpenAPI document: 1.7.0
|
|
101
101
|
*
|
|
102
102
|
*
|
|
103
103
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1076,6 +1076,12 @@ interface RunReadResponse {
|
|
|
1076
1076
|
* @memberof RunReadResponse
|
|
1077
1077
|
*/
|
|
1078
1078
|
'submitted_by': string;
|
|
1079
|
+
/**
|
|
1080
|
+
*
|
|
1081
|
+
* @type {string}
|
|
1082
|
+
* @memberof RunReadResponse
|
|
1083
|
+
*/
|
|
1084
|
+
'organization_id'?: string | null;
|
|
1079
1085
|
/**
|
|
1080
1086
|
*
|
|
1081
1087
|
* @type {string}
|
|
@@ -1602,6 +1608,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1602
1608
|
* @param {string | null} [resourceId]
|
|
1603
1609
|
* @param {SubjectType | null} [subjectType]
|
|
1604
1610
|
* @param {string | null} [subjectId]
|
|
1611
|
+
* @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
|
|
1605
1612
|
* @param {boolean | null} [revoked]
|
|
1606
1613
|
* @param {number} [page]
|
|
1607
1614
|
* @param {number} [pageSize]
|
|
@@ -1609,7 +1616,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1609
1616
|
* @param {*} [options] Override http request option.
|
|
1610
1617
|
* @throws {RequiredError}
|
|
1611
1618
|
*/
|
|
1612
|
-
listGrantsV1AccessGrantsGet: (resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1619
|
+
listGrantsV1AccessGrantsGet: (resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, relation?: Array<GrantRelation> | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1613
1620
|
/**
|
|
1614
1621
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1615
1622
|
* @summary List Run Items
|
|
@@ -1636,12 +1643,14 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1636
1643
|
* @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**
|
|
1637
1644
|
* @param {number} [page]
|
|
1638
1645
|
* @param {number} [pageSize]
|
|
1646
|
+
* @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
1647
|
+
* @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
1639
1648
|
* @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.
|
|
1640
1649
|
* @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)
|
|
1641
1650
|
* @param {*} [options] Override http request option.
|
|
1642
1651
|
* @throws {RequiredError}
|
|
1643
1652
|
*/
|
|
1644
|
-
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>;
|
|
1653
|
+
listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, submittedBy?: string | null, organizationId?: string | null, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1645
1654
|
/**
|
|
1646
1655
|
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1647
1656
|
* @summary List Share Tokens
|
|
@@ -1861,6 +1870,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1861
1870
|
* @param {string | null} [resourceId]
|
|
1862
1871
|
* @param {SubjectType | null} [subjectType]
|
|
1863
1872
|
* @param {string | null} [subjectId]
|
|
1873
|
+
* @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
|
|
1864
1874
|
* @param {boolean | null} [revoked]
|
|
1865
1875
|
* @param {number} [page]
|
|
1866
1876
|
* @param {number} [pageSize]
|
|
@@ -1868,7 +1878,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1868
1878
|
* @param {*} [options] Override http request option.
|
|
1869
1879
|
* @throws {RequiredError}
|
|
1870
1880
|
*/
|
|
1871
|
-
listGrantsV1AccessGrantsGet(resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GrantReadResponse>>>;
|
|
1881
|
+
listGrantsV1AccessGrantsGet(resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, relation?: Array<GrantRelation> | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GrantReadResponse>>>;
|
|
1872
1882
|
/**
|
|
1873
1883
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1874
1884
|
* @summary List Run Items
|
|
@@ -1895,12 +1905,14 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1895
1905
|
* @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**
|
|
1896
1906
|
* @param {number} [page]
|
|
1897
1907
|
* @param {number} [pageSize]
|
|
1908
|
+
* @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
1909
|
+
* @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
1898
1910
|
* @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.
|
|
1899
1911
|
* @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)
|
|
1900
1912
|
* @param {*} [options] Override http request option.
|
|
1901
1913
|
* @throws {RequiredError}
|
|
1902
1914
|
*/
|
|
1903
|
-
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>>>;
|
|
1915
|
+
listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, submittedBy?: string | null, organizationId?: string | null, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
|
|
1904
1916
|
/**
|
|
1905
1917
|
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1906
1918
|
* @summary List Share Tokens
|
|
@@ -2729,6 +2741,12 @@ interface PublicApiListGrantsV1AccessGrantsGetRequest {
|
|
|
2729
2741
|
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2730
2742
|
*/
|
|
2731
2743
|
readonly subjectId?: string | null;
|
|
2744
|
+
/**
|
|
2745
|
+
* Filter grants by relation type. Can be specified multiple times.
|
|
2746
|
+
* @type {Array<GrantRelation>}
|
|
2747
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2748
|
+
*/
|
|
2749
|
+
readonly relation?: Array<GrantRelation> | null;
|
|
2732
2750
|
/**
|
|
2733
2751
|
*
|
|
2734
2752
|
* @type {boolean}
|
|
@@ -2863,6 +2881,18 @@ interface PublicApiListRunsV1RunsGetRequest {
|
|
|
2863
2881
|
* @memberof PublicApiListRunsV1RunsGet
|
|
2864
2882
|
*/
|
|
2865
2883
|
readonly pageSize?: number;
|
|
2884
|
+
/**
|
|
2885
|
+
* Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
2886
|
+
* @type {string}
|
|
2887
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
2888
|
+
*/
|
|
2889
|
+
readonly submittedBy?: string | null;
|
|
2890
|
+
/**
|
|
2891
|
+
* Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
2892
|
+
* @type {string}
|
|
2893
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
2894
|
+
*/
|
|
2895
|
+
readonly organizationId?: string | null;
|
|
2866
2896
|
/**
|
|
2867
2897
|
* 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.
|
|
2868
2898
|
* @type {string}
|
package/dist/index.cjs
CHANGED
|
@@ -647,6 +647,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
647
647
|
* @param {string | null} [resourceId]
|
|
648
648
|
* @param {SubjectType | null} [subjectType]
|
|
649
649
|
* @param {string | null} [subjectId]
|
|
650
|
+
* @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
|
|
650
651
|
* @param {boolean | null} [revoked]
|
|
651
652
|
* @param {number} [page]
|
|
652
653
|
* @param {number} [pageSize]
|
|
@@ -654,7 +655,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
654
655
|
* @param {*} [options] Override http request option.
|
|
655
656
|
* @throws {RequiredError}
|
|
656
657
|
*/
|
|
657
|
-
listGrantsV1AccessGrantsGet: async (resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options = {}) => {
|
|
658
|
+
listGrantsV1AccessGrantsGet: async (resourceType, resourceId, subjectType, subjectId, relation, revoked, page, pageSize, sort, options = {}) => {
|
|
658
659
|
const localVarPath = `/v1/access/grants`;
|
|
659
660
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
660
661
|
let baseOptions;
|
|
@@ -677,6 +678,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
677
678
|
if (subjectId !== void 0) {
|
|
678
679
|
localVarQueryParameter["subject_id"] = subjectId;
|
|
679
680
|
}
|
|
681
|
+
if (relation) {
|
|
682
|
+
localVarQueryParameter["relation"] = relation;
|
|
683
|
+
}
|
|
680
684
|
if (revoked !== void 0) {
|
|
681
685
|
localVarQueryParameter["revoked"] = revoked;
|
|
682
686
|
}
|
|
@@ -769,12 +773,14 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
769
773
|
* @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: `$.study` - Runs that have a study field defined - **Exact value match**: `$.study ? (@ == \"high\")` - Runs with specific study value - **Numeric comparison**: `$.confidence_score ? (@ > 0.75)` - Runs with confidence score greater than 0.75 - **Array operations**: `$.tags[*] ? (@ == \"draft\")` - Runs with tags array containing \"draft\" - **Complex conditions**: `$.resources ? (@.gpu_count > 2 && @.memory_gb >= 16)` - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: `%24.study` - **Exact value match**: `%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)` - **Numeric comparison**: `%24.confidence_score%20%3F%20(%40%20%3E%200.75)` - **Array operations**: `%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)` - **Complex conditions**: `%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)` #### Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations - Regular expressions use `like_regex` with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
|
|
770
774
|
* @param {number} [page]
|
|
771
775
|
* @param {number} [pageSize]
|
|
776
|
+
* @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
777
|
+
* @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
772
778
|
* @param {string | null} [forOrganization] Filter runs by organization ID. Available for superadmins (any org) and admins (own org only). When provided, returns all runs for the specified organization instead of only the caller\'s own runs.
|
|
773
779
|
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `run_id` - `application_id` - `version_number` - `custom_metadata` - `submitted_at` - `submitted_by` - `terminated_at` - `termination_reason` **Examples:** - `?sort=submitted_at` - Sort by creation time (ascending) - `?sort=-submitted_at` - Sort by creation time (descending) - `?sort=state&sort=-submitted_at` - Sort by state, then by time (descending)
|
|
774
780
|
* @param {*} [options] Override http request option.
|
|
775
781
|
* @throws {RequiredError}
|
|
776
782
|
*/
|
|
777
|
-
listRunsV1RunsGet: async (applicationId, applicationVersion, externalId, customMetadata, page, pageSize, forOrganization, sort, options = {}) => {
|
|
783
|
+
listRunsV1RunsGet: async (applicationId, applicationVersion, externalId, customMetadata, page, pageSize, submittedBy, organizationId, forOrganization, sort, options = {}) => {
|
|
778
784
|
const localVarPath = `/v1/runs`;
|
|
779
785
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
780
786
|
let baseOptions;
|
|
@@ -803,6 +809,12 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
803
809
|
if (pageSize !== void 0) {
|
|
804
810
|
localVarQueryParameter["page_size"] = pageSize;
|
|
805
811
|
}
|
|
812
|
+
if (submittedBy !== void 0) {
|
|
813
|
+
localVarQueryParameter["submitted_by"] = submittedBy;
|
|
814
|
+
}
|
|
815
|
+
if (organizationId !== void 0) {
|
|
816
|
+
localVarQueryParameter["organization_id"] = organizationId;
|
|
817
|
+
}
|
|
806
818
|
if (forOrganization !== void 0) {
|
|
807
819
|
localVarQueryParameter["for_organization"] = forOrganization;
|
|
808
820
|
}
|
|
@@ -1273,6 +1285,7 @@ var PublicApiFp = function(configuration) {
|
|
|
1273
1285
|
* @param {string | null} [resourceId]
|
|
1274
1286
|
* @param {SubjectType | null} [subjectType]
|
|
1275
1287
|
* @param {string | null} [subjectId]
|
|
1288
|
+
* @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
|
|
1276
1289
|
* @param {boolean | null} [revoked]
|
|
1277
1290
|
* @param {number} [page]
|
|
1278
1291
|
* @param {number} [pageSize]
|
|
@@ -1280,8 +1293,8 @@ var PublicApiFp = function(configuration) {
|
|
|
1280
1293
|
* @param {*} [options] Override http request option.
|
|
1281
1294
|
* @throws {RequiredError}
|
|
1282
1295
|
*/
|
|
1283
|
-
async listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options) {
|
|
1284
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options);
|
|
1296
|
+
async listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, relation, revoked, page, pageSize, sort, options) {
|
|
1297
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, relation, revoked, page, pageSize, sort, options);
|
|
1285
1298
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1286
1299
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.listGrantsV1AccessGrantsGet"]?.[localVarOperationServerIndex]?.url;
|
|
1287
1300
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1317,13 +1330,15 @@ var PublicApiFp = function(configuration) {
|
|
|
1317
1330
|
* @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: `$.study` - Runs that have a study field defined - **Exact value match**: `$.study ? (@ == \"high\")` - Runs with specific study value - **Numeric comparison**: `$.confidence_score ? (@ > 0.75)` - Runs with confidence score greater than 0.75 - **Array operations**: `$.tags[*] ? (@ == \"draft\")` - Runs with tags array containing \"draft\" - **Complex conditions**: `$.resources ? (@.gpu_count > 2 && @.memory_gb >= 16)` - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: `%24.study` - **Exact value match**: `%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)` - **Numeric comparison**: `%24.confidence_score%20%3F%20(%40%20%3E%200.75)` - **Array operations**: `%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)` - **Complex conditions**: `%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)` #### Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations - Regular expressions use `like_regex` with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
|
|
1318
1331
|
* @param {number} [page]
|
|
1319
1332
|
* @param {number} [pageSize]
|
|
1333
|
+
* @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
1334
|
+
* @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
1320
1335
|
* @param {string | null} [forOrganization] Filter runs by organization ID. Available for superadmins (any org) and admins (own org only). When provided, returns all runs for the specified organization instead of only the caller\'s own runs.
|
|
1321
1336
|
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `run_id` - `application_id` - `version_number` - `custom_metadata` - `submitted_at` - `submitted_by` - `terminated_at` - `termination_reason` **Examples:** - `?sort=submitted_at` - Sort by creation time (ascending) - `?sort=-submitted_at` - Sort by creation time (descending) - `?sort=state&sort=-submitted_at` - Sort by state, then by time (descending)
|
|
1322
1337
|
* @param {*} [options] Override http request option.
|
|
1323
1338
|
* @throws {RequiredError}
|
|
1324
1339
|
*/
|
|
1325
|
-
async listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, forOrganization, sort, options) {
|
|
1326
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, forOrganization, sort, options);
|
|
1340
|
+
async listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, submittedBy, organizationId, forOrganization, sort, options) {
|
|
1341
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, submittedBy, organizationId, forOrganization, sort, options);
|
|
1327
1342
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1328
1343
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunsV1RunsGet"]?.[localVarOperationServerIndex]?.url;
|
|
1329
1344
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1600,7 +1615,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1600
1615
|
* @throws {RequiredError}
|
|
1601
1616
|
*/
|
|
1602
1617
|
listGrantsV1AccessGrantsGet(requestParameters = {}, options) {
|
|
1603
|
-
return localVarFp.listGrantsV1AccessGrantsGet(requestParameters.resourceType, requestParameters.resourceId, requestParameters.subjectType, requestParameters.subjectId, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1618
|
+
return localVarFp.listGrantsV1AccessGrantsGet(requestParameters.resourceType, requestParameters.resourceId, requestParameters.subjectType, requestParameters.subjectId, requestParameters.relation, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1604
1619
|
},
|
|
1605
1620
|
/**
|
|
1606
1621
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
@@ -1620,7 +1635,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
1620
1635
|
* @throws {RequiredError}
|
|
1621
1636
|
*/
|
|
1622
1637
|
listRunsV1RunsGet(requestParameters = {}, options) {
|
|
1623
|
-
return localVarFp.listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1638
|
+
return localVarFp.listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.submittedBy, requestParameters.organizationId, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1624
1639
|
},
|
|
1625
1640
|
/**
|
|
1626
1641
|
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
@@ -1879,7 +1894,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
1879
1894
|
* @memberof PublicApi
|
|
1880
1895
|
*/
|
|
1881
1896
|
listGrantsV1AccessGrantsGet(requestParameters = {}, options) {
|
|
1882
|
-
return PublicApiFp(this.configuration).listGrantsV1AccessGrantsGet(requestParameters.resourceType, requestParameters.resourceId, requestParameters.subjectType, requestParameters.subjectId, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1897
|
+
return PublicApiFp(this.configuration).listGrantsV1AccessGrantsGet(requestParameters.resourceType, requestParameters.resourceId, requestParameters.subjectType, requestParameters.subjectId, requestParameters.relation, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1883
1898
|
}
|
|
1884
1899
|
/**
|
|
1885
1900
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
@@ -1901,7 +1916,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
1901
1916
|
* @memberof PublicApi
|
|
1902
1917
|
*/
|
|
1903
1918
|
listRunsV1RunsGet(requestParameters = {}, options) {
|
|
1904
|
-
return PublicApiFp(this.configuration).listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1919
|
+
return PublicApiFp(this.configuration).listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.submittedBy, requestParameters.organizationId, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1905
1920
|
}
|
|
1906
1921
|
/**
|
|
1907
1922
|
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
@@ -2170,23 +2185,33 @@ function getRunProgress(run) {
|
|
|
2170
2185
|
return Math.round(processed / item_count * 100);
|
|
2171
2186
|
}
|
|
2172
2187
|
function getRunStatus(run) {
|
|
2173
|
-
const { state,
|
|
2188
|
+
const { state, termination_reason, output } = run;
|
|
2174
2189
|
switch (state) {
|
|
2175
2190
|
case "PENDING":
|
|
2176
2191
|
return "PENDING";
|
|
2177
2192
|
case "PROCESSING":
|
|
2178
2193
|
return "PROCESSING";
|
|
2179
2194
|
case "TERMINATED":
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
|
|
2195
|
+
switch (termination_reason) {
|
|
2196
|
+
case "CANCELED_BY_USER":
|
|
2197
|
+
return "CANCELED";
|
|
2198
|
+
case "CANCELED_BY_SYSTEM":
|
|
2199
|
+
case "ALL_ITEMS_PROCESSED":
|
|
2200
|
+
switch (output) {
|
|
2201
|
+
case "NONE":
|
|
2202
|
+
return "FAILED";
|
|
2203
|
+
case "PARTIAL":
|
|
2204
|
+
return "COMPLETED_WITH_ERRORS";
|
|
2205
|
+
case "FULL":
|
|
2206
|
+
return "COMPLETED";
|
|
2207
|
+
default:
|
|
2208
|
+
return "UNKNOWN";
|
|
2209
|
+
}
|
|
2210
|
+
default:
|
|
2211
|
+
return "UNKNOWN";
|
|
2188
2212
|
}
|
|
2189
|
-
|
|
2213
|
+
default:
|
|
2214
|
+
return "UNKNOWN";
|
|
2190
2215
|
}
|
|
2191
2216
|
}
|
|
2192
2217
|
var canDownloadRunItems = (run) => {
|
|
@@ -2208,6 +2233,12 @@ var processApplicationRun = (run) => {
|
|
|
2208
2233
|
var canDownloadItem = (item) => {
|
|
2209
2234
|
return getItemStatus(item) === "COMPLETED";
|
|
2210
2235
|
};
|
|
2236
|
+
var ERROR_TERMINATION_REASONS = /* @__PURE__ */ new Set([
|
|
2237
|
+
"CANCELED_BY_SYSTEM",
|
|
2238
|
+
"CANCELED_BY_USER",
|
|
2239
|
+
"SYSTEM_ERROR",
|
|
2240
|
+
"USER_ERROR"
|
|
2241
|
+
]);
|
|
2211
2242
|
function getItemStatus(item) {
|
|
2212
2243
|
const { state, termination_reason } = item;
|
|
2213
2244
|
switch (state) {
|
|
@@ -2216,13 +2247,19 @@ function getItemStatus(item) {
|
|
|
2216
2247
|
case "PROCESSING":
|
|
2217
2248
|
return "PROCESSING";
|
|
2218
2249
|
case "TERMINATED":
|
|
2219
|
-
if (termination_reason
|
|
2250
|
+
if (!termination_reason) {
|
|
2251
|
+
return "UNKNOWN";
|
|
2252
|
+
}
|
|
2253
|
+
if (ERROR_TERMINATION_REASONS.has(termination_reason)) {
|
|
2220
2254
|
return "FAILED";
|
|
2221
2255
|
}
|
|
2222
2256
|
if (termination_reason === "SKIPPED") {
|
|
2223
2257
|
return "SKIPPED";
|
|
2224
2258
|
}
|
|
2225
|
-
|
|
2259
|
+
if (termination_reason === "SUCCEEDED") {
|
|
2260
|
+
return "COMPLETED";
|
|
2261
|
+
}
|
|
2262
|
+
return "UNKNOWN";
|
|
2226
2263
|
}
|
|
2227
2264
|
}
|
|
2228
2265
|
|