feat: [Orchestration] Support for Orchestration config persistence #697

Jonas-Isr · 2025-12-23T08:17:00Z

Context

https://github.com/orgs/SAP/projects/62/views/7?pane=issue&itemId=138596334&issue=SAP%7Cai-sdk-java-backlog%7C343

The PR enables the management of Orchestration Configs in prompt registry (create, delete, list via generated code and new client) as well as convenience to use these Orchestration Configs in the OrchestrationClient.

Sample of new convenience:

// create OrchestrationPrompt (for placeholder values and history) with already existing convenience
List<Message> history = List.of(new SystemMessage("System Message"));
OrchestrationPrompt prompt = new OrchestrationPrompt(Map.of("placeholder", "value")).messageHistory(history);

// create (newly added) OrchestrationConfigReference to refer to saved Orchestration config
OrchestrationConfigReference reference =
    OrchestrationConfigReference.fromScenario("scenario").name("name").version("0.0.1");

// use OrchestrationClient todo chat completion with the referenced config
OrchestrationChatResponse response = client.executeRequestFromReference(prompt, reference);

Feature scope:

add new OchestrationConfigClient in prompt registry
- unit and e2e tests for generated code and new client in prompt registry
convenience for use with OrchestrationClient
- unit and e2e tests for new convenience

Definition of Done

Functionality scope stated & covered
Tests cover the scope above
Error handling created / updated & covered by the tests above
~~Aligned changes with the JavaScript SDK~~
Documentation updated
- java: Support for Orchestration config persistence ai-sdk#353
Release notes updated

# Conflicts: # docs/release_notes.md

orchestration/src/main/java/com/sap/ai/sdk/orchestration/ConfigToRequestTransformer.java

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClient.java

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationConfigReference.java

.../prompt-registry/src/main/java/com/sap/ai/sdk/prompt/registry/OrchestrationConfigClient.java

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationConfigReference.java

CharlesDuboisSAP

Looking good 😎

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/OrchestrationService.java

docs/release_notes.md

orchestration/src/main/java/com/sap/ai/sdk/orchestration/ConfigToRequestTransformer.java

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/OrchestrationService.java

# Conflicts: # docs/release_notes.md # sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/PromptRegistryController.java # sample-code/spring-app/src/test/java/com/sap/ai/sdk/app/controllers/PromptRegistryTest.java

Jonas-Isr · 2026-01-14T15:17:42Z

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationPrompt.java

+   *     parameters.
+   */
+  @Nonnull
+  OrchestrationPrompt templateParameters(@Nonnull final Map<String, String> templateParameters) {


I need this to be able to set the template parameters in OrchestrationConfigReference.templateParameters()

Jonas-Isr · 2026-01-14T15:18:57Z

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationConfigReference.java

+@AllArgsConstructor(access = AccessLevel.PRIVATE)
+@Getter(AccessLevel.PACKAGE)
+@Beta
+public class OrchestrationConfigReference {


I put the prompt needed to call a config by reference into this class now to make it more convenient for the user.

CharlesDuboisSAP

LGTM

orchestration/src/main/java/com/sap/ai/sdk/orchestration/ConfigToRequestTransformer.java

newtork · 2026-01-16T09:38:54Z

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClient.java

+  @Beta
+  @Nonnull
+  public OrchestrationChatResponse chatCompletionUsingReference(
+      @Nonnull final OrchestrationConfigReference reference) {


(Question/Major)

I'm confused. Wouldn't we want (optional) prompt arguments?

I guess we expect the usage via prompt-parameters

All the necessary (and possible) options are now stored in the OrchestrationConfigReference object.

newtork · 2026-01-16T09:42:41Z

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationConfigReference.java

+  public OrchestrationConfigReference templateParameters(
+      @Nonnull final Map<String, String> templateParameters) {
+    prompt.templateParameters(templateParameters);
+    return this;


(Minor)

You are using shallow-immutability then? Can be acceptable, just a little surprising to me.

newtork · 2026-01-16T09:47:59Z

orchestration/src/test/java/com/sap/ai/sdk/orchestration/OrchestrationUnitTest.java

+            .templateParameters(params);
+    final var response = client.chatCompletionUsingReference(reference);
+
+    final String expectedRequest = fileLoaderStr.apply("orchConfigByRequestHistoryParams.json");


(Comment)

Looks good!

newtork · 2026-01-16T09:49:52Z

.../prompt-registry/src/main/java/com/sap/ai/sdk/prompt/registry/OrchestrationConfigClient.java

+        .addMixIn(OutputFilterConfig.class, JacksonMixin.OutputFilter.class)
+        .addMixIn(InputFilterConfig.class, JacksonMixin.InputFilter.class);
+    Iterables.filter(rt.getMessageConverters(), MappingJackson2YamlHttpMessageConverter.class)
+        .forEach(converter -> converter.setObjectMapper(yamlMapper));


(Question)

Why do we need a MappingJackson2YamlHttpMessageConverter?

newtork · 2026-01-16T10:16:18Z

...e-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/PromptRegistryController.java

+                                    .template(
+                                        UserChatMessage.create()
+                                            .content(
+                                                new UserChatMessageContent.InnerString("message"))


(Minor)

Please fix format.

Can we avoid this helper method? We should not attempt hiding complexity in our demo app.

Jonas-Isr added 8 commits December 4, 2025 16:28

add OrchestrationConfigClient, test list, add, delete

3e34453

intermediate

8abe277

clean up code

7039c85

add e2e tests

435aac5

add unit tests

7a6d117

small changes, more tests, and codestyle etc.

e6a8239

Merge branch 'main' into orchestrationConfig-persistence

33ddc76

# Conflicts: # docs/release_notes.md

fix after merge

54849bd

Jonas-Isr self-assigned this Dec 23, 2025

Jonas-Isr added the please-review Request to review a pull-request label Dec 23, 2025

Jonas-Isr commented Dec 23, 2025

View reviewed changes

orchestration/src/main/java/com/sap/ai/sdk/orchestration/ConfigToRequestTransformer.java Outdated Show resolved Hide resolved

Jonas-Isr commented Dec 23, 2025

View reviewed changes

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClient.java Outdated Show resolved Hide resolved

Jonas-Isr commented Dec 23, 2025

View reviewed changes

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationConfigReference.java Show resolved Hide resolved

newtork reviewed Dec 23, 2025

View reviewed changes

.../prompt-registry/src/main/java/com/sap/ai/sdk/prompt/registry/OrchestrationConfigClient.java Show resolved Hide resolved

newtork reviewed Dec 23, 2025

View reviewed changes

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationConfigReference.java Outdated Show resolved Hide resolved

newtork reviewed Dec 23, 2025

View reviewed changes

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationConfigReference.java Show resolved Hide resolved

CharlesDuboisSAP reviewed Jan 7, 2026

View reviewed changes

Jonas-Isr added 7 commits January 13, 2026 11:02

refactor OrchestrationConfigReference and rename method

1b42911

reviews

fb1ecd4

more reviews

67db669

more reviews and formatting

bef51dd

fix dependency issues

8f9e811

Merge branch 'main' into orchestrationConfig-persistence

85759ad

Jonas-Isr commented Jan 14, 2026

View reviewed changes

small fixes

cc63701

CharlesDuboisSAP reviewed Jan 15, 2026

View reviewed changes

Jonas-Isr mentioned this pull request Jan 15, 2026

java: Support for Orchestration config persistence SAP/ai-sdk#353

Open

add links to release_notes

7082cd0

newtork reviewed Jan 16, 2026

View reviewed changes

orchestration/src/main/java/com/sap/ai/sdk/orchestration/ConfigToRequestTransformer.java Show resolved Hide resolved

newtork reviewed Jan 16, 2026

View reviewed changes

feat: [Orchestration] Support for Orchestration config persistence #697

Are you sure you want to change the base?

feat: [Orchestration] Support for Orchestration config persistence #697

Uh oh!

Conversation

Jonas-Isr commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Feature scope:

Definition of Done

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CharlesDuboisSAP left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CharlesDuboisSAP left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Jonas-Isr commented Dec 23, 2025 •

edited

Loading