|
| 1 | +/* |
| 2 | + * Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved. |
| 3 | + * |
| 4 | + * This is a generated file powered by the SAP Cloud SDK for JavaScript. |
| 5 | + */ |
| 6 | +import { OpenApiRequestBuilder } from '@sap-ai-sdk/core'; |
| 7 | +import type { |
| 8 | + PromptTemplateListResponse, |
| 9 | + PromptTemplatePostRequest, |
| 10 | + PromptTemplatePostResponse, |
| 11 | + PromptTemplateGetResponse, |
| 12 | + PromptTemplateDeleteResponse, |
| 13 | + PromptTemplateSubstitutionRequest, |
| 14 | + PromptTemplateSubstitutionResponse |
| 15 | +} from './schema/index.js'; |
| 16 | +/** |
| 17 | + * Representation of the 'PromptTemplatesApi'. |
| 18 | + * This API is part of the 'prompt-registry' service. |
| 19 | + */ |
| 20 | +export const PromptTemplatesApi = { |
| 21 | + _defaultBasePath: undefined, |
| 22 | + /** |
| 23 | + * List prompt templates |
| 24 | + * @param queryParameters - Object containing the following keys: scenario, name, version, retrieve, includeSpec. |
| 25 | + * @returns The request builder, use the `execute()` method to trigger the request. |
| 26 | + */ |
| 27 | + listPromptTemplates: (queryParameters?: { |
| 28 | + scenario?: string; |
| 29 | + name?: string; |
| 30 | + version?: string; |
| 31 | + retrieve?: string; |
| 32 | + includeSpec?: boolean; |
| 33 | + }) => |
| 34 | + new OpenApiRequestBuilder<PromptTemplateListResponse>( |
| 35 | + 'get', |
| 36 | + '/lm/promptTemplates', |
| 37 | + { |
| 38 | + queryParameters |
| 39 | + }, |
| 40 | + PromptTemplatesApi._defaultBasePath |
| 41 | + ), |
| 42 | + /** |
| 43 | + * Create or update a prompt template |
| 44 | + * @param body - Request body. |
| 45 | + * @returns The request builder, use the `execute()` method to trigger the request. |
| 46 | + */ |
| 47 | + createUpdatePromptTemplate: (body: PromptTemplatePostRequest) => |
| 48 | + new OpenApiRequestBuilder<PromptTemplatePostResponse>( |
| 49 | + 'post', |
| 50 | + '/lm/promptTemplates', |
| 51 | + { |
| 52 | + body |
| 53 | + }, |
| 54 | + PromptTemplatesApi._defaultBasePath |
| 55 | + ), |
| 56 | + /** |
| 57 | + * List prompt template history |
| 58 | + * @param scenario - Path parameter. |
| 59 | + * @param version - Path parameter. |
| 60 | + * @param name - Path parameter. |
| 61 | + * @returns The request builder, use the `execute()` method to trigger the request. |
| 62 | + */ |
| 63 | + listPromptTemplateHistory: ( |
| 64 | + scenario: string, |
| 65 | + version: string, |
| 66 | + name: string |
| 67 | + ) => |
| 68 | + new OpenApiRequestBuilder<PromptTemplateListResponse>( |
| 69 | + 'get', |
| 70 | + '/lm/scenarios/{scenario}/promptTemplates/{name}/versions/{version}/history', |
| 71 | + { |
| 72 | + pathParameters: { scenario, version, name } |
| 73 | + }, |
| 74 | + PromptTemplatesApi._defaultBasePath |
| 75 | + ), |
| 76 | + /** |
| 77 | + * Get prompt template by UUID |
| 78 | + * @param promptTemplateId - Path parameter. |
| 79 | + * @returns The request builder, use the `execute()` method to trigger the request. |
| 80 | + */ |
| 81 | + getPromptTemplateByUuid: (promptTemplateId: string) => |
| 82 | + new OpenApiRequestBuilder<PromptTemplateGetResponse>( |
| 83 | + 'get', |
| 84 | + '/lm/promptTemplates/{promptTemplateId}', |
| 85 | + { |
| 86 | + pathParameters: { promptTemplateId } |
| 87 | + }, |
| 88 | + PromptTemplatesApi._defaultBasePath |
| 89 | + ), |
| 90 | + /** |
| 91 | + * Delete prompt template |
| 92 | + * @param promptTemplateId - Path parameter. |
| 93 | + * @returns The request builder, use the `execute()` method to trigger the request. |
| 94 | + */ |
| 95 | + deletePromptTemplate: (promptTemplateId: string) => |
| 96 | + new OpenApiRequestBuilder<PromptTemplateDeleteResponse>( |
| 97 | + 'delete', |
| 98 | + '/lm/promptTemplates/{promptTemplateId}', |
| 99 | + { |
| 100 | + pathParameters: { promptTemplateId } |
| 101 | + }, |
| 102 | + PromptTemplatesApi._defaultBasePath |
| 103 | + ), |
| 104 | + /** |
| 105 | + * Import prompt template |
| 106 | + * @param body - Request body. |
| 107 | + * @returns The request builder, use the `execute()` method to trigger the request. |
| 108 | + */ |
| 109 | + importPromptTemplate: (body: any | undefined) => |
| 110 | + new OpenApiRequestBuilder<PromptTemplatePostResponse>( |
| 111 | + 'post', |
| 112 | + '/lm/promptTemplates/import', |
| 113 | + { |
| 114 | + body |
| 115 | + }, |
| 116 | + PromptTemplatesApi._defaultBasePath |
| 117 | + ), |
| 118 | + /** |
| 119 | + * Export prompt template |
| 120 | + * @param promptTemplateId - Path parameter. |
| 121 | + * @returns The request builder, use the `execute()` method to trigger the request. |
| 122 | + */ |
| 123 | + exportPromptTemplate: (promptTemplateId: string) => |
| 124 | + new OpenApiRequestBuilder<string>( |
| 125 | + 'get', |
| 126 | + '/lm/promptTemplates/{promptTemplateId}/export', |
| 127 | + { |
| 128 | + pathParameters: { promptTemplateId } |
| 129 | + }, |
| 130 | + PromptTemplatesApi._defaultBasePath |
| 131 | + ), |
| 132 | + /** |
| 133 | + * Parse prompt template by ID |
| 134 | + * @param promptTemplateId - Path parameter. |
| 135 | + * @param body - Request body. |
| 136 | + * @param queryParameters - Object containing the following keys: metadata. |
| 137 | + * @returns The request builder, use the `execute()` method to trigger the request. |
| 138 | + */ |
| 139 | + parsePromptTemplateById: ( |
| 140 | + promptTemplateId: string, |
| 141 | + body: PromptTemplateSubstitutionRequest | undefined, |
| 142 | + queryParameters?: { metadata?: boolean } |
| 143 | + ) => |
| 144 | + new OpenApiRequestBuilder<PromptTemplateSubstitutionResponse>( |
| 145 | + 'post', |
| 146 | + '/lm/promptTemplates/{promptTemplateId}/substitution', |
| 147 | + { |
| 148 | + pathParameters: { promptTemplateId }, |
| 149 | + body, |
| 150 | + queryParameters |
| 151 | + }, |
| 152 | + PromptTemplatesApi._defaultBasePath |
| 153 | + ), |
| 154 | + /** |
| 155 | + * Parse prompt template by name and version |
| 156 | + * @param scenario - Path parameter. |
| 157 | + * @param version - Path parameter. |
| 158 | + * @param name - Path parameter. |
| 159 | + * @param body - Request body. |
| 160 | + * @param queryParameters - Object containing the following keys: metadata. |
| 161 | + * @returns The request builder, use the `execute()` method to trigger the request. |
| 162 | + */ |
| 163 | + parsePromptTemplateByNameVersion: ( |
| 164 | + scenario: string, |
| 165 | + version: string, |
| 166 | + name: string, |
| 167 | + body: PromptTemplateSubstitutionRequest | undefined, |
| 168 | + queryParameters?: { metadata?: boolean } |
| 169 | + ) => |
| 170 | + new OpenApiRequestBuilder<PromptTemplateSubstitutionResponse>( |
| 171 | + 'post', |
| 172 | + '/lm/scenarios/{scenario}/promptTemplates/{name}/versions/{version}/substitution', |
| 173 | + { |
| 174 | + pathParameters: { scenario, version, name }, |
| 175 | + body, |
| 176 | + queryParameters |
| 177 | + }, |
| 178 | + PromptTemplatesApi._defaultBasePath |
| 179 | + ) |
| 180 | +}; |
0 commit comments