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

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

import { OpenApiRequestBuilder } from '@sap-ai-sdk/core';
import type { AiDeploymentList, AiDeploymentCreationRequest, AiDeploymentCreationResponse, AiDeploymentBulkModificationRequest, AiDeploymentBulkModificationResponse, AiDeploymentResponseWithDetails, AiDeploymentModificationRequest, AiDeploymentModificationResponse, AiDeploymentDeletionResponse, RTALogCommonResponse } from './schema/index.js';
/**
 * Representation of the 'DeploymentApi'.
 * This API is part of the 'AI_CORE_API' service.
 */
export declare 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: {
        executableIds?: string[];
        configurationId?: string;
        scenarioId?: string;
        status?: "PENDING" | "RUNNING" | "COMPLETED" | "DEAD" | "STOPPING" | "STOPPED" | "UNKNOWN";
        $top?: number;
        $skip?: number;
        $select?: "status";
    }, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiDeploymentList>;
    /**
     * 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: AiDeploymentCreationRequest, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiDeploymentCreationResponse>;
    /**
     * 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: AiDeploymentBulkModificationRequest, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiDeploymentBulkModificationResponse>;
    /**
     * 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: string, queryParameters: {
        $select?: "status";
    }, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiDeploymentResponseWithDetails>;
    /**
     * 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: string, body: AiDeploymentModificationRequest, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiDeploymentModificationResponse>;
    /**
     * 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: string, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiDeploymentDeletionResponse>;
    /**
     * 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: {
        executableIds?: string[];
        configurationId?: string;
        scenarioId?: string;
        status?: "PENDING" | "RUNNING" | "COMPLETED" | "DEAD" | "STOPPING" | "STOPPED" | "UNKNOWN";
    }, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<number>;
    /**
     * 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: string, queryParameters?: {
        $top?: number;
        start?: string;
        end?: string;
        $order?: "asc" | "desc";
    }, headerParameters?: {
        Authorization?: string;
    }) => OpenApiRequestBuilder<RTALogCommonResponse>;
};
//# sourceMappingURL=deployment-api.d.ts.map