Skip to content
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

feat: Update AI API Specification to 2501a Release #480

Merged
merged 6 commits into from
Jan 23, 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
3 changes: 2 additions & 1 deletion .changeset/big-mayflies-begin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
'@sap-ai-sdk/orchestration': minor
---

Update orchestration to 2501a release.
[Compatibility Note] Update orchestration to 2501a release.
As part of this change, the `modelsGet` method of `ScenarioAPI` has been renamed to `scenarioQueryModels`.
ZhongpinWang marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion packages/ai-api/src/client/AI_CORE_API/file-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export const FileApi = {
*/
fileUpload: (
path: string,
body: string | undefined,
body: any | undefined,
queryParameters?: { overwrite?: boolean },
headerParameters?: { 'AI-Resource-Group'?: string }
) =>
Expand Down
2 changes: 1 addition & 1 deletion packages/ai-api/src/client/AI_CORE_API/scenario-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export const ScenarioApi = {
* @param headerParameters - Object containing the following keys: AI-Resource-Group.
* @returns The request builder, use the `execute()` method to trigger the request.
*/
modelsGet: (
scenarioQueryModels: (
scenarioId: string,
headerParameters: { 'AI-Resource-Group': string }
) =>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,12 @@ export type AiModelBaseData = {
*/
description: string;
versions: AiModelVersionList;
/**
* Display name of the model
*/
displayName?: string;
/**
* Access type of the model
*/
accessType?: string;
} & Record<string, any>;
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
*/

/**
* Model version information including whether it is latest version
* Model version information including whether it is latest version, its deprecation status and optional retirement date
*/
export type AiModelVersion = {
/**
Expand All @@ -16,4 +16,24 @@ export type AiModelVersion = {
* Displays whether it is the latest version offered for the model
*/
isLatest: boolean;
/**
* Deprecation status of model
*/
deprecated: boolean;
/**
* Retirement date of model in ISO 8601 timestamp
*/
retirementDate?: string;
/**
* Context length of the model
*/
contextLength?: number;
/**
* List of input types supported by the model
*/
inputTypes?: string[];
/**
* List of capabilities supported by the model
*/
capabilities?: string[];
} & Record<string, any>;
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
* 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 'BckndGenericSecretLabel' schema.
*/
export type BckndGenericSecretLabel = {
/**
* @example "ext.ai.sap.com/my-label"
* Max Length: 63.
* Pattern: "^ext.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,48}$".
*/
key: string;
/**
* Max Length: 5000.
*/
value: string;
} & Record<string, any>;
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/*
* 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.
*/
import type { BckndGenericSecretLabel } from './bcknd-generic-secret-label.js';
/**
* Arbitrary labels as meta information
*/
export type BckndGenericSecretLabels = BckndGenericSecretLabel[];
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* This is a generated file powered by the SAP Cloud SDK for JavaScript.
*/
import type { BckndGenericSecretData } from './bcknd-generic-secret-data.js';
import type { BckndGenericSecretLabels } from './bcknd-generic-secret-labels.js';
/**
* Representation of the 'BckndGenericSecretPostBody' schema.
*/
Expand All @@ -16,4 +17,5 @@ export type BckndGenericSecretPostBody = {
*/
name: string;
data: BckndGenericSecretData;
labels?: BckndGenericSecretLabels;
} & Record<string, any>;
72 changes: 37 additions & 35 deletions packages/ai-api/src/client/AI_CORE_API/schema/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,6 @@ export * from './rt-atimestamp.js';
export * from './rt-amessage.js';
export * from './rta-error-response.js';
export * from './rta-error.js';
export * from './d-set-url.js';
export * from './d-set-error.js';
export * from './d-set-file-creation-response.js';
export * from './ai-scenario.js';
export * from './ai-scenario-label-list.js';
export * from './ai-label-list.js';
Expand Down Expand Up @@ -173,6 +170,32 @@ 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 './bcknd-id.js';
export * from './bcknd-message.js';
export * from './bcknd-name.js';
Expand Down Expand Up @@ -220,6 +243,8 @@ 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';
Expand Down Expand Up @@ -269,38 +294,6 @@ 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 './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 './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 './kpi-column-name.js';
export * from './kpi-array-of-column-names.js';
export * from './kpi-aggregation-attribute.js';
Expand All @@ -310,3 +303,12 @@ 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 './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';
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,12 @@ export type RTAModelBaseData = {
*/
description: string;
versions: RTAModelVersionList;
/**
* Display name of the model
*/
displayName?: string;
/**
* Access type of the model
*/
accessType?: string;
} & Record<string, any>;
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,17 @@ export type RTAModelVersion = {
/**
* Retirement date of model in ISO 8601 timestamp
*/
retirementDate: string;
retirementDate?: string;
/**
* Context length of the model
*/
contextLength?: number;
/**
* List of input types supported by the model
*/
inputTypes?: string[];
/**
* List of capabilities supported by the model
*/
capabilities?: string[];
} & Record<string, any>;
Loading
Loading