Skip to content

feat: Update ai-api specification #725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/ai-api/src/client/AI_CORE_API/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ export * from './application-api.js';
export * from './docker-registry-secret-api.js';
export * from './service-api.js';
export * from './resource-quota-api.js';
export * from './tenant-info-api.js';
export * from './schema/index.js';
6 changes: 5 additions & 1 deletion packages/ai-api/src/client/AI_CORE_API/metrics-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ export const MetricsApi = {
* Retrieve metrics, labels, or tags according to filter conditions.
* One query parameter is mandatory, either execution ID or filter.
* Use up to 10 execution IDs in a query parameter.
* With top/skip parameters it is possible to paginate the result list.
*
* @param queryParameters - Object containing the following keys: $filter, executionIds, $select.
* @param queryParameters - Object containing the following keys: $filter, executionIds, $select, tagFilters, $top, $skip.
* @param headerParameters - Object containing the following keys: AI-Resource-Group.
* @returns The request builder, use the `execute()` method to trigger the request.
*/
Expand All @@ -32,6 +33,9 @@ export const MetricsApi = {
$filter?: string;
executionIds?: TrckStringArray;
$select?: TrckmetricSelectorPermissibleValues;
tagFilters?: string;
$top?: number;
$skip?: number;
},
headerParameters: { 'AI-Resource-Group': string }
) =>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import type { BckndServiceBrokerSecret } from './bcknd-service-broker-secret.js';
import type { BckndServiceCapabilities } from './bcknd-service-capabilities.js';
import type { BckndServiceServiceCatalog } from './bcknd-service-service-catalog.js';
import type { BckndSharedResourceGroupStatus } from './bcknd-shared-resource-group-status.js';
/**
* Representation of the 'BckndExtendedService' schema.
*/
Expand All @@ -25,6 +26,7 @@ export type BckndExtendedService = {
brokerSecret?: BckndServiceBrokerSecret;
capabilities?: BckndServiceCapabilities;
serviceCatalog?: BckndServiceServiceCatalog;
sharedResourceGroupStatus?: BckndSharedResourceGroupStatus;
/**
* aggregated status of the service
*/
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/*
* Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
*
* This is a generated file powered by the SAP Cloud SDK for JavaScript.
*/

/**
* Representation of the 'BckndSharedResourceGroupStatus' schema.
*/
export type BckndSharedResourceGroupStatus = {
/**
* indicates whether shared resource group is enabled
*/
isEnabled?: boolean;
/**
* shared resource group id
*/
id?: string;
/**
* current state of shared resource group
*/
state?: string;
} & Record<string, any>;
257 changes: 130 additions & 127 deletions packages/ai-api/src/client/AI_CORE_API/schema/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
*
* This is a generated file powered by the SAP Cloud SDK for JavaScript.
*/
export * from './d-set-url.js';
export * from './d-set-error.js';
export * from './d-set-file-creation-response.js';
export * from './kpi-column-name.js';
export * from './kpi-array-of-column-names.js';
export * from './kpi-aggregation-attribute.js';
Expand All @@ -15,6 +12,107 @@ export * from './kpi-result-row-item.js';
export * from './kpi-result-row-list.js';
export * from './kpi-result-set.js';
export * from './kpi-api-error.js';
export * from './bcknd-id.js';
export * from './bcknd-message.js';
export * from './bcknd-name.js';
export * from './bcknd-creation-response-message.js';
export * from './bcknd-url.js';
export * from './bcknd-resource-group-list.js';
export * from './bcknd-resource-group-base.js';
export * from './bcknd-resource-group.js';
export * from './bcknd-internal-resource-group.js';
export * from './bcknd-resource-groups-post-request.js';
export * from './bcknd-resource-group-labels.js';
export * from './bcknd-resource-group-label.js';
export * from './bcknd-internal-resource-group-labels.js';
export * from './bcknd-internal-resource-group-label.js';
export * from './bcknd-internal-resource-group-annotations.js';
export * from './bcknd-internal-resource-group-annotation.js';
export * from './bcknd-resource-group-deletion-response.js';
export * from './bcknd-resource-group-deletion-response-message.js';
export * from './bcknd-resource-group-patch-request.js';
export * from './bcknd-event.js';
export * from './bcknd-tenant.js';
export * from './bckndobject-store-secret-with-sensitive-data-request.js';
export * from './bckndobject-store-secret-with-sensitive-data-request-for-post-call.js';
export * from './bckndobject-store-secret-status-response.js';
export * from './bckndobject-store-secret-status.js';
export * from './bckndobject-store-secret-deletion-response.js';
export * from './bckndobject-store-secret-deletion-response-message.js';
export * from './bckndobject-store-secret-creation-response.js';
export * from './bckndobject-store-secret-creation-response-message.js';
export * from './bckndobject-store-secret-modification-response-message.js';
export * from './bckndobject-store-secret-modification-response.js';
export * from './bcknddocker-registry-name-component.js';
export * from './bcknddocker-registry-secret-with-sensitive-data-request.js';
export * from './bcknddocker-registry-secret-status-response.js';
export * from './bcknddocker-registry-secret-status.js';
export * from './bcknddocker-registry-secret-deletion-response.js';
export * from './bcknddocker-registry-secret-deletion-response-message.js';
export * from './bcknddocker-registry-secret-creation-response.js';
export * from './bcknddocker-registry-secret-creation-response-message.js';
export * from './bcknddocker-registry-secret-modification-response-message.js';
export * from './bcknddocker-registry-secret-modification-response.js';
export * from './bcknd-generic-secret-data.js';
export * from './bcknd-generic-secret-post-body.js';
export * from './bcknd-generic-secret-patch-body.js';
export * from './bcknd-generic-secret-data-response.js';
export * from './bcknd-generic-secret-details.js';
export * from './bcknd-list-generic-secrets-response.js';
export * from './bcknd-generic-secret-labels.js';
export * from './bcknd-generic-secret-label.js';
export * from './bcknd-argo-cd-repository-data.js';
export * from './bcknd-argo-cd-repository-credentials.js';
export * from './bcknd-argo-cd-repository-data-response.js';
export * from './bcknd-argo-cd-repository-creation-response.js';
export * from './bcknd-argo-cd-repository-creation-response-message.js';
export * from './bcknd-argo-cd-repository-details.js';
export * from './bcknd-argo-cd-repository-deletion-response.js';
export * from './bcknd-argo-cd-repository-deletion-response-message.js';
export * from './bcknd-argo-cd-repository-modification-response.js';
export * from './bcknd-argo-cd-repository-modification-response-message.js';
export * from './bcknd-argo-cd-application-base-data.js';
export * from './bcknd-argo-cd-application-data.js';
export * from './bcknd-all-argo-cd-application-data.js';
export * from './bcknd-argo-cd-application-data-repo-name.js';
export * from './bcknd-argo-cd-application-status.js';
export * from './bcknd-argo-cd-application-deletion-response.js';
export * from './bcknd-argo-cd-application-deletion-response-message.js';
export * from './bcknd-argo-cd-application-creation-response.js';
export * from './bcknd-argo-cd-application-creation-response-message.js';
export * from './bcknd-argo-cd-application-modification-response.js';
export * from './bcknd-argo-cd-application-modification-response-message.js';
export * from './bcknd-argo-cd-application-refresh-response.js';
export * from './bcknd-argo-cd-application-refresh-response-message.js';
export * from './bcknd-service-list.js';
export * from './bcknd-service.js';
export * from './bcknd-extended-service.js';
export * from './bcknd-service-broker-secret.js';
export * from './bcknd-service-capabilities.js';
export * from './bcknd-service-service-catalog.js';
export * from './bcknd-service-service-catalog-item.js';
export * from './bcknd-service-service-catalog-item-extend-catalog.js';
export * from './bcknd-service-service-plan-item.js';
export * from './bcknd-service-service-plan-item-metadata.js';
export * from './bcknd-service-service-catalog-item-extend-credentials.js';
export * from './bcknd-shared-resource-group-status.js';
export * from './bcknd-deployment-resource-quota-response.js';
export * from './bcknd-deployment-usage.js';
export * from './bcknd-usage-resource-plan-item.js';
export * from './bcknd-deployment-quota-item.js';
export * from './bcknd-deployment-quota.js';
export * from './bcknd-common-resource-quota-response.js';
export * from './bcknd-executable-resource-quota-response.js';
export * from './bcknd-resource-patch-body.js';
export * from './bcknd-resource-patch-resource-plans.js';
export * from './bcknd-resource-patch-nodes.js';
export * from './bcknd-resource-patch-response.js';
export * from './bcknd-resource-get-response.js';
export * from './bcknd-resource-get-resource-plans.js';
export * from './bcknd-error-response.js';
export * from './bcknd-error.js';
export * from './tnt-tenant-info.js';
export * from './tnt-api-error.js';
export * from './ai-scenario.js';
export * from './ai-scenario-label-list.js';
export * from './ai-label-list.js';
Expand Down Expand Up @@ -129,32 +227,6 @@ export * from './ai-creation-response-message.js';
export * from './ai-url.js';
export * from './ai-api-error-with-id.js';
export * from './ai-api-error.js';
export * from './trck-get-metric-resource.js';
export * from './trck-metric-resource.js';
export * from './trck-get-metric-resource-list.js';
export * from './trck-delete-metrics-response.js';
export * from './trck-execution-id.js';
export * from './trck-timestamp.js';
export * from './trck-get-metric-list.js';
export * from './trck-metric-list.js';
export * from './trck-get-metric.js';
export * from './trck-metric.js';
export * from './trck-metric-name.js';
export * from './trck-metric-value.js';
export * from './trckmetric-selector-permissible-values.js';
export * from './trck-label-list.js';
export * from './trck-label.js';
export * from './trck-tag-list.js';
export * from './trck-tag.js';
export * from './trck-custom-info-object-list.js';
export * from './trck-custom-info-object.js';
export * from './trck-custom-info-object-data.js';
export * from './trck-mlapi-execution-id.js';
export * from './trck-generic-name.js';
export * from './trck-label-name.js';
export * from './trck-api-error.js';
export * from './trck-details-error-response.js';
export * from './trck-string-array.js';
export * from './rta-id.js';
export * from './rta-ttl.js';
export * from './rta-label-list.js';
Expand Down Expand Up @@ -208,107 +280,38 @@ export * from './rt-atimestamp.js';
export * from './rt-amessage.js';
export * from './rta-error-response.js';
export * from './rta-error.js';
export * from './trck-get-metric-resource.js';
export * from './trck-metric-resource.js';
export * from './trck-get-metric-resource-list.js';
export * from './trck-delete-metrics-response.js';
export * from './trck-execution-id.js';
export * from './trck-timestamp.js';
export * from './trck-get-metric-list.js';
export * from './trck-metric-list.js';
export * from './trck-get-metric.js';
export * from './trck-metric.js';
export * from './trck-metric-name.js';
export * from './trck-metric-value.js';
export * from './trckmetric-selector-permissible-values.js';
export * from './trck-label-list.js';
export * from './trck-label.js';
export * from './trck-tag-list.js';
export * from './trck-tag.js';
export * from './trck-custom-info-object-list.js';
export * from './trck-custom-info-object.js';
export * from './trck-custom-info-object-data.js';
export * from './trck-mlapi-execution-id.js';
export * from './trck-generic-name.js';
export * from './trck-label-name.js';
export * from './trck-api-error.js';
export * from './trck-details-error-response.js';
export * from './trck-string-array.js';
export * from './d-set-url.js';
export * from './d-set-error.js';
export * from './d-set-file-creation-response.js';
export * from './meta-capabilities.js';
export * from './meta-extensions.js';
export * from './meta-ai-api.js';
export * from './meta-version.js';
export * from './meta-api-version.js';
export * from './meta-api-error.js';
export * from './bcknd-id.js';
export * from './bcknd-message.js';
export * from './bcknd-name.js';
export * from './bcknd-creation-response-message.js';
export * from './bcknd-url.js';
export * from './bcknd-resource-group-list.js';
export * from './bcknd-resource-group-base.js';
export * from './bcknd-resource-group.js';
export * from './bcknd-internal-resource-group.js';
export * from './bcknd-resource-groups-post-request.js';
export * from './bcknd-resource-group-labels.js';
export * from './bcknd-resource-group-label.js';
export * from './bcknd-internal-resource-group-labels.js';
export * from './bcknd-internal-resource-group-label.js';
export * from './bcknd-internal-resource-group-annotations.js';
export * from './bcknd-internal-resource-group-annotation.js';
export * from './bcknd-resource-group-deletion-response.js';
export * from './bcknd-resource-group-deletion-response-message.js';
export * from './bcknd-resource-group-patch-request.js';
export * from './bcknd-event.js';
export * from './bcknd-tenant.js';
export * from './bckndobject-store-secret-with-sensitive-data-request.js';
export * from './bckndobject-store-secret-with-sensitive-data-request-for-post-call.js';
export * from './bckndobject-store-secret-status-response.js';
export * from './bckndobject-store-secret-status.js';
export * from './bckndobject-store-secret-deletion-response.js';
export * from './bckndobject-store-secret-deletion-response-message.js';
export * from './bckndobject-store-secret-creation-response.js';
export * from './bckndobject-store-secret-creation-response-message.js';
export * from './bckndobject-store-secret-modification-response-message.js';
export * from './bckndobject-store-secret-modification-response.js';
export * from './bcknddocker-registry-name-component.js';
export * from './bcknddocker-registry-secret-with-sensitive-data-request.js';
export * from './bcknddocker-registry-secret-status-response.js';
export * from './bcknddocker-registry-secret-status.js';
export * from './bcknddocker-registry-secret-deletion-response.js';
export * from './bcknddocker-registry-secret-deletion-response-message.js';
export * from './bcknddocker-registry-secret-creation-response.js';
export * from './bcknddocker-registry-secret-creation-response-message.js';
export * from './bcknddocker-registry-secret-modification-response-message.js';
export * from './bcknddocker-registry-secret-modification-response.js';
export * from './bcknd-generic-secret-data.js';
export * from './bcknd-generic-secret-post-body.js';
export * from './bcknd-generic-secret-patch-body.js';
export * from './bcknd-generic-secret-data-response.js';
export * from './bcknd-generic-secret-details.js';
export * from './bcknd-list-generic-secrets-response.js';
export * from './bcknd-generic-secret-labels.js';
export * from './bcknd-generic-secret-label.js';
export * from './bcknd-argo-cd-repository-data.js';
export * from './bcknd-argo-cd-repository-credentials.js';
export * from './bcknd-argo-cd-repository-data-response.js';
export * from './bcknd-argo-cd-repository-creation-response.js';
export * from './bcknd-argo-cd-repository-creation-response-message.js';
export * from './bcknd-argo-cd-repository-details.js';
export * from './bcknd-argo-cd-repository-deletion-response.js';
export * from './bcknd-argo-cd-repository-deletion-response-message.js';
export * from './bcknd-argo-cd-repository-modification-response.js';
export * from './bcknd-argo-cd-repository-modification-response-message.js';
export * from './bcknd-argo-cd-application-base-data.js';
export * from './bcknd-argo-cd-application-data.js';
export * from './bcknd-all-argo-cd-application-data.js';
export * from './bcknd-argo-cd-application-data-repo-name.js';
export * from './bcknd-argo-cd-application-status.js';
export * from './bcknd-argo-cd-application-deletion-response.js';
export * from './bcknd-argo-cd-application-deletion-response-message.js';
export * from './bcknd-argo-cd-application-creation-response.js';
export * from './bcknd-argo-cd-application-creation-response-message.js';
export * from './bcknd-argo-cd-application-modification-response.js';
export * from './bcknd-argo-cd-application-modification-response-message.js';
export * from './bcknd-argo-cd-application-refresh-response.js';
export * from './bcknd-argo-cd-application-refresh-response-message.js';
export * from './bcknd-service-list.js';
export * from './bcknd-service.js';
export * from './bcknd-extended-service.js';
export * from './bcknd-service-broker-secret.js';
export * from './bcknd-service-capabilities.js';
export * from './bcknd-service-service-catalog.js';
export * from './bcknd-service-service-catalog-item.js';
export * from './bcknd-service-service-catalog-item-extend-catalog.js';
export * from './bcknd-service-service-plan-item.js';
export * from './bcknd-service-service-plan-item-metadata.js';
export * from './bcknd-service-service-catalog-item-extend-credentials.js';
export * from './bcknd-deployment-resource-quota-response.js';
export * from './bcknd-deployment-usage.js';
export * from './bcknd-usage-resource-plan-item.js';
export * from './bcknd-deployment-quota-item.js';
export * from './bcknd-deployment-quota.js';
export * from './bcknd-common-resource-quota-response.js';
export * from './bcknd-executable-resource-quota-response.js';
export * from './bcknd-resource-patch-body.js';
export * from './bcknd-resource-patch-resource-plans.js';
export * from './bcknd-resource-patch-nodes.js';
export * from './bcknd-resource-patch-response.js';
export * from './bcknd-resource-get-response.js';
export * from './bcknd-resource-get-resource-plans.js';
export * from './bcknd-error-response.js';
export * from './bcknd-error.js';
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/
import type { RTAExecutableId } from './rta-executable-id.js';
import type { RTAModelVersionList } from './rta-model-version-list.js';
import type { RTAScenarioId } from './rta-scenario-id.js';
/**
* Representation of the 'RTAModelBaseData' schema.
*/
Expand All @@ -31,4 +32,11 @@ export type RTAModelBaseData = {
* Provider of the model
*/
provider?: string;
/**
* List of scenarioId:executuableId pair where the model supported
*/
allowedScenarios?: ({
scenarioId: RTAScenarioId;
executableId: RTAExecutableId;
} & Record<string, any>)[];
} & Record<string, any>;
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,12 @@ export type RTAModelVersion = {
* List of suggested replacements for the model
*/
suggestedReplacements?: string[];
/**
* Streaming support status of the model
*/
streamingSupported?: boolean;
/**
* List of model capabilities supported by orchestration service
*/
orchestrationCapabilities?: string[];
} & Record<string, any>;
Loading
Loading