@sap-ai-sdk/ai-api/dist/client/AI_CORE_API/deployment-api.js

SAP Cloud SDK for AI is the official Software Development Kit (SDK) for **SAP AI Core**, **SAP Generative AI Hub**, and **Orchestration Service**.

/*
 * Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
 *
 * This is a generated file powered by the SAP Cloud SDK for JavaScript.
 */
import { OpenApiRequestBuilder } from '@sap-ai-sdk/core';
/**
 * Representation of the 'DeploymentApi'.
 * This API is part of the 'AI_CORE_API' service.
 */
export const DeploymentApi = {
    _defaultBasePath: undefined,
    /**
     * Retrieve a list of deployments that match the specified filter criteria.
     * Filter criteria include a list of executableIds, a scenarioId, a configurationId, or a deployment status.
     * With top/skip parameters it is possible to paginate the result list.
     * With select parameter it is possible to select only status.
     *
     * @param queryParameters - Object containing the following keys: executableIds, configurationId, scenarioId, status, $top, $skip, $select.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    deploymentQuery: (queryParameters, headerParameters) => new OpenApiRequestBuilder('get', '/lm/deployments', {
        queryParameters,
        headerParameters
    }, DeploymentApi._defaultBasePath),
    /**
     * Create a deployment using the configuration specified by configurationId after synchronously checking the
     * correctness of the configuration.
     *
     * @param body - Request body.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    deploymentCreate: (body, headerParameters) => new OpenApiRequestBuilder('post', '/lm/deployments', {
        body,
        headerParameters
    }, DeploymentApi._defaultBasePath),
    /**
     * Update status of multiple deployments. stop or delete multiple deployments.
     * @param body - Request body.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    deploymentBatchModify: (body, headerParameters) => new OpenApiRequestBuilder('patch', '/lm/deployments', {
        body,
        headerParameters
    }, DeploymentApi._defaultBasePath),
    /**
     * Retrieve details for execution with deploymentId.
     * @param deploymentId - Deployment identifier
     * @param queryParameters - Object containing the following keys: $select.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    deploymentGet: (deploymentId, queryParameters, headerParameters) => new OpenApiRequestBuilder('get', '/lm/deployments/{deploymentId}', {
        pathParameters: { deploymentId },
        queryParameters,
        headerParameters
    }, DeploymentApi._defaultBasePath),
    /**
     * Update target status of a deployment to stop a deployment or change the configuration to be used by the
     * deployment after synchronously checking the correctness of the configuration. A change of configuration is only
     * allowed for RUNNING and PENDING deployments.
     *
     * @param deploymentId - Deployment identifier
     * @param body - Request body.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    deploymentModify: (deploymentId, body, headerParameters) => new OpenApiRequestBuilder('patch', '/lm/deployments/{deploymentId}', {
        pathParameters: { deploymentId },
        body,
        headerParameters
    }, DeploymentApi._defaultBasePath),
    /**
     * Mark deployment with deploymentId as deleted.
     * @param deploymentId - Deployment identifier
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    deploymentDelete: (deploymentId, headerParameters) => new OpenApiRequestBuilder('delete', '/lm/deployments/{deploymentId}', {
        pathParameters: { deploymentId },
        headerParameters
    }, DeploymentApi._defaultBasePath),
    /**
     * Retrieve the number of available deployments. The number can be filtered by
     * scenarioId, configurationId, executableIdsList or by deployment status.
     *
     * @param queryParameters - Object containing the following keys: executableIds, configurationId, scenarioId, status.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    deploymentCount: (queryParameters, headerParameters) => new OpenApiRequestBuilder('get', '/lm/deployments/$count', {
        queryParameters,
        headerParameters
    }, DeploymentApi._defaultBasePath),
    /**
     * Retrieve logs of a deployment for getting insight into the deployment results or failures.
     * @param deploymentId - Deployment identifier
     * @param queryParameters - Object containing the following keys: $top, start, end, $order.
     * @param headerParameters - Object containing the following keys: Authorization.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    kubesubmitV4DeploymentsGetLogs: (deploymentId, queryParameters, headerParameters) => new OpenApiRequestBuilder('get', '/lm/deployments/{deploymentId}/logs', {
        pathParameters: { deploymentId },
        queryParameters,
        headerParameters
    }, DeploymentApi._defaultBasePath)
};
//# sourceMappingURL=deployment-api.js.map