@sap-ai-sdk/prompt-registry/dist/client/prompt-registry/orchestration-configs-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 { OrchestrationConfigListResponse, OrchestrationConfigPostRequest, OrchestrationConfigPostResponse, OrchestrationConfigGetResponse, OrchestrationConfigDeleteResponse } from './schema/index.js';
/**
 * Representation of the 'OrchestrationConfigsApi'.
 * This API is part of the 'prompt-registry' service.
 */
export declare const OrchestrationConfigsApi: {
    _defaultBasePath: undefined;
    /**
     * List orchestration configs
     * @param queryParameters - Object containing the following keys: scenario, name, version, retrieve, include_spec, includeSpec, resolve_template_ref, resolveTemplateRef, $top, $skip.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    listOrchestrationConfigs: (queryParameters?: {
        scenario?: string;
        name?: string;
        version?: string;
        retrieve?: 'both' | 'imperative' | 'declarative';
        include_spec?: boolean;
        includeSpec?: boolean;
        resolve_template_ref?: boolean;
        resolveTemplateRef?: boolean;
        $top?: number;
        $skip?: number;
    }, headerParameters?: {
        'AI-Resource-Group'?: string;
    }) => OpenApiRequestBuilder<OrchestrationConfigListResponse>;
    /**
     * Create or update an orchestration config
     * @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.
     */
    createUpdateOrchestrationConfig: (body: OrchestrationConfigPostRequest, headerParameters?: {
        'AI-Resource-Group'?: string;
    }) => OpenApiRequestBuilder<OrchestrationConfigPostResponse>;
    /**
     * List orchestration config history
     * @param scenario - Path parameter.
     * @param version - Path parameter.
     * @param name - Path parameter.
     * @param queryParameters - Object containing the following keys: include_spec, includeSpec, resolve_template_ref, resolveTemplateRef, $top, $skip.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    listOrchestrationConfigHistory: (scenario: string, version: string, name: string, queryParameters?: {
        include_spec?: boolean;
        includeSpec?: boolean;
        resolve_template_ref?: boolean;
        resolveTemplateRef?: boolean;
        $top?: number;
        $skip?: number;
    }, headerParameters?: {
        'AI-Resource-Group'?: string;
    }) => OpenApiRequestBuilder<OrchestrationConfigListResponse>;
    /**
     * Get orchestration config by UUID
     * @param orchestrationConfigId - Path parameter.
     * @param queryParameters - Object containing the following keys: resolve_template_ref, resolveTemplateRef.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    getOrchestrationConfigByUuid: (orchestrationConfigId: string, queryParameters?: {
        resolve_template_ref?: boolean;
        resolveTemplateRef?: boolean;
    }, headerParameters?: {
        'AI-Resource-Group'?: string;
    }) => OpenApiRequestBuilder<OrchestrationConfigGetResponse>;
    /**
     * Delete orchestration config
     * @param orchestrationConfigId - Path parameter.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    deleteOrchestrationConfig: (orchestrationConfigId: string, headerParameters?: {
        'AI-Resource-Group'?: string;
    }) => OpenApiRequestBuilder<OrchestrationConfigDeleteResponse>;
    /**
     * Import orchestration config
     * @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.
     */
    importOrchestrationConfig: (body: ({
        /**
         * Format: "binary".
         */
        file?: Blob;
    } & Record<string, any>) | undefined, headerParameters?: {
        'AI-Resource-Group'?: string;
    }) => OpenApiRequestBuilder<OrchestrationConfigPostResponse>;
    /**
     * Export orchestration config
     * @param orchestrationConfigId - Path parameter.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    exportOrchestrationConfig: (orchestrationConfigId: string, headerParameters?: {
        'AI-Resource-Group'?: string;
    }) => OpenApiRequestBuilder<Blob>;
};
//# sourceMappingURL=orchestration-configs-api.d.ts.map