@sap-ai-sdk/ai-api/dist/client/AI_CORE_API/execution-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 'ExecutionApi'.
 * This API is part of the 'AI_CORE_API' service.
 */
export 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, headerParameters) => new OpenApiRequestBuilder('get', '/lm/executions', {
        queryParameters,
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, headerParameters) => new OpenApiRequestBuilder('post', '/lm/executions', {
        body,
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, headerParameters) => new OpenApiRequestBuilder('patch', '/lm/executions', {
        body,
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, queryParameters, headerParameters) => new OpenApiRequestBuilder('get', '/lm/executions/{executionId}', {
        pathParameters: { executionId },
        queryParameters,
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, body, headerParameters) => new OpenApiRequestBuilder('patch', '/lm/executions/{executionId}', {
        pathParameters: { executionId },
        body,
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, headerParameters) => new OpenApiRequestBuilder('delete', '/lm/executions/{executionId}', {
        pathParameters: { executionId },
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, headerParameters) => new OpenApiRequestBuilder('get', '/lm/executionSchedules', {
        queryParameters,
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, headerParameters) => new OpenApiRequestBuilder('post', '/lm/executionSchedules', {
        body,
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, headerParameters) => new OpenApiRequestBuilder('get', '/lm/executionSchedules/{executionScheduleId}', {
        pathParameters: { executionScheduleId },
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, body, headerParameters) => new OpenApiRequestBuilder('patch', '/lm/executionSchedules/{executionScheduleId}', {
        pathParameters: { executionScheduleId },
        body,
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, headerParameters) => new OpenApiRequestBuilder('delete', '/lm/executionSchedules/{executionScheduleId}', {
        pathParameters: { executionScheduleId },
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, headerParameters) => new OpenApiRequestBuilder('get', '/lm/executions/$count', {
        queryParameters,
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, headerParameters) => new OpenApiRequestBuilder('get', '/lm/executionSchedules/$count', {
        queryParameters,
        headerParameters
    }, ExecutionApi._defaultBasePath),
    /**
     * 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, queryParameters, headerParameters) => new OpenApiRequestBuilder('get', '/lm/executions/{executionId}/logs', {
        pathParameters: { executionId },
        queryParameters,
        headerParameters
    }, ExecutionApi._defaultBasePath)
};
//# sourceMappingURL=execution-api.js.map