@sap-ai-sdk/prompt-registry
Version:
SAP Cloud SDK for AI is the official Software Development Kit (SDK) for **SAP AI Core**, **SAP Generative AI Hub**, and **Orchestration Service**.
116 lines • 6.04 kB
JavaScript
/*
* 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 '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.
* @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', {
queryParameters,
headerParameters
}, 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
}, 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.
* @returns The request builder, use the `execute()` method to trigger the request.
*/
listPromptTemplateHistory: (scenario, version, name, headerParameters) => new OpenApiRequestBuilder('get', '/lm/scenarios/{scenario}/promptTemplates/{name}/versions/{version}/history', {
pathParameters: { scenario, version, name },
headerParameters
}, 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,
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,
queryParameters,
headerParameters
}, 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,
queryParameters,
headerParameters
}, PromptTemplatesApi._defaultBasePath)
};
//# sourceMappingURL=prompt-templates-api.js.map