Skip to content

chore: [Orchestration] Add warning for incompatible API usage #627

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

chore: [Orchestration] Add warning for incompatible API usage #627

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a169ce
Initial
newtork Oct 21, 2025
4f2221c
Formatting
bot-sdk-js Oct 21, 2025
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
10 changes: 10 additions & 0 deletions orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,16 @@ public OrchestrationClient(@Nonnull final HttpDestination destination) {
@Nonnull
public static CompletionRequestConfiguration toCompletionPostRequest(
@Nonnull final OrchestrationPrompt prompt, @Nonnull final OrchestrationModuleConfig config) {
if (prompt.getMessages().size() == 1 && prompt.getMessages().get(0) instanceof UserMessage m) {
val items = m.content().items();
if (items.size() == 1 && items.get(0) instanceof TextItem t) {
val JSON_SCHEMA = "https://json-schema.org/draft/2020-12/schema";
if (t.text().contains(JSON_SCHEMA) && config.getTemplateConfig() != null) {
log.warn("Combination of `entity(...)` and `withTemplateConfig(...)` is not supported.");
}
Comment on lines +85 to +88
Copy link
Member

@Jonas-Isr Jonas-Isr Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if testing just for https://json-schema.org/draft/2020-12/schema is good here. This might lead to false positives if a users specifies the schema version in their actual prompt (not sure how likely it is, but might happen?!)

I would thus add a bit of the formatting around it to the test string.

Suggested change
val JSON_SCHEMA = "https://json-schema.org/draft/2020-12/schema";
if (t.text().contains(JSON_SCHEMA) && config.getTemplateConfig() != null) {
log.warn("Combination of `entity(...)` and `withTemplateConfig(...)` is not supported.");
}
val JSON_SCHEMA = "\\n \\\"$schema\\\" : \\\"https://json-schema.org/draft/2020-12/schema\\\",";
if (t.text().contains(JSON_SCHEMA) && config.getTemplateConfig() != null) {
log.warn("Combination of `entity(...)` and `withTemplateConfig(...)` is not supported.");
}

Copy link
Contributor Author

@newtork newtork Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likely we shouldn't put this in OrchestrationClient altogether. If we put this into code, it'd be better located in Spring AI related class(es) 🤔

}
}

return ConfigToRequestTransformer.toCompletionPostRequest(prompt, config);
}

Expand Down
Loading