Skip to content

feat: [DevOps] Update prompt-registry specification #571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bot-sdk-js wants to merge 1 commit into from
+103 −27
Closed

feat: [DevOps] Update prompt-registry specification #571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions ...registry/src/main/java/com/sap/ai/sdk/prompt/registry/client/OrchestrationConfigsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public OrchestrationConfigPostResponse createUpdateOrchestrationConfig(
}

final String localVarPath =
UriComponentsBuilder.fromPath("/lm/orchestrationConfigs").build().toUriString();
UriComponentsBuilder.fromPath("/registry/v2/orchestrationConfigs").build().toUriString();

final MultiValueMap<String, String> localVarQueryParams =
new LinkedMultiValueMap<String, String>();
Expand Down Expand Up @@ -171,7 +171,7 @@ public OrchestrationConfigDeleteResponse deleteOrchestrationConfig(
final Map<String, Object> localVarPathParams = new HashMap<String, Object>();
localVarPathParams.put("orchestrationConfigId", orchestrationConfigId);
final String localVarPath =
UriComponentsBuilder.fromPath("/lm/orchestrationConfigs/{orchestrationConfigId}")
UriComponentsBuilder.fromPath("/registry/v2/orchestrationConfigs/{orchestrationConfigId}")
.buildAndExpand(localVarPathParams)
.toUriString();

Expand Down Expand Up @@ -257,7 +257,8 @@ public File exportOrchestrationConfig(
final Map<String, Object> localVarPathParams = new HashMap<String, Object>();
localVarPathParams.put("orchestrationConfigId", orchestrationConfigId);
final String localVarPath =
UriComponentsBuilder.fromPath("/lm/orchestrationConfigs/{orchestrationConfigId}/export")
UriComponentsBuilder.fromPath(
"/registry/v2/orchestrationConfigs/{orchestrationConfigId}/export")
.buildAndExpand(localVarPathParams)
.toUriString();

Expand Down Expand Up @@ -347,7 +348,7 @@ public OrchestrationConfigGetResponse getOrchestrationConfigByUuid(
final Map<String, Object> localVarPathParams = new HashMap<String, Object>();
localVarPathParams.put("orchestrationConfigId", orchestrationConfigId);
final String localVarPath =
UriComponentsBuilder.fromPath("/lm/orchestrationConfigs/{orchestrationConfigId}")
UriComponentsBuilder.fromPath("/registry/v2/orchestrationConfigs/{orchestrationConfigId}")
.buildAndExpand(localVarPathParams)
.toUriString();

Expand Down Expand Up @@ -427,7 +428,9 @@ public OrchestrationConfigPostResponse importOrchestrationConfig(
final Object localVarPostBody = null;

final String localVarPath =
UriComponentsBuilder.fromPath("/lm/orchestrationConfigs/import").build().toUriString();
UriComponentsBuilder.fromPath("/registry/v2/orchestrationConfigs/import")
.build()
.toUriString();

final MultiValueMap<String, String> localVarQueryParams =
new LinkedMultiValueMap<String, String>();
Expand Down Expand Up @@ -546,7 +549,7 @@ public OrchestrationConfigListResponse listOrchestrationConfigHistory(
localVarPathParams.put("model_name", modelName);
final String localVarPath =
UriComponentsBuilder.fromPath(
"/lm/scenarios/{scenario}/orchestrationConfigs/{name}/versions/{version}/models/{model_name}/history")
"/registry/v2/scenarios/{scenario}/orchestrationConfigs/{name}/versions/{version}/models/{model_name}/history")
.buildAndExpand(localVarPathParams)
.toUriString();

Expand Down Expand Up @@ -651,7 +654,7 @@ public OrchestrationConfigListResponse listOrchestrationConfigs(
final Object localVarPostBody = null;

final String localVarPath =
UriComponentsBuilder.fromPath("/lm/orchestrationConfigs").build().toUriString();
UriComponentsBuilder.fromPath("/registry/v2/orchestrationConfigs").build().toUriString();

final MultiValueMap<String, String> localVarQueryParams =
new LinkedMultiValueMap<String, String>();
Expand Down
79 changes: 64 additions & 15 deletions ...ompt-registry/src/main/java/com/sap/ai/sdk/prompt/registry/client/PromptTemplatesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,15 @@ public PromptTemplatesApi(@Nonnull final ApiClient apiClient) {
* @param promptTemplatePostRequest (required) The value for the parameter
* promptTemplatePostRequest
* @param aiResourceGroup (optional) Specify a resource group id to use
* @param aiResourceGroupScope (optional) Specify whether the resource group scope is to be used
* @return PromptTemplatePostResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
@Nonnull
public PromptTemplatePostResponse createUpdatePromptTemplate(
@Nonnull final PromptTemplatePostRequest promptTemplatePostRequest,
@Nullable final String aiResourceGroup)
@Nullable final String aiResourceGroup,
@Nullable final String aiResourceGroupScope)
throws OpenApiRequestException {
final Object localVarPostBody = promptTemplatePostRequest;

Expand All @@ -95,6 +97,9 @@ public PromptTemplatePostResponse createUpdatePromptTemplate(

if (aiResourceGroup != null)
localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
localVarHeaderParams.add(
"AI-Resource-Group-Scope", apiClient.parameterToString(aiResourceGroupScope));

final String[] localVarAccepts = {"application/json"};
final List<MediaType> localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
Expand Down Expand Up @@ -137,7 +142,7 @@ public PromptTemplatePostResponse createUpdatePromptTemplate(
public PromptTemplatePostResponse createUpdatePromptTemplate(
@Nonnull final PromptTemplatePostRequest promptTemplatePostRequest)
throws OpenApiRequestException {
return createUpdatePromptTemplate(promptTemplatePostRequest, null);
return createUpdatePromptTemplate(promptTemplatePostRequest, null, null);
}

/**
Expand All @@ -153,12 +158,15 @@ public PromptTemplatePostResponse createUpdatePromptTemplate(
*
* @param promptTemplateId (required) The value for the parameter promptTemplateId
* @param aiResourceGroup (optional) Specify a resource group id to use
* @param aiResourceGroupScope (optional) Specify whether the resource group scope is to be used
* @return PromptTemplateDeleteResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
@Nonnull
public PromptTemplateDeleteResponse deletePromptTemplate(
@Nonnull final UUID promptTemplateId, @Nullable final String aiResourceGroup)
@Nonnull final UUID promptTemplateId,
@Nullable final String aiResourceGroup,
@Nullable final String aiResourceGroupScope)
throws OpenApiRequestException {
final Object localVarPostBody = null;

Expand All @@ -184,6 +192,9 @@ public PromptTemplateDeleteResponse deletePromptTemplate(

if (aiResourceGroup != null)
localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
localVarHeaderParams.add(
"AI-Resource-Group-Scope", apiClient.parameterToString(aiResourceGroupScope));

final String[] localVarAccepts = {"application/json"};
final List<MediaType> localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
Expand Down Expand Up @@ -225,7 +236,7 @@ public PromptTemplateDeleteResponse deletePromptTemplate(
@Nonnull
public PromptTemplateDeleteResponse deletePromptTemplate(@Nonnull final UUID promptTemplateId)
throws OpenApiRequestException {
return deletePromptTemplate(promptTemplateId, null);
return deletePromptTemplate(promptTemplateId, null, null);
}

/**
Expand All @@ -239,12 +250,15 @@ public PromptTemplateDeleteResponse deletePromptTemplate(@Nonnull final UUID pro
*
* @param promptTemplateId (required) The value for the parameter promptTemplateId
* @param aiResourceGroup (optional) Specify a resource group id to use
* @param aiResourceGroupScope (optional) Specify whether the resource group scope is to be used
* @return File
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
@Nonnull
public File exportPromptTemplate(
@Nonnull final UUID promptTemplateId, @Nullable final String aiResourceGroup)
@Nonnull final UUID promptTemplateId,
@Nullable final String aiResourceGroup,
@Nullable final String aiResourceGroupScope)
throws OpenApiRequestException {
final Object localVarPostBody = null;

Expand All @@ -270,6 +284,9 @@ public File exportPromptTemplate(

if (aiResourceGroup != null)
localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
localVarHeaderParams.add(
"AI-Resource-Group-Scope", apiClient.parameterToString(aiResourceGroupScope));

final String[] localVarAccepts = {"application/octet-stream", "application/json"};
final List<MediaType> localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
Expand Down Expand Up @@ -309,7 +326,7 @@ public File exportPromptTemplate(
@Nonnull
public File exportPromptTemplate(@Nonnull final UUID promptTemplateId)
throws OpenApiRequestException {
return exportPromptTemplate(promptTemplateId, null);
return exportPromptTemplate(promptTemplateId, null, null);
}

/**
Expand All @@ -325,12 +342,15 @@ public File exportPromptTemplate(@Nonnull final UUID promptTemplateId)
*
* @param promptTemplateId (required) The value for the parameter promptTemplateId
* @param aiResourceGroup (optional) Specify a resource group id to use
* @param aiResourceGroupScope (optional) Specify whether the resource group scope is to be used
* @return PromptTemplateGetResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
@Nonnull
public PromptTemplateGetResponse getPromptTemplateByUuid(
@Nonnull final UUID promptTemplateId, @Nullable final String aiResourceGroup)
@Nonnull final UUID promptTemplateId,
@Nullable final String aiResourceGroup,
@Nullable final String aiResourceGroupScope)
throws OpenApiRequestException {
final Object localVarPostBody = null;

Expand All @@ -356,6 +376,9 @@ public PromptTemplateGetResponse getPromptTemplateByUuid(

if (aiResourceGroup != null)
localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
localVarHeaderParams.add(
"AI-Resource-Group-Scope", apiClient.parameterToString(aiResourceGroupScope));

final String[] localVarAccepts = {"application/json"};
final List<MediaType> localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
Expand Down Expand Up @@ -397,7 +420,7 @@ public PromptTemplateGetResponse getPromptTemplateByUuid(
@Nonnull
public PromptTemplateGetResponse getPromptTemplateByUuid(@Nonnull final UUID promptTemplateId)
throws OpenApiRequestException {
return getPromptTemplateByUuid(promptTemplateId, null);
return getPromptTemplateByUuid(promptTemplateId, null, null);
}

/**
Expand All @@ -410,13 +433,16 @@ public PromptTemplateGetResponse getPromptTemplateByUuid(@Nonnull final UUID pro
* <p><b>0</b> - Common Error
*
* @param aiResourceGroup (optional) Specify a resource group id to use
* @param aiResourceGroupScope (optional) Specify whether the resource group scope is to be used
* @param _file (optional) The value for the parameter _file
* @return PromptTemplatePostResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
@Nonnull
public PromptTemplatePostResponse importPromptTemplate(
@Nullable final String aiResourceGroup, @Nullable final File _file)
@Nullable final String aiResourceGroup,
@Nullable final String aiResourceGroupScope,
@Nullable final File _file)
throws OpenApiRequestException {
final Object localVarPostBody = null;

Expand All @@ -431,6 +457,9 @@ public PromptTemplatePostResponse importPromptTemplate(

if (aiResourceGroup != null)
localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
localVarHeaderParams.add(
"AI-Resource-Group-Scope", apiClient.parameterToString(aiResourceGroupScope));

if (_file != null) localVarFormParams.add("file", new FileSystemResource(_file));

Expand Down Expand Up @@ -470,7 +499,7 @@ public PromptTemplatePostResponse importPromptTemplate(
*/
@Nonnull
public PromptTemplatePostResponse importPromptTemplate() throws OpenApiRequestException {
return importPromptTemplate(null, null);
return importPromptTemplate(null, null, null);
}

/**
Expand All @@ -488,6 +517,7 @@ public PromptTemplatePostResponse importPromptTemplate() throws OpenApiRequestEx
* @param version (required) The value for the parameter version
* @param name (required) The value for the parameter name
* @param aiResourceGroup (optional) Specify a resource group id to use
* @param aiResourceGroupScope (optional) Specify whether the resource group scope is to be used
* @return PromptTemplateListResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
Expand All @@ -496,7 +526,8 @@ public PromptTemplateListResponse listPromptTemplateHistory(
@Nonnull final String scenario,
@Nonnull final String version,
@Nonnull final String name,
@Nullable final String aiResourceGroup)
@Nullable final String aiResourceGroup,
@Nullable final String aiResourceGroupScope)
throws OpenApiRequestException {
final Object localVarPostBody = null;

Expand Down Expand Up @@ -537,6 +568,9 @@ public PromptTemplateListResponse listPromptTemplateHistory(

if (aiResourceGroup != null)
localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
localVarHeaderParams.add(
"AI-Resource-Group-Scope", apiClient.parameterToString(aiResourceGroupScope));

final String[] localVarAccepts = {"application/json"};
final List<MediaType> localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
Expand Down Expand Up @@ -581,7 +615,7 @@ public PromptTemplateListResponse listPromptTemplateHistory(
public PromptTemplateListResponse listPromptTemplateHistory(
@Nonnull final String scenario, @Nonnull final String version, @Nonnull final String name)
throws OpenApiRequestException {
return listPromptTemplateHistory(scenario, version, name, null);
return listPromptTemplateHistory(scenario, version, name, null, null);
}

/**
Expand All @@ -596,6 +630,7 @@ public PromptTemplateListResponse listPromptTemplateHistory(
* <p><b>0</b> - Common Error
*
* @param aiResourceGroup (optional) Specify a resource group id to use
* @param aiResourceGroupScope (optional) Specify whether the resource group scope is to be used
* @param scenario (optional) The value for the parameter scenario
* @param name (optional) The value for the parameter name
* @param version (optional) The value for the parameter version
Expand All @@ -607,6 +642,7 @@ public PromptTemplateListResponse listPromptTemplateHistory(
@Nonnull
public PromptTemplateListResponse listPromptTemplates(
@Nullable final String aiResourceGroup,
@Nullable final String aiResourceGroupScope,
@Nullable final String scenario,
@Nullable final String name,
@Nullable final String version,
Expand All @@ -633,6 +669,9 @@ public PromptTemplateListResponse listPromptTemplates(

if (aiResourceGroup != null)
localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
localVarHeaderParams.add(
"AI-Resource-Group-Scope", apiClient.parameterToString(aiResourceGroupScope));

final String[] localVarAccepts = {"application/json"};
final List<MediaType> localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
Expand Down Expand Up @@ -672,7 +711,7 @@ public PromptTemplateListResponse listPromptTemplates(
*/
@Nonnull
public PromptTemplateListResponse listPromptTemplates() throws OpenApiRequestException {
return listPromptTemplates(null, null, null, null, null, null);
return listPromptTemplates(null, null, null, null, null, null, null);
}

/**
Expand All @@ -688,6 +727,7 @@ public PromptTemplateListResponse listPromptTemplates() throws OpenApiRequestExc
*
* @param promptTemplateId (required) The value for the parameter promptTemplateId
* @param aiResourceGroup (optional) Specify a resource group id to use
* @param aiResourceGroupScope (optional) Specify whether the resource group scope is to be used
* @param metadata (optional, default to false) The value for the parameter metadata
* @param promptTemplateSubstitutionRequest (optional) The value for the parameter
* promptTemplateSubstitutionRequest
Expand All @@ -698,6 +738,7 @@ public PromptTemplateListResponse listPromptTemplates() throws OpenApiRequestExc
public PromptTemplateSubstitutionResponse parsePromptTemplateById(
@Nonnull final UUID promptTemplateId,
@Nullable final String aiResourceGroup,
@Nullable final String aiResourceGroupScope,
@Nullable final Boolean metadata,
@Nullable final PromptTemplateSubstitutionRequest promptTemplateSubstitutionRequest)
throws OpenApiRequestException {
Expand Down Expand Up @@ -727,6 +768,9 @@ public PromptTemplateSubstitutionResponse parsePromptTemplateById(

if (aiResourceGroup != null)
localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
localVarHeaderParams.add(
"AI-Resource-Group-Scope", apiClient.parameterToString(aiResourceGroupScope));

final String[] localVarAccepts = {"application/json"};
final List<MediaType> localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
Expand Down Expand Up @@ -768,7 +812,7 @@ public PromptTemplateSubstitutionResponse parsePromptTemplateById(
@Nonnull
public PromptTemplateSubstitutionResponse parsePromptTemplateById(
@Nonnull final UUID promptTemplateId) throws OpenApiRequestException {
return parsePromptTemplateById(promptTemplateId, null, null, null);
return parsePromptTemplateById(promptTemplateId, null, null, null, null);
}

/**
Expand All @@ -786,6 +830,7 @@ public PromptTemplateSubstitutionResponse parsePromptTemplateById(
* @param version (required) The value for the parameter version
* @param name (required) The value for the parameter name
* @param aiResourceGroup (optional) Specify a resource group id to use
* @param aiResourceGroupScope (optional) Specify whether the resource group scope is to be used
* @param metadata (optional, default to false) The value for the parameter metadata
* @param promptTemplateSubstitutionRequest (optional) The value for the parameter
* promptTemplateSubstitutionRequest
Expand All @@ -798,6 +843,7 @@ public PromptTemplateSubstitutionResponse parsePromptTemplateByNameVersion(
@Nonnull final String version,
@Nonnull final String name,
@Nullable final String aiResourceGroup,
@Nullable final String aiResourceGroupScope,
@Nullable final Boolean metadata,
@Nullable final PromptTemplateSubstitutionRequest promptTemplateSubstitutionRequest)
throws OpenApiRequestException {
Expand Down Expand Up @@ -842,6 +888,9 @@ public PromptTemplateSubstitutionResponse parsePromptTemplateByNameVersion(

if (aiResourceGroup != null)
localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
localVarHeaderParams.add(
"AI-Resource-Group-Scope", apiClient.parameterToString(aiResourceGroupScope));

final String[] localVarAccepts = {"application/json"};
final List<MediaType> localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
Expand Down Expand Up @@ -886,6 +935,6 @@ public PromptTemplateSubstitutionResponse parsePromptTemplateByNameVersion(
public PromptTemplateSubstitutionResponse parsePromptTemplateByNameVersion(
@Nonnull final String scenario, @Nonnull final String version, @Nonnull final String name)
throws OpenApiRequestException {
return parsePromptTemplateByNameVersion(scenario, version, name, null, null, null);
return parsePromptTemplateByNameVersion(scenario, version, name, null, null, null, null);
}
}
Loading
Loading