@sap-ai-sdk/ai-api/dist/client/AI_CORE_API/execution-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 { AiExecutionList, AiEnactmentCreationRequest, AiExecutionCreationResponse, AiExecutionBulkModificationRequest, AiExecutionBulkModificationResponse, AiExecutionResponseWithDetails, AiExecutionModificationRequest, AiExecutionModificationResponse, AiExecutionDeletionResponse, AiExecutionScheduleList, AiExecutionScheduleCreationData, AiExecutionScheduleCreationResponse, AiExecutionSchedule, AiExecutionScheduleModificationRequest, AiExecutionScheduleModificationResponse, AiExecutionScheduleDeletionResponse, RTALogCommonResponse } from './schema/index.js';
/**
 * Representation of the 'ExecutionApi'.
 * This API is part of the 'AI_CORE_API' service.
 */
export declare const ExecutionApi: {
    _defaultBasePath: undefined;
    /**
     * Retrieve a list of executions that match the specified filter criteria.
     * Filter criteria include a list of executableIds, a scenarioId, a configurationId, or a execution 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, executionScheduleId, 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.
     */
    executionQuery: (queryParameters: {
        executableIds?: string[];
        configurationId?: string;
        scenarioId?: string;
        executionScheduleId?: string;
        status?: "PENDING" | "RUNNING" | "COMPLETED" | "DEAD" | "STOPPING" | "STOPPED" | "UNKNOWN";
        $top?: number;
        $skip?: number;
        $select?: "status";
    }, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionList>;
    /**
     * Create an execution using the configuration specified by configurationId.
     * @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.
     */
    executionCreate: (body: AiEnactmentCreationRequest, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionCreationResponse>;
    /**
     * Patch multiple executions' status to stopped or deleted.
     * @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.
     */
    executionBatchModify: (body: AiExecutionBulkModificationRequest, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionBulkModificationResponse>;
    /**
     * Retrieve details for execution with executionId.
     * @param executionId - Execution 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.
     */
    executionGet: (executionId: string, queryParameters: {
        $select?: "status";
    }, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionResponseWithDetails>;
    /**
     * Update target status of the execution to stop an execution.
     * @param executionId - Execution 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.
     */
    executionModify: (executionId: string, body: AiExecutionModificationRequest, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionModificationResponse>;
    /**
     * Mark the execution with executionId as deleted.
     * @param executionId - Execution identifier
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    executionDelete: (executionId: string, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionDeletionResponse>;
    /**
     * 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.
     *
     * @param queryParameters - Object containing the following keys: configurationId, status, $top, $skip.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    executionScheduleQuery: (queryParameters: {
        configurationId?: string;
        status?: "ACTIVE" | "INACTIVE";
        $top?: number;
        $skip?: number;
    }, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionScheduleList>;
    /**
     * Create an execution schedule using the configuration specified by configurationId, and schedule.
     * @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.
     */
    executionScheduleCreate: (body: AiExecutionScheduleCreationData, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionScheduleCreationResponse>;
    /**
     * Retrieve details for execution schedule with executionScheduleId.
     * @param executionScheduleId - Execution Schedule identifier
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    executionScheduleGet: (executionScheduleId: string, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionSchedule>;
    /**
     * Update details of an execution schedule
     * @param executionScheduleId - Execution Schedule 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.
     */
    executionScheduleModify: (executionScheduleId: string, body: AiExecutionScheduleModificationRequest, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionScheduleModificationResponse>;
    /**
     * Delete the execution schedule with executionScheduleId.
     * @param executionScheduleId - Execution Schedule identifier
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    executionScheduleDelete: (executionScheduleId: string, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<AiExecutionScheduleDeletionResponse>;
    /**
     * Retrieve the number of available executions. The number can be filtered by
     * scenarioId, configurationId, executableIdsList or by execution status.
     *
     * @param queryParameters - Object containing the following keys: executableIds, configurationId, scenarioId, executionScheduleId, status.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    executionCount: (queryParameters: {
        executableIds?: string[];
        configurationId?: string;
        scenarioId?: string;
        executionScheduleId?: string;
        status?: "PENDING" | "RUNNING" | "COMPLETED" | "DEAD" | "STOPPING" | "STOPPED" | "UNKNOWN";
    }, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<number>;
    /**
     * Retrieve the number of scheduled executions. The number can be filtered by
     * configurationId or executionScheduleStatus.
     *
     * @param queryParameters - Object containing the following keys: configurationId, status.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    executionScheduleCount: (queryParameters: {
        configurationId?: string;
        status?: "ACTIVE" | "INACTIVE";
    }, headerParameters: {
        "AI-Resource-Group": string;
    }) => OpenApiRequestBuilder<number>;
    /**
     * Retrieve logs of an execution for getting insight into the execution results or failures.
     * @param executionId - Execution 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.
     */
    kubesubmitV4ExecutionsGetLogs: (executionId: string, queryParameters?: {
        $top?: number;
        start?: string;
        end?: string;
        $order?: "asc" | "desc";
    }, headerParameters?: {
        Authorization?: string;
    }) => OpenApiRequestBuilder<RTALogCommonResponse>;
};
//# sourceMappingURL=execution-api.d.ts.map