diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ApplicationApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ApplicationApi.java index 318382522..e65b70546 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ApplicationApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ApplicationApi.java @@ -26,7 +26,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ArtifactApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ArtifactApi.java index c193a03ab..28e349fb8 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ArtifactApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ArtifactApi.java @@ -23,7 +23,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ConfigurationApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ConfigurationApi.java index 58349007c..171335e05 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ConfigurationApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ConfigurationApi.java @@ -23,7 +23,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/DeploymentApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/DeploymentApi.java index d0aa19fc9..63eb9dd63 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/DeploymentApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/DeploymentApi.java @@ -30,7 +30,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/DockerRegistrySecretApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/DockerRegistrySecretApi.java index 31f102a35..5fa907bac 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/DockerRegistrySecretApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/DockerRegistrySecretApi.java @@ -24,7 +24,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutableApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutableApi.java index 950d1ef88..cb5ff55d6 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutableApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutableApi.java @@ -19,7 +19,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionApi.java index 3ca21be51..303add8bb 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionApi.java @@ -10,6 +10,13 @@ import com.sap.ai.sdk.core.model.AiExecutionModificationRequest; import com.sap.ai.sdk.core.model.AiExecutionModificationResponse; import com.sap.ai.sdk.core.model.AiExecutionResponseWithDetails; +import com.sap.ai.sdk.core.model.AiExecutionSchedule; +import com.sap.ai.sdk.core.model.AiExecutionScheduleCreationData; +import com.sap.ai.sdk.core.model.AiExecutionScheduleCreationResponse; +import com.sap.ai.sdk.core.model.AiExecutionScheduleDeletionResponse; +import com.sap.ai.sdk.core.model.AiExecutionScheduleList; +import com.sap.ai.sdk.core.model.AiExecutionScheduleModificationRequest; +import com.sap.ai.sdk.core.model.AiExecutionScheduleModificationResponse; import com.sap.ai.sdk.core.model.RTALogCommonResponse; import com.sap.cloud.sdk.services.openapi.apiclient.ApiClient; import com.sap.cloud.sdk.services.openapi.core.AbstractOpenApiService; @@ -30,7 +37,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve @@ -224,6 +231,93 @@ public Integer count(@Nonnull final String aiResourceGroup) throws OpenApiReques return count(aiResourceGroup, null, null, null, null, null); } + /** + * Get number of execution schedules + * + *

Retrieve the number of scheduled executions. The number can be filtered by configurationId + * or executionScheduleStatus. + * + *

200 - Number of execution schedules + * + *

400 - The specification of the resource was incorrect + * + * @param aiResourceGroup (required) Specify a resource group id + * @param configurationId (optional) Configuration identifier + * @param status (optional) Execution Schedule status + * @return Integer + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public Integer count_0( + @Nonnull final String aiResourceGroup, + @Nullable final String configurationId, + @Nullable final String status) + throws OpenApiRequestException { + final Object localVarPostBody = null; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling count_0"); + } + + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules/$count").build().toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + localVarQueryParams.putAll( + apiClient.parameterToMultiValueMap(null, "configurationId", configurationId)); + localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "status", status)); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"text/plain", "application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.GET, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + + /** + * Get number of execution schedules + * + *

Retrieve the number of scheduled executions. The number can be filtered by configurationId + * or executionScheduleStatus. + * + *

200 - Number of execution schedules + * + *

400 - The specification of the resource was incorrect + * + * @param aiResourceGroup Specify a resource group id + * @return Integer + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public Integer count_0(@Nonnull final String aiResourceGroup) throws OpenApiRequestException { + return count_0(aiResourceGroup, null, null); + } + /** * Create execution * @@ -291,6 +385,75 @@ public AiExecutionCreationResponse create( localVarReturnType); } + /** + * Create execution schedule + * + *

Create an execution schedule using the configuration specified by configurationId, and + * schedule. + * + *

202 - The execution schedule has been created successfully + * + *

400 - The specification of the resource was incorrect + * + * @param aiResourceGroup Specify a resource group id + * @param aiExecutionScheduleCreationData The value for the parameter + * aiExecutionScheduleCreationData + * @return AiExecutionScheduleCreationResponse + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionScheduleCreationResponse create_0( + @Nonnull final String aiResourceGroup, + @Nonnull final AiExecutionScheduleCreationData aiExecutionScheduleCreationData) + throws OpenApiRequestException { + final Object localVarPostBody = aiExecutionScheduleCreationData; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling create_0"); + } + + // verify the required parameter 'aiExecutionScheduleCreationData' is set + if (aiExecutionScheduleCreationData == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiExecutionScheduleCreationData' when calling create_0"); + } + + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules").build().toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {"application/json"}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.POST, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + /** * Mark execution as deleted * @@ -366,6 +529,79 @@ public AiExecutionDeletionResponse delete( localVarReturnType); } + /** + * Delete execution schedule + * + *

Delete the execution schedule with executionScheduleId. + * + *

202 - The execution schedule has been deleted successfully + * + *

400 - The specification of the resource was incorrect + * + *

404 - The specified resource was not found + * + * @param aiResourceGroup Specify a resource group id + * @param executionScheduleId Execution Schedule identifier + * @return AiExecutionScheduleDeletionResponse + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionScheduleDeletionResponse delete_0( + @Nonnull final String aiResourceGroup, @Nonnull final String executionScheduleId) + throws OpenApiRequestException { + final Object localVarPostBody = null; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling delete_0"); + } + + // verify the required parameter 'executionScheduleId' is set + if (executionScheduleId == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'executionScheduleId' when calling delete_0"); + } + + // create path and map variables + final Map localVarPathParams = new HashMap(); + localVarPathParams.put("executionScheduleId", executionScheduleId); + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") + .buildAndExpand(localVarPathParams) + .toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.DELETE, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + /** * Get information about a specific execution * @@ -585,6 +821,79 @@ public RTALogCommonResponse getLogs(@Nonnull final String executionId) return getLogs(executionId, null, null, null, null, null); } + /** + * Get information about an execution schedule + * + *

Retrieve details for execution schedule with executionScheduleId. + * + *

200 - Information about the execution schedule + * + *

400 - The specification of the resource was incorrect + * + *

404 - The specified resource was not found + * + * @param aiResourceGroup Specify a resource group id + * @param executionScheduleId Execution Schedule identifier + * @return AiExecutionSchedule + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionSchedule get_0( + @Nonnull final String aiResourceGroup, @Nonnull final String executionScheduleId) + throws OpenApiRequestException { + final Object localVarPostBody = null; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling get_0"); + } + + // verify the required parameter 'executionScheduleId' is set + if (executionScheduleId == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'executionScheduleId' when calling get_0"); + } + + // create path and map variables + final Map localVarPathParams = new HashMap(); + localVarPathParams.put("executionScheduleId", executionScheduleId); + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") + .buildAndExpand(localVarPathParams) + .toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.GET, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + /** * Update target status of an execution * @@ -670,6 +979,89 @@ public AiExecutionModificationResponse modify( localVarReturnType); } + /** + * Update an execution schedule + * + *

Update details of an execution schedule + * + *

202 - The execution schedule has been modified successfully + * + *

400 - The specification of the resource was incorrect + * + *

404 - The specified resource was not found + * + * @param aiResourceGroup Specify a resource group id + * @param executionScheduleId Execution Schedule identifier + * @param aiExecutionScheduleModificationRequest The value for the parameter + * aiExecutionScheduleModificationRequest + * @return AiExecutionScheduleModificationResponse + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionScheduleModificationResponse modify_0( + @Nonnull final String aiResourceGroup, + @Nonnull final String executionScheduleId, + @Nonnull final AiExecutionScheduleModificationRequest aiExecutionScheduleModificationRequest) + throws OpenApiRequestException { + final Object localVarPostBody = aiExecutionScheduleModificationRequest; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling modify_0"); + } + + // verify the required parameter 'executionScheduleId' is set + if (executionScheduleId == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'executionScheduleId' when calling modify_0"); + } + + // verify the required parameter 'aiExecutionScheduleModificationRequest' is set + if (aiExecutionScheduleModificationRequest == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiExecutionScheduleModificationRequest' when calling modify_0"); + } + + // create path and map variables + final Map localVarPathParams = new HashMap(); + localVarPathParams.put("executionScheduleId", executionScheduleId); + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") + .buildAndExpand(localVarPathParams) + .toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {"application/json"}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.PATCH, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + /** * Get list of executions * @@ -784,4 +1176,100 @@ public AiExecutionList query(@Nonnull final String aiResourceGroup) throws OpenApiRequestException { return query(aiResourceGroup, null, null, null, null, null, null, null, null); } + + /** + * Get list of execution schedules + * + *

Retrieve a list of execution schedules that match the specified filter criteria. Filter + * criteria include executionScheduleStatus or a configurationId. With top/skip parameters it is + * possible to paginate the result list. + * + *

200 - A list of execution schedules + * + *

400 - The specification of the resource was incorrect + * + * @param aiResourceGroup (required) Specify a resource group id + * @param configurationId (optional) Configuration identifier + * @param status (optional) Execution Schedule status + * @param $top (optional, default to 10000) Number of results to display + * @param $skip (optional) Number of results to be skipped from the ordered list of results + * @return AiExecutionScheduleList + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionScheduleList query_0( + @Nonnull final String aiResourceGroup, + @Nullable final String configurationId, + @Nullable final String status, + @Nullable final Integer $top, + @Nullable final Integer $skip) + throws OpenApiRequestException { + final Object localVarPostBody = null; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling query_0"); + } + + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules").build().toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + localVarQueryParams.putAll( + apiClient.parameterToMultiValueMap(null, "configurationId", configurationId)); + localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "status", status)); + localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "$top", $top)); + localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "$skip", $skip)); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.GET, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + + /** + * Get list of execution schedules + * + *

Retrieve a list of execution schedules that match the specified filter criteria. Filter + * criteria include executionScheduleStatus or a configurationId. With top/skip parameters it is + * possible to paginate the result list. + * + *

200 - A list of execution schedules + * + *

400 - The specification of the resource was incorrect + * + * @param aiResourceGroup Specify a resource group id + * @return AiExecutionScheduleList + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionScheduleList query_0(@Nonnull final String aiResourceGroup) + throws OpenApiRequestException { + return query_0(aiResourceGroup, null, null, null, null); + } } diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionScheduleApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionScheduleApi.java deleted file mode 100644 index 5d23901ff..000000000 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionScheduleApi.java +++ /dev/null @@ -1,532 +0,0 @@ -package com.sap.ai.sdk.core.client; - -import com.sap.ai.sdk.core.AiCoreService; -import com.sap.ai.sdk.core.model.AiExecutionSchedule; -import com.sap.ai.sdk.core.model.AiExecutionScheduleCreationData; -import com.sap.ai.sdk.core.model.AiExecutionScheduleCreationResponse; -import com.sap.ai.sdk.core.model.AiExecutionScheduleDeletionResponse; -import com.sap.ai.sdk.core.model.AiExecutionScheduleList; -import com.sap.ai.sdk.core.model.AiExecutionScheduleModificationRequest; -import com.sap.ai.sdk.core.model.AiExecutionScheduleModificationResponse; -import com.sap.cloud.sdk.services.openapi.core.AbstractOpenApiService; -import com.sap.cloud.sdk.services.openapi.core.OpenApiRequestException; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import javax.annotation.Nonnull; -import javax.annotation.Nullable; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.MediaType; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.util.UriComponentsBuilder; - -/** - * AI Core in version 2.40.1. - * - *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a - * batch job, for example to pre-process or train your models, or perform batch inference. Serve - * inference requests of trained models. Deploy а trained machine learning model as a web service to - * serve inference requests with high performance. Register your own Docker registry, synchronize - * your AI content from your own git repository, and register your own object store for training - * data and trained models. - */ -public class ExecutionScheduleApi extends AbstractOpenApiService { - - /** Instantiates this API class to invoke operations on the AI Core */ - public ExecutionScheduleApi() { - super(new AiCoreService().getApiClient()); - } - - /** - * Instantiates this API class to invoke operations on the AI Core - * - * @param aiCoreService The configured connectivity instance to AI Core - */ - public ExecutionScheduleApi(@Nonnull final AiCoreService aiCoreService) { - super(aiCoreService.getApiClient()); - } - - /** - * Get number of execution schedules - * - *

Retrieve the number of scheduled executions. The number can be filtered by configurationId - * or executionScheduleStatus. - * - *

200 - Number of execution schedules - * - *

400 - The specification of the resource was incorrect - * - * @param aiResourceGroup (required) Specify a resource group id - * @param configurationId (optional) Configuration identifier - * @param status (optional) Execution Schedule status - * @return Integer - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public Integer count( - @Nonnull final String aiResourceGroup, - @Nullable final String configurationId, - @Nullable final String status) - throws OpenApiRequestException { - final Object localVarPostBody = null; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling count"); - } - - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules/$count").build().toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - localVarQueryParams.putAll( - apiClient.parameterToMultiValueMap(null, "configurationId", configurationId)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "status", status)); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"text/plain", "application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.GET, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - - /** - * Get number of execution schedules - * - *

Retrieve the number of scheduled executions. The number can be filtered by configurationId - * or executionScheduleStatus. - * - *

200 - Number of execution schedules - * - *

400 - The specification of the resource was incorrect - * - * @param aiResourceGroup Specify a resource group id - * @return Integer - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public Integer count(@Nonnull final String aiResourceGroup) throws OpenApiRequestException { - return count(aiResourceGroup, null, null); - } - - /** - * Create execution schedule - * - *

Create an execution schedule using the configuration specified by configurationId, and - * schedule. - * - *

202 - The execution schedule has been created successfully - * - *

400 - The specification of the resource was incorrect - * - * @param aiResourceGroup Specify a resource group id - * @param aiExecutionScheduleCreationData The value for the parameter - * aiExecutionScheduleCreationData - * @return AiExecutionScheduleCreationResponse - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionScheduleCreationResponse create( - @Nonnull final String aiResourceGroup, - @Nonnull final AiExecutionScheduleCreationData aiExecutionScheduleCreationData) - throws OpenApiRequestException { - final Object localVarPostBody = aiExecutionScheduleCreationData; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling create"); - } - - // verify the required parameter 'aiExecutionScheduleCreationData' is set - if (aiExecutionScheduleCreationData == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiExecutionScheduleCreationData' when calling create"); - } - - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules").build().toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {"application/json"}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.POST, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - - /** - * Delete execution schedule - * - *

Delete the execution schedule with executionScheduleId. - * - *

202 - The execution schedule has been deleted successfully - * - *

400 - The specification of the resource was incorrect - * - *

404 - The specified resource was not found - * - * @param aiResourceGroup Specify a resource group id - * @param executionScheduleId Execution Schedule identifier - * @return AiExecutionScheduleDeletionResponse - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionScheduleDeletionResponse delete( - @Nonnull final String aiResourceGroup, @Nonnull final String executionScheduleId) - throws OpenApiRequestException { - final Object localVarPostBody = null; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling delete"); - } - - // verify the required parameter 'executionScheduleId' is set - if (executionScheduleId == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'executionScheduleId' when calling delete"); - } - - // create path and map variables - final Map localVarPathParams = new HashMap(); - localVarPathParams.put("executionScheduleId", executionScheduleId); - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") - .buildAndExpand(localVarPathParams) - .toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.DELETE, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - - /** - * Get information about an execution schedule - * - *

Retrieve details for execution schedule with executionScheduleId. - * - *

200 - Information about the execution schedule - * - *

400 - The specification of the resource was incorrect - * - *

404 - The specified resource was not found - * - * @param aiResourceGroup Specify a resource group id - * @param executionScheduleId Execution Schedule identifier - * @return AiExecutionSchedule - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionSchedule get( - @Nonnull final String aiResourceGroup, @Nonnull final String executionScheduleId) - throws OpenApiRequestException { - final Object localVarPostBody = null; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling get"); - } - - // verify the required parameter 'executionScheduleId' is set - if (executionScheduleId == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'executionScheduleId' when calling get"); - } - - // create path and map variables - final Map localVarPathParams = new HashMap(); - localVarPathParams.put("executionScheduleId", executionScheduleId); - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") - .buildAndExpand(localVarPathParams) - .toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.GET, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - - /** - * Update an execution schedule - * - *

Update details of an execution schedule - * - *

202 - The execution schedule has been modified successfully - * - *

400 - The specification of the resource was incorrect - * - *

404 - The specified resource was not found - * - * @param aiResourceGroup Specify a resource group id - * @param executionScheduleId Execution Schedule identifier - * @param aiExecutionScheduleModificationRequest The value for the parameter - * aiExecutionScheduleModificationRequest - * @return AiExecutionScheduleModificationResponse - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionScheduleModificationResponse modify( - @Nonnull final String aiResourceGroup, - @Nonnull final String executionScheduleId, - @Nonnull final AiExecutionScheduleModificationRequest aiExecutionScheduleModificationRequest) - throws OpenApiRequestException { - final Object localVarPostBody = aiExecutionScheduleModificationRequest; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling modify"); - } - - // verify the required parameter 'executionScheduleId' is set - if (executionScheduleId == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'executionScheduleId' when calling modify"); - } - - // verify the required parameter 'aiExecutionScheduleModificationRequest' is set - if (aiExecutionScheduleModificationRequest == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiExecutionScheduleModificationRequest' when calling modify"); - } - - // create path and map variables - final Map localVarPathParams = new HashMap(); - localVarPathParams.put("executionScheduleId", executionScheduleId); - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") - .buildAndExpand(localVarPathParams) - .toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {"application/json"}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.PATCH, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - - /** - * Get list of execution schedules - * - *

Retrieve a list of execution schedules that match the specified filter criteria. Filter - * criteria include executionScheduleStatus or a configurationId. With top/skip parameters it is - * possible to paginate the result list. - * - *

200 - A list of execution schedules - * - *

400 - The specification of the resource was incorrect - * - * @param aiResourceGroup (required) Specify a resource group id - * @param configurationId (optional) Configuration identifier - * @param status (optional) Execution Schedule status - * @param $top (optional, default to 10000) Number of results to display - * @param $skip (optional) Number of results to be skipped from the ordered list of results - * @return AiExecutionScheduleList - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionScheduleList query( - @Nonnull final String aiResourceGroup, - @Nullable final String configurationId, - @Nullable final String status, - @Nullable final Integer $top, - @Nullable final Integer $skip) - throws OpenApiRequestException { - final Object localVarPostBody = null; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling query"); - } - - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules").build().toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - localVarQueryParams.putAll( - apiClient.parameterToMultiValueMap(null, "configurationId", configurationId)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "status", status)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "$top", $top)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "$skip", $skip)); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.GET, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - - /** - * Get list of execution schedules - * - *

Retrieve a list of execution schedules that match the specified filter criteria. Filter - * criteria include executionScheduleStatus or a configurationId. With top/skip parameters it is - * possible to paginate the result list. - * - *

200 - A list of execution schedules - * - *

400 - The specification of the resource was incorrect - * - * @param aiResourceGroup Specify a resource group id - * @return AiExecutionScheduleList - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionScheduleList query(@Nonnull final String aiResourceGroup) - throws OpenApiRequestException { - return query(aiResourceGroup, null, null, null, null); - } -} diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/FileApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/FileApi.java index 6c6ff6175..d0c5126da 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/FileApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/FileApi.java @@ -20,7 +20,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/KpiApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/KpiApi.java index 6dcbba907..1b3591e61 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/KpiApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/KpiApi.java @@ -20,7 +20,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/MetaApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/MetaApi.java index 9ca88f73b..464c23f42 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/MetaApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/MetaApi.java @@ -15,7 +15,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/MetricsApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/MetricsApi.java index 83eb16441..15c1e6642 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/MetricsApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/MetricsApi.java @@ -21,7 +21,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ObjectStoreSecretApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ObjectStoreSecretApi.java index f2a3763d2..7a871e518 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ObjectStoreSecretApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ObjectStoreSecretApi.java @@ -24,7 +24,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/RepositoryApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/RepositoryApi.java index 1a5064dc8..b4a42aa2c 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/RepositoryApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/RepositoryApi.java @@ -24,7 +24,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceApi.java index 6532faf19..71f898a76 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceApi.java @@ -1,6 +1,7 @@ package com.sap.ai.sdk.core.client; import com.sap.ai.sdk.core.AiCoreService; +import com.sap.ai.sdk.core.model.BckndInstanceTypeGetResponse; import com.sap.ai.sdk.core.model.BckndResourceGetResponse; import com.sap.ai.sdk.core.model.BckndResourcePatchBody; import com.sap.ai.sdk.core.model.BckndResourcePatchResponse; @@ -18,7 +19,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve @@ -116,6 +117,79 @@ public BckndResourceGetResponse get() throws OpenApiRequestException { return get(null); } + /** + * Get list of available instance types + * + *

Lists all the instance types available in the cluster. + * + *

200 - List of available instance types + * + *

400 - The request was malformed and could thus not be processed. + * + *

0 - HTTP status codes 401, 403 or 500. Response body contains further details. + * + * @param authorization (optional) Authorization bearer token containing a JWT token. + * @return BckndInstanceTypeGetResponse + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public BckndInstanceTypeGetResponse get_0(@Nullable final String authorization) + throws OpenApiRequestException { + final Object localVarPostBody = null; + + final String localVarPath = + UriComponentsBuilder.fromPath("/admin/resources/instanceTypes").build().toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + if (authorization != null) + localVarHeaderParams.add("Authorization", apiClient.parameterToString(authorization)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.GET, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + + /** + * Get list of available instance types + * + *

Lists all the instance types available in the cluster. + * + *

200 - List of available instance types + * + *

400 - The request was malformed and could thus not be processed. + * + *

0 - HTTP status codes 401, 403 or 500. Response body contains further details. + * + * @return BckndInstanceTypeGetResponse + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public BckndInstanceTypeGetResponse get_0() throws OpenApiRequestException { + return get_0(null); + } + /** * Set reserved resources corresponding to tenant * diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceGroupApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceGroupApi.java index 5e7834226..5aaeab219 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceGroupApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceGroupApi.java @@ -26,7 +26,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceQuotaApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceQuotaApi.java index 275f12382..f07c93007 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceQuotaApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceQuotaApi.java @@ -18,7 +18,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ScenarioApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ScenarioApi.java index 3959121f1..620ed4c14 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ScenarioApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ScenarioApi.java @@ -23,7 +23,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/SecretApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/SecretApi.java index 812f0224a..1a4c34a9e 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/SecretApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/SecretApi.java @@ -23,7 +23,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ServiceApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ServiceApi.java index f1662ec64..4f5ec0a4d 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ServiceApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ServiceApi.java @@ -19,7 +19,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/TenantInfoApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/TenantInfoApi.java index 6628d435b..144578c81 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/TenantInfoApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/TenantInfoApi.java @@ -15,7 +15,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.40.1. + * AI Core in version 2.41.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndGenericSecretDetails.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndGenericSecretDetails.java index e1c42d560..f8f568e52 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/model/BckndGenericSecretDetails.java +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndGenericSecretDetails.java @@ -15,8 +15,10 @@ import com.fasterxml.jackson.annotation.JsonAnySetter; import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.ArrayList; import java.util.HashMap; import java.util.LinkedHashMap; +import java.util.List; import java.util.Map; import java.util.NoSuchElementException; import java.util.Objects; @@ -35,6 +37,9 @@ public class BckndGenericSecretDetails @JsonProperty("createdAt") private String createdAt; + @JsonProperty("labels") + private List labels = new ArrayList<>(); + @JsonProperty("resourceGroupSecretsSyncStatus") private Map resourceGroupSecretsSyncStatus = new HashMap<>(); @@ -107,6 +112,53 @@ public void setCreatedAt(@Nonnull final String createdAt) { this.createdAt = createdAt; } + /** + * Set the labels of this {@link BckndGenericSecretDetails} instance and return the same instance. + * + * @param labels Arbitrary labels as meta information + * @return The same instance of this {@link BckndGenericSecretDetails} class + */ + @Nonnull + public BckndGenericSecretDetails labels(@Nullable final List labels) { + this.labels = labels; + return this; + } + + /** + * Add one labels instance to this {@link BckndGenericSecretDetails}. + * + * @param labelsItem The labels that should be added + * @return The same instance of type {@link BckndGenericSecretDetails} + */ + @Nonnull + public BckndGenericSecretDetails addLabelsItem( + @Nonnull final BckndGenericSecretLabel labelsItem) { + if (this.labels == null) { + this.labels = new ArrayList<>(); + } + this.labels.add(labelsItem); + return this; + } + + /** + * Arbitrary labels as meta information + * + * @return labels The labels of this {@link BckndGenericSecretDetails} instance. + */ + @Nonnull + public List getLabels() { + return labels; + } + + /** + * Set the labels of this {@link BckndGenericSecretDetails} instance. + * + * @param labels Arbitrary labels as meta information + */ + public void setLabels(@Nullable final List labels) { + this.labels = labels; + } + /** * Set the resourceGroupSecretsSyncStatus of this {@link BckndGenericSecretDetails} instance and * return the same instance. @@ -204,6 +256,7 @@ public Map toMap() { final Map declaredFields = new LinkedHashMap<>(cloudSdkCustomFields); if (name != null) declaredFields.put("name", name); if (createdAt != null) declaredFields.put("createdAt", createdAt); + if (labels != null) declaredFields.put("labels", labels); if (resourceGroupSecretsSyncStatus != null) declaredFields.put("resourceGroupSecretsSyncStatus", resourceGroupSecretsSyncStatus); return declaredFields; @@ -233,6 +286,7 @@ public boolean equals(@Nullable final java.lang.Object o) { return Objects.equals(this.cloudSdkCustomFields, bckndGenericSecretDetails.cloudSdkCustomFields) && Objects.equals(this.name, bckndGenericSecretDetails.name) && Objects.equals(this.createdAt, bckndGenericSecretDetails.createdAt) + && Objects.equals(this.labels, bckndGenericSecretDetails.labels) && Objects.equals( this.resourceGroupSecretsSyncStatus, bckndGenericSecretDetails.resourceGroupSecretsSyncStatus); @@ -240,7 +294,8 @@ public boolean equals(@Nullable final java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(name, createdAt, resourceGroupSecretsSyncStatus, cloudSdkCustomFields); + return Objects.hash( + name, createdAt, labels, resourceGroupSecretsSyncStatus, cloudSdkCustomFields); } @Override @@ -250,6 +305,7 @@ public String toString() { sb.append("class BckndGenericSecretDetails {\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); + sb.append(" labels: ").append(toIndentedString(labels)).append("\n"); sb.append(" resourceGroupSecretsSyncStatus: ") .append(toIndentedString(resourceGroupSecretsSyncStatus)) .append("\n"); diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndGenericSecretPatchBody.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndGenericSecretPatchBody.java index 010045bf0..4680bb455 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/model/BckndGenericSecretPatchBody.java +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndGenericSecretPatchBody.java @@ -15,8 +15,10 @@ import com.fasterxml.jackson.annotation.JsonAnySetter; import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.ArrayList; import java.util.HashMap; import java.util.LinkedHashMap; +import java.util.List; import java.util.Map; import java.util.NoSuchElementException; import java.util.Objects; @@ -32,6 +34,9 @@ public class BckndGenericSecretPatchBody @JsonProperty("data") private Map data = new HashMap<>(); + @JsonProperty("labels") + private List labels = new ArrayList<>(); + @JsonAnySetter @JsonAnyGetter private final Map cloudSdkCustomFields = new LinkedHashMap<>(); @@ -83,6 +88,54 @@ public void setData(@Nonnull final Map data) { this.data = data; } + /** + * Set the labels of this {@link BckndGenericSecretPatchBody} instance and return the same + * instance. + * + * @param labels Arbitrary labels as meta information + * @return The same instance of this {@link BckndGenericSecretPatchBody} class + */ + @Nonnull + public BckndGenericSecretPatchBody labels(@Nullable final List labels) { + this.labels = labels; + return this; + } + + /** + * Add one labels instance to this {@link BckndGenericSecretPatchBody}. + * + * @param labelsItem The labels that should be added + * @return The same instance of type {@link BckndGenericSecretPatchBody} + */ + @Nonnull + public BckndGenericSecretPatchBody addLabelsItem( + @Nonnull final BckndGenericSecretLabel labelsItem) { + if (this.labels == null) { + this.labels = new ArrayList<>(); + } + this.labels.add(labelsItem); + return this; + } + + /** + * Arbitrary labels as meta information + * + * @return labels The labels of this {@link BckndGenericSecretPatchBody} instance. + */ + @Nonnull + public List getLabels() { + return labels; + } + + /** + * Set the labels of this {@link BckndGenericSecretPatchBody} instance. + * + * @param labels Arbitrary labels as meta information + */ + public void setLabels(@Nullable final List labels) { + this.labels = labels; + } + /** * Get the names of the unrecognizable properties of the {@link BckndGenericSecretPatchBody}. * @@ -124,6 +177,7 @@ public Object getCustomField(@Nonnull final String name) throws NoSuchElementExc public Map toMap() { final Map declaredFields = new LinkedHashMap<>(cloudSdkCustomFields); if (data != null) declaredFields.put("data", data); + if (labels != null) declaredFields.put("labels", labels); return declaredFields; } @@ -150,12 +204,13 @@ public boolean equals(@Nullable final java.lang.Object o) { final BckndGenericSecretPatchBody bckndGenericSecretPatchBody = (BckndGenericSecretPatchBody) o; return Objects.equals( this.cloudSdkCustomFields, bckndGenericSecretPatchBody.cloudSdkCustomFields) - && Objects.equals(this.data, bckndGenericSecretPatchBody.data); + && Objects.equals(this.data, bckndGenericSecretPatchBody.data) + && Objects.equals(this.labels, bckndGenericSecretPatchBody.labels); } @Override public int hashCode() { - return Objects.hash(data, cloudSdkCustomFields); + return Objects.hash(data, labels, cloudSdkCustomFields); } @Override @@ -164,6 +219,7 @@ public String toString() { final StringBuilder sb = new StringBuilder(); sb.append("class BckndGenericSecretPatchBody {\n"); sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" labels: ").append(toIndentedString(labels)).append("\n"); cloudSdkCustomFields.forEach( (k, v) -> sb.append(" ").append(k).append(": ").append(toIndentedString(v)).append("\n")); diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndInstanceTypeGetResponse.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndInstanceTypeGetResponse.java new file mode 100644 index 000000000..06b77066a --- /dev/null +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndInstanceTypeGetResponse.java @@ -0,0 +1,207 @@ +/* + * AI Core + * Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a batch job, for example to pre-process or train your models, or perform batch inference. Serve inference requests of trained models. Deploy а trained machine learning model as a web service to serve inference requests with high performance. Register your own Docker registry, synchronize your AI content from your own git repository, and register your own object store for training data and trained models. + * + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.sap.ai.sdk.core.model; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.NoSuchElementException; +import java.util.Objects; +import java.util.Set; +import javax.annotation.Nonnull; +import javax.annotation.Nullable; + +/** BckndInstanceTypeGetResponse */ +// CHECKSTYLE:OFF +public class BckndInstanceTypeGetResponse +// CHECKSTYLE:ON +{ + @JsonProperty("instanceTypes") + private Map instanceTypes = new HashMap<>(); + + @JsonAnySetter @JsonAnyGetter + private final Map cloudSdkCustomFields = new LinkedHashMap<>(); + + /** Default constructor for BckndInstanceTypeGetResponse. */ + protected BckndInstanceTypeGetResponse() {} + + /** + * Set the instanceTypes of this {@link BckndInstanceTypeGetResponse} instance and return the same + * instance. + * + * @param instanceTypes The instanceTypes of this {@link BckndInstanceTypeGetResponse} + * @return The same instance of this {@link BckndInstanceTypeGetResponse} class + */ + @Nonnull + public BckndInstanceTypeGetResponse instanceTypes( + @Nonnull final Map instanceTypes) { + this.instanceTypes = instanceTypes; + return this; + } + + /** + * Put one instanceTypes instance to this {@link BckndInstanceTypeGetResponse} instance. + * + * @param key The String key of this instanceTypes instance + * @param instanceTypesItem The instanceTypes that should be added under the given key + * @return The same instance of type {@link BckndInstanceTypeGetResponse} + */ + @Nonnull + public BckndInstanceTypeGetResponse putinstanceTypesItem( + @Nonnull final String key, @Nonnull final BckndInstanceTypeValue instanceTypesItem) { + this.instanceTypes.put(key, instanceTypesItem); + return this; + } + + /** + * Get instanceTypes + * + * @return instanceTypes The instanceTypes of this {@link BckndInstanceTypeGetResponse} instance. + */ + @Nonnull + public Map getInstanceTypes() { + return instanceTypes; + } + + /** + * Set the instanceTypes of this {@link BckndInstanceTypeGetResponse} instance. + * + * @param instanceTypes The instanceTypes of this {@link BckndInstanceTypeGetResponse} + */ + public void setInstanceTypes(@Nonnull final Map instanceTypes) { + this.instanceTypes = instanceTypes; + } + + /** + * Get the names of the unrecognizable properties of the {@link BckndInstanceTypeGetResponse}. + * + * @return The set of properties names + */ + @JsonIgnore + @Nonnull + public Set getCustomFieldNames() { + return cloudSdkCustomFields.keySet(); + } + + /** + * Get the value of an unrecognizable property of this {@link BckndInstanceTypeGetResponse} + * instance. + * + * @deprecated Use {@link #toMap()} instead. + * @param name The name of the property + * @return The value of the property + * @throws NoSuchElementException If no property with the given name could be found. + */ + @Nullable + @Deprecated + public Object getCustomField(@Nonnull final String name) throws NoSuchElementException { + if (!cloudSdkCustomFields.containsKey(name)) { + throw new NoSuchElementException( + "BckndInstanceTypeGetResponse has no field with name '" + name + "'."); + } + return cloudSdkCustomFields.get(name); + } + + /** + * Get the value of all properties of this {@link BckndInstanceTypeGetResponse} instance including + * unrecognized properties. + * + * @return The map of all properties + */ + @JsonIgnore + @Nonnull + public Map toMap() { + final Map declaredFields = new LinkedHashMap<>(cloudSdkCustomFields); + if (instanceTypes != null) declaredFields.put("instanceTypes", instanceTypes); + return declaredFields; + } + + /** + * Set an unrecognizable property of this {@link BckndInstanceTypeGetResponse} instance. If the + * map previously contained a mapping for the key, the old value is replaced by the specified + * value. + * + * @param customFieldName The name of the property + * @param customFieldValue The value of the property + */ + @JsonIgnore + public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue) { + cloudSdkCustomFields.put(customFieldName, customFieldValue); + } + + @Override + public boolean equals(@Nullable final java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + final BckndInstanceTypeGetResponse bckndInstanceTypeGetResponse = + (BckndInstanceTypeGetResponse) o; + return Objects.equals( + this.cloudSdkCustomFields, bckndInstanceTypeGetResponse.cloudSdkCustomFields) + && Objects.equals(this.instanceTypes, bckndInstanceTypeGetResponse.instanceTypes); + } + + @Override + public int hashCode() { + return Objects.hash(instanceTypes, cloudSdkCustomFields); + } + + @Override + @Nonnull + public String toString() { + final StringBuilder sb = new StringBuilder(); + sb.append("class BckndInstanceTypeGetResponse {\n"); + sb.append(" instanceTypes: ").append(toIndentedString(instanceTypes)).append("\n"); + cloudSdkCustomFields.forEach( + (k, v) -> + sb.append(" ").append(k).append(": ").append(toIndentedString(v)).append("\n")); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first line). + */ + private String toIndentedString(final java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Create a type-safe, fluent-api builder object to construct a new {@link + * BckndInstanceTypeGetResponse} instance with all required arguments. + */ + public static Builder create() { + return (instanceTypes) -> new BckndInstanceTypeGetResponse().instanceTypes(instanceTypes); + } + + /** Builder helper class. */ + public interface Builder { + /** + * Set the instanceTypes of this {@link BckndInstanceTypeGetResponse} instance. + * + * @param instanceTypes The instanceTypes of this {@link BckndInstanceTypeGetResponse} + * @return The BckndInstanceTypeGetResponse instance. + */ + BckndInstanceTypeGetResponse instanceTypes( + @Nonnull final Map instanceTypes); + } +} diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndInstanceTypeValue.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndInstanceTypeValue.java new file mode 100644 index 000000000..9f3078c01 --- /dev/null +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndInstanceTypeValue.java @@ -0,0 +1,344 @@ +/* + * AI Core + * Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a batch job, for example to pre-process or train your models, or perform batch inference. Serve inference requests of trained models. Deploy а trained machine learning model as a web service to serve inference requests with high performance. Register your own Docker registry, synchronize your AI content from your own git repository, and register your own object store for training data and trained models. + * + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.sap.ai.sdk.core.model; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.math.BigDecimal; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.NoSuchElementException; +import java.util.Objects; +import java.util.Set; +import javax.annotation.Nonnull; +import javax.annotation.Nullable; + +/** BckndInstanceTypeValue */ +// CHECKSTYLE:OFF +public class BckndInstanceTypeValue +// CHECKSTYLE:ON +{ + @JsonProperty("memory") + private String memory; + + @JsonProperty("cpu") + private BigDecimal cpu; + + @JsonProperty("gpu") + private BigDecimal gpu; + + @JsonProperty("billableUnitsPerHour") + private BigDecimal billableUnitsPerHour; + + @JsonAnySetter @JsonAnyGetter + private final Map cloudSdkCustomFields = new LinkedHashMap<>(); + + /** Default constructor for BckndInstanceTypeValue. */ + protected BckndInstanceTypeValue() {} + + /** + * Set the memory of this {@link BckndInstanceTypeValue} instance and return the same instance. + * + * @param memory Memory allocated for the instance type (e.g., \"16Gi\") + * @return The same instance of this {@link BckndInstanceTypeValue} class + */ + @Nonnull + public BckndInstanceTypeValue memory(@Nonnull final String memory) { + this.memory = memory; + return this; + } + + /** + * Memory allocated for the instance type (e.g., \"16Gi\") + * + * @return memory The memory of this {@link BckndInstanceTypeValue} instance. + */ + @Nonnull + public String getMemory() { + return memory; + } + + /** + * Set the memory of this {@link BckndInstanceTypeValue} instance. + * + * @param memory Memory allocated for the instance type (e.g., \"16Gi\") + */ + public void setMemory(@Nonnull final String memory) { + this.memory = memory; + } + + /** + * Set the cpu of this {@link BckndInstanceTypeValue} instance and return the same instance. + * + * @param cpu Number of CPU cores allocated for the instance type + * @return The same instance of this {@link BckndInstanceTypeValue} class + */ + @Nonnull + public BckndInstanceTypeValue cpu(@Nonnull final BigDecimal cpu) { + this.cpu = cpu; + return this; + } + + /** + * Number of CPU cores allocated for the instance type + * + * @return cpu The cpu of this {@link BckndInstanceTypeValue} instance. + */ + @Nonnull + public BigDecimal getCpu() { + return cpu; + } + + /** + * Set the cpu of this {@link BckndInstanceTypeValue} instance. + * + * @param cpu Number of CPU cores allocated for the instance type + */ + public void setCpu(@Nonnull final BigDecimal cpu) { + this.cpu = cpu; + } + + /** + * Set the gpu of this {@link BckndInstanceTypeValue} instance and return the same instance. + * + * @param gpu Number of GPUs allocated for the instance type + * @return The same instance of this {@link BckndInstanceTypeValue} class + */ + @Nonnull + public BckndInstanceTypeValue gpu(@Nonnull final BigDecimal gpu) { + this.gpu = gpu; + return this; + } + + /** + * Number of GPUs allocated for the instance type + * + * @return gpu The gpu of this {@link BckndInstanceTypeValue} instance. + */ + @Nonnull + public BigDecimal getGpu() { + return gpu; + } + + /** + * Set the gpu of this {@link BckndInstanceTypeValue} instance. + * + * @param gpu Number of GPUs allocated for the instance type + */ + public void setGpu(@Nonnull final BigDecimal gpu) { + this.gpu = gpu; + } + + /** + * Set the billableUnitsPerHour of this {@link BckndInstanceTypeValue} instance and return the + * same instance. + * + * @param billableUnitsPerHour Number of billable units per hour for the instance type + * @return The same instance of this {@link BckndInstanceTypeValue} class + */ + @Nonnull + public BckndInstanceTypeValue billableUnitsPerHour( + @Nonnull final BigDecimal billableUnitsPerHour) { + this.billableUnitsPerHour = billableUnitsPerHour; + return this; + } + + /** + * Number of billable units per hour for the instance type + * + * @return billableUnitsPerHour The billableUnitsPerHour of this {@link BckndInstanceTypeValue} + * instance. + */ + @Nonnull + public BigDecimal getBillableUnitsPerHour() { + return billableUnitsPerHour; + } + + /** + * Set the billableUnitsPerHour of this {@link BckndInstanceTypeValue} instance. + * + * @param billableUnitsPerHour Number of billable units per hour for the instance type + */ + public void setBillableUnitsPerHour(@Nonnull final BigDecimal billableUnitsPerHour) { + this.billableUnitsPerHour = billableUnitsPerHour; + } + + /** + * Get the names of the unrecognizable properties of the {@link BckndInstanceTypeValue}. + * + * @return The set of properties names + */ + @JsonIgnore + @Nonnull + public Set getCustomFieldNames() { + return cloudSdkCustomFields.keySet(); + } + + /** + * Get the value of an unrecognizable property of this {@link BckndInstanceTypeValue} instance. + * + * @deprecated Use {@link #toMap()} instead. + * @param name The name of the property + * @return The value of the property + * @throws NoSuchElementException If no property with the given name could be found. + */ + @Nullable + @Deprecated + public Object getCustomField(@Nonnull final String name) throws NoSuchElementException { + if (!cloudSdkCustomFields.containsKey(name)) { + throw new NoSuchElementException( + "BckndInstanceTypeValue has no field with name '" + name + "'."); + } + return cloudSdkCustomFields.get(name); + } + + /** + * Get the value of all properties of this {@link BckndInstanceTypeValue} instance including + * unrecognized properties. + * + * @return The map of all properties + */ + @JsonIgnore + @Nonnull + public Map toMap() { + final Map declaredFields = new LinkedHashMap<>(cloudSdkCustomFields); + if (memory != null) declaredFields.put("memory", memory); + if (cpu != null) declaredFields.put("cpu", cpu); + if (gpu != null) declaredFields.put("gpu", gpu); + if (billableUnitsPerHour != null) + declaredFields.put("billableUnitsPerHour", billableUnitsPerHour); + return declaredFields; + } + + /** + * Set an unrecognizable property of this {@link BckndInstanceTypeValue} instance. If the map + * previously contained a mapping for the key, the old value is replaced by the specified value. + * + * @param customFieldName The name of the property + * @param customFieldValue The value of the property + */ + @JsonIgnore + public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue) { + cloudSdkCustomFields.put(customFieldName, customFieldValue); + } + + @Override + public boolean equals(@Nullable final java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + final BckndInstanceTypeValue bckndInstanceTypeValue = (BckndInstanceTypeValue) o; + return Objects.equals(this.cloudSdkCustomFields, bckndInstanceTypeValue.cloudSdkCustomFields) + && Objects.equals(this.memory, bckndInstanceTypeValue.memory) + && Objects.equals(this.cpu, bckndInstanceTypeValue.cpu) + && Objects.equals(this.gpu, bckndInstanceTypeValue.gpu) + && Objects.equals(this.billableUnitsPerHour, bckndInstanceTypeValue.billableUnitsPerHour); + } + + @Override + public int hashCode() { + return Objects.hash(memory, cpu, gpu, billableUnitsPerHour, cloudSdkCustomFields); + } + + @Override + @Nonnull + public String toString() { + final StringBuilder sb = new StringBuilder(); + sb.append("class BckndInstanceTypeValue {\n"); + sb.append(" memory: ").append(toIndentedString(memory)).append("\n"); + sb.append(" cpu: ").append(toIndentedString(cpu)).append("\n"); + sb.append(" gpu: ").append(toIndentedString(gpu)).append("\n"); + sb.append(" billableUnitsPerHour: ") + .append(toIndentedString(billableUnitsPerHour)) + .append("\n"); + cloudSdkCustomFields.forEach( + (k, v) -> + sb.append(" ").append(k).append(": ").append(toIndentedString(v)).append("\n")); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first line). + */ + private String toIndentedString(final java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Create a type-safe, fluent-api builder object to construct a new {@link BckndInstanceTypeValue} + * instance with all required arguments. + */ + public static Builder create() { + return (memory) -> + (cpu) -> + (gpu) -> + (billableUnitsPerHour) -> + new BckndInstanceTypeValue() + .memory(memory) + .cpu(cpu) + .gpu(gpu) + .billableUnitsPerHour(billableUnitsPerHour); + } + + /** Builder helper class. */ + public interface Builder { + /** + * Set the memory of this {@link BckndInstanceTypeValue} instance. + * + * @param memory Memory allocated for the instance type (e.g., \"16Gi\") + * @return The BckndInstanceTypeValue builder. + */ + Builder1 memory(@Nonnull final String memory); + } + + /** Builder helper class. */ + public interface Builder1 { + /** + * Set the cpu of this {@link BckndInstanceTypeValue} instance. + * + * @param cpu Number of CPU cores allocated for the instance type + * @return The BckndInstanceTypeValue builder. + */ + Builder2 cpu(@Nonnull final BigDecimal cpu); + } + + /** Builder helper class. */ + public interface Builder2 { + /** + * Set the gpu of this {@link BckndInstanceTypeValue} instance. + * + * @param gpu Number of GPUs allocated for the instance type + * @return The BckndInstanceTypeValue builder. + */ + Builder3 gpu(@Nonnull final BigDecimal gpu); + } + + /** Builder helper class. */ + public interface Builder3 { + /** + * Set the billableUnitsPerHour of this {@link BckndInstanceTypeValue} instance. + * + * @param billableUnitsPerHour Number of billable units per hour for the instance type + * @return The BckndInstanceTypeValue instance. + */ + BckndInstanceTypeValue billableUnitsPerHour(@Nonnull final BigDecimal billableUnitsPerHour); + } +} diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndServiceCapabilitiesBasic.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndServiceCapabilitiesBasic.java index 5ad68a421..b8e372d9d 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/model/BckndServiceCapabilitiesBasic.java +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndServiceCapabilitiesBasic.java @@ -37,6 +37,9 @@ public class BckndServiceCapabilitiesBasic @JsonProperty("createExecutions") private Boolean createExecutions; + @JsonProperty("userPromptTemplates") + private Boolean userPromptTemplates; + @JsonProperty("multitenant") private Boolean multitenant; @@ -155,6 +158,42 @@ public void setCreateExecutions(@Nullable final Boolean createExecutions) { this.createExecutions = createExecutions; } + /** + * Set the userPromptTemplates of this {@link BckndServiceCapabilitiesBasic} instance and return + * the same instance. + * + * @param userPromptTemplates Services that only support create, read and delete of prompt + * templates + * @return The same instance of this {@link BckndServiceCapabilitiesBasic} class + */ + @Nonnull + public BckndServiceCapabilitiesBasic userPromptTemplates( + @Nullable final Boolean userPromptTemplates) { + this.userPromptTemplates = userPromptTemplates; + return this; + } + + /** + * Services that only support create, read and delete of prompt templates + * + * @return userPromptTemplates The userPromptTemplates of this {@link + * BckndServiceCapabilitiesBasic} instance. + */ + @Nonnull + public Boolean isUserPromptTemplates() { + return userPromptTemplates; + } + + /** + * Set the userPromptTemplates of this {@link BckndServiceCapabilitiesBasic} instance. + * + * @param userPromptTemplates Services that only support create, read and delete of prompt + * templates + */ + public void setUserPromptTemplates(@Nullable final Boolean userPromptTemplates) { + this.userPromptTemplates = userPromptTemplates; + } + /** * Set the multitenant of this {@link BckndServiceCapabilitiesBasic} instance and return the same * instance. @@ -235,6 +274,7 @@ public Map toMap() { if (staticDeployments != null) declaredFields.put("staticDeployments", staticDeployments); if (userDeployments != null) declaredFields.put("userDeployments", userDeployments); if (createExecutions != null) declaredFields.put("createExecutions", createExecutions); + if (userPromptTemplates != null) declaredFields.put("userPromptTemplates", userPromptTemplates); if (multitenant != null) declaredFields.put("multitenant", multitenant); return declaredFields; } @@ -267,13 +307,20 @@ public boolean equals(@Nullable final java.lang.Object o) { && Objects.equals(this.staticDeployments, bckndServiceCapabilitiesBasic.staticDeployments) && Objects.equals(this.userDeployments, bckndServiceCapabilitiesBasic.userDeployments) && Objects.equals(this.createExecutions, bckndServiceCapabilitiesBasic.createExecutions) + && Objects.equals( + this.userPromptTemplates, bckndServiceCapabilitiesBasic.userPromptTemplates) && Objects.equals(this.multitenant, bckndServiceCapabilitiesBasic.multitenant); } @Override public int hashCode() { return Objects.hash( - staticDeployments, userDeployments, createExecutions, multitenant, cloudSdkCustomFields); + staticDeployments, + userDeployments, + createExecutions, + userPromptTemplates, + multitenant, + cloudSdkCustomFields); } @Override @@ -284,6 +331,9 @@ public String toString() { sb.append(" staticDeployments: ").append(toIndentedString(staticDeployments)).append("\n"); sb.append(" userDeployments: ").append(toIndentedString(userDeployments)).append("\n"); sb.append(" createExecutions: ").append(toIndentedString(createExecutions)).append("\n"); + sb.append(" userPromptTemplates: ") + .append(toIndentedString(userPromptTemplates)) + .append("\n"); sb.append(" multitenant: ").append(toIndentedString(multitenant)).append("\n"); cloudSdkCustomFields.forEach( (k, v) -> diff --git a/core/src/main/resources/spec/aicore.yaml b/core/src/main/resources/spec/aicore.yaml index 6156fd9f6..2e6ff3f5e 100644 --- a/core/src/main/resources/spec/aicore.yaml +++ b/core/src/main/resources/spec/aicore.yaml @@ -8,7 +8,7 @@ info: with high performance. Register your own Docker registry, synchronize your AI content from your own git repository, and register your own object store for training data and trained models.\n" - version: 2.40.1 + version: 2.41.0 x-sap-shortText: Create and manage AI scenarios, trainings, deployments, and artifacts in SAP AI Core. servers: @@ -59,7 +59,7 @@ tags: description: Access to tenant information - name: Meta description: Metadata about API provider and capabilities -- name: Execution Schedule +- name: Execution description: Access to executionSchedules paths: /lm/artifacts: @@ -561,7 +561,7 @@ paths: - $ref: '#/components/parameters/AiresourceGroupHeader' get: tags: - - Execution Schedule + - Execution summary: Get list of execution schedules description: 'Retrieve a list of execution schedules that match the specified filter criteria. @@ -588,7 +588,7 @@ paths: $ref: '#/components/responses/AiBadRequest' post: tags: - - Execution Schedule + - Execution summary: Create execution schedule description: Create an execution schedule using the configuration specified by configurationId, and schedule. @@ -619,7 +619,7 @@ paths: - $ref: '#/components/parameters/AiexecutionScheduleId' get: tags: - - Execution Schedule + - Execution summary: Get information about an execution schedule description: Retrieve details for execution schedule with executionScheduleId. operationId: execution_schedule.get @@ -636,7 +636,7 @@ paths: $ref: '#/components/responses/AiNotFound' patch: tags: - - Execution Schedule + - Execution summary: Update an execution schedule description: Update details of an execution schedule operationId: execution_schedule.modify @@ -659,7 +659,7 @@ paths: $ref: '#/components/responses/AiNotFound' delete: tags: - - Execution Schedule + - Execution summary: Delete execution schedule description: Delete the execution schedule with executionScheduleId. operationId: execution_schedule.delete @@ -926,7 +926,7 @@ paths: /lm/executionSchedules/$count: get: tags: - - Execution Schedule + - Execution summary: Get number of execution schedules description: 'Retrieve the number of scheduled executions. The number can be filtered by @@ -1683,6 +1683,26 @@ paths: $ref: '#/components/responses/BckndBadRequest' default: $ref: '#/components/responses/BckndCommonError' + /admin/resources/instanceTypes: + get: + tags: + - Resource + summary: Get list of available instance types + description: Lists all the instance types available in the cluster. + operationId: kubesubmit.v4.instance_types.get + parameters: + - $ref: '#/components/parameters/BckndtokenHeader' + responses: + '200': + description: List of available instance types + content: + application/json: + schema: + $ref: '#/components/schemas/BckndInstanceTypeGetResponse' + '400': + $ref: '#/components/responses/BckndBadRequest' + default: + $ref: '#/components/responses/BckndCommonError' /lm/executions/{executionId}/logs: get: tags: @@ -2425,7 +2445,7 @@ components: can be requested from SAP BTP cloud cockpit. flows: clientCredentials: - tokenUrl: https://(subdomain_identity_zone).authentication.(host)/oauth/token + tokenUrl: https://{subdomain_identity_zone}.authentication.{host}/oauth/token scopes: {} schemas: MetaCapabilities: @@ -2654,343 +2674,149 @@ components: details: description: Optional details of the error message type: object - TrckGetMetricResource: - description: Collection of various metrics/tags/labels associated against some - execution/deployment - type: object - properties: - executionId: - $ref: '#/components/schemas/TrckExecutionId' - createdAt: - $ref: '#/components/schemas/TrckTimestamp' - modifiedAt: - $ref: '#/components/schemas/TrckTimestamp' - metrics: - $ref: '#/components/schemas/TrckGetMetricList' - tags: - $ref: '#/components/schemas/TrckTagList' - customInfo: - $ref: '#/components/schemas/TrckCustomInfoObjectList' - required: - - executionId - TrckMetricResource: - description: Collection of various metrics/tags/labels associated against some - execution/deployment - required: - - executionId + KpiColumnName: + readOnly: true + type: string + description: Name of the Column + anyOf: + - enum: + - ResourceGroup + - Scenario + - Executable + - Executions + - Artifacts + - Deployments + - {} + KpiArrayOfColumnNames: + uniqueItems: true + type: array + readOnly: true + items: + $ref: '#/components/schemas/KpiColumnName' + KpiAggregationAttribute: + type: string + title: Aggregation Attribute + readOnly: true + KpiCountAggregate: + type: integer + title: CountAggregate + format: int64 + minimum: 0 + x-examples: {} + readOnly: true + KpiResultRow: + type: array + title: ResultRow + uniqueItems: false + x-examples: {} + description: '' + items: + $ref: '#/components/schemas/KpiResultRowItem' + readOnly: true + KpiResultRowItem: + title: ResultRowItem + anyOf: + - $ref: '#/components/schemas/KpiAggregationAttribute' + - $ref: '#/components/schemas/KpiCountAggregate' + x-examples: {} + KpiResultRowList: + title: ResultRowList + type: array + items: + $ref: '#/components/schemas/KpiResultRow' + KpiResultSet: type: object + title: ResultSet + x-examples: + example-1: + header: + - ResourceGroup + - Executions + - Artifacts + - Deployments + rows: + - - 00112233-4455-6677-8899-aabbccddeeff + - 30 + - 30 + - 3 + additionalProperties: false + minProperties: 2 + maxProperties: 2 properties: - executionId: - $ref: '#/components/schemas/TrckExecutionId' - createdAt: - $ref: '#/components/schemas/TrckTimestamp' - modifiedAt: - $ref: '#/components/schemas/TrckTimestamp' - metrics: - $ref: '#/components/schemas/TrckMetricList' - tags: - $ref: '#/components/schemas/TrckTagList' - customInfo: - $ref: '#/components/schemas/TrckCustomInfoObjectList' - TrckGetMetricResourceList: + header: + $ref: '#/components/schemas/KpiArrayOfColumnNames' + rows: + $ref: '#/components/schemas/KpiResultRowList' + readOnly: true + KpiApiError: type: object required: - - resources - properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/TrckGetMetricResource' - TrckDeleteMetricsResponse: - type: object + - code + - message properties: - id: - $ref: '#/components/schemas/TrckExecutionId' + code: + type: string + description: Descriptive error code (not http status code) message: type: string - example: Metric Resource was successfully deleted - TrckExecutionId: + description: Plaintext error description + requestId: + type: string + description: ID of the individual request + target: + type: string + description: Invoked URL + details: + description: Optional details of the error message + type: object + RTAId: type: string - example: aa97b177-9383-4934-8543-0f91b7a0283a - oneOf: - - $ref: '#/components/schemas/TrckMlapiExecutionId' - description: ID of the deployment/execution - TrckTimestamp: + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: Generic ID + RTATtl: type: string - description: Time when the metric was created or logged in RFC3339 format - format: date-time - TrckGetMetricList: - description: Array of Metric items + pattern: ^[0-9]+[m,M,h,H,d,D]$ + example: 24H + description: TTL value of deployment + RTALabelList: type: array + description: Arbitrary labels as meta information items: - $ref: '#/components/schemas/TrckGetMetric' - TrckMetricList: - description: Array of Metric items + $ref: '#/components/schemas/RTALabel' + RTAArtifactLabelList: type: array + description: Arbitrary labels as meta information items: - $ref: '#/components/schemas/TrckMetric' - TrckGetMetric: - description: Key-value metrics, where the value is numeric. Metric can also - have optional step and label fields. + $ref: '#/components/schemas/RTAArtifactLabel' + RTALabel: type: object required: - - name + - key - value - - timestamp properties: - name: - $ref: '#/components/schemas/TrckMetricName' + key: + type: string + example: ai.sap.com/scenarioName + pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*ai\.sap\.com\/[\w\.-]+$ value: - $ref: '#/components/schemas/TrckMetricValue' - timestamp: - $ref: '#/components/schemas/TrckTimestamp' - step: - description: step is an optional integer that represents any measurement - of training progress (number of training iterations, number of epochs, - and so on) for the metric - type: integer - minimum: 0 - example: 2 - labels: - $ref: '#/components/schemas/TrckLabelList' - TrckMetric: - description: Key-value metrics, where the value is numeric. Metric can also - have optional step and label fields. + type: string + maxLength: 5000 + RTAArtifactLabel: + type: object required: - - name + - key - value - type: object properties: - name: - $ref: '#/components/schemas/TrckMetricName' + key: + type: string + example: ext.ai.sap.com/s4hana-version + pattern: ^ext\.ai\.sap\.com\/[\w\.-]+$ + maxLength: 256 value: - $ref: '#/components/schemas/TrckMetricValue' - timestamp: - $ref: '#/components/schemas/TrckTimestamp' - step: - description: step is an optional integer that represents any measurement - of training progress (number of training iterations, number of epochs, - and so on) for the metric - type: integer - minimum: 0 - example: 2 - labels: - $ref: '#/components/schemas/TrckLabelList' - TrckMetricName: - pattern: '[\w-]{1,64}' - type: string - maxLength: 256 - description: Name of the metric - example: Error Rate - TrckMetricValue: - type: number - description: Numeric Value of the metric - example: 0.98 - TrckmetricSelectorPermissibleValues: - description: Permissible value for $select could be either * or one or many - of the values from metrics, tags, custominfo - type: array - items: - type: string - enum: - - metrics - - tags - - customInfo - - '*' - TrckLabelList: - description: a list of name-value object pairs associated with some metric. - type: array - items: - $ref: '#/components/schemas/TrckLabel' - example: - - name: group - value: tree-82 - - name: metrics.ai.sap.com/Artifact.name - value: sk_learn_rf_classifier_model - TrckLabel: - description: a classifying phrase/name applied to a metric - required: - - name - - value - type: object - properties: - name: - $ref: '#/components/schemas/TrckLabelName' - value: - description: Metric Label Value - maxLength: 256 - minLength: 1 - type: string - example: sk_learn_random_forest_model - example: - name: group - value: tree-82 - TrckTagList: - description: a list of name-value object pairs associated with the execution/deployment. - Tags are queryable. - type: array - items: - $ref: '#/components/schemas/TrckTag' - TrckTag: - description: A dictionary of name-value pairs to support segregation at execution - level. - required: - - name - - value - type: object - properties: - name: - oneOf: - - $ref: '#/components/schemas/TrckGenericName' - value: - description: tag value - maxLength: 256 - minLength: 1 - type: string - example: RFC-1 - example: - name: Artifact Group - value: RFC-1 - TrckCustomInfoObjectList: - description: '' - type: array - items: - $ref: '#/components/schemas/TrckCustomInfoObject' - TrckCustomInfoObject: - description: large object which provides rendering/semantic information regarding - certain metric for consuming application or can be complex metrics in JSON - format - required: - - name - - value - type: object - properties: - name: - oneOf: - - $ref: '#/components/schemas/TrckGenericName' - value: - $ref: '#/components/schemas/TrckCustomInfoObjectData' - example: - name: Confusion Matrix - value: '[{''Predicted'': ''False'', ''Actual'': ''False'',''value'': 34},{''Predicted'': - ''False'',''Actual'': ''True'', ''value'': 124}, {''Predicted'': ''True'',''Actual'': - ''False'',''value'': 165},{ ''Predicted'': ''True'',''Actual'': ''True'',''value'': - 36}]' - TrckCustomInfoObjectData: - description: Message - minLength: 1 - type: string - example: "[{'Predicted': 'False',\t'Actual': 'False','value': 34},{'Predicted': - 'False','Actual': 'True',\t'value': 124}, {'Predicted': 'True','Actual': 'False','value': - 165},{\t'Predicted': 'True','Actual': 'True','value': 36}]" - TrckMlapiExecutionId: - description: Generic ID - pattern: ^[\w.-]{4,64}$ - type: string - example: aa97b177-9383-4934-8543-0f91b7a0283a - TrckGenericName: - description: Generic name which can belong to a tag,label,metric or customInfo - Object - maxLength: 256 - minLength: 1 - type: string - example: sample name - TrckLabelName: - description: Label name to label one or more metrics. "metrics.ai.sap.com/Artifact.name" - is a reserved label to associate an artifact with the metrics - maxLength: 256 - minLength: 1 - type: string - example: metrics.ai.sap.com/Artifact.name - TrckApiError: - required: - - code - - message - type: object - properties: - code: - description: Descriptive error code (not http status code). - type: string - message: - description: plaintext error description - type: string - requestId: - description: id of individual request - type: string - target: - description: url that has been called - type: string - details: - type: array - items: - $ref: '#/components/schemas/TrckDetailsErrorResponse' - TrckDetailsErrorResponse: - type: object - properties: - code: - description: Descriptive error code (not http status code) - type: string - message: - description: Plaintext error description - type: string - TrckStringArray: - type: array - example: - - value1 - - value2 - items: - type: string - RTAId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: Generic ID - RTATtl: - type: string - pattern: ^[0-9]+[m,M,h,H,d,D]$ - example: 24H - description: TTL value of deployment - RTALabelList: - type: array - description: Arbitrary labels as meta information - items: - $ref: '#/components/schemas/RTALabel' - RTAArtifactLabelList: - type: array - description: Arbitrary labels as meta information - items: - $ref: '#/components/schemas/RTAArtifactLabel' - RTALabel: - type: object - required: - - key - - value - properties: - key: - type: string - example: ai.sap.com/scenarioName - pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*ai\.sap\.com\/[\w\.-]+$ - value: - type: string - maxLength: 5000 - RTAArtifactLabel: - type: object - required: - - key - - value - properties: - key: - type: string - example: ext.ai.sap.com/s4hana-version - pattern: ^ext\.ai\.sap\.com\/[\w\.-]+$ - maxLength: 256 - value: - type: string - maxLength: 5000 - RTACreationResponseMessage: + type: string + maxLength: 5000 + RTACreationResponseMessage: type: string description: Message example: Created @@ -3577,102 +3403,107 @@ components: details: description: Optional details of the error message type: object - AiScenario: + DSetUrl: + type: string + format: url + example: https://download.example.com/test/file.bin + DSetError: + description: Error Response type: object - description: 'An ML Scenario consists of a number of executables. E.g., there - can be one or several training executables, an inference (deployment) executable. - An ML Scenario is versioned. - - ' - required: - - name - - id - - createdAt - - modifiedAt properties: - name: + code: type: string - maxLength: 256 - description: Name of the scenario - description: + minLength: 1 + message: type: string - maxLength: 5000 - description: Description of the scenario - labels: - $ref: '#/components/schemas/AiScenarioLabelList' - id: - $ref: '#/components/schemas/AiScenarioId' - createdAt: + minLength: 1 + target: type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: + minLength: 1 + requestId: type: string - format: date-time - description: Timestamp of latest resource modification - AiScenarioLabelList: - type: array - description: Arbitrary labels as meta information - items: - $ref: '#/components/schemas/AiScenarioLabel' - AiLabelList: - type: array - description: Arbitrary labels as meta information - items: - $ref: '#/components/schemas/AiLabel' - AiScenarioLabel: - type: object - required: - - key - - value - properties: - key: - $ref: '#/components/schemas/AiScenarioLabelKey' - value: - $ref: '#/components/schemas/AiLabelValue' - AiLabel: + details: + type: array + uniqueItems: true + minItems: 0 + items: + required: + - code + - message + properties: + code: + type: string + minLength: 1 + message: + type: string + minLength: 1 + required: + - code + - message + x-examples: + example-1: + code: '03021655' + message: Bad request encountered. Please try again with possible-solution-here. + target: /url/path + requestId: 9832bf934f3743v3948v3 + details: + - code: '01041211' + message: Optional nested error message. + DSetFileCreationResponse: + description: Response for successful file creation type: object required: - - key - - value + - message + - url properties: - key: - $ref: '#/components/schemas/AiLabelKey' - value: - $ref: '#/components/schemas/AiLabelValue' - AiLabelValue: - type: string - maxLength: 5000 - AiScenarioLabelKey: - type: string - example: scenarios.ai.sap.com/s4hana-version - maxLength: 256 - pattern: ^(scenarios|ext)\.ai\.sap\.com\/[\w\.-]+$ - AiLabelKey: - type: string - example: ext.ai.sap.com/s4hana-version - maxLength: 256 - pattern: ^ext\.ai\.sap\.com\/[\w\.-]+$ - AiScenarioId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the scenario - AiScenarioList: + message: + type: string + description: File creation response message + example: File creation acknowledged + url: + $ref: '#/components/schemas/DSetUrl' + TrckGetMetricResource: + description: Collection of various metrics/tags/labels associated against some + execution/deployment type: object properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/AiScenario' + executionId: + $ref: '#/components/schemas/TrckExecutionId' + createdAt: + $ref: '#/components/schemas/TrckTimestamp' + modifiedAt: + $ref: '#/components/schemas/TrckTimestamp' + metrics: + $ref: '#/components/schemas/TrckGetMetricList' + tags: + $ref: '#/components/schemas/TrckTagList' + customInfo: + $ref: '#/components/schemas/TrckCustomInfoObjectList' required: - - count - - resources - AiModelList: + - executionId + TrckMetricResource: + description: Collection of various metrics/tags/labels associated against some + execution/deployment + required: + - executionId + type: object + properties: + executionId: + $ref: '#/components/schemas/TrckExecutionId' + createdAt: + $ref: '#/components/schemas/TrckTimestamp' + modifiedAt: + $ref: '#/components/schemas/TrckTimestamp' + metrics: + $ref: '#/components/schemas/TrckMetricList' + tags: + $ref: '#/components/schemas/TrckTagList' + customInfo: + $ref: '#/components/schemas/TrckCustomInfoObjectList' + TrckGetMetricResourceList: type: object + required: + - resources properties: count: type: integer @@ -3680,361 +3511,265 @@ components: resources: type: array items: - $ref: '#/components/schemas/AiModelBaseData' - required: - - count - - resources - AiModelBaseData: + $ref: '#/components/schemas/TrckGetMetricResource' + TrckDeleteMetricsResponse: type: object - required: - - model - - executableId - - description - - versions properties: - model: - type: string - description: Name of the model - executableId: - $ref: '#/components/schemas/AiExecutableId' - description: - type: string - description: Description of the model and its capabilities - versions: - $ref: '#/components/schemas/AiModelVersionList' - displayName: - type: string - description: Display name of the model - accessType: - type: string - description: Access type of the model - provider: + id: + $ref: '#/components/schemas/TrckExecutionId' + message: type: string - description: Provider of the model - allowedScenarios: - type: array - description: List of scenarioId:executableId pair where the model supported - items: - type: object - required: - - scenarioId - - executableId - properties: - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - executableId: - $ref: '#/components/schemas/AiExecutableId' - AiModelVersionList: + example: Metric Resource was successfully deleted + TrckExecutionId: + type: string + example: aa97b177-9383-4934-8543-0f91b7a0283a + oneOf: + - $ref: '#/components/schemas/TrckMlapiExecutionId' + description: ID of the deployment/execution + TrckTimestamp: + type: string + description: Time when the metric was created or logged in RFC3339 format + format: date-time + TrckGetMetricList: + description: Array of Metric items type: array - description: List of model versions that the model object has items: - $ref: '#/components/schemas/AiModelVersion' - AiModelVersion: + $ref: '#/components/schemas/TrckGetMetric' + TrckMetricList: + description: Array of Metric items + type: array + items: + $ref: '#/components/schemas/TrckMetric' + TrckGetMetric: + description: Key-value metrics, where the value is numeric. Metric can also + have optional step and label fields. type: object - description: Model version information including whether it is latest version, - its deprecation status and optional retirement date required: - name - - isLatest - - deprecated + - value + - timestamp properties: name: - type: string - description: Name of model version - isLatest: - type: boolean - description: Displays whether it is the latest version offered for the model - deprecated: - type: boolean - description: Deprecation status of model - retirementDate: - type: string - description: Retirement date of model in ISO 8601 timestamp - contextLength: + $ref: '#/components/schemas/TrckMetricName' + value: + $ref: '#/components/schemas/TrckMetricValue' + timestamp: + $ref: '#/components/schemas/TrckTimestamp' + step: + description: step is an optional integer that represents any measurement + of training progress (number of training iterations, number of epochs, + and so on) for the metric type: integer - description: Context length of the model - inputTypes: - type: array - description: List of input types supported by the model - items: - type: string - capabilities: - type: array - description: List of capabilities supported by the model - items: - type: string - metadata: - type: array - description: List of metadata supported by the model - items: - type: object - additionalProperties: - type: string - cost: - type: array - description: List of costs associated with the model - items: - type: object - additionalProperties: - type: string - suggestedReplacements: - type: array - description: List of suggested replacements for the model - items: - type: string - streamingSupported: - type: boolean - description: Streaming support status of the model - orchestrationCapabilities: - type: array - description: List of model capabilities supported by orchestration service - items: - type: string - AiVersion: - type: object - required: - - id - - createdAt - - modifiedAt - properties: - description: - $ref: '#/components/schemas/AiVersionDescription' - id: - $ref: '#/components/schemas/AiVersionId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - createdAt: - type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: - type: string - format: date-time - description: Timestamp of latest resource modification - AiVersionList: - type: object - properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/AiVersion' - required: - - count - - resources - AiExecutable: - description: 'An ML executable consists of a set of ML tasks, flows between - tasks, dependencies between tasks, models (or model versions?). - - ' - type: object + minimum: 0 + example: 2 + labels: + $ref: '#/components/schemas/TrckLabelList' + TrckMetric: + description: Key-value metrics, where the value is numeric. Metric can also + have optional step and label fields. required: - name - - id - - versionId - - deployable - - createdAt - - modifiedAt - properties: - labels: - $ref: '#/components/schemas/AiLabelList' - name: - type: string - description: Name of the executable - description: - type: string - description: Description of the executable - id: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - versionId: - $ref: '#/components/schemas/AiVersionId' - parameters: - $ref: '#/components/schemas/AiExecutableParameterList' - inputArtifacts: - $ref: '#/components/schemas/AiExecutableArtifactList' - outputArtifacts: - $ref: '#/components/schemas/AiExecutableArtifactList' - deployable: - type: boolean - description: Whether this executable is deployable - example: false - createdAt: - type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: - type: string - format: date-time - description: Timestamp of latest resource modification - AiExecutableId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the executable - AiExecutableList: + - value type: object properties: - count: + name: + $ref: '#/components/schemas/TrckMetricName' + value: + $ref: '#/components/schemas/TrckMetricValue' + timestamp: + $ref: '#/components/schemas/TrckTimestamp' + step: + description: step is an optional integer that represents any measurement + of training progress (number of training iterations, number of epochs, + and so on) for the metric type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/AiExecutable' - required: - - count - - resources - AiExecutableParameter: - type: object + minimum: 0 + example: 2 + labels: + $ref: '#/components/schemas/TrckLabelList' + TrckMetricName: + pattern: '[\w-]{1,64}' + type: string + maxLength: 256 + description: Name of the metric + example: Error Rate + TrckMetricValue: + type: number + description: Numeric Value of the metric + example: 0.98 + TrckmetricSelectorPermissibleValues: + description: Permissible value for $select could be either * or one or many + of the values from metrics, tags, custominfo + type: array + items: + type: string + enum: + - metrics + - tags + - customInfo + - '*' + TrckLabelList: + description: a list of name-value object pairs associated with some metric. + type: array + items: + $ref: '#/components/schemas/TrckLabel' + example: + - name: group + value: tree-82 + - name: metrics.ai.sap.com/Artifact.name + value: sk_learn_rf_classifier_model + TrckLabel: + description: a classifying phrase/name applied to a metric required: - name + - value + type: object properties: name: + $ref: '#/components/schemas/TrckLabelName' + value: + description: Metric Label Value + maxLength: 256 + minLength: 1 type: string - description: Name of the executable parameter - description: - type: string - description: Description of the signature argument - default: - type: string - description: Default value of the signature argument - type: - type: string - enum: - - string - description: Type of the executable parameter - AiExecutableParameterList: + example: sk_learn_random_forest_model + example: + name: group + value: tree-82 + TrckTagList: + description: a list of name-value object pairs associated with the execution/deployment. + Tags are queryable. type: array - description: Executable parameters items: - $ref: '#/components/schemas/AiExecutableParameter' - AiExecutableArtifact: - type: object + $ref: '#/components/schemas/TrckTag' + TrckTag: + description: A dictionary of name-value pairs to support segregation at execution + level. required: - name + - value + type: object properties: name: + oneOf: + - $ref: '#/components/schemas/TrckGenericName' + value: + description: tag value + maxLength: 256 + minLength: 1 type: string - description: Name of the executable input artifacts - kind: - type: string - description: Artifact kind (model, dataset, other) - description: - type: string - description: Description of the signature argument - labels: - $ref: '#/components/schemas/AiLabelList' - AiExecutableArtifactList: + example: RFC-1 + example: + name: Artifact Group + value: RFC-1 + TrckCustomInfoObjectList: + description: '' type: array - description: Executable parameters items: - $ref: '#/components/schemas/AiExecutableArtifact' - AiConfiguration: - type: object - properties: - name: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - parameterBindings: - $ref: '#/components/schemas/AiParameterArgumentBindingList' - inputArtifactBindings: - $ref: '#/components/schemas/AiArtifactArgumentBindingList' - id: - $ref: '#/components/schemas/AiConfigurationId' - createdAt: - type: string - description: Timestamp of resource creation - format: date-time - scenario: - type: object - nullable: true - anyOf: - - $ref: '#/components/schemas/AiScenario' - - {} + $ref: '#/components/schemas/TrckCustomInfoObject' + TrckCustomInfoObject: + description: large object which provides rendering/semantic information regarding + certain metric for consuming application or can be complex metrics in JSON + format required: - name - - executableId - - scenarioId - - id - - createdAt - AiConfigurationBaseData: + - value type: object - required: - - name - - executableId - - scenarioId properties: name: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - parameterBindings: - $ref: '#/components/schemas/AiParameterArgumentBindingList' - inputArtifactBindings: - $ref: '#/components/schemas/AiArtifactArgumentBindingList' - AiConfigurationName: + oneOf: + - $ref: '#/components/schemas/TrckGenericName' + value: + $ref: '#/components/schemas/TrckCustomInfoObjectData' + example: + name: Confusion Matrix + value: '[{''Predicted'': ''False'', ''Actual'': ''False'',''value'': 34},{''Predicted'': + ''False'',''Actual'': ''True'', ''value'': 124}, {''Predicted'': ''True'',''Actual'': + ''False'',''value'': 165},{ ''Predicted'': ''True'',''Actual'': ''True'',''value'': + 36}]' + TrckCustomInfoObjectData: + description: Message + minLength: 1 type: string - pattern: ^[\w\s.!?,;:\[\](){}<>"'=+*/\\^&%@~$#|-]*$ + example: "[{'Predicted': 'False',\t'Actual': 'False','value': 34},{'Predicted': + 'False','Actual': 'True',\t'value': 124}, {'Predicted': 'True','Actual': 'False','value': + 165},{\t'Predicted': 'True','Actual': 'True','value': 36}]" + TrckMlapiExecutionId: + description: Generic ID + pattern: ^[\w.-]{4,64}$ + type: string + example: aa97b177-9383-4934-8543-0f91b7a0283a + TrckGenericName: + description: Generic name which can belong to a tag,label,metric or customInfo + Object maxLength: 256 - description: Name of the configuration - AiConfigurationId: + minLength: 1 type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the configuration - AiParameterArgumentBinding: - type: object + example: sample name + TrckLabelName: + description: Label name to label one or more metrics. "metrics.ai.sap.com/Artifact.name" + is a reserved label to associate an artifact with the metrics + maxLength: 256 + minLength: 1 + type: string + example: metrics.ai.sap.com/Artifact.name + TrckApiError: required: - - key - - value + - code + - message + type: object properties: - key: + code: + description: Descriptive error code (not http status code). type: string - maxLength: 256 - value: + message: + description: plaintext error description type: string - maxLength: 5000 - description: 'Required for execution - - Result of activation - - ' - AiParameterArgumentBindingList: - type: array - maxItems: 1000 - items: - $ref: '#/components/schemas/AiParameterArgumentBinding' - AiArtifactArgumentBinding: + requestId: + description: id of individual request + type: string + target: + description: url that has been called + type: string + details: + type: array + items: + $ref: '#/components/schemas/TrckDetailsErrorResponse' + TrckDetailsErrorResponse: type: object - required: - - key - - artifactId properties: - key: + code: + description: Descriptive error code (not http status code) type: string - maxLength: 256 - artifactId: - $ref: '#/components/schemas/AiArtifactId' - description: 'Required for execution - - Result of activation - - ' - AiArtifactArgumentBindingList: + message: + description: Plaintext error description + type: string + TrckStringArray: type: array - maxItems: 1000 + example: + - value1 + - value2 items: - $ref: '#/components/schemas/AiArtifactArgumentBinding' - AiConfigurationList: + type: string + BckndId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: Generic ID + BckndMessage: + type: string + description: Message + BckndName: + type: string + description: Name + BckndCreationResponseMessage: + type: string + description: Message + example: Created + BckndUrl: + type: string + format: url + BckndResourceGroupList: type: object properties: count: @@ -4043,387 +3778,313 @@ components: resources: type: array items: - $ref: '#/components/schemas/AiConfiguration' + $ref: '#/components/schemas/BckndResourceGroup' required: - count - resources - AiConfigurationCreationResponse: + BckndResourceGroupBase: type: object properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiConfigurationCreationResponseMessage' - required: - - id - - message - AiConfigurationCreationResponseMessage: - type: string - description: Message - example: Configuration created - AiDeploymentTargetStatus: - type: string - description: Status - enum: - - STOPPED - example: STOPPED - AiDeploymentStatus: - type: string - description: Deployment status - enum: - - PENDING - - RUNNING - - COMPLETED - - DEAD - - STOPPING - - STOPPED - - UNKNOWN - example: COMPLETED - AiDeploymentStatusMessage: - type: string - description: Deployment status message - maxLength: 256 - AiDeploymentStatusDetails: - type: object - description: Current status details of the deployment - AiExecutionStatus: - type: string - description: Execution status - enum: - - PENDING - - RUNNING - - COMPLETED - - DEAD - - STOPPING - - STOPPED - - UNKNOWN - example: COMPLETED - AiExecutionStatusMessage: - type: string - description: Execution status message - maxLength: 256 - AiExecutionStatusDetails: - type: object - description: Current status details of the execution - AiExecution: + resourceGroupId: + description: resource group id + type: string + tenantId: + description: tenant id + type: string + zoneId: + description: zone id + type: string + BckndResourceGroup: type: object - description: Execution that may generate artifacts properties: - id: - $ref: '#/components/schemas/AiExecutionId' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - configurationName: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - targetStatus: + resourceGroupId: + description: resource group id type: string - description: Target status of the execution - enum: - - COMPLETED - - RUNNING - - STOPPED - - DELETED - example: STOPPED - status: - $ref: '#/components/schemas/AiExecutionStatus' - statusMessage: - $ref: '#/components/schemas/AiExecutionStatusMessage' - outputArtifacts: - $ref: '#/components/schemas/AiArtifactArray' - executionScheduleId: - $ref: '#/components/schemas/AiExecutionScheduleId' - createdAt: + tenantId: + description: tenant id type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: + zoneId: + description: zone id type: string - format: date-time - description: Timestamp of latest resource modification - submissionTime: + createdAt: + description: Timestamp of resource group creation type: string format: date-time - description: Timestamp of job submitted - startTime: + labels: + $ref: '#/components/schemas/BckndResourceGroupLabels' + status: + description: aggregated status of the onboarding process type: string - format: date-time - description: Timestamp of job status changed to RUNNING - completionTime: + enum: + - PROVISIONED + - ERROR + - PROVISIONING + statusMessage: + description: status message type: string - format: date-time - description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED required: - - id - - configurationId - status - createdAt - - modifiedAt - AiExecutionId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the execution - AiExecutionList: - type: object - properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/AiExecution' - required: - - count - - resources - AiExecutionCreationResponse: + - resourceGroupId + BckndInternalResourceGroup: type: object properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiExecutionCreationResponseMessage' + resourceGroupId: + description: resource group id + type: string + tenantId: + description: tenant id + type: string + zoneId: + description: zone id + type: string + createdAt: + description: Timestamp of resource group creation + type: string + format: date-time + labels: + $ref: '#/components/schemas/BckndInternalResourceGroupLabels' status: - $ref: '#/components/schemas/AiExecutionStatus' - required: - - id - - message - AiExecutionCreationResponseMessage: - type: string - description: Message - example: Execution scheduled - AiExecutionModificationRequest: - type: object - description: Request object for changing the target status of an execution (currently - only STOPPED is supported) - required: - - targetStatus - properties: - targetStatus: + description: aggregated status of the onboarding process type: string - description: Desired target status of the execution (currently only STOPPED - is supported) enum: - - STOPPED - AiExecutionModificationRequestWithIdentifier: + - PROVISIONED + - ERROR + - PROVISIONING + statusMessage: + description: status message + type: string + annotations: + $ref: '#/components/schemas/BckndInternalResourceGroupAnnotations' required: - - targetStatus - - id + - status + - createdAt + - resourceGroupId + BckndResourceGroupsPostRequest: type: object properties: - id: - $ref: '#/components/schemas/AiExecutionId' - targetStatus: + resourceGroupId: + description: resource group id type: string - description: Desired target status of the execution (currently STOPPED and - DELETED are supported) - enum: - - STOPPED - - DELETED - description: Request object for changing the target status of an execution (currently - STOPPED and DELETED are supported) - AiExecutionModificationRequestList: + pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]{1,251}[a-zA-Z0-9]$ + minLength: 3 + maxLength: 253 + labels: + $ref: '#/components/schemas/BckndResourceGroupLabels' + BckndResourceGroupLabels: type: array + description: Arbitrary labels as meta information items: - $ref: '#/components/schemas/AiExecutionModificationRequestWithIdentifier' - uniqueItems: true - minItems: 1 - maxItems: 100 - example: - - id: aa97b177-9383-4934-8543-0f91a7a0283a - targetStatus: STOPPED - - id: qweq32131-qwee-1231-8543-0f91a7a2e2e - targetStatus: DELETED - AiExecutionBulkModificationRequest: + $ref: '#/components/schemas/BckndResourceGroupLabel' + BckndResourceGroupLabel: type: object - description: Request object to change status of multiple executions + required: + - key + - value properties: - executions: - $ref: '#/components/schemas/AiExecutionModificationRequestList' - AiExecutionModificationResponse: + key: + type: string + pattern: ^ext.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,48}$ + maxLength: 63 + example: ext.ai.sap.com/my-label + value: + type: string + maxLength: 5000 + BckndInternalResourceGroupLabels: + type: array + description: Arbitrary labels as meta information + items: + $ref: '#/components/schemas/BckndInternalResourceGroupLabel' + BckndInternalResourceGroupLabel: type: object - properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiExecutionModificationResponseMessage' required: - - id - - message - AiExecutionModificationResponseList: + - key + - value + properties: + key: + type: string + pattern: ^internal.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,43}$ + maxLength: 63 + example: internal.ai.sap.com/my-label + value: + type: string + maxLength: 5000 + BckndInternalResourceGroupAnnotations: type: array + description: Arbitrary annotations as meta information items: - oneOf: - - $ref: '#/components/schemas/AiExecutionModificationResponse' - - $ref: '#/components/schemas/AiApiErrorWithId' - AiExecutionBulkModificationResponse: + $ref: '#/components/schemas/BckndInternalResourceGroupAnnotation' + BckndInternalResourceGroupAnnotation: type: object - description: Response object with array of executions and its status + required: + - key + - value properties: - executions: - $ref: '#/components/schemas/AiExecutionModificationResponseList' - AiExecutionDeletionResponse: + key: + type: string + pattern: ^internal.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,43}$ + maxLength: 63 + example: internal.ai.sap.com/my-annotation + value: + type: string + maxLength: 5000 + BckndResourceGroupDeletionResponse: type: object properties: id: - $ref: '#/components/schemas/AiId' + $ref: '#/components/schemas/BckndId' message: - $ref: '#/components/schemas/AiExecutionDeletionResponseMessage' + $ref: '#/components/schemas/BckndResourceGroupDeletionResponseMessage' required: - id - message - AiExecutionDeletionResponseMessage: - type: string - description: Message - example: Execution deletion scheduled - AiExecutionModificationResponseMessage: + BckndResourceGroupDeletionResponseMessage: type: string description: Message - example: Execution modification scheduled - AiExecutionResponseWithDetails: + example: Resource Group deletion scheduled + BckndResourceGroupPatchRequest: type: object - description: Execution that may generate artifacts properties: - id: - $ref: '#/components/schemas/AiExecutionId' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - configurationName: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - targetStatus: + labels: + $ref: '#/components/schemas/BckndResourceGroupLabels' + BckndEvent: + type: object + properties: + tenantId: + description: tenant id + type: string + action: type: string - description: Target status of the execution enum: - - COMPLETED - - RUNNING - - STOPPED - - DELETED - example: STOPPED - status: - $ref: '#/components/schemas/AiExecutionStatus' - statusMessage: - $ref: '#/components/schemas/AiExecutionStatusMessage' - outputArtifacts: - $ref: '#/components/schemas/AiArtifactArray' - executionScheduleId: - $ref: '#/components/schemas/AiExecutionScheduleId' + - PROVISION + - DEPROVISION + state: + type: string + enum: + - SUCCESSFUL + - FAILED + - PENDING + description: + description: describes the event state + type: string createdAt: type: string - description: Timestamp of resource creation format: date-time - modifiedAt: + example: '2017-09-28T08:56:23.275Z' + BckndTenant: + type: object + properties: + tenantId: + description: tenant id type: string - format: date-time - description: Timestamp of latest resource modification - submissionTime: + zoneId: + description: zone id type: string - format: date-time - description: Timestamp of job submitted - startTime: + realSubaccountId: + description: real sub account id type: string - format: date-time - description: Timestamp of job status changed to RUNNING - completionTime: + servicePlan: + description: service plan type: string - format: date-time - description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED - statusDetails: - $ref: '#/components/schemas/AiExecutionStatusDetails' - required: - - id - - configurationId - - status - - createdAt - - modifiedAt - AiExecutionSchedule: + BckndobjectStoreSecretWithSensitiveDataRequest: type: object - description: Data about execution schedule + description: This represents all the meta-data and extra information to be stored + as a k8-secret required: - - configurationId - - cron - name - - createdAt - - modifiedAt + - type + - data properties: - cron: - $ref: '#/components/schemas/AiCron' name: - maxLength: 256 type: string - description: Name of the execution schedule - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - start: + description: Name of the object store for the secret object to be created. + Can be used later on check for existence of the secret. + example: myobjectstore + type: type: string - description: Timestamp, defining when the executions should start running - periodically, defaults to now - format: date-time - end: + description: Storage type e.g. S3, GCS,... + example: S3 + bucket: type: string - description: Timestamp, defining when the executions should stop running - format: date-time - id: - $ref: '#/components/schemas/AiExecutionScheduleId' - status: - $ref: '#/components/schemas/AiExecutionScheduleStatus' - createdAt: + description: Bucket to be used + example: mybucket1 + endpoint: type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: + description: Optional parameter - URL of the storage server (S3 only) + example: www.example.com + region: type: string - format: date-time - description: Timestamp of latest resource modification - AiExecutionScheduleId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the execution schedule - AiExecutionScheduleStatus: - type: string - description: Execution Schedule Status - enum: - - ACTIVE - - INACTIVE - example: ACTIVE - AiCron: - type: string - description: Cron defining the schedule to run the executions. - example: 0 0 0 1 * - AiExecutionScheduleCreationData: + description: Optional parameter - Region of the storage server (S3 only) + example: eu + pathPrefix: + type: string + description: prefix folder to be added to storage path + example: mp-api + verifyssl: + type: string + description: 0, 1 flag for the KF-serving annotation - serving.kubeflow.org/s3-verifyssl + example: '0' + usehttps: + type: string + description: 0, 1 flag for KF-serving annotations - serving.kubeflow.org/s3-usehttps + example: '1' + default: '1' + data: + type: object + description: key:value pairs of data + writeOnly: true + BckndobjectStoreSecretWithSensitiveDataRequestForPostCall: type: object - description: Start and end an execution schedule. + description: This represents all the meta-data and extra information to be stored + as a k8-secret + required: + - name + - type + - data properties: - cron: - $ref: '#/components/schemas/AiCron' name: - maxLength: 256 type: string - description: Name of the execution schedule - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - start: + pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ + maxLength: 233 + description: Name of the object store for the secret object to be created. + Can be used later on check for existence of the secret. + example: myobjectstore + type: type: string - description: Timestamp, defining when the executions should start running - periodically, defaults to now - format: date-time - end: + description: Storage type e.g. S3, GCS,... + example: S3 + bucket: type: string - description: Timestamp, defining when the executions should stop running - format: date-time - required: - - configurationId - - cron - - name - AiExecutionScheduleList: + description: Bucket to be used + example: mybucket1 + endpoint: + type: string + description: Optional parameter - URL of the storage server (S3 only) + example: www.example.com + region: + type: string + description: Optional parameter - Region of the storage server (S3 only) + example: eu + pathPrefix: + type: string + description: prefix folder to be added to storage path + example: mp-api + verifyssl: + type: string + description: 0, 1 flag for the KF-serving annotation - serving.kubeflow.org/s3-verifyssl + example: '0' + usehttps: + type: string + description: 0, 1 flag for KF-serving annotations - serving.kubeflow.org/s3-usehttps + example: '1' + default: '1' + data: + type: object + description: key:value pairs of data + writeOnly: true + BckndobjectStoreSecretStatusResponse: + description: This represents a list of meta-data of a stored secret. The 'data' + field of the secret is never retrieved. type: object properties: count: @@ -4432,155 +4093,151 @@ components: resources: type: array items: - $ref: '#/components/schemas/AiExecutionSchedule' + $ref: '#/components/schemas/BckndobjectStoreSecretStatus' required: - count - resources - AiExecutionScheduleModificationRequest: + BckndobjectStoreSecretStatus: type: object - description: Request object for changing the execution schedule + description: This represents the meta-data of a stored secret. The 'data' field + of the secret is never retrieved. properties: - cron: - $ref: '#/components/schemas/AiCron' - start: - type: string - description: Timestamp, defining when the executions should start running - periodically, defaults to now - format: date-time - end: + metadata: + description: Key value pairs of meta-data assigned to the secret when the + secret was being created. + type: object + properties: + serving.kubeflow.org/s3-usehttps: + type: string + description: 0 and 1 values for setting the flag + example: '1' + serving.kubeflow.org/s3-verifyssl: + type: string + description: 0 and 1 values for setting the flag + example: '0' + serving.kubeflow.org/s3-endpoint: + type: string + description: Annotation for endpoint required by KF_Serving + example: some_endpoint + serving.kubeflow.org/s3-region: + type: string + description: Annotation for region required by KF_Serving + example: EU + storage.ai.sap.com/type: + type: string + description: Storage type of the secret + example: S3 + storage.ai.sap.com/bucket: + type: string + description: bucket assigned to the secret on creation + example: my_bucket + storage.ai.sap.com/endpoint: + type: string + description: Endpoint assigned to the secret on creation + example: some_endpoint + storage.ai.sap.com/region: + type: string + description: Region of the storage server + example: EU + storage.ai.sap.com/pathPrefix: + type: string + description: Pathprefix type assigned to the secret on creation. + example: mnist_folder + storage.ai.sap.com/hdfsNameNode: + type: string + description: name node of the HDFS file system + example: https://c3272xxxxxfa8f.files.hdl.canary-eu10.hanacloud.ondemand.com + storage.ai.sap.com/headers: + type: string + description: headers for webHDFS and other protocols + example: '{"x-sap-filecontainer": "c32727xxxxxxx322dcfa8f"}' + storage.ai.sap.com/containerUri: + type: string + description: container uri of azure storage + example: + https://sapcv842awjkfb2.blob.core.windows.net/sapcp-osaas-xxx-xxxx-xxxx-xxxx-xxxx-zrs + storage.ai.sap.com/subscriptionId: + type: string + description: subscription id + example: dgewg2-gkrwnegiw + storage.ai.sap.com/tenantId: + type: string + description: tenant id + example: dawd2120-dadwad2 + storage.ai.sap.com/projectId: + type: string + description: project id of google cloud platform + example: sap-gcp-oaas-us31-1 + name: + description: Name of objectstore type: string - description: Timestamp, defining when the executions should stop running - format: date-time - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - status: - $ref: '#/components/schemas/AiExecutionScheduleStatus' - AiExecutionScheduleModificationResponse: + example: myobjectstore-object-store-secret + BckndobjectStoreSecretDeletionResponse: type: object properties: id: - $ref: '#/components/schemas/AiId' + $ref: '#/components/schemas/BckndId' message: - $ref: '#/components/schemas/AiExecutionScheduleModificationResponseMessage' + $ref: '#/components/schemas/BckndobjectStoreSecretDeletionResponseMessage' required: - id - message - AiExecutionScheduleModificationResponseMessage: + BckndobjectStoreSecretDeletionResponseMessage: type: string description: Message - example: Execution Schedule modified - AiExecutionScheduleDeletionResponse: + example: Object Store Secret has been deleted + BckndobjectStoreSecretCreationResponse: type: object + description: Message + example: Created properties: - id: - $ref: '#/components/schemas/AiId' message: - $ref: '#/components/schemas/AiExecutionScheduleDeletionResponseMessage' - required: - - id - - message - AiExecutionScheduleDeletionResponseMessage: + $ref: '#/components/schemas/BckndobjectStoreSecretCreationResponseMessage' + BckndobjectStoreSecretCreationResponseMessage: type: string description: Message - example: Execution Schedule deleted - AiExecutionScheduleCreationResponse: + example: Secret has been created + BckndobjectStoreSecretModificationResponseMessage: + type: string + description: Message + example: Secret has been modified + BckndobjectStoreSecretModificationResponse: type: object properties: id: - $ref: '#/components/schemas/AiId' + $ref: '#/components/schemas/BckndId' message: - $ref: '#/components/schemas/AiExecutionScheduleCreationResponseMessage' + $ref: '#/components/schemas/BckndobjectStoreSecretModificationResponseMessage' required: - id - message - AiExecutionScheduleCreationResponseMessage: + BcknddockerRegistryNameComponent: + description: Name of the docker Registry store for the secret. type: string - description: Message - example: Execution Schedule created - AiDeployment: + pattern: ^[a-z0-9](?:_?[a-z0-9\.\-]+)*[a-z0-9]$ + maxLength: 63 + example: mydockeregistry + BcknddockerRegistrySecretWithSensitiveDataRequest: type: object - description: Detailed data about a deployment - properties: - id: - $ref: '#/components/schemas/AiDeploymentId' - deploymentUrl: - $ref: '#/components/schemas/AiDeploymentUrl' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - configurationName: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - status: - $ref: '#/components/schemas/AiDeploymentStatus' - statusMessage: - $ref: '#/components/schemas/AiDeploymentStatusMessage' - targetStatus: - type: string - description: Deployment target status - enum: - - RUNNING - - STOPPED - - DELETED - lastOperation: - type: string - description: Last operation applied to this deployment. - anyOf: - - enum: - - CREATE - - UPDATE - - DELETE - - CASCADE-UPDATE - - {} - latestRunningConfigurationId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: configurationId that was running before a PATCH operation has - modified the configurationId of the deployment. This can be used for a - manual rollback in case the new configurationId results in a DEAD deployment - ttl: - $ref: '#/components/schemas/AiDeploymentTimeToLive' - details: - $ref: '#/components/schemas/AiDeploymentDetails' - createdAt: - type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: - type: string - format: date-time - description: Timestamp of latest resource modification - submissionTime: - type: string - format: date-time - description: Timestamp of job submitted - startTime: - type: string - format: date-time - description: Timestamp of job status changed to RUNNING - completionTime: - type: string - format: date-time - description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED + description: This represents all the meta-data and extra information to be stored + as a k8-secret required: - - id - - configurationId - - status - - createdAt - - modifiedAt - AiDeploymentId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the deployment - AiDeploymentUrl: - description: Consumption URL of the deployment - type: string - format: url - AiDeploymentList: + - data + properties: + data: + type: object + required: + - .dockerconfigjson + description: key:value pairs of data + writeOnly: true + additionalProperties: false + properties: + .dockerconfigjson: + type: string + description: .dockerconfigjson data + BcknddockerRegistrySecretStatusResponse: + description: This represents a list of meta-data of a stored secret. The 'data' + field of the secret is never retrieved. type: object properties: count: @@ -4589,995 +4246,979 @@ components: resources: type: array items: - $ref: '#/components/schemas/AiDeployment' + $ref: '#/components/schemas/BcknddockerRegistrySecretStatus' required: - count - resources - AiDeploymentCreationResponse: + BcknddockerRegistrySecretStatus: + type: object + description: This represents the meta-data of a stored secret. The 'data' field + of the secret is never retrieved. + properties: + name: + description: Name of dockerRegistryStore + type: string + example: mydockeregistry + BcknddockerRegistrySecretDeletionResponse: type: object properties: id: - $ref: '#/components/schemas/AiId' + $ref: '#/components/schemas/BckndId' message: - $ref: '#/components/schemas/AiDeploymentCreationResponseMessage' - deploymentUrl: - $ref: '#/components/schemas/AiDeploymentUrl' - status: - $ref: '#/components/schemas/AiExecutionStatus' - ttl: - $ref: '#/components/schemas/AiDeploymentTimeToLive' + $ref: '#/components/schemas/BcknddockerRegistrySecretDeletionResponseMessage' required: - id - message - AiDeploymentCreationResponseMessage: + BcknddockerRegistrySecretDeletionResponseMessage: type: string description: Message - example: Deployment scheduled - AiEnactmentCreationRequest: + example: Docker Registry Secret has been deleted + BcknddockerRegistrySecretCreationResponse: type: object - description: Request object for creating an execution or an deployment + description: Message + example: Created + properties: + message: + $ref: '#/components/schemas/BcknddockerRegistrySecretCreationResponseMessage' + BcknddockerRegistrySecretCreationResponseMessage: + type: string + description: Message + example: Secret has been created + BcknddockerRegistrySecretModificationResponseMessage: + type: string + description: Message + example: Secret has been modified + BcknddockerRegistrySecretModificationResponse: + type: object + properties: + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BcknddockerRegistrySecretModificationResponseMessage' required: - - configurationId + - id + - message + BckndGenericSecretData: + description: Base64 encoded secret data + type: object + additionalProperties: + type: string + BckndGenericSecretPostBody: + type: object + required: + - name + - data properties: - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - AiDeploymentCreationRequest: + name: + description: The name of the secret + type: string + minLength: 1 + maxLength: 252 + pattern: ^[a-z0-9\-\.]+$ + data: + $ref: '#/components/schemas/BckndGenericSecretData' + labels: + $ref: '#/components/schemas/BckndGenericSecretLabels' + BckndGenericSecretPatchBody: type: object - description: Request object for creating an execution or an deployment required: - - configurationId + - data properties: - ttl: - $ref: '#/components/schemas/AiDeploymentTimeToLive' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - AiDeploymentModificationRequest: + data: + $ref: '#/components/schemas/BckndGenericSecretData' + labels: + $ref: '#/components/schemas/BckndGenericSecretLabels' + BckndGenericSecretDataResponse: type: object - description: Request object for changing the target status of a deployment (currently - only STOPPED is supported) properties: - targetStatus: - $ref: '#/components/schemas/AiDeploymentTargetStatus' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - AiDeploymentModificationRequestWithIdentifier: + message: + $ref: '#/components/schemas/BckndMessage' + name: + $ref: '#/components/schemas/BckndName' + BckndGenericSecretDetails: type: object required: - - targetStatus - - id + - name + - createdAt properties: - id: - $ref: '#/components/schemas/AiDeploymentId' - targetStatus: + name: + description: Name of the secret type: string - description: Deployment target status - enum: - - STOPPED - - DELETED - description: Request object for changing the target status of a deployment ( - STOPPED and DELETED are supported) - AiDeploymentModificationRequestList: - type: array - items: - $ref: '#/components/schemas/AiDeploymentModificationRequestWithIdentifier' - uniqueItems: true - minItems: 1 - maxItems: 100 - example: - - id: aa97b177-9383-4934-8543-0f91a7a0283a - targetStatus: STOPPED - - id: qweq32131-qwee-1231-8543-0f91a7a2e2e - targetStatus: DELETED - AiDeploymentBulkModificationRequest: + createdAt: + description: Timestamp at which secret was created + type: string + labels: + $ref: '#/components/schemas/BckndGenericSecretLabels' + resourceGroupSecretsSyncStatus: + description: Sync status of the replicated secrets in all resource groups + of the tenant + type: object + additionalProperties: + type: boolean + description: Resource group ID and sync status + BckndListGenericSecretsResponse: + description: This represents a list of meta-data of the secret. The 'data' field + of the secret is never retrieved. type: object - description: Request object for changing the target status of multiple deployments properties: - deployments: - $ref: '#/components/schemas/AiDeploymentModificationRequestList' - AiDeploymentModificationResponse: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/BckndGenericSecretDetails' + required: + - count + - resources + BckndGenericSecretLabels: + type: array + description: Arbitrary labels as meta information + items: + $ref: '#/components/schemas/BckndGenericSecretLabel' + BckndGenericSecretLabel: + type: object + required: + - key + - value + properties: + key: + type: string + pattern: ^ext.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,48}$ + maxLength: 63 + example: ext.ai.sap.com/my-label + value: + type: string + maxLength: 5000 + BckndArgoCDRepositoryData: + type: object + required: + - url + - username + - password + properties: + name: + description: Name of the repository + type: string + minLength: 1 + maxLength: 51 + pattern: ^[a-z0-9\-]+$ + url: + description: URL of the repository to synchronise + type: string + username: + description: Username for read-access to the repository + type: string + password: + description: Password for read-access to the repository + type: string + BckndArgoCDRepositoryCredentials: + type: object + required: + - username + - password + properties: + username: + description: Username for read-access to the repository + type: string + password: + description: Password for read-access to the repository + type: string + BckndArgoCDRepositoryDataResponse: + description: This represents a list of GitOps repositories for the tenant. + type: object + properties: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/BckndArgoCDRepositoryDetails' + required: + - count + - resources + BckndArgoCDRepositoryCreationResponse: type: object properties: id: - $ref: '#/components/schemas/AiId' + $ref: '#/components/schemas/BckndId' message: - $ref: '#/components/schemas/AiDeploymentModificationResponseMessage' + $ref: '#/components/schemas/BckndArgoCDRepositoryCreationResponseMessage' required: - id - message - AiDeploymentModificationResponseList: - type: array - items: - oneOf: - - $ref: '#/components/schemas/AiDeploymentModificationResponse' - - $ref: '#/components/schemas/AiApiErrorWithId' - AiDeploymentBulkModificationResponse: + BckndArgoCDRepositoryCreationResponseMessage: + type: string + description: Message + example: Repository has been on-boarded + BckndArgoCDRepositoryDetails: type: object - description: Response object with array of deployments + description: Repository details properties: - deployments: - $ref: '#/components/schemas/AiDeploymentModificationResponseList' - AiDeploymentDeletionResponse: + name: + description: The name of the repository + type: string + url: + description: The repository URL + type: string + status: + description: The status of the repository's on-boarding + type: string + enum: + - ERROR + - IN-PROGRESS + - COMPLETED + example: COMPLETED + BckndArgoCDRepositoryDeletionResponse: type: object properties: id: - $ref: '#/components/schemas/AiId' + $ref: '#/components/schemas/BckndId' message: - $ref: '#/components/schemas/AiDeploymentDeletionResponseMessage' + $ref: '#/components/schemas/BckndArgoCDRepositoryDeletionResponseMessage' required: - id - message - AiDeploymentModificationResponseMessage: + BckndArgoCDRepositoryDeletionResponseMessage: type: string description: Message - example: Deployment modification scheduled - AiDeploymentDeletionResponseMessage: + example: The repository has been off-boarded. + BckndArgoCDRepositoryModificationResponse: + type: object + properties: + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDRepositoryModificationResponseMessage' + required: + - id + - message + BckndArgoCDRepositoryModificationResponseMessage: type: string description: Message - example: Deployment deletion scheduled - AiDeploymentResponseWithDetails: + example: ArgoCD application has been updated + BckndArgoCDApplicationBaseData: type: object - description: Detail properties of the deployment + required: + - repositoryUrl + - revision + - path properties: - id: - $ref: '#/components/schemas/AiDeploymentId' - deploymentUrl: - $ref: '#/components/schemas/AiDeploymentUrl' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - configurationName: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - status: - $ref: '#/components/schemas/AiDeploymentStatus' - statusMessage: - $ref: '#/components/schemas/AiDeploymentStatusMessage' - targetStatus: - type: string - description: Deployment target status - enum: - - RUNNING - - STOPPED - - DELETED - lastOperation: + repositoryUrl: + description: URL of the repository to synchronise type: string - description: Last operation applied to this deployment. - anyOf: - - enum: - - CREATE - - UPDATE - - DELETE - - CASCADE-UPDATE - - {} - latestRunningConfigurationId: + revision: + description: revision to synchronise type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: configurationId that was running before a PATCH operation has - modified the configurationId of the deployment. This can be used for a - manual rollback in case the new configurationId results in a DEAD deployment - ttl: - $ref: '#/components/schemas/AiDeploymentTimeToLive' - details: - $ref: '#/components/schemas/AiDeploymentDetails' - createdAt: + path: + description: path within the repository to synchronise type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: + BckndArgoCDApplicationData: + type: object + properties: + repositoryUrl: + description: URL of the repository to synchronise type: string - format: date-time - description: Timestamp of latest resource modification - submissionTime: + revision: + description: revision to synchronise type: string - format: date-time - description: Timestamp of job submitted - startTime: + path: + description: path within the repository to synchronise type: string - format: date-time - description: Timestamp of job status changed to RUNNING - completionTime: + applicationName: + description: ArgoCD application name type: string - format: date-time - description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED - statusDetails: - $ref: '#/components/schemas/AiDeploymentStatusDetails' + minLength: 3 + maxLength: 54 + pattern: ^[a-z0-9\-]+$ required: - - id - - configurationId - - status - - createdAt - - modifiedAt - AiBackendDetails: - type: object - description: backend-specific details of the deployment - AiScalingDetails: - type: object - description: Scaling details of a deployment - example: - backendDetails: - predictor: - minReplicas: 0 - maxReplicas: 2 - runningReplicas: 1 - properties: - backendDetails: - $ref: '#/components/schemas/AiBackendDetails' - AiResourcesDetails: + - repositoryUrl + - revision + - path + BckndAllArgoCDApplicationData: + description: list of applications type: object - description: Resources details of a deployment - example: - backendDetails: - predictor: - resourcePlan: starter properties: - backendDetails: - $ref: '#/components/schemas/AiBackendDetails' - AiDeploymentDetails: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/BckndArgoCDApplicationData' + required: + - count + - resources + BckndArgoCDApplicationDataRepoName: type: object - description: 'Detail information about a deployment (including predefined sections: - `scaling` and `resources`). - - JSON String representation of this object is limited to 5000 characters - - ' + required: + - repositoryName + - revision + - path properties: - scaling: - $ref: '#/components/schemas/AiScalingDetails' - resources: - $ref: '#/components/schemas/AiResourcesDetails' - AiDeploymentTimeToLive: - type: string - description: Time to live for a deployment. Its value can be either null or - a number followed by the unit (any of following values, minutes(m|M), hours(h|H) - or days(d|D)) - nullable: true - pattern: ^[0-9]+[m,M,h,H,d,D]$ - example: 24H - AiArtifact: - description: 'Base data of the artifact; this is the data that can be provided - when the artifact is created; `name` and `kind` are required because they - constitute important semantic filtering criteria for use in training / inference - executables (`name` is a semantic handle of the artifact within a scenario - and `kind` specifies the type of usage, e.g. you would only want to allow - models in the model operator). - - ' + repositoryName: + description: Name of the repository to synchronise + type: string + revision: + description: revision to synchronise + type: string + path: + description: path within the repository to synchronise + type: string + applicationName: + description: ArgoCD application name + type: string + minLength: 3 + maxLength: 54 + pattern: ^[a-z0-9\-]+$ + BckndArgoCDApplicationStatus: type: object + description: ArgoCD application definition and status properties: - labels: - $ref: '#/components/schemas/AiLabelList' - name: - $ref: '#/components/schemas/AiArtifactName' - kind: + healthStatus: + description: ArgoCD application health status type: string - enum: - - model - - dataset - - resultset - - other - description: Kind of the artifact, i.e. model or dataset - url: - $ref: '#/components/schemas/AiArtifactUrl' - description: - $ref: '#/components/schemas/AiArtifactDescription' - id: - $ref: '#/components/schemas/AiArtifactId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - executionId: - $ref: '#/components/schemas/AiExecutionId' - createdAt: + syncStatus: + description: ArgoCD application sync status type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: + message: + description: ArgoCD application health status message type: string - format: date-time - description: Timestamp of latest resource modification - scenario: + source: + description: Information about the ArgoCD application itself type: object - nullable: true - anyOf: - - $ref: '#/components/schemas/AiScenario' - - {} + properties: + repoURL: + description: URL of the repository + type: string + path: + description: Path of the repository + type: string + revision: + description: Revision number of the ArgoCD application + type: string + syncFinishedAt: + description: Gets the timestamp information related to the sync state of + the ArgoCD application + type: string + syncStartedAt: + description: Get timestamp information related to the sync state of the + ArgoCD application + type: string + reconciledAt: + description: Get timestamp information related to the sync state of the + ArgoCD application + type: string + syncResourcesStatus: + description: Status of all resources that need to be synchronized with the + gitops repo + type: array + items: + type: object + properties: + name: + description: ArgoCD application object name + type: string + kind: + description: ArgoCD application object kind + type: string + status: + description: ArgoCD application object sync status + type: string + message: + description: ArgoCD application object message + type: string + syncRessourcesStatus: + deprecated: true + description: Status of all resources that need to be synchronized with the + gitops repo. Misspelled and deprecated, use syncResourcesStatus instead. + type: array + items: + type: object + properties: + name: + description: ArgoCD application object name + type: string + kind: + description: ArgoCD application object kind + type: string + status: + description: ArgoCD application object sync status + type: string + message: + description: ArgoCD application object message + type: string + BckndArgoCDApplicationDeletionResponse: + type: object + properties: + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDApplicationDeletionResponseMessage' required: - - name - - kind - - url - id - - scenarioId - - createdAt - - modifiedAt - AiArtifactDescription: + - message + BckndArgoCDApplicationDeletionResponseMessage: type: string - maxLength: 5000 - description: Description of the artifact - AiArtifactPostData: + description: Message + example: ArgoCD application has been deleted + BckndArgoCDApplicationCreationResponse: type: object - description: 'Base data of the artifact; this is the data that can be provided - when the artifact is created; `name` and `kind` are required because they - constitute important semantic filtering criteria for use in training / inference - executables (`name` is a semantic handle of the artifact within a scenario - and `kind` specifies the type of usage, e.g. you would only want to allow - models in the model operator). - - ' - required: - - name - - kind - - url - - scenarioId properties: - labels: - $ref: '#/components/schemas/AiLabelList' - name: - $ref: '#/components/schemas/AiArtifactName' - kind: - type: string - enum: - - model - - dataset - - resultset - - other - description: Kind of the artifact, i.e. model or dataset - url: - $ref: '#/components/schemas/AiArtifactUrl' - description: - $ref: '#/components/schemas/AiArtifactDescription' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - AiArtifactCreationResponse: - type: object + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDApplicationCreationResponseMessage' required: - id - message - - url + BckndArgoCDApplicationCreationResponseMessage: + type: string + description: Message + example: ArgoCD application has been created + BckndArgoCDApplicationModificationResponse: + type: object properties: id: - $ref: '#/components/schemas/AiId' + $ref: '#/components/schemas/BckndId' message: - $ref: '#/components/schemas/AiArtifactCreationResponseMessage' - url: - $ref: '#/components/schemas/AiArtifactUrl' - AiArtifactCreationResponseMessage: + $ref: '#/components/schemas/BckndArgoCDApplicationModificationResponseMessage' + required: + - id + - message + BckndArgoCDApplicationModificationResponseMessage: type: string description: Message - example: Artifact acknowledged - AiArtifactId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the artifact - AiArtifactName: - type: string - pattern: ^[\w\s.!?,;:\[\](){}<>"'=+*/\\^&%@~$#|-]*$ - maxLength: 256 - description: Name of the artifact - AiArtifactUrl: + example: ArgoCD application has been updated + BckndArgoCDApplicationRefreshResponse: + type: object + properties: + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDApplicationRefreshResponseMessage' + required: + - id + - message + BckndArgoCDApplicationRefreshResponseMessage: type: string - pattern: ([a-z0-9-]+):\/\/.+ - maxLength: 1024 - example: https://example.com/some_path - description: 'Reference to the location of the artifact. - - ' - AiArtifactList: + description: Message + example: Refresh of ArgoCD application has been scheduled + BckndServiceList: type: object properties: count: type: integer description: Number of the resource instances in the list resources: - $ref: '#/components/schemas/AiArtifactArray' + type: array + items: + $ref: '#/components/schemas/BckndService' required: - count - resources - AiArtifactArray: - type: array - items: - $ref: '#/components/schemas/AiArtifact' - AiLogCommonData: - type: object - properties: - result: - $ref: '#/components/schemas/AiLogCommonResult' - AiLogCommonResult: - type: array - items: - $ref: '#/components/schemas/AiLogCommonResultItem' - AiLogCommonResultItem: + BckndService: type: object - description: Common log record. properties: - timestamp: - description: Datetime in RFC 3339. + name: + description: service name type: string - format: date-time - example: '2021-05-19T00:00:14.347+00:00' - msg: - description: message content. + description: + description: service description type: string - AiId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: Generic ID - AiVersionId: - description: Version ID - type: string - AiVersionDescription: - type: string - maxLength: 5000 - example: This is version v1 - description: Version description - AiCreationResponseMessage: - type: string - description: Message - example: Created - AiUrl: - type: string - format: url - AiApiErrorWithId: + url: + description: service broker url + type: string + status: + description: aggregated status of the service + type: string + enum: + - PROVISIONED + - ERROR + - PROVISIONING + - DEPROVISIONING + statusMessage: + description: status message + type: string + BckndExtendedService: type: object - required: - - id - - error properties: - id: - $ref: '#/components/schemas/AiId' - error: - $ref: '#/components/schemas/AiApiError' - AiApiError: + name: + description: service name + type: string + description: + description: service description + type: string + url: + description: service broker url + type: string + brokerSecret: + $ref: '#/components/schemas/BckndServiceBrokerSecret' + capabilities: + $ref: '#/components/schemas/BckndServiceCapabilities' + serviceCatalog: + $ref: '#/components/schemas/BckndServiceServiceCatalog' + sharedResourceGroupStatus: + $ref: '#/components/schemas/BckndSharedResourceGroupStatus' + status: + description: aggregated status of the service + type: string + enum: + - PROVISIONED + - ERROR + - PROVISIONING + - DEPROVISIONING + statusMessage: + description: status message + type: string + BckndServiceBrokerSecret: type: object - required: - - code - - message properties: - code: - type: string - description: Descriptive error code (not http status code) - message: + name: + description: broker secret name type: string - description: Plaintext error description - requestId: + passwordKeyRef: + description: username key reference in broker secret type: string - description: ID of the individual request - target: + usernameKeyRef: + description: password key reference in broker secret type: string - description: Invoked URL - details: - description: Optional details of the error message + BckndServiceCapabilities: + type: object + properties: + logs: + description: Capabilities to read logs from deployments and executions. type: object - TntTenantInfo: + properties: + deployments: + type: boolean + executions: + type: boolean + basic: + description: Basic capabilities like creating deployments and executions. + type: object + properties: + staticDeployments: + description: There are static always running endpoints that can be used + for inference without the need to do user deployments. + type: boolean + userDeployments: + description: Services that only support batch inference typically neither + allow listing nor creation of deployments. For these, userDeployments + == false + type: boolean + createExecutions: + description: Services that only support deployment typically neither + allow create executions. For these, createExecutions == false + type: boolean + userPromptTemplates: + description: Services that only support create, read and delete of prompt + templates + type: boolean + multitenant: + description: true-> AI API implementation supports resource groups (Main + Tenant scenario), false-> implementation does not support resource + groups (Service Tenant scenario) + type: boolean + BckndServiceServiceCatalog: + type: array + items: + $ref: '#/components/schemas/BckndServiceServiceCatalogItem' + BckndServiceServiceCatalogItem: type: object - required: - - tenantId - - servicePlan - - status properties: - tenantId: - description: tenant id + extendCatalog: + $ref: '#/components/schemas/BckndServiceServiceCatalogItemExtendCatalog' + extendCredentials: + $ref: '#/components/schemas/BckndServiceServiceCatalogItemExtendCredentials' + BckndServiceServiceCatalogItemExtendCatalog: + type: object + properties: + bindable: + description: if the service is bindable + type: boolean + description: + description: description of the service type: string - example: aa97b177-9383-4934-8543-0f91a7a0283a - servicePlan: + id: + description: id of the service type: string - status: - description: Provisioning status of the tenant + name: + description: name of the service type: string - TntApiError: + plans: + type: array + items: + $ref: '#/components/schemas/BckndServiceServicePlanItem' + BckndServiceServicePlanItem: type: object - required: - - code - - message properties: - code: + description: + description: description of the service plan type: string - description: Descriptive error code (not http status code) - message: + free: + description: if the service plan free + type: boolean + id: + description: id of the service plan type: string - description: Plaintext error description - requestId: + name: + description: name of the service plan type: string - description: ID of the individual request - target: - type: string - description: Invoked URL - details: - description: Optional details of the error message - type: object - KpiColumnName: - readOnly: true - type: string - description: Name of the Column - anyOf: - - enum: - - ResourceGroup - - Scenario - - Executable - - Executions - - Artifacts - - Deployments - - {} - KpiArrayOfColumnNames: - uniqueItems: true - type: array - readOnly: true - items: - $ref: '#/components/schemas/KpiColumnName' - KpiAggregationAttribute: - type: string - title: Aggregation Attribute - readOnly: true - KpiCountAggregate: - type: integer - title: CountAggregate - format: int64 - minimum: 0 - x-examples: {} - readOnly: true - KpiResultRow: - type: array - title: ResultRow - uniqueItems: false - x-examples: {} - description: '' - items: - $ref: '#/components/schemas/KpiResultRowItem' - readOnly: true - KpiResultRowItem: - title: ResultRowItem - anyOf: - - $ref: '#/components/schemas/KpiAggregationAttribute' - - $ref: '#/components/schemas/KpiCountAggregate' - x-examples: {} - KpiResultRowList: - title: ResultRowList - type: array - items: - $ref: '#/components/schemas/KpiResultRow' - KpiResultSet: + metadata: + $ref: '#/components/schemas/BckndServiceServicePlanItemMetadata' + BckndServiceServicePlanItemMetadata: type: object - title: ResultSet - x-examples: - example-1: - header: - - ResourceGroup - - Executions - - Artifacts - - Deployments - rows: - - - 00112233-4455-6677-8899-aabbccddeeff - - 30 - - 30 - - 3 - additionalProperties: false - minProperties: 2 - maxProperties: 2 properties: - header: - $ref: '#/components/schemas/KpiArrayOfColumnNames' - rows: - $ref: '#/components/schemas/KpiResultRowList' - readOnly: true - KpiApiError: + supportedPlatforms: + description: supported platforms of the service plan + type: array + items: + type: string + enum: + - cloudfoundry + - kubernetes + - sapbtp + BckndServiceServiceCatalogItemExtendCredentials: type: object - required: - - code - - message properties: - code: - type: string - description: Descriptive error code (not http status code) - message: - type: string - description: Plaintext error description - requestId: - type: string - description: ID of the individual request - target: - type: string - description: Invoked URL - details: - description: Optional details of the error message + shared: type: object - DSetUrl: - type: string - format: url - example: https://download.example.com/test/file.bin - DSetError: - description: Error Response + properties: + serviceUrls: + type: object + properties: + AI_API_URL: + type: string + BckndSharedResourceGroupStatus: type: object properties: - code: - type: string - minLength: 1 - message: - type: string - minLength: 1 - target: + isEnabled: + description: indicates whether shared resource group is enabled + type: boolean + id: + description: shared resource group id type: string - minLength: 1 - requestId: + state: + description: current state of shared resource group type: string - details: - type: array - uniqueItems: true - minItems: 0 - items: - required: - - code - - message - properties: - code: - type: string - minLength: 1 - message: - type: string - minLength: 1 - required: - - code - - message - x-examples: - example-1: - code: '03021655' - message: Bad request encountered. Please try again with possible-solution-here. - target: /url/path - requestId: 9832bf934f3743v3948v3 - details: - - code: '01041211' - message: Optional nested error message. - DSetFileCreationResponse: - description: Response for successful file creation + BckndDeploymentResourceQuotaResponse: type: object required: - - message - - url + - quotas properties: - message: - type: string - description: File creation response message - example: File creation acknowledged - url: - $ref: '#/components/schemas/DSetUrl' - BckndId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: Generic ID - BckndMessage: - type: string - description: Message - BckndName: - type: string - description: Name - BckndCreationResponseMessage: - type: string - description: Message - example: Created - BckndUrl: - type: string - format: url - BckndResourceGroupList: + usage: + $ref: '#/components/schemas/BckndDeploymentUsage' + quotas: + type: array + items: + $ref: '#/components/schemas/BckndDeploymentQuotaItem' + BckndDeploymentUsage: type: object + required: + - count + - items properties: count: type: integer - description: Number of the resource instances in the list - resources: + items: type: array items: - $ref: '#/components/schemas/BckndResourceGroup' - required: - - count - - resources - BckndResourceGroupBase: + $ref: '#/components/schemas/BckndUsageResourcePlanItem' + BckndUsageResourcePlanItem: type: object + required: + - id properties: - resourceGroupId: - description: resource group id - type: string - tenantId: - description: tenant id + id: type: string - zoneId: - description: zone id + resourcePlanType: type: string - BckndResourceGroup: + configuredMaxReplicas: + type: integer + BckndDeploymentQuotaItem: type: object properties: - resourceGroupId: - description: resource group id - type: string - tenantId: - description: tenant id - type: string - zoneId: - description: zone id - type: string - createdAt: - description: Timestamp of resource group creation - type: string - format: date-time - labels: - $ref: '#/components/schemas/BckndResourceGroupLabels' - status: - description: aggregated status of the onboarding process + resourcePlanType: type: string - enum: - - PROVISIONED - - ERROR - - PROVISIONING - statusMessage: - description: status message - type: string - required: - - status - - createdAt - - resourceGroupId - BckndInternalResourceGroup: + deploymentQuota: + $ref: '#/components/schemas/BckndDeploymentQuota' + BckndDeploymentQuota: type: object properties: - resourceGroupId: - description: resource group id - type: string - tenantId: - description: tenant id - type: string - zoneId: - description: zone id - type: string - createdAt: - description: Timestamp of resource group creation - type: string - format: date-time - labels: - $ref: '#/components/schemas/BckndInternalResourceGroupLabels' - status: - description: aggregated status of the onboarding process - type: string - enum: - - PROVISIONED - - ERROR - - PROVISIONING - statusMessage: - description: status message - type: string - annotations: - $ref: '#/components/schemas/BckndInternalResourceGroupAnnotations' + maxCount: + type: integer + description: The value can be 0(disabled) or a positive integer defining + the maximum allowed number + example: 10 + maxReplicaPerDeployment: + type: integer + BckndCommonResourceQuotaResponse: + type: object required: - - status - - createdAt - - resourceGroupId - BckndResourceGroupsPostRequest: + - quota + properties: + usage: + type: object + properties: + count: + type: integer + quota: + type: object + properties: + maxCount: + type: integer + description: The value can be 0(disabled) or a positive integer defining + the maximum allowed number + example: 10 + BckndExecutableResourceQuotaResponse: type: object + required: + - quota properties: - resourceGroupId: - description: resource group id - type: string - pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]{1,251}[a-zA-Z0-9]$ - minLength: 3 - maxLength: 253 - labels: - $ref: '#/components/schemas/BckndResourceGroupLabels' - BckndResourceGroupLabels: - type: array - description: Arbitrary labels as meta information - items: - $ref: '#/components/schemas/BckndResourceGroupLabel' - BckndResourceGroupLabel: + usage: + type: object + properties: + servingTemplateCount: + type: integer + workflowTemplateCount: + type: integer + quota: + type: object + properties: + servingTemplateMaxCount: + type: integer + description: The value can be 0(disabled) or a positive integer defining + the maximum allowed number + example: 10 + workflowTemplateMaxCount: + type: integer + description: The value can be 0(disabled) or a positive integer defining + the maximum allowed number + example: 10 + BckndResourcePatchBody: type: object required: - - key - - value + - resourcePlans properties: - key: - type: string - pattern: ^ext.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,48}$ - maxLength: 63 - example: ext.ai.sap.com/my-label - value: - type: string - maxLength: 5000 - BckndInternalResourceGroupLabels: + resourcePlans: + $ref: '#/components/schemas/BckndResourcePatchResourcePlans' + BckndResourcePatchResourcePlans: type: array - description: Arbitrary labels as meta information items: - $ref: '#/components/schemas/BckndInternalResourceGroupLabel' - BckndInternalResourceGroupLabel: + $ref: '#/components/schemas/BckndResourcePatchNodes' + BckndResourcePatchNodes: type: object required: - - key - - value + - name + - request properties: - key: - type: string - pattern: ^internal.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,43}$ - maxLength: 63 - example: internal.ai.sap.com/my-label - value: + name: type: string - maxLength: 5000 - BckndInternalResourceGroupAnnotations: - type: array - description: Arbitrary annotations as meta information - items: - $ref: '#/components/schemas/BckndInternalResourceGroupAnnotation' - BckndInternalResourceGroupAnnotation: + request: + type: integer + BckndResourcePatchResponse: type: object required: - - key - - value + - message properties: - key: - type: string - pattern: ^internal.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,43}$ - maxLength: 63 - example: internal.ai.sap.com/my-annotation - value: + message: type: string - maxLength: 5000 - BckndResourceGroupDeletionResponse: + BckndResourceGetResponse: type: object + required: + - resourcePlans properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndResourceGroupDeletionResponseMessage' + resourcePlans: + $ref: '#/components/schemas/BckndResourceGetResourcePlans' + BckndInstanceTypeGetResponse: + type: object required: - - id - - message - BckndResourceGroupDeletionResponseMessage: - type: string - description: Message - example: Resource Group deletion scheduled - BckndResourceGroupPatchRequest: + - instanceTypes + properties: + instanceTypes: + $ref: '#/components/schemas/BckndInstanceType' + BckndResourceGetResourcePlans: + type: object + additionalProperties: + type: object + required: + - provisioned + - requested + properties: + provisioned: + type: integer + requested: + type: integer + BckndInstanceType: + type: object + additionalProperties: + type: object + required: + - memory + - cpu + - gpu + - billableUnitsPerHour + properties: + memory: + type: string + description: Memory allocated for the instance type (e.g., "16Gi") + cpu: + type: number + description: Number of CPU cores allocated for the instance type + gpu: + type: number + description: Number of GPUs allocated for the instance type + billableUnitsPerHour: + type: number + description: Number of billable units per hour for the instance type + BckndErrorResponse: type: object properties: - labels: - $ref: '#/components/schemas/BckndResourceGroupLabels' - BckndEvent: + error: + $ref: '#/components/schemas/BckndError' + BckndError: type: object + required: + - code + - message properties: - tenantId: - description: tenant id - type: string - action: + code: type: string - enum: - - PROVISION - - DEPROVISION - state: + description: Descriptive error code (not http status code) + message: type: string - enum: - - SUCCESSFUL - - FAILED - - PENDING - description: - description: describes the event state + description: Plaintext error description + example: something went wrong + requestId: type: string - createdAt: + description: ID of the individual request + target: type: string - format: date-time - example: '2017-09-28T08:56:23.275Z' - BckndTenant: + description: Invoked URL + details: + description: Optional details of the error message + type: object + TntTenantInfo: type: object + required: + - tenantId + - servicePlan + - status properties: tenantId: description: tenant id type: string - zoneId: - description: zone id - type: string - realSubaccountId: - description: real sub account id - type: string + example: aa97b177-9383-4934-8543-0f91a7a0283a servicePlan: - description: service plan type: string - BckndobjectStoreSecretWithSensitiveDataRequest: + status: + description: Provisioning status of the tenant + type: string + TntApiError: type: object - description: This represents all the meta-data and extra information to be stored - as a k8-secret required: - - name - - type - - data + - code + - message properties: - name: - type: string - description: Name of the object store for the secret object to be created. - Can be used later on check for existence of the secret. - example: myobjectstore - type: - type: string - description: Storage type e.g. S3, GCS,... - example: S3 - bucket: - type: string - description: Bucket to be used - example: mybucket1 - endpoint: - type: string - description: Optional parameter - URL of the storage server (S3 only) - example: www.example.com - region: + code: type: string - description: Optional parameter - Region of the storage server (S3 only) - example: eu - pathPrefix: + description: Descriptive error code (not http status code) + message: type: string - description: prefix folder to be added to storage path - example: mp-api - verifyssl: + description: Plaintext error description + requestId: type: string - description: 0, 1 flag for the KF-serving annotation - serving.kubeflow.org/s3-verifyssl - example: '0' - usehttps: + description: ID of the individual request + target: type: string - description: 0, 1 flag for KF-serving annotations - serving.kubeflow.org/s3-usehttps - example: '1' - default: '1' - data: + description: Invoked URL + details: + description: Optional details of the error message type: object - description: key:value pairs of data - writeOnly: true - BckndobjectStoreSecretWithSensitiveDataRequestForPostCall: + AiScenario: type: object - description: This represents all the meta-data and extra information to be stored - as a k8-secret + description: 'An ML Scenario consists of a number of executables. E.g., there + can be one or several training executables, an inference (deployment) executable. + An ML Scenario is versioned. + + ' required: - name - - type - - data + - id + - createdAt + - modifiedAt properties: name: type: string - pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ - maxLength: 233 - description: Name of the object store for the secret object to be created. - Can be used later on check for existence of the secret. - example: myobjectstore - type: - type: string - description: Storage type e.g. S3, GCS,... - example: S3 - bucket: - type: string - description: Bucket to be used - example: mybucket1 - endpoint: - type: string - description: Optional parameter - URL of the storage server (S3 only) - example: www.example.com - region: - type: string - description: Optional parameter - Region of the storage server (S3 only) - example: eu - pathPrefix: + maxLength: 256 + description: Name of the scenario + description: type: string - description: prefix folder to be added to storage path - example: mp-api - verifyssl: + maxLength: 5000 + description: Description of the scenario + labels: + $ref: '#/components/schemas/AiScenarioLabelList' + id: + $ref: '#/components/schemas/AiScenarioId' + createdAt: type: string - description: 0, 1 flag for the KF-serving annotation - serving.kubeflow.org/s3-verifyssl - example: '0' - usehttps: + description: Timestamp of resource creation + format: date-time + modifiedAt: type: string - description: 0, 1 flag for KF-serving annotations - serving.kubeflow.org/s3-usehttps - example: '1' - default: '1' - data: - type: object - description: key:value pairs of data - writeOnly: true - BckndobjectStoreSecretStatusResponse: - description: This represents a list of meta-data of a stored secret. The 'data' - field of the secret is never retrieved. + format: date-time + description: Timestamp of latest resource modification + AiScenarioLabelList: + type: array + description: Arbitrary labels as meta information + items: + $ref: '#/components/schemas/AiScenarioLabel' + AiLabelList: + type: array + description: Arbitrary labels as meta information + items: + $ref: '#/components/schemas/AiLabel' + AiScenarioLabel: + type: object + required: + - key + - value + properties: + key: + $ref: '#/components/schemas/AiScenarioLabelKey' + value: + $ref: '#/components/schemas/AiLabelValue' + AiLabel: + type: object + required: + - key + - value + properties: + key: + $ref: '#/components/schemas/AiLabelKey' + value: + $ref: '#/components/schemas/AiLabelValue' + AiLabelValue: + type: string + maxLength: 5000 + AiScenarioLabelKey: + type: string + example: scenarios.ai.sap.com/s4hana-version + maxLength: 256 + pattern: ^(scenarios|ext)\.ai\.sap\.com\/[\w\.-]+$ + AiLabelKey: + type: string + example: ext.ai.sap.com/s4hana-version + maxLength: 256 + pattern: ^ext\.ai\.sap\.com\/[\w\.-]+$ + AiScenarioId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the scenario + AiScenarioList: type: object properties: count: @@ -5586,151 +5227,151 @@ components: resources: type: array items: - $ref: '#/components/schemas/BckndobjectStoreSecretStatus' + $ref: '#/components/schemas/AiScenario' required: - count - resources - BckndobjectStoreSecretStatus: + AiModelList: type: object - description: This represents the meta-data of a stored secret. The 'data' field - of the secret is never retrieved. properties: - metadata: - description: Key value pairs of meta-data assigned to the secret when the - secret was being created. - type: object - properties: - serving.kubeflow.org/s3-usehttps: - type: string - description: 0 and 1 values for setting the flag - example: '1' - serving.kubeflow.org/s3-verifyssl: - type: string - description: 0 and 1 values for setting the flag - example: '0' - serving.kubeflow.org/s3-endpoint: - type: string - description: Annotation for endpoint required by KF_Serving - example: some_endpoint - serving.kubeflow.org/s3-region: - type: string - description: Annotation for region required by KF_Serving - example: EU - storage.ai.sap.com/type: - type: string - description: Storage type of the secret - example: S3 - storage.ai.sap.com/bucket: - type: string - description: bucket assigned to the secret on creation - example: my_bucket - storage.ai.sap.com/endpoint: - type: string - description: Endpoint assigned to the secret on creation - example: some_endpoint - storage.ai.sap.com/region: - type: string - description: Region of the storage server - example: EU - storage.ai.sap.com/pathPrefix: - type: string - description: Pathprefix type assigned to the secret on creation. - example: mnist_folder - storage.ai.sap.com/hdfsNameNode: - type: string - description: name node of the HDFS file system - example: https://c3272xxxxxfa8f.files.hdl.canary-eu10.hanacloud.ondemand.com - storage.ai.sap.com/headers: - type: string - description: headers for webHDFS and other protocols - example: '{"x-sap-filecontainer": "c32727xxxxxxx322dcfa8f"}' - storage.ai.sap.com/containerUri: - type: string - description: container uri of azure storage - example: - https://sapcv842awjkfb2.blob.core.windows.net/sapcp-osaas-xxx-xxxx-xxxx-xxxx-xxxx-zrs - storage.ai.sap.com/subscriptionId: - type: string - description: subscription id - example: dgewg2-gkrwnegiw - storage.ai.sap.com/tenantId: - type: string - description: tenant id - example: dawd2120-dadwad2 - storage.ai.sap.com/projectId: - type: string - description: project id of google cloud platform - example: sap-gcp-oaas-us31-1 - name: - description: Name of objectstore - type: string - example: myobjectstore-object-store-secret - BckndobjectStoreSecretDeletionResponse: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/AiModelBaseData' + required: + - count + - resources + AiModelBaseData: type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndobjectStoreSecretDeletionResponseMessage' required: - - id - - message - BckndobjectStoreSecretDeletionResponseMessage: - type: string - description: Message - example: Object Store Secret has been deleted - BckndobjectStoreSecretCreationResponse: - type: object - description: Message - example: Created + - model + - executableId + - description + - versions properties: - message: - $ref: '#/components/schemas/BckndobjectStoreSecretCreationResponseMessage' - BckndobjectStoreSecretCreationResponseMessage: - type: string - description: Message - example: Secret has been created - BckndobjectStoreSecretModificationResponseMessage: - type: string - description: Message - example: Secret has been modified - BckndobjectStoreSecretModificationResponse: + model: + type: string + description: Name of the model + executableId: + $ref: '#/components/schemas/AiExecutableId' + description: + type: string + description: Description of the model and its capabilities + versions: + $ref: '#/components/schemas/AiModelVersionList' + displayName: + type: string + description: Display name of the model + accessType: + type: string + description: Access type of the model + provider: + type: string + description: Provider of the model + allowedScenarios: + type: array + description: List of scenarioId:executableId pair where the model supported + items: + type: object + required: + - scenarioId + - executableId + properties: + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + executableId: + $ref: '#/components/schemas/AiExecutableId' + AiModelVersionList: + type: array + description: List of model versions that the model object has + items: + $ref: '#/components/schemas/AiModelVersion' + AiModelVersion: type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndobjectStoreSecretModificationResponseMessage' + description: Model version information including whether it is latest version, + its deprecation status and optional retirement date required: - - id - - message - BcknddockerRegistryNameComponent: - description: Name of the docker Registry store for the secret. - type: string - pattern: ^[a-z0-9](?:_?[a-z0-9\.\-]+)*[a-z0-9]$ - maxLength: 63 - example: mydockeregistry - BcknddockerRegistrySecretWithSensitiveDataRequest: + - name + - isLatest + - deprecated + properties: + name: + type: string + description: Name of model version + isLatest: + type: boolean + description: Displays whether it is the latest version offered for the model + deprecated: + type: boolean + description: Deprecation status of model + retirementDate: + type: string + description: Retirement date of model in ISO 8601 timestamp + contextLength: + type: integer + description: Context length of the model + inputTypes: + type: array + description: List of input types supported by the model + items: + type: string + capabilities: + type: array + description: List of capabilities supported by the model + items: + type: string + metadata: + type: array + description: List of metadata supported by the model + items: + type: object + additionalProperties: + type: string + cost: + type: array + description: List of costs associated with the model + items: + type: object + additionalProperties: + type: string + suggestedReplacements: + type: array + description: List of suggested replacements for the model + items: + type: string + streamingSupported: + type: boolean + description: Streaming support status of the model + orchestrationCapabilities: + type: array + description: List of model capabilities supported by orchestration service + items: + type: string + AiVersion: type: object - description: This represents all the meta-data and extra information to be stored - as a k8-secret required: - - data + - id + - createdAt + - modifiedAt properties: - data: - type: object - required: - - .dockerconfigjson - description: key:value pairs of data - writeOnly: true - additionalProperties: false - properties: - .dockerconfigjson: - type: string - description: .dockerconfigjson data - BcknddockerRegistrySecretStatusResponse: - description: This represents a list of meta-data of a stored secret. The 'data' - field of the secret is never retrieved. + description: + $ref: '#/components/schemas/AiVersionDescription' + id: + $ref: '#/components/schemas/AiVersionId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + createdAt: + type: string + description: Timestamp of resource creation + format: date-time + modifiedAt: + type: string + format: date-time + description: Timestamp of latest resource modification + AiVersionList: type: object properties: count: @@ -5739,133 +5380,178 @@ components: resources: type: array items: - $ref: '#/components/schemas/BcknddockerRegistrySecretStatus' + $ref: '#/components/schemas/AiVersion' required: - count - resources - BcknddockerRegistrySecretStatus: + AiExecutable: + description: 'An ML executable consists of a set of ML tasks, flows between + tasks, dependencies between tasks, models (or model versions?). + + ' type: object - description: This represents the meta-data of a stored secret. The 'data' field - of the secret is never retrieved. + required: + - name + - id + - versionId + - deployable + - createdAt + - modifiedAt properties: + labels: + $ref: '#/components/schemas/AiLabelList' name: - description: Name of dockerRegistryStore type: string - example: mydockeregistry - BcknddockerRegistrySecretDeletionResponse: + description: Name of the executable + description: + type: string + description: Description of the executable + id: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + versionId: + $ref: '#/components/schemas/AiVersionId' + parameters: + $ref: '#/components/schemas/AiExecutableParameterList' + inputArtifacts: + $ref: '#/components/schemas/AiExecutableArtifactList' + outputArtifacts: + $ref: '#/components/schemas/AiExecutableArtifactList' + deployable: + type: boolean + description: Whether this executable is deployable + example: false + createdAt: + type: string + description: Timestamp of resource creation + format: date-time + modifiedAt: + type: string + format: date-time + description: Timestamp of latest resource modification + AiExecutableId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the executable + AiExecutableList: type: object properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BcknddockerRegistrySecretDeletionResponseMessage' + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/AiExecutable' required: - - id - - message - BcknddockerRegistrySecretDeletionResponseMessage: - type: string - description: Message - example: Docker Registry Secret has been deleted - BcknddockerRegistrySecretCreationResponse: + - count + - resources + AiExecutableParameter: type: object - description: Message - example: Created + required: + - name properties: - message: - $ref: '#/components/schemas/BcknddockerRegistrySecretCreationResponseMessage' - BcknddockerRegistrySecretCreationResponseMessage: - type: string - description: Message - example: Secret has been created - BcknddockerRegistrySecretModificationResponseMessage: - type: string - description: Message - example: Secret has been modified - BcknddockerRegistrySecretModificationResponse: - type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BcknddockerRegistrySecretModificationResponseMessage' - required: - - id - - message - BckndGenericSecretData: - description: Base64 encoded secret data - type: object - additionalProperties: - type: string - BckndGenericSecretPostBody: + name: + type: string + description: Name of the executable parameter + description: + type: string + description: Description of the signature argument + default: + type: string + description: Default value of the signature argument + type: + type: string + enum: + - string + description: Type of the executable parameter + AiExecutableParameterList: + type: array + description: Executable parameters + items: + $ref: '#/components/schemas/AiExecutableParameter' + AiExecutableArtifact: type: object required: - name - - data properties: name: - description: The name of the secret type: string - minLength: 1 - maxLength: 252 - pattern: ^[a-z0-9\-\.]+$ - data: - $ref: '#/components/schemas/BckndGenericSecretData' + description: Name of the executable input artifacts + kind: + type: string + description: Artifact kind (model, dataset, other) + description: + type: string + description: Description of the signature argument labels: - $ref: '#/components/schemas/BckndGenericSecretLabels' - BckndGenericSecretPatchBody: - type: object - required: - - data - properties: - data: - $ref: '#/components/schemas/BckndGenericSecretData' - BckndGenericSecretDataResponse: - type: object - properties: - message: - $ref: '#/components/schemas/BckndMessage' - name: - $ref: '#/components/schemas/BckndName' - BckndGenericSecretDetails: + $ref: '#/components/schemas/AiLabelList' + AiExecutableArtifactList: + type: array + description: Executable parameters + items: + $ref: '#/components/schemas/AiExecutableArtifact' + AiConfiguration: type: object - required: - - name - - createdAt properties: name: - description: Name of the secret - type: string + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + parameterBindings: + $ref: '#/components/schemas/AiParameterArgumentBindingList' + inputArtifactBindings: + $ref: '#/components/schemas/AiArtifactArgumentBindingList' + id: + $ref: '#/components/schemas/AiConfigurationId' createdAt: - description: Timestamp at which secret was created type: string - resourceGroupSecretsSyncStatus: - description: Sync status of the replicated secrets in all resource groups - of the tenant + description: Timestamp of resource creation + format: date-time + scenario: type: object - additionalProperties: - type: boolean - description: Resource group ID and sync status - BckndListGenericSecretsResponse: - description: This represents a list of meta-data of the secret. The 'data' field - of the secret is never retrieved. + nullable: true + anyOf: + - $ref: '#/components/schemas/AiScenario' + - {} + required: + - name + - executableId + - scenarioId + - id + - createdAt + AiConfigurationBaseData: type: object - properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/BckndGenericSecretDetails' required: - - count - - resources - BckndGenericSecretLabels: - type: array - description: Arbitrary labels as meta information - items: - $ref: '#/components/schemas/BckndGenericSecretLabel' - BckndGenericSecretLabel: + - name + - executableId + - scenarioId + properties: + name: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + parameterBindings: + $ref: '#/components/schemas/AiParameterArgumentBindingList' + inputArtifactBindings: + $ref: '#/components/schemas/AiArtifactArgumentBindingList' + AiConfigurationName: + type: string + pattern: ^[\w\s.!?,;:\[\](){}<>"'=+*/\\^&%@~$#|-]*$ + maxLength: 256 + description: Name of the configuration + AiConfigurationId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the configuration + AiParameterArgumentBinding: type: object required: - key @@ -5873,48 +5559,42 @@ components: properties: key: type: string - pattern: ^ext.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,48}$ - maxLength: 63 - example: ext.ai.sap.com/my-label + maxLength: 256 value: type: string maxLength: 5000 - BckndArgoCDRepositoryData: - type: object - required: - - url - - username - - password - properties: - name: - description: Name of the repository - type: string - minLength: 1 - maxLength: 51 - pattern: ^[a-z0-9\-]+$ - url: - description: URL of the repository to synchronise - type: string - username: - description: Username for read-access to the repository - type: string - password: - description: Password for read-access to the repository - type: string - BckndArgoCDRepositoryCredentials: + description: 'Required for execution + + Result of activation + + ' + AiParameterArgumentBindingList: + type: array + maxItems: 1000 + items: + $ref: '#/components/schemas/AiParameterArgumentBinding' + AiArtifactArgumentBinding: type: object required: - - username - - password + - key + - artifactId properties: - username: - description: Username for read-access to the repository - type: string - password: - description: Password for read-access to the repository + key: type: string - BckndArgoCDRepositoryDataResponse: - description: This represents a list of GitOps repositories for the tenant. + maxLength: 256 + artifactId: + $ref: '#/components/schemas/AiArtifactId' + description: 'Required for execution + + Result of activation + + ' + AiArtifactArgumentBindingList: + type: array + maxItems: 1000 + items: + $ref: '#/components/schemas/AiArtifactArgumentBinding' + AiConfigurationList: type: object properties: count: @@ -5923,110 +5603,131 @@ components: resources: type: array items: - $ref: '#/components/schemas/BckndArgoCDRepositoryDetails' + $ref: '#/components/schemas/AiConfiguration' required: - count - resources - BckndArgoCDRepositoryCreationResponse: + AiConfigurationCreationResponse: type: object properties: id: - $ref: '#/components/schemas/BckndId' + $ref: '#/components/schemas/AiId' message: - $ref: '#/components/schemas/BckndArgoCDRepositoryCreationResponseMessage' + $ref: '#/components/schemas/AiConfigurationCreationResponseMessage' required: - id - message - BckndArgoCDRepositoryCreationResponseMessage: + AiConfigurationCreationResponseMessage: type: string description: Message - example: Repository has been on-boarded - BckndArgoCDRepositoryDetails: + example: Configuration created + AiDeploymentTargetStatus: + type: string + description: Status + enum: + - STOPPED + example: STOPPED + AiDeploymentStatus: + type: string + description: Deployment status + enum: + - PENDING + - RUNNING + - COMPLETED + - DEAD + - STOPPING + - STOPPED + - UNKNOWN + example: COMPLETED + AiDeploymentStatusMessage: + type: string + description: Deployment status message + maxLength: 256 + AiDeploymentStatusDetails: type: object - description: Repository details - properties: - name: - description: The name of the repository - type: string - url: - description: The repository URL - type: string - status: - description: The status of the repository's on-boarding - type: string - enum: - - ERROR - - IN-PROGRESS - - COMPLETED - example: COMPLETED - BckndArgoCDRepositoryDeletionResponse: - type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndArgoCDRepositoryDeletionResponseMessage' - required: - - id - - message - BckndArgoCDRepositoryDeletionResponseMessage: + description: Current status details of the deployment + AiExecutionStatus: type: string - description: Message - example: The repository has been off-boarded. - BckndArgoCDRepositoryModificationResponse: - type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndArgoCDRepositoryModificationResponseMessage' - required: - - id - - message - BckndArgoCDRepositoryModificationResponseMessage: + description: Execution status + enum: + - PENDING + - RUNNING + - COMPLETED + - DEAD + - STOPPING + - STOPPED + - UNKNOWN + example: COMPLETED + AiExecutionStatusMessage: type: string - description: Message - example: ArgoCD application has been updated - BckndArgoCDApplicationBaseData: + description: Execution status message + maxLength: 256 + AiExecutionStatusDetails: type: object - required: - - repositoryUrl - - revision - - path + description: Current status details of the execution + AiExecution: + type: object + description: Execution that may generate artifacts properties: - repositoryUrl: - description: URL of the repository to synchronise - type: string - revision: - description: revision to synchronise + id: + $ref: '#/components/schemas/AiExecutionId' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + configurationName: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + targetStatus: type: string - path: - description: path within the repository to synchronise + description: Target status of the execution + enum: + - COMPLETED + - RUNNING + - STOPPED + - DELETED + example: STOPPED + status: + $ref: '#/components/schemas/AiExecutionStatus' + statusMessage: + $ref: '#/components/schemas/AiExecutionStatusMessage' + outputArtifacts: + $ref: '#/components/schemas/AiArtifactArray' + executionScheduleId: + $ref: '#/components/schemas/AiExecutionScheduleId' + createdAt: type: string - BckndArgoCDApplicationData: - type: object - properties: - repositoryUrl: - description: URL of the repository to synchronise + description: Timestamp of resource creation + format: date-time + modifiedAt: type: string - revision: - description: revision to synchronise + format: date-time + description: Timestamp of latest resource modification + submissionTime: type: string - path: - description: path within the repository to synchronise + format: date-time + description: Timestamp of job submitted + startTime: type: string - applicationName: - description: ArgoCD application name + format: date-time + description: Timestamp of job status changed to RUNNING + completionTime: type: string - minLength: 3 - maxLength: 54 - pattern: ^[a-z0-9\-]+$ + format: date-time + description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED required: - - repositoryUrl - - revision - - path - BckndAllArgoCDApplicationData: - description: list of applications + - id + - configurationId + - status + - createdAt + - modifiedAt + AiExecutionId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the execution + AiExecutionList: type: object properties: count: @@ -6035,506 +5736,863 @@ components: resources: type: array items: - $ref: '#/components/schemas/BckndArgoCDApplicationData' + $ref: '#/components/schemas/AiExecution' required: - count - resources - BckndArgoCDApplicationDataRepoName: - type: object - required: - - repositoryName - - revision - - path - properties: - repositoryName: - description: Name of the repository to synchronise - type: string - revision: - description: revision to synchronise - type: string - path: - description: path within the repository to synchronise - type: string - applicationName: - description: ArgoCD application name - type: string - minLength: 3 - maxLength: 54 - pattern: ^[a-z0-9\-]+$ - BckndArgoCDApplicationStatus: - type: object - description: ArgoCD application definition and status - properties: - healthStatus: - description: ArgoCD application health status - type: string - syncStatus: - description: ArgoCD application sync status - type: string - message: - description: ArgoCD application health status message - type: string - source: - description: Information about the ArgoCD application itself - type: object - properties: - repoURL: - description: URL of the repository - type: string - path: - description: Path of the repository - type: string - revision: - description: Revision number of the ArgoCD application - type: string - syncFinishedAt: - description: Gets the timestamp information related to the sync state of - the ArgoCD application - type: string - syncStartedAt: - description: Get timestamp information related to the sync state of the - ArgoCD application - type: string - reconciledAt: - description: Get timestamp information related to the sync state of the - ArgoCD application - type: string - syncResourcesStatus: - description: Status of all resources that need to be synchronized with the - gitops repo - type: array - items: - type: object - properties: - name: - description: ArgoCD application object name - type: string - kind: - description: ArgoCD application object kind - type: string - status: - description: ArgoCD application object sync status - type: string - message: - description: ArgoCD application object message - type: string - syncRessourcesStatus: - deprecated: true - description: Status of all resources that need to be synchronized with the - gitops repo. Misspelled and deprecated, use syncResourcesStatus instead. - type: array - items: - type: object - properties: - name: - description: ArgoCD application object name - type: string - kind: - description: ArgoCD application object kind - type: string - status: - description: ArgoCD application object sync status - type: string - message: - description: ArgoCD application object message - type: string - BckndArgoCDApplicationDeletionResponse: + AiExecutionCreationResponse: type: object properties: id: - $ref: '#/components/schemas/BckndId' + $ref: '#/components/schemas/AiId' message: - $ref: '#/components/schemas/BckndArgoCDApplicationDeletionResponseMessage' + $ref: '#/components/schemas/AiExecutionCreationResponseMessage' + status: + $ref: '#/components/schemas/AiExecutionStatus' required: - id - message - BckndArgoCDApplicationDeletionResponseMessage: + AiExecutionCreationResponseMessage: type: string description: Message - example: ArgoCD application has been deleted - BckndArgoCDApplicationCreationResponse: + example: Execution scheduled + AiExecutionModificationRequest: type: object + description: Request object for changing the target status of an execution (currently + only STOPPED is supported) + required: + - targetStatus properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndArgoCDApplicationCreationResponseMessage' + targetStatus: + type: string + description: Desired target status of the execution (currently only STOPPED + is supported) + enum: + - STOPPED + AiExecutionModificationRequestWithIdentifier: required: + - targetStatus - id - - message - BckndArgoCDApplicationCreationResponseMessage: - type: string - description: Message - example: ArgoCD application has been created - BckndArgoCDApplicationModificationResponse: type: object properties: id: - $ref: '#/components/schemas/BckndId' + $ref: '#/components/schemas/AiExecutionId' + targetStatus: + type: string + description: Desired target status of the execution (currently STOPPED and + DELETED are supported) + enum: + - STOPPED + - DELETED + description: Request object for changing the target status of an execution (currently + STOPPED and DELETED are supported) + AiExecutionModificationRequestList: + type: array + items: + $ref: '#/components/schemas/AiExecutionModificationRequestWithIdentifier' + uniqueItems: true + minItems: 1 + maxItems: 100 + example: + - id: aa97b177-9383-4934-8543-0f91a7a0283a + targetStatus: STOPPED + - id: qweq32131-qwee-1231-8543-0f91a7a2e2e + targetStatus: DELETED + AiExecutionBulkModificationRequest: + type: object + description: Request object to change status of multiple executions + properties: + executions: + $ref: '#/components/schemas/AiExecutionModificationRequestList' + AiExecutionModificationResponse: + type: object + properties: + id: + $ref: '#/components/schemas/AiId' message: - $ref: '#/components/schemas/BckndArgoCDApplicationModificationResponseMessage' + $ref: '#/components/schemas/AiExecutionModificationResponseMessage' required: - id - message - BckndArgoCDApplicationModificationResponseMessage: - type: string - description: Message - example: ArgoCD application has been updated - BckndArgoCDApplicationRefreshResponse: + AiExecutionModificationResponseList: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AiExecutionModificationResponse' + - $ref: '#/components/schemas/AiApiErrorWithId' + AiExecutionBulkModificationResponse: + type: object + description: Response object with array of executions and its status + properties: + executions: + $ref: '#/components/schemas/AiExecutionModificationResponseList' + AiExecutionDeletionResponse: type: object properties: id: - $ref: '#/components/schemas/BckndId' + $ref: '#/components/schemas/AiId' message: - $ref: '#/components/schemas/BckndArgoCDApplicationRefreshResponseMessage' + $ref: '#/components/schemas/AiExecutionDeletionResponseMessage' required: - id - message - BckndArgoCDApplicationRefreshResponseMessage: + AiExecutionDeletionResponseMessage: type: string description: Message - example: Refresh of ArgoCD application has been scheduled - BckndServiceList: - type: object - properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/BckndService' - required: - - count - - resources - BckndService: + example: Execution deletion scheduled + AiExecutionModificationResponseMessage: + type: string + description: Message + example: Execution modification scheduled + AiExecutionResponseWithDetails: type: object + description: Execution that may generate artifacts properties: - name: - description: service name + id: + $ref: '#/components/schemas/AiExecutionId' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + configurationName: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + targetStatus: type: string - description: - description: service description + description: Target status of the execution + enum: + - COMPLETED + - RUNNING + - STOPPED + - DELETED + example: STOPPED + status: + $ref: '#/components/schemas/AiExecutionStatus' + statusMessage: + $ref: '#/components/schemas/AiExecutionStatusMessage' + outputArtifacts: + $ref: '#/components/schemas/AiArtifactArray' + executionScheduleId: + $ref: '#/components/schemas/AiExecutionScheduleId' + createdAt: type: string - url: - description: service broker url + description: Timestamp of resource creation + format: date-time + modifiedAt: type: string - status: - description: aggregated status of the service + format: date-time + description: Timestamp of latest resource modification + submissionTime: type: string - enum: - - PROVISIONED - - ERROR - - PROVISIONING - - DEPROVISIONING - statusMessage: - description: status message + format: date-time + description: Timestamp of job submitted + startTime: type: string - BckndExtendedService: + format: date-time + description: Timestamp of job status changed to RUNNING + completionTime: + type: string + format: date-time + description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED + statusDetails: + $ref: '#/components/schemas/AiExecutionStatusDetails' + required: + - id + - configurationId + - status + - createdAt + - modifiedAt + AiExecutionSchedule: type: object + description: Data about execution schedule + required: + - configurationId + - cron + - name + - createdAt + - modifiedAt properties: + cron: + $ref: '#/components/schemas/AiCron' name: - description: service name + maxLength: 256 type: string - description: - description: service description + description: Name of the execution schedule + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + start: type: string - url: - description: service broker url + description: Timestamp, defining when the executions should start running + periodically, defaults to now + format: date-time + end: type: string - brokerSecret: - $ref: '#/components/schemas/BckndServiceBrokerSecret' - capabilities: - $ref: '#/components/schemas/BckndServiceCapabilities' - serviceCatalog: - $ref: '#/components/schemas/BckndServiceServiceCatalog' - sharedResourceGroupStatus: - $ref: '#/components/schemas/BckndSharedResourceGroupStatus' + description: Timestamp, defining when the executions should stop running + format: date-time + id: + $ref: '#/components/schemas/AiExecutionScheduleId' status: - description: aggregated status of the service + $ref: '#/components/schemas/AiExecutionScheduleStatus' + createdAt: type: string - enum: - - PROVISIONED - - ERROR - - PROVISIONING - - DEPROVISIONING - statusMessage: - description: status message + description: Timestamp of resource creation + format: date-time + modifiedAt: type: string - BckndServiceBrokerSecret: + format: date-time + description: Timestamp of latest resource modification + AiExecutionScheduleId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the execution schedule + AiExecutionScheduleStatus: + type: string + description: Execution Schedule Status + enum: + - ACTIVE + - INACTIVE + example: ACTIVE + AiCron: + type: string + description: Cron defining the schedule to run the executions. + example: 0 0 0 1 * + AiExecutionScheduleCreationData: type: object + description: Start and end an execution schedule. properties: + cron: + $ref: '#/components/schemas/AiCron' name: - description: broker secret name + maxLength: 256 type: string - passwordKeyRef: - description: username key reference in broker secret + description: Name of the execution schedule + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + start: type: string - usernameKeyRef: - description: password key reference in broker secret + description: Timestamp, defining when the executions should start running + periodically, defaults to now + format: date-time + end: type: string - BckndServiceCapabilities: - type: object - properties: - logs: - description: Capabilities to read logs from deployments and executions. - type: object - properties: - deployments: - type: boolean - executions: - type: boolean - basic: - description: Basic capabilities like creating deployments and executions. - type: object - properties: - staticDeployments: - description: There are static always running endpoints that can be used - for inference without the need to do user deployments. - type: boolean - userDeployments: - description: Services that only support batch inference typically neither - allow listing nor creation of deployments. For these, userDeployments - == false - type: boolean - createExecutions: - description: Services that only support deployment typically neither - allow create executions. For these, createExecutions == false - type: boolean - multitenant: - description: true-> AI API implementation supports resource groups (Main - Tenant scenario), false-> implementation does not support resource - groups (Service Tenant scenario) - type: boolean - BckndServiceServiceCatalog: - type: array - items: - $ref: '#/components/schemas/BckndServiceServiceCatalogItem' - BckndServiceServiceCatalogItem: + description: Timestamp, defining when the executions should stop running + format: date-time + required: + - configurationId + - cron + - name + AiExecutionScheduleList: type: object properties: - extendCatalog: - $ref: '#/components/schemas/BckndServiceServiceCatalogItemExtendCatalog' - extendCredentials: - $ref: '#/components/schemas/BckndServiceServiceCatalogItemExtendCredentials' - BckndServiceServiceCatalogItemExtendCatalog: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/AiExecutionSchedule' + required: + - count + - resources + AiExecutionScheduleModificationRequest: type: object + description: Request object for changing the execution schedule properties: - bindable: - description: if the service is bindable - type: boolean - description: - description: description of the service - type: string - id: - description: id of the service + cron: + $ref: '#/components/schemas/AiCron' + start: type: string - name: - description: name of the service + description: Timestamp, defining when the executions should start running + periodically, defaults to now + format: date-time + end: type: string - plans: - type: array - items: - $ref: '#/components/schemas/BckndServiceServicePlanItem' - BckndServiceServicePlanItem: + description: Timestamp, defining when the executions should stop running + format: date-time + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + status: + $ref: '#/components/schemas/AiExecutionScheduleStatus' + AiExecutionScheduleModificationResponse: type: object properties: - description: - description: description of the service plan - type: string - free: - description: if the service plan free - type: boolean id: - description: id of the service plan - type: string - name: - description: name of the service plan - type: string - metadata: - $ref: '#/components/schemas/BckndServiceServicePlanItemMetadata' - BckndServiceServicePlanItemMetadata: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiExecutionScheduleModificationResponseMessage' + required: + - id + - message + AiExecutionScheduleModificationResponseMessage: + type: string + description: Message + example: Execution Schedule modified + AiExecutionScheduleDeletionResponse: type: object properties: - supportedPlatforms: - description: supported platforms of the service plan - type: array - items: - type: string - enum: - - cloudfoundry - - kubernetes - - sapbtp - BckndServiceServiceCatalogItemExtendCredentials: + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiExecutionScheduleDeletionResponseMessage' + required: + - id + - message + AiExecutionScheduleDeletionResponseMessage: + type: string + description: Message + example: Execution Schedule deleted + AiExecutionScheduleCreationResponse: type: object properties: - shared: - type: object - properties: - serviceUrls: - type: object - properties: - AI_API_URL: - type: string - BckndSharedResourceGroupStatus: + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiExecutionScheduleCreationResponseMessage' + required: + - id + - message + AiExecutionScheduleCreationResponseMessage: + type: string + description: Message + example: Execution Schedule created + AiDeployment: type: object + description: Detailed data about a deployment properties: - isEnabled: - description: indicates whether shared resource group is enabled - type: boolean id: - description: shared resource group id + $ref: '#/components/schemas/AiDeploymentId' + deploymentUrl: + $ref: '#/components/schemas/AiDeploymentUrl' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + configurationName: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + status: + $ref: '#/components/schemas/AiDeploymentStatus' + statusMessage: + $ref: '#/components/schemas/AiDeploymentStatusMessage' + targetStatus: type: string - state: - description: current state of shared resource group + description: Deployment target status + enum: + - RUNNING + - STOPPED + - DELETED + lastOperation: type: string - BckndDeploymentResourceQuotaResponse: - type: object + description: Last operation applied to this deployment. + anyOf: + - enum: + - CREATE + - UPDATE + - DELETE + - CASCADE-UPDATE + - {} + latestRunningConfigurationId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: configurationId that was running before a PATCH operation has + modified the configurationId of the deployment. This can be used for a + manual rollback in case the new configurationId results in a DEAD deployment + ttl: + $ref: '#/components/schemas/AiDeploymentTimeToLive' + details: + $ref: '#/components/schemas/AiDeploymentDetails' + createdAt: + type: string + description: Timestamp of resource creation + format: date-time + modifiedAt: + type: string + format: date-time + description: Timestamp of latest resource modification + submissionTime: + type: string + format: date-time + description: Timestamp of job submitted + startTime: + type: string + format: date-time + description: Timestamp of job status changed to RUNNING + completionTime: + type: string + format: date-time + description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED required: - - quotas - properties: - usage: - $ref: '#/components/schemas/BckndDeploymentUsage' - quotas: - type: array - items: - $ref: '#/components/schemas/BckndDeploymentQuotaItem' - BckndDeploymentUsage: - type: object - required: - - count - - items + - id + - configurationId + - status + - createdAt + - modifiedAt + AiDeploymentId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the deployment + AiDeploymentUrl: + description: Consumption URL of the deployment + type: string + format: url + AiDeploymentList: + type: object properties: count: type: integer - items: + description: Number of the resource instances in the list + resources: type: array items: - $ref: '#/components/schemas/BckndUsageResourcePlanItem' - BckndUsageResourcePlanItem: + $ref: '#/components/schemas/AiDeployment' + required: + - count + - resources + AiDeploymentCreationResponse: + type: object + properties: + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiDeploymentCreationResponseMessage' + deploymentUrl: + $ref: '#/components/schemas/AiDeploymentUrl' + status: + $ref: '#/components/schemas/AiExecutionStatus' + ttl: + $ref: '#/components/schemas/AiDeploymentTimeToLive' + required: + - id + - message + AiDeploymentCreationResponseMessage: + type: string + description: Message + example: Deployment scheduled + AiEnactmentCreationRequest: + type: object + description: Request object for creating an execution or an deployment + required: + - configurationId + properties: + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + AiDeploymentCreationRequest: + type: object + description: Request object for creating an execution or an deployment + required: + - configurationId + properties: + ttl: + $ref: '#/components/schemas/AiDeploymentTimeToLive' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + AiDeploymentModificationRequest: + type: object + description: Request object for changing the target status of a deployment (currently + only STOPPED is supported) + properties: + targetStatus: + $ref: '#/components/schemas/AiDeploymentTargetStatus' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + AiDeploymentModificationRequestWithIdentifier: + type: object + required: + - targetStatus + - id + properties: + id: + $ref: '#/components/schemas/AiDeploymentId' + targetStatus: + type: string + description: Deployment target status + enum: + - STOPPED + - DELETED + description: Request object for changing the target status of a deployment ( + STOPPED and DELETED are supported) + AiDeploymentModificationRequestList: + type: array + items: + $ref: '#/components/schemas/AiDeploymentModificationRequestWithIdentifier' + uniqueItems: true + minItems: 1 + maxItems: 100 + example: + - id: aa97b177-9383-4934-8543-0f91a7a0283a + targetStatus: STOPPED + - id: qweq32131-qwee-1231-8543-0f91a7a2e2e + targetStatus: DELETED + AiDeploymentBulkModificationRequest: + type: object + description: Request object for changing the target status of multiple deployments + properties: + deployments: + $ref: '#/components/schemas/AiDeploymentModificationRequestList' + AiDeploymentModificationResponse: + type: object + properties: + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiDeploymentModificationResponseMessage' + required: + - id + - message + AiDeploymentModificationResponseList: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AiDeploymentModificationResponse' + - $ref: '#/components/schemas/AiApiErrorWithId' + AiDeploymentBulkModificationResponse: + type: object + description: Response object with array of deployments + properties: + deployments: + $ref: '#/components/schemas/AiDeploymentModificationResponseList' + AiDeploymentDeletionResponse: + type: object + properties: + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiDeploymentDeletionResponseMessage' + required: + - id + - message + AiDeploymentModificationResponseMessage: + type: string + description: Message + example: Deployment modification scheduled + AiDeploymentDeletionResponseMessage: + type: string + description: Message + example: Deployment deletion scheduled + AiDeploymentResponseWithDetails: type: object + description: Detail properties of the deployment + properties: + id: + $ref: '#/components/schemas/AiDeploymentId' + deploymentUrl: + $ref: '#/components/schemas/AiDeploymentUrl' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + configurationName: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + status: + $ref: '#/components/schemas/AiDeploymentStatus' + statusMessage: + $ref: '#/components/schemas/AiDeploymentStatusMessage' + targetStatus: + type: string + description: Deployment target status + enum: + - RUNNING + - STOPPED + - DELETED + lastOperation: + type: string + description: Last operation applied to this deployment. + anyOf: + - enum: + - CREATE + - UPDATE + - DELETE + - CASCADE-UPDATE + - {} + latestRunningConfigurationId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: configurationId that was running before a PATCH operation has + modified the configurationId of the deployment. This can be used for a + manual rollback in case the new configurationId results in a DEAD deployment + ttl: + $ref: '#/components/schemas/AiDeploymentTimeToLive' + details: + $ref: '#/components/schemas/AiDeploymentDetails' + createdAt: + type: string + description: Timestamp of resource creation + format: date-time + modifiedAt: + type: string + format: date-time + description: Timestamp of latest resource modification + submissionTime: + type: string + format: date-time + description: Timestamp of job submitted + startTime: + type: string + format: date-time + description: Timestamp of job status changed to RUNNING + completionTime: + type: string + format: date-time + description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED + statusDetails: + $ref: '#/components/schemas/AiDeploymentStatusDetails' + required: + - id + - configurationId + - status + - createdAt + - modifiedAt + AiBackendDetails: + type: object + description: backend-specific details of the deployment + AiScalingDetails: + type: object + description: Scaling details of a deployment + example: + backendDetails: + predictor: + minReplicas: 0 + maxReplicas: 2 + runningReplicas: 1 + properties: + backendDetails: + $ref: '#/components/schemas/AiBackendDetails' + AiResourcesDetails: + type: object + description: Resources details of a deployment + example: + backendDetails: + predictor: + resourcePlan: starter + properties: + backendDetails: + $ref: '#/components/schemas/AiBackendDetails' + AiDeploymentDetails: + type: object + description: 'Detail information about a deployment (including predefined sections: + `scaling` and `resources`). + + JSON String representation of this object is limited to 5000 characters + + ' + properties: + scaling: + $ref: '#/components/schemas/AiScalingDetails' + resources: + $ref: '#/components/schemas/AiResourcesDetails' + AiDeploymentTimeToLive: + type: string + description: Time to live for a deployment. Its value can be either null or + a number followed by the unit (any of following values, minutes(m|M), hours(h|H) + or days(d|D)) + nullable: true + pattern: ^[0-9]+[m,M,h,H,d,D]$ + example: 24H + AiArtifact: + description: 'Base data of the artifact; this is the data that can be provided + when the artifact is created; `name` and `kind` are required because they + constitute important semantic filtering criteria for use in training / inference + executables (`name` is a semantic handle of the artifact within a scenario + and `kind` specifies the type of usage, e.g. you would only want to allow + models in the model operator). + + ' + type: object + properties: + labels: + $ref: '#/components/schemas/AiLabelList' + name: + $ref: '#/components/schemas/AiArtifactName' + kind: + type: string + enum: + - model + - dataset + - resultset + - other + description: Kind of the artifact, i.e. model or dataset + url: + $ref: '#/components/schemas/AiArtifactUrl' + description: + $ref: '#/components/schemas/AiArtifactDescription' + id: + $ref: '#/components/schemas/AiArtifactId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + executionId: + $ref: '#/components/schemas/AiExecutionId' + createdAt: + type: string + description: Timestamp of resource creation + format: date-time + modifiedAt: + type: string + format: date-time + description: Timestamp of latest resource modification + scenario: + type: object + nullable: true + anyOf: + - $ref: '#/components/schemas/AiScenario' + - {} + required: + - name + - kind + - url + - id + - scenarioId + - createdAt + - modifiedAt + AiArtifactDescription: + type: string + maxLength: 5000 + description: Description of the artifact + AiArtifactPostData: + type: object + description: 'Base data of the artifact; this is the data that can be provided + when the artifact is created; `name` and `kind` are required because they + constitute important semantic filtering criteria for use in training / inference + executables (`name` is a semantic handle of the artifact within a scenario + and `kind` specifies the type of usage, e.g. you would only want to allow + models in the model operator). + + ' required: - - id + - name + - kind + - url + - scenarioId properties: - id: - type: string - resourcePlanType: + labels: + $ref: '#/components/schemas/AiLabelList' + name: + $ref: '#/components/schemas/AiArtifactName' + kind: type: string - configuredMaxReplicas: - type: integer - BckndDeploymentQuotaItem: + enum: + - model + - dataset + - resultset + - other + description: Kind of the artifact, i.e. model or dataset + url: + $ref: '#/components/schemas/AiArtifactUrl' + description: + $ref: '#/components/schemas/AiArtifactDescription' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + AiArtifactCreationResponse: type: object + required: + - id + - message + - url properties: - resourcePlanType: - type: string - deploymentQuota: - $ref: '#/components/schemas/BckndDeploymentQuota' - BckndDeploymentQuota: + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiArtifactCreationResponseMessage' + url: + $ref: '#/components/schemas/AiArtifactUrl' + AiArtifactCreationResponseMessage: + type: string + description: Message + example: Artifact acknowledged + AiArtifactId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the artifact + AiArtifactName: + type: string + pattern: ^[\w\s.!?,;:\[\](){}<>"'=+*/\\^&%@~$#|-]*$ + maxLength: 256 + description: Name of the artifact + AiArtifactUrl: + type: string + pattern: ([a-z0-9-]+):\/\/.+ + maxLength: 1024 + example: https://example.com/some_path + description: 'Reference to the location of the artifact. + + ' + AiArtifactList: type: object properties: - maxCount: - type: integer - description: The value can be 0(disabled) or a positive integer defining - the maximum allowed number - example: 10 - maxReplicaPerDeployment: + count: type: integer - BckndCommonResourceQuotaResponse: - type: object - required: - - quota - properties: - usage: - type: object - properties: - count: - type: integer - quota: - type: object - properties: - maxCount: - type: integer - description: The value can be 0(disabled) or a positive integer defining - the maximum allowed number - example: 10 - BckndExecutableResourceQuotaResponse: - type: object + description: Number of the resource instances in the list + resources: + $ref: '#/components/schemas/AiArtifactArray' required: - - quota - properties: - usage: - type: object - properties: - servingTemplateCount: - type: integer - workflowTemplateCount: - type: integer - quota: - type: object - properties: - servingTemplateMaxCount: - type: integer - description: The value can be 0(disabled) or a positive integer defining - the maximum allowed number - example: 10 - workflowTemplateMaxCount: - type: integer - description: The value can be 0(disabled) or a positive integer defining - the maximum allowed number - example: 10 - BckndResourcePatchBody: + - count + - resources + AiArtifactArray: + type: array + items: + $ref: '#/components/schemas/AiArtifact' + AiLogCommonData: type: object - required: - - resourcePlans properties: - resourcePlans: - $ref: '#/components/schemas/BckndResourcePatchResourcePlans' - BckndResourcePatchResourcePlans: + result: + $ref: '#/components/schemas/AiLogCommonResult' + AiLogCommonResult: type: array items: - $ref: '#/components/schemas/BckndResourcePatchNodes' - BckndResourcePatchNodes: + $ref: '#/components/schemas/AiLogCommonResultItem' + AiLogCommonResultItem: type: object - required: - - name - - request + description: Common log record. properties: - name: + timestamp: + description: Datetime in RFC 3339. type: string - request: - type: integer - BckndResourcePatchResponse: - type: object - required: - - message - properties: - message: + format: date-time + example: '2021-05-19T00:00:14.347+00:00' + msg: + description: message content. type: string - BckndResourceGetResponse: + AiId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: Generic ID + AiVersionId: + description: Version ID + type: string + AiVersionDescription: + type: string + maxLength: 5000 + example: This is version v1 + description: Version description + AiCreationResponseMessage: + type: string + description: Message + example: Created + AiUrl: + type: string + format: url + AiApiErrorWithId: type: object required: - - resourcePlans - properties: - resourcePlans: - $ref: '#/components/schemas/BckndResourceGetResourcePlans' - BckndResourceGetResourcePlans: - type: object - additionalProperties: - type: object - required: - - provisioned - - requested - properties: - provisioned: - type: integer - requested: - type: integer - BckndErrorResponse: - type: object + - id + - error properties: + id: + $ref: '#/components/schemas/AiId' error: - $ref: '#/components/schemas/BckndError' - BckndError: + $ref: '#/components/schemas/AiApiError' + AiApiError: type: object required: - code @@ -6546,7 +6604,6 @@ components: message: type: string description: Plaintext error description - example: something went wrong requestId: type: string description: ID of the individual request @@ -6557,6 +6614,162 @@ components: description: Optional details of the error message type: object parameters: + KpiquerySelect: + name: $select + description: Columns to select + in: query + required: false + schema: + uniqueItems: true + type: array + readOnly: true + default: + - ResourceGroup + - Executions + - Artifacts + - Deployments + items: + $ref: '#/components/schemas/KpiColumnName' + style: form + explode: false + RTAtokenHeader: + name: Authorization + in: header + description: Authorization bearer token containing a JWT token. + required: false + schema: + type: string + RTAlimit: + in: query + name: $top + description: The max number of entries to return. Defaults to 1000. Limited + to 5000 max. + required: false + schema: + type: integer + minimum: 1 + maximum: 5000 + default: 1000 + examples: + min: + value: 1 + summary: Min number of entries to return + max: + value: 5000 + summary: Max number of entries to return + default: + value: 1000 + summary: default number of entries to return + RTAstart: + name: start + in: query + description: The start time for the query as a RFC 3339 datetime format. Defaults + to one hour ago. + in timezone need to be encoded to %2B. + required: false + schema: + type: string + format: date-time + examples: + zulu: + value: '2021-05-19T00:00:14.347Z' + summary: Datetime example use Z as timezone + utc: + value: 2021-05-19T00:00:14.347%2B00:00 + summary: Datetime example use +00:00 as timezone, where + is encoded to + %2B + local-plus: + value: 2021-05-19T08:00:14.347%2B08:00 + summary: Datetime example use +08:00 as timezone, where + is encoded to + %2B + local-minus: + value: '2021-05-18T16:00:14.347-08:00' + summary: Datetime example use -08:00 as timezone + RTAend: + name: end + in: query + description: The end time for the query as a RFC 3339 datetime format. Defaults + to now. + in timezone need to be encoded to %2B. + required: false + schema: + type: string + format: date-time + examples: + zulu: + value: '2021-05-19T01:00:14.347Z' + summary: Datetime example use Z as timezone + utc: + value: 2021-05-19T01:00:14.347%2B00:00 + summary: Datetime example use +00:00 as timezone, where + is encoded to + %2B + local-plus: + value: 2021-05-19T09:00:14.347%2B08:00 + summary: Datetime example use +08:00 as timezone, where + is encoded to + %2B + local-minus: + value: '2021-05-18T17:00:14.347-08:00' + summary: Datetime example use -08:00 as timezone + RTAorder: + name: $order + in: query + description: "Determines the sort order. Supported values are asc or desc. Defaults + to asc. Sort order:\n * `asc` - Ascending, earliest in the order will appear + at the top of the list\n * `desc` - Descending, last in the order will appear + at the top of the list\n" + required: false + schema: + type: string + enum: + - asc + - desc + examples: + asc: + value: asc + summary: Sort the results in ascending order + desc: + value: desc + summary: Sort the results in descending order + RTAexecutionId: + name: executionId + description: Execution identifier + in: path + required: true + schema: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + RTAdeploymentId: + name: deploymentId + description: Deployment identifier + in: path + required: true + schema: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + DSetresourceGroupHeader: + in: header + name: AI-Resource-Group + description: Specify a resource group id + schema: + type: string + required: false + DSetpath: + name: path + in: path + required: true + schema: + type: string + format: path + pattern: ^(([\w.-]+):([\w.-]+)|([\w.-]+))(/([\w./-]+[\w.-]+)?)?$ + maxLength: 1024 + description: path relative to the object store root URL in the secret + DSetoverwrite: + name: overwrite + in: query + required: false + schema: + type: boolean + description: If true, then file is overwritten. Default is false. TrckqueryFilter: example: executionId eq 'aa97b177-9383-4934-8543-0f91b7a0283a' name: $filter @@ -6645,120 +6858,148 @@ components: type: integer example: 10 x-visible: false - RTAtokenHeader: + BckndtokenHeader: name: Authorization in: header description: Authorization bearer token containing a JWT token. required: false schema: type: string - RTAlimit: - in: query + Bckndai-resource-group: + name: AI-Resource-Group + in: header + description: Specify an existing resource group id to use + required: false + schema: + type: string + Bckndai-resource-group-default: + name: AI-Resource-Group + in: header + description: Specify an existing resource group id to use. Uses "default" if + value not provided. + required: false + schema: + type: string + default: default + Bckndai-tenant-scope: + name: AI-Tenant-Scope + in: header + description: Specify whether the main tenant scope is to be used + required: false + schema: + type: boolean + example: true + Bckndtop: name: $top - description: The max number of entries to return. Defaults to 1000. Limited - to 5000 max. + description: Number of results to display + in: query required: false schema: type: integer - minimum: 1 - maximum: 5000 - default: 1000 - examples: - min: - value: 1 - summary: Min number of entries to return - max: - value: 5000 - summary: Max number of entries to return - default: - value: 1000 - summary: default number of entries to return - RTAstart: - name: start + minimum: 0 + example: 10 + Bckndskip: + name: $skip + description: Number of results to be skipped from the ordered list of results in: query - description: The start time for the query as a RFC 3339 datetime format. Defaults - to one hour ago. + in timezone need to be encoded to %2B. required: false schema: - type: string - format: date-time - examples: - zulu: - value: '2021-05-19T00:00:14.347Z' - summary: Datetime example use Z as timezone - utc: - value: 2021-05-19T00:00:14.347%2B00:00 - summary: Datetime example use +00:00 as timezone, where + is encoded to - %2B - local-plus: - value: 2021-05-19T08:00:14.347%2B08:00 - summary: Datetime example use +08:00 as timezone, where + is encoded to - %2B - local-minus: - value: '2021-05-18T16:00:14.347-08:00' - summary: Datetime example use -08:00 as timezone - RTAend: - name: end + type: integer + minimum: 0 + example: 10 + Bckndcount: + name: $count + description: When the $count field is set to false, the response contains a + count of the items present in the response. When the $count field is set to + true, the response contains a count of all the items present on the server, + and not just the ones in the response. When the $count field is not passed, + it is false by default. in: query - description: The end time for the query as a RFC 3339 datetime format. Defaults - to now. + in timezone need to be encoded to %2B. required: false + schema: + type: boolean + example: true + BckndresourceGroupId: + name: resourceGroupId + description: Resource group identifier + in: path + required: true schema: type: string - format: date-time - examples: - zulu: - value: '2021-05-19T01:00:14.347Z' - summary: Datetime example use Z as timezone - utc: - value: 2021-05-19T01:00:14.347%2B00:00 - summary: Datetime example use +00:00 as timezone, where + is encoded to - %2B - local-plus: - value: 2021-05-19T09:00:14.347%2B08:00 - summary: Datetime example use +08:00 as timezone, where + is encoded to - %2B - local-minus: - value: '2021-05-18T17:00:14.347-08:00' - summary: Datetime example use -08:00 as timezone - RTAorder: - name: $order - in: query - description: "Determines the sort order. Supported values are asc or desc. Defaults - to asc. Sort order:\n * `asc` - Ascending, earliest in the order will appear - at the top of the list\n * `desc` - Descending, last in the order will appear - at the top of the list\n" - required: false + pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]{1,251}[a-zA-Z0-9]$ + minLength: 3 + maxLength: 253 + example: my-test-rg + BckndobjectStoreName: + name: objectStoreName + description: Name of the object store for the secret. + in: path + required: true + schema: + type: string + pattern: ^[a-zA-Z0-9\.\-_]+$ + example: My_objectStore + BcknddockerRegistryName: + name: dockerRegistryName + description: Name of the docker Registry store for the secret. + in: path + required: true + schema: + type: string + pattern: ^[a-z0-9](?:_?[a-z0-9\.\-]+)*[a-z0-9]$ + maxLength: 63 + example: mydockeregistry + BckndsecretName: + name: secretName + in: path + required: true + schema: + type: string + minLength: 1 + maxLength: 252 + pattern: ^[a-z0-9\-\.]+$ + BckndrepositoryName: + name: repositoryName + description: Name of the repository + in: path + required: true schema: type: string - enum: - - asc - - desc - examples: - asc: - value: asc - summary: Sort the results in ascending order - desc: - value: desc - summary: Sort the results in descending order - RTAexecutionId: - name: executionId - description: Execution identifier + minLength: 1 + maxLength: 51 + pattern: ^[a-z0-9\-]+$ + example: tenant-application + BckndapplicationName: + name: applicationName + description: Name of the ArgoCD application in: path required: true schema: type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - RTAdeploymentId: - name: deploymentId - description: Deployment identifier + minLength: 3 + maxLength: 54 + pattern: ^[a-z0-9\-]+$ + example: tenant-application + BckndServiceName: + name: ServiceName + description: Name of the Service in: path required: true schema: type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a + pattern: ^[a-zA-Z0-9\-_]+$ + minLength: 1 + maxLength: 32 + example: cashapp + BckndquotaOnly: + name: quotaOnly + description: When being set to true, the response contains only the quota of + the resource and not the quota usage. + in: query + required: false + schema: + type: boolean + example: true AiresourceGroupHeader: in: header name: AI-Resource-Group @@ -6985,255 +7226,71 @@ components: name: status description: Filter by status in: query - required: false - schema: - type: string - enum: - - PENDING - - RUNNING - - COMPLETED - - DEAD - - STOPPING - - STOPPED - - UNKNOWN - example: RUNNING - Aitop: - name: $top - description: Number of results to display - in: query - required: false - schema: - type: integer - maximum: 100000 - default: 10000 - example: 10 - x-visible: false - Aiskip: - name: $skip - description: Number of results to be skipped from the ordered list of results - in: query - required: false - schema: - type: integer - example: 10 - x-visible: false - AiqueryConfigurationExpand: - name: $expand - description: expand detailed information on scenario - in: query - required: false - schema: - type: string - enum: - - scenario - example: scenario - x-visible: false - AiqueryArtifactExpand: - name: $expand - description: expand detailed information on scenario - in: query - required: false - schema: - type: string - enum: - - scenario - example: scenario - x-visible: false - Aiselect: - name: $select - description: Allows to request a specified set of properties for each entity - in: query - required: false - schema: - type: string - enum: - - status - example: status - x-visible: false - KpiquerySelect: - name: $select - description: Columns to select - in: query - required: false - schema: - uniqueItems: true - type: array - readOnly: true - default: - - ResourceGroup - - Executions - - Artifacts - - Deployments - items: - $ref: '#/components/schemas/KpiColumnName' - style: form - explode: false - DSetresourceGroupHeader: - in: header - name: AI-Resource-Group - description: Specify a resource group id - schema: - type: string - required: false - DSetpath: - name: path - in: path - required: true - schema: - type: string - format: path - pattern: ^(([\w.-]+):([\w.-]+)|([\w.-]+))(/([\w./-]+[\w.-]+)?)?$ - maxLength: 1024 - description: path relative to the object store root URL in the secret - DSetoverwrite: - name: overwrite - in: query - required: false - schema: - type: boolean - description: If true, then file is overwritten. Default is false. - BckndtokenHeader: - name: Authorization - in: header - description: Authorization bearer token containing a JWT token. - required: false - schema: - type: string - Bckndai-resource-group: - name: AI-Resource-Group - in: header - description: Specify an existing resource group id to use - required: false - schema: - type: string - Bckndai-resource-group-default: - name: AI-Resource-Group - in: header - description: Specify an existing resource group id to use. Uses "default" if - value not provided. - required: false - schema: - type: string - default: default - Bckndai-tenant-scope: - name: AI-Tenant-Scope - in: header - description: Specify whether the main tenant scope is to be used - required: false - schema: - type: boolean - example: true - Bckndtop: - name: $top - description: Number of results to display - in: query - required: false - schema: - type: integer - minimum: 0 - example: 10 - Bckndskip: - name: $skip - description: Number of results to be skipped from the ordered list of results - in: query - required: false - schema: - type: integer - minimum: 0 - example: 10 - Bckndcount: - name: $count - description: When the $count field is set to false, the response contains a - count of the items present in the response. When the $count field is set to - true, the response contains a count of all the items present on the server, - and not just the ones in the response. When the $count field is not passed, - it is false by default. - in: query - required: false - schema: - type: boolean - example: true - BckndresourceGroupId: - name: resourceGroupId - description: Resource group identifier - in: path - required: true - schema: - type: string - pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]{1,251}[a-zA-Z0-9]$ - minLength: 3 - maxLength: 253 - example: my-test-rg - BckndobjectStoreName: - name: objectStoreName - description: Name of the object store for the secret. - in: path - required: true - schema: - type: string - pattern: ^[a-zA-Z0-9\.\-_]+$ - example: My_objectStore - BcknddockerRegistryName: - name: dockerRegistryName - description: Name of the docker Registry store for the secret. - in: path - required: true - schema: - type: string - pattern: ^[a-z0-9](?:_?[a-z0-9\.\-]+)*[a-z0-9]$ - maxLength: 63 - example: mydockeregistry - BckndsecretName: - name: secretName - in: path - required: true + required: false schema: type: string - minLength: 1 - maxLength: 252 - pattern: ^[a-z0-9\-\.]+$ - BckndrepositoryName: - name: repositoryName - description: Name of the repository - in: path - required: true + enum: + - PENDING + - RUNNING + - COMPLETED + - DEAD + - STOPPING + - STOPPED + - UNKNOWN + example: RUNNING + Aitop: + name: $top + description: Number of results to display + in: query + required: false schema: - type: string - minLength: 1 - maxLength: 51 - pattern: ^[a-z0-9\-]+$ - example: tenant-application - BckndapplicationName: - name: applicationName - description: Name of the ArgoCD application - in: path - required: true + type: integer + maximum: 100000 + default: 10000 + example: 10 + x-visible: false + Aiskip: + name: $skip + description: Number of results to be skipped from the ordered list of results + in: query + required: false + schema: + type: integer + example: 10 + x-visible: false + AiqueryConfigurationExpand: + name: $expand + description: expand detailed information on scenario + in: query + required: false schema: type: string - minLength: 3 - maxLength: 54 - pattern: ^[a-z0-9\-]+$ - example: tenant-application - BckndServiceName: - name: ServiceName - description: Name of the Service - in: path - required: true + enum: + - scenario + example: scenario + x-visible: false + AiqueryArtifactExpand: + name: $expand + description: expand detailed information on scenario + in: query + required: false schema: type: string - pattern: ^[a-zA-Z0-9\-_]+$ - minLength: 1 - maxLength: 32 - example: cashapp - BckndquotaOnly: - name: quotaOnly - description: When being set to true, the response contains only the quota of - the resource and not the quota usage. + enum: + - scenario + example: scenario + x-visible: false + Aiselect: + name: $select + description: Allows to request a specified set of properties for each entity in: query required: false schema: - type: boolean - example: true + type: string + enum: + - status + example: status + x-visible: false responses: MetaNotFound: description: The specified resource was not found @@ -7244,42 +7301,33 @@ components: properties: error: $ref: '#/components/schemas/MetaApiError' - TrckBadRequest: - content: - application/json: - schema: - type: object - properties: - error: - $ref: '#/components/schemas/TrckApiError' - description: The specification of the resource was incorrect - TrckNotImplemented: + KpiNotFound: + description: The specified resource was not found content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/TrckApiError' - description: Operation is not Supported. - TrckNotFound: - description: The specified resource was not found + $ref: '#/components/schemas/KpiApiError' + KpiTooManyRequests: + description: Too many requests content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/TrckApiError' - TrckPayloadTooLarge: + $ref: '#/components/schemas/KpiApiError' + KpiInvalidRequest: + description: Invalid request content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/TrckApiError' - description: request entity is larger than limits defined by server. + $ref: '#/components/schemas/KpiApiError' RTANotFound: description: The specified resource was not found content: @@ -7305,70 +7353,6 @@ components: application/json: schema: $ref: '#/components/schemas/RTAErrorResponse' - AiNotFound: - description: The specified resource was not found - content: - application/json: - schema: - type: object - properties: - error: - $ref: '#/components/schemas/AiApiError' - AiPreconditionFailed: - description: The service didn't meet the precondition needed to execute this - operation - content: - application/json: - schema: - type: object - properties: - error: - $ref: '#/components/schemas/AiApiError' - AiBadRequest: - description: The specification of the resource was incorrect - content: - application/json: - schema: - type: object - properties: - error: - $ref: '#/components/schemas/AiApiError' - TntNotFound: - description: The specified resource was not found - content: - application/json: - schema: - type: object - properties: - error: - $ref: '#/components/schemas/TntApiError' - KpiNotFound: - description: The specified resource was not found - content: - application/json: - schema: - type: object - properties: - error: - $ref: '#/components/schemas/KpiApiError' - KpiTooManyRequests: - description: Too many requests - content: - application/json: - schema: - type: object - properties: - error: - $ref: '#/components/schemas/KpiApiError' - KpiInvalidRequest: - description: Invalid request - content: - application/json: - schema: - type: object - properties: - error: - $ref: '#/components/schemas/KpiApiError' DSetBadRequest: description: The specification of the resource was incorrect content: @@ -7481,6 +7465,42 @@ components: the artifact API to register this file. schema: $ref: '#/components/schemas/DSetUrl' + TrckBadRequest: + content: + application/json: + schema: + type: object + properties: + error: + $ref: '#/components/schemas/TrckApiError' + description: The specification of the resource was incorrect + TrckNotImplemented: + content: + application/json: + schema: + type: object + properties: + error: + $ref: '#/components/schemas/TrckApiError' + description: Operation is not Supported. + TrckNotFound: + description: The specified resource was not found + content: + application/json: + schema: + type: object + properties: + error: + $ref: '#/components/schemas/TrckApiError' + TrckPayloadTooLarge: + content: + application/json: + schema: + type: object + properties: + error: + $ref: '#/components/schemas/TrckApiError' + description: request entity is larger than limits defined by server. BckndCommonError: description: HTTP status codes 401, 403 or 500. Response body contains further details. @@ -7500,3 +7520,40 @@ components: application/json: schema: $ref: '#/components/schemas/BckndErrorResponse' + TntNotFound: + description: The specified resource was not found + content: + application/json: + schema: + type: object + properties: + error: + $ref: '#/components/schemas/TntApiError' + AiNotFound: + description: The specified resource was not found + content: + application/json: + schema: + type: object + properties: + error: + $ref: '#/components/schemas/AiApiError' + AiPreconditionFailed: + description: The service didn't meet the precondition needed to execute this + operation + content: + application/json: + schema: + type: object + properties: + error: + $ref: '#/components/schemas/AiApiError' + AiBadRequest: + description: The specification of the resource was incorrect + content: + application/json: + schema: + type: object + properties: + error: + $ref: '#/components/schemas/AiApiError'