@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**.
118 lines • 6.33 kB
TypeScript
import { OpenApiRequestBuilder } from '@sap-ai-sdk/core';
import type { PromptTemplateListResponse, PromptTemplatePostRequest, PromptTemplatePostResponse, PromptTemplateGetResponse, PromptTemplateDeleteResponse, PromptTemplateSubstitutionRequest, PromptTemplateSubstitutionResponse } from './schema/index.js';
/**
* Representation of the 'PromptTemplatesApi'.
* This API is part of the 'prompt-registry' service.
*/
export declare 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?: {
scenario?: string;
name?: string;
version?: string;
retrieve?: string;
includeSpec?: boolean;
}, headerParameters?: {
"AI-Resource-Group"?: string;
"AI-Resource-Group-Scope"?: "true" | "True" | "false" | "False";
}) => OpenApiRequestBuilder<PromptTemplateListResponse>;
/**
* 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: PromptTemplatePostRequest, headerParameters?: {
"AI-Resource-Group"?: string;
"AI-Resource-Group-Scope"?: "true" | "True" | "false" | "False";
}) => OpenApiRequestBuilder<PromptTemplatePostResponse>;
/**
* 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: string, version: string, name: string, headerParameters?: {
"AI-Resource-Group"?: string;
"AI-Resource-Group-Scope"?: "true" | "True" | "false" | "False";
}) => OpenApiRequestBuilder<PromptTemplateListResponse>;
/**
* 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: string, headerParameters?: {
"AI-Resource-Group"?: string;
"AI-Resource-Group-Scope"?: "true" | "True" | "false" | "False";
}) => OpenApiRequestBuilder<PromptTemplateGetResponse>;
/**
* 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: string, headerParameters?: {
"AI-Resource-Group"?: string;
"AI-Resource-Group-Scope"?: "true" | "True" | "false" | "False";
}) => OpenApiRequestBuilder<PromptTemplateDeleteResponse>;
/**
* 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: any | undefined, headerParameters?: {
"AI-Resource-Group"?: string;
"AI-Resource-Group-Scope"?: "true" | "True" | "false" | "False";
}) => OpenApiRequestBuilder<PromptTemplatePostResponse>;
/**
* 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: string, headerParameters?: {
"AI-Resource-Group"?: string;
"AI-Resource-Group-Scope"?: "true" | "True" | "false" | "False";
}) => OpenApiRequestBuilder<string>;
/**
* 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: string, body: PromptTemplateSubstitutionRequest | undefined, queryParameters?: {
metadata?: boolean;
}, headerParameters?: {
"AI-Resource-Group"?: string;
"AI-Resource-Group-Scope"?: "true" | "True" | "false" | "False";
}) => OpenApiRequestBuilder<PromptTemplateSubstitutionResponse>;
/**
* 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: string, version: string, name: string, body: PromptTemplateSubstitutionRequest | undefined, queryParameters?: {
metadata?: boolean;
}, headerParameters?: {
"AI-Resource-Group"?: string;
"AI-Resource-Group-Scope"?: "true" | "True" | "false" | "False";
}) => OpenApiRequestBuilder<PromptTemplateSubstitutionResponse>;
};
//# sourceMappingURL=prompt-templates-api.d.ts.map