@sap-ai-sdk/prompt-registry/dist/client/prompt-registry/prompt-templates-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) 2026 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 'PromptTemplatesApi'.
 * This API is part of the 'prompt-registry' service.
 */
export const PromptTemplatesApi = {
    _defaultBasePath: undefined,
    /**
     * List prompt templates
     * @param queryParameters - Object containing the following keys: scenario, name, version, retrieve, includeSpec, $top, $skip.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group, AI-Resource-Group-Scope.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    listPromptTemplates: (queryParameters, headerParameters) => new OpenApiRequestBuilder('get', '/lm/promptTemplates', {
        headerParameters,
        queryParameters
    }, PromptTemplatesApi._defaultBasePath),
    /**
     * Create or update a prompt template
     * @param body - Request body.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group, AI-Resource-Group-Scope.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    createUpdatePromptTemplate: (body, headerParameters) => new OpenApiRequestBuilder('post', '/lm/promptTemplates', {
        body,
        headerParameters: {
            'content-type': 'application/json',
            ...headerParameters
        }
    }, PromptTemplatesApi._defaultBasePath),
    /**
     * List prompt template history
     * @param scenario - Path parameter.
     * @param version - Path parameter.
     * @param name - Path parameter.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group, AI-Resource-Group-Scope.
     * @param queryParameters - Object containing the following keys: $top, $skip.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    listPromptTemplateHistory: (scenario, version, name, headerParameters, queryParameters) => new OpenApiRequestBuilder('get', '/lm/scenarios/{scenario}/promptTemplates/{name}/versions/{version}/history', {
        pathParameters: { scenario, version, name },
        headerParameters,
        queryParameters
    }, PromptTemplatesApi._defaultBasePath),
    /**
     * Get prompt template by UUID
     * @param promptTemplateId - Path parameter.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group, AI-Resource-Group-Scope.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    getPromptTemplateByUuid: (promptTemplateId, headerParameters) => new OpenApiRequestBuilder('get', '/lm/promptTemplates/{promptTemplateId}', {
        pathParameters: { promptTemplateId },
        headerParameters
    }, PromptTemplatesApi._defaultBasePath),
    /**
     * Delete prompt template
     * @param promptTemplateId - Path parameter.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group, AI-Resource-Group-Scope.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    deletePromptTemplate: (promptTemplateId, headerParameters) => new OpenApiRequestBuilder('delete', '/lm/promptTemplates/{promptTemplateId}', {
        pathParameters: { promptTemplateId },
        headerParameters
    }, PromptTemplatesApi._defaultBasePath),
    /**
     * Import prompt template
     * @param body - Request body.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group, AI-Resource-Group-Scope.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    importPromptTemplate: (body, headerParameters) => new OpenApiRequestBuilder('post', '/lm/promptTemplates/import', {
        body,
        _encoding: {
            file: {
                contentType: 'application/octet-stream',
                isImplicit: true,
                parsedContentTypes: [
                    { type: 'application/octet-stream', parameters: {} }
                ]
            }
        },
        headerParameters: {
            'content-type': 'multipart/form-data',
            ...headerParameters
        }
    }, PromptTemplatesApi._defaultBasePath),
    /**
     * Export prompt template
     * @param promptTemplateId - Path parameter.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group, AI-Resource-Group-Scope.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    exportPromptTemplate: (promptTemplateId, headerParameters) => new OpenApiRequestBuilder('get', '/lm/promptTemplates/{promptTemplateId}/export', {
        pathParameters: { promptTemplateId },
        headerParameters
    }, PromptTemplatesApi._defaultBasePath),
    /**
     * Parse prompt template by ID
     * @param promptTemplateId - Path parameter.
     * @param body - Request body.
     * @param queryParameters - Object containing the following keys: metadata.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group, AI-Resource-Group-Scope.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    parsePromptTemplateById: (promptTemplateId, body, queryParameters, headerParameters) => new OpenApiRequestBuilder('post', '/lm/promptTemplates/{promptTemplateId}/substitution', {
        pathParameters: { promptTemplateId },
        body,
        headerParameters: {
            'content-type': 'application/json',
            ...headerParameters
        },
        queryParameters
    }, PromptTemplatesApi._defaultBasePath),
    /**
     * Parse prompt template by name and version
     * @param scenario - Path parameter.
     * @param version - Path parameter.
     * @param name - Path parameter.
     * @param body - Request body.
     * @param queryParameters - Object containing the following keys: metadata.
     * @param headerParameters - Object containing the following keys: AI-Resource-Group, AI-Resource-Group-Scope.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    parsePromptTemplateByNameVersion: (scenario, version, name, body, queryParameters, headerParameters) => new OpenApiRequestBuilder('post', '/lm/scenarios/{scenario}/promptTemplates/{name}/versions/{version}/substitution', {
        pathParameters: { scenario, version, name },
        body,
        headerParameters: {
            'content-type': 'application/json',
            ...headerParameters
        },
        queryParameters
    }, PromptTemplatesApi._defaultBasePath)
};
//# sourceMappingURL=prompt-templates-api.js.map