Release 1.3.0

What's Changed

🔧 Compatibility Notes

• Message.content() returns a ContentItem now instead of a String. Use ((TextItem) Message.content().items().get(0)).text() if the corresponding ContentItem is a TextItem and the string representation is needed.

✨ New Functionality

• Upgrade to release 2502a of AI Core.
• Orchestration:
  • Add LlamaGuardFilter.
  • Convenient methods to create messages containing images and multiple text inputs
  • Enable setting the response format

All Commits

click to expand

• fix: Fix link in PR message of prepare-release.yaml by @Jonas-Isr in #313
• feat: Llama🦙Guard by @CharlesDuboisSAP in #308
• feat: [DevOps] Update orchestration specification by @bot-sdk-js in #314
• fix: Update json version in parent POM by @Jonas-Isr in #315
• feat: [DevOps] Update core specification by @bot-sdk-js in #316
• chore: [DevOps] bump org.wiremock:wiremock from 3.10.0 to 3.11.0 in the production-minor-patch group by @dependabot in #318
• chore: Improve release notes by @TillK17 in #321
• chore: DevOps mvn install fail early by @CharlesDuboisSAP in #324
• feat: [DevOps] Update Orchestration to 2502a by @bot-sdk-js in #325
• feat: Orchestration image support by @Jonas-Isr in #294
• chore: Use absolute URL in release notes by @jjtang1985 in #329
• feat: [Orchestration] Enable and test setting response_format by @Jonas-Isr in #328

Full Changelog: https://github.com/SAP/ai-sdk-java/commits/rel/1.3.0

Release 1.2.0

🔧 Compatibility Notes

• SingleChatMessage, as well as new MultiChatMessage, are now subtypes of new interface ChatMessage.
  Most variables or methods previously typed as ChatMessage in model package are now typed as SingleChatMessage.
• Add missing @Beta annotations to all com.sap.ai.sdk.core.client and com.sap.ai.sdk.core.model classes.

✨ New Functionality

• New Orchestration features:
  • Spring AI integration
  • Add Grounding configuration convenience
  • Images are now supported as input in newly introduced MultiChatMessage.
  • MultiChatMessage also allows for multiple content items (text or image) in one object.
  • Grounding input can be masked with DPIConfig.
  • LLama Guard can now be used for content filtering.
  • Support for tool calling and response format
  • Updated the list for supported models (e.g., added amazon nova models).

📈 Improvements

• Update Orchestration client to version 0.48.2 (2501a)

All Commits

click to expand

• Reduce duplication of StreamingResponseHandlers by @CharlesDuboisSAP in #258
• Fix release script by @CharlesDuboisSAP in #265
• [Sample App] Content filtering demo by @rpanackal in #256
• chore: [Documentation] Add Disclaimer for Model Classes and Improve Connectivity Guide by @MatKuhr in #268
• chore(core): Add unit test for ClientResponseHandler class by @newtork in #251
• [Doc] For request/parameter objects, use var instead of type by @newtork in #236
• chore: [DevOps] bump the plugins group with 2 updates by @dependabot in #272
• fix: [Core] Add Missing Beta Annotations by @MatKuhr in #275
• fix: Add actual messages to AI Core endpoints in sample app by @Jonas-Isr in #270
• feat: [Orchestration] Spec update 12a by @TillK17 in #267
• docs: [DevOps] Update Release Strategy ADR by @MatKuhr in #274
• test: [Orchestration] Success scenarios for PolymorphicFallbackDeserializer by @rpanackal in #279
• chore: [DevOps] Slack Notification for Snapshot Deployment Job by @MatKuhr in #277
• chore [Orchestration]: Update of available model list by @TillK17 in #280
• chore: [DevOps] PR Title Linter by @MatKuhr in #273
• test: [Orchestration] Extend Grounding Unit Test by @rpanackal in #281
• feat: [Orchestration] Spring AI integration by @CharlesDuboisSAP in #278
• feat: [DevOps] Update orchestration Specification to 0.48 by @bot-sdk-js in #285
• chore: [DevOps] Automation to Update Spec Files by @MatKuhr in #282
• chore: [DevOps] bump com.diffplug.spotless:spotless-maven-plugin from 2.44.1 to 2.44.2 in the plugins group by @dependabot in #288
• chore: [DevOps] bump org.assertj:assertj-core from 3.27.2 to 3.27.3 in the production-minor-patch group by @dependabot in #287
• chore: [DevOps] Switch From Temurin to SapMachine by @skateball in #286
• fix: Add Spring AI Dependency Requirements to the Docs by @MatKuhr in #291
• feat: Spring AI Orchestration streaming by @CharlesDuboisSAP in #292
• chore: [DevOps] Minor Spec Update Job Improvements by @MatKuhr in #299
• ci: Fix jacoco coverage by @TillK17 in #296
• chore: [DevOps] bump org.openapitools:openapi-generator-maven-plugin from 7.10.0 to 7.11.0 in the plugins group by @dependabot in #302
• chore: [DevOps] bump com.puppycrawl.tools:checkstyle from 10.21.1 to 10.21.2 in the production-minor-patch group by @dependabot in #301
• feat: Orchestration Grounding convenience by @CharlesDuboisSAP in #293
• fix: release_notes.md by @CharlesDuboisSAP in #304
• fix: Fosstars badge by @CharlesDuboisSAP in #303
• feat: Update model list for orchestration by @jjtang1985 in #307
• fix: Removed Javascript from Spring application by @CharlesDuboisSAP in #306
• fix: Spring AI consistent behaviour with Orchestration streaming by @CharlesDuboisSAP in #309
• chore: Update Cloud SDK to version 5.16.0 by @Jonas-Isr in #310

New Contributors

• @skateball made their first contribution in #286

Full Changelog: https://github.com/SAP/ai-sdk-java/commits/rel/1.2.0

Release 1.1.0

Version 1.1.0 mainly brings enhancements for the Orchestration service, including streaming support.

🔧 Compatibility Notes

• Changed return type of List<Double> getEmbedding() from experimental API OpenAiEmbeddingData to float[] to match recent Spring AI change.

✨ New Functionality

• Added streamChatCompletion() and streamChatCompletionDeltas() to the OrchestrationClient.

📈 Improvements

• Update AI Core client to 2.37.0

All Commits

click to expand

• chore: move orchestration package up in the Readme by @jjtang1985 in #226
• Try fix CVE scan by @MatKuhr in #225
• Release notes 1.0.0 by @CharlesDuboisSAP in #229
• Fix CVE Scan again by @MatKuhr in #232
• Added embedding documentation by @CharlesDuboisSAP in #230
• chore: [DevOps] bump org.apache.maven.plugins:maven-javadoc-plugin from 3.11.1 to 3.11.2 in the plugins group by @dependabot in #234
• chore: [DevOps] bump the production-minor-patch group with 2 updates by @dependabot in #233
• Update with new generator version by @MatKuhr in #235
• [Blog] Introduction blog post by @newtork in #154
• [Documentation] Update Readme and Document using Destinations by @MatKuhr in #231
• Test: Using Orchestration Grounding module by @Jonas-Isr in #228
• Orchestration streaming by @CharlesDuboisSAP in #227
• Exchanged GPT-3.5 for Gemini-1.5 in OrchestrationTest by @Jonas-Isr in #238
• Split logic of sample-app into service and controller by @Jonas-Isr in #240
• chore: [Orchestration] Improve Streaming Sample Code by @MatKuhr in #243
• Refactor OpenAiController in sample app by @Jonas-Isr in #245
• chore: [DevOps] bump the plugins group with 6 updates by @dependabot in #249
• chore: [DevOps] Update to Cloud SDK 5.15.0 by @MatKuhr in #246
• Reduce duplication of ResponseHandlers by @CharlesDuboisSAP in #244
• chore: [DevOps] bump the production-minor-patch group across 1 directory with 4 updates by @dependabot in #250
• [Docs] Document using a custom RG by @MatKuhr in #247
• Change OpenAI Emedding vector type from List<Double> to float[] by @newtork in #252
• chore: [DevOps] bump com.puppycrawl.tools:checkstyle from 10.21.0 to 10.21.1 in the production-minor-patch group by @dependabot in #254
• Html page redesign by @TillK17 in #242
• Increase Test Coverage for Orchestration by @Jonas-Isr in #255
• chore: [DevOps] bump the production-minor-patch group with 3 updates by @dependabot in #259
• Fix: Update Table of Contents by @jjtang1985 in #260
• Update AI Core specification by @bot-sdk-js in #261
• Missing release notes by @CharlesDuboisSAP in #263

New Contributors

• @bot-sdk-js made their first contribution in #14
• @jjtang1985 made their first contribution in #54
• @rpanackal made their first contribution in #42
• @Jonas-Isr made their first contribution in #153
• @Terry-Huang-00 made their first contribution in #159
• @TillK17 made their first contribution in #242

Full Changelog: https://github.com/SAP/ai-sdk-java/commits/rel/1.1.0

Release 1.0.0

✨ New Functionality

• Introduce AI Core client to consume the AI Core Rest APIs.
  Here are a few features:
  • Artifact management: register and organize datasets and model artifacts.
  • Configuration management: set up configurations for various models and use cases.
  • Deployment management: deploy AI models and manage their lifecycle within SAP AI Core.
• Introduce Orchestration client for consuming the following features of the orchestration service:
  • Harmonized LLM access via orchestration
  • Prompt templates
  • Content filtering
  • Masking
• Introduce the OpenAI client to consume the following features:
  • Chat completion and streaming chat completion
    • Text
    • Images
    • Tools
  • Generate embeddings for input text.

All Commits

click to expand

• [Ops] Test compatibility with Cloud SDK automatically by @newtork in #161
• chore: [DevOps] Reschedule E2E Tests by @MatKuhr in #175
• Data Masking Convenience by @CharlesDuboisSAP in #172
• Add orchestration convenient filtering API by @rpanackal in #169
• Change tool_calls to camelCase by @Jonas-Isr in #176
• Drop redundant "model" method prefix by @newtork in #170
• Align handling of empty choices by @Jonas-Isr in #179
• Add Response Convenience by @Jonas-Isr in #173
• [Doc] Add SAP Cloud SDK version requirements by @newtork in #160
• fix: AiCoreService NoClassDefFound Error by @MatKuhr in #178
• feat: [Orchestration] Configuration as JSON String by @MatKuhr in #177
• chore: [DevOps] OWASP Cache by @MatKuhr in #188
• fix: Update Response Masking Format by @MatKuhr in #191
• Update AI Core specification by @bot-sdk-js in #183
• fix: [DevOps] Fix Masking E2E Test by @MatKuhr in #194
• Cloud SDK generator with oneOf fix by @CharlesDuboisSAP in #186
• Dependency License Compliance Test by @rpanackal in #189
• chore: [DevOps] bump the plugins group with 5 updates by @dependabot in #185
• chore: [DevOps] E2E Test Matrix Build by @MatKuhr in #193
• chore: improve maven pom descriptions by @CharlesDuboisSAP in #197
• [DevOps] ADR005: Development Lifecycle by @MatKuhr in #192
• Renamed generated packages by @CharlesDuboisSAP in #196
• chore: [DevOps] Update OWASP Workflow by @MatKuhr in #190
• [Orchestration Convenience] Typed model parameters by @newtork in #180
• Automate release notes by @Jonas-Isr in #200
• Chat Message Convenience [Redone] by @rpanackal in #199
• chore: [DevOps] bump the production-minor-patch group with 2 updates by @dependabot in #207
• chore: [DevOps] bump org.codehaus.mojo:license-maven-plugin from 2.4.0 to 2.5.0 in the plugins group by @dependabot in #208
• feat: [Orchestration] Update to Orchestration Spec 0.36.1 by @MatKuhr in #203
• [Orchestration] Convenience Message on Response by @rpanackal in #205
• Fix javadoc in sample code by @Jonas-Isr in #214
• Add links to orchestration documentation in javadocs by @Jonas-Isr in #213
• Refactor AiCoreService class by @MatKuhr in #201
• chore: [DevOps] Switch to Mirror for CVE Downloads by @MatKuhr in #202
• chore: Code Cleanup Before GA Release by @MatKuhr in #212
• chore: [DevOps] Fix Slack Notifications by @MatKuhr in #216
• feat: [Orchestration] Make getChoice public by @MatKuhr in #204
• Update PULL_REQUEST_TEMPLATE.md by @CharlesDuboisSAP in #218
• Add @Beta annotation to OpenAI model classes by @newtork in #221
• feat: [Core] Updated Base Path Behaviour by @MatKuhr in #219
• E2E Different Resource Group by @rpanackal in #222
• chore: Remove disclaimer by @jjtang1985 in #210

New Contributors

• @bot-sdk-js made their first contribution in #14
• @jjtang1985 made their first contribution in #54
• @rpanackal made their first contribution in #42
• @Jonas-Isr made their first contribution in #153
• @Terry-Huang-00 made their first contribution in #159

Full Changelog: https://github.com/SAP/ai-sdk-java/commits/rel/1.0.0

Release 0.2.0

What's Changed

• Refactor Core class by @newtork in #79
• chore: Include License in Release JAR Files by @MatKuhr in #101
• Refactor AiCoreDeployment by @CharlesDuboisSAP in #100
• Update docs by @newtork in #102
• Added resource group isolation to DeploymentCache by @CharlesDuboisSAP in #103
• Release 0.1.0 by @bot-sdk-js in #105
• Openai model version by @rpanackal in #99
• Fix Readme by @newtork in #110
• Update OPENAI_CHAT_COMPLETION.md by @rpanackal in #112
• Run PMD by default by @newtork in #106
• Run Spotbugs by default by @newtork in #109
• Run Checkstyle by default by @newtork in #111
• Lombok use of val by @newtork in #104
• chore: [DevOps] bump the test group with 2 updates by @dependabot in #121
• chore: [DevOps] bump the plugins group with 7 updates by @dependabot in #120
• chore: [DevOps] bump the production-minor-patch group across 1 directory with 3 updates by @dependabot in #122
• Chore/sample app readme update by @MatKuhr in #125
• [Streaming] Fix issues when not using try-with-resource by @newtork in #49
• Orchestration Client by @CharlesDuboisSAP in #128
• Updated AI Core unit tests by @CharlesDuboisSAP in #131
• Added Cloud SDK logo by @CharlesDuboisSAP in #132
• AICORE_SERVICE_KEY in .env file by @CharlesDuboisSAP in #129
• Make checkstyle fail on info-level findings by @newtork in #130
• Remove redundant property by @newtork in #126
• chore: [DevOps] bump the plugins group with 3 updates by @dependabot in #134
• chore: [DevOps] bump the production-minor-patch group with 2 updates by @dependabot in #133
• Performance fix: Made Dotenv.load() static by @CharlesDuboisSAP in #135
• [DevOps] Skip Code Generation By Default by @MatKuhr in #123
• [CI/CD] Run test coverage check locally by @newtork in #116
• [CI/CD] Remove redundant steps from workflow: Checkstyle, PMD, Spotbugs by @newtork in #115
• README fix for AICORE_SERVICE_KEY instructions by @CharlesDuboisSAP in #137
• Reduce visibility AiCoreService#DOTENV from public to private by @newtork in #136
• feat: Improve Orchestration Sample Code by @MatKuhr in #141
• chore: Remove Backend_details workaround by @MatKuhr in #142
• [README] Add vulnerability disclaimer by @newtork in #138
• feat: Orchestration Prompt by @MatKuhr in #140
• Better constructor for generated clients (Cloud SDK 5.14.0 update) by @dependabot in #148
• YAML Issue templates by @CharlesDuboisSAP in #144
• Enabling compilation with JDK23+ by @Jonas-Isr in #153
• Update README.md: Fix Navigation in "Set AI Core Credentials" by @Jonas-Isr in #155
• [PMD] Apply public API rules to protected as well by @newtork in #156
• chore: [Orchestration] Increase Test Coverage by @MatKuhr in #147
• Openapi generator orchestration by @rpanackal in #146
• chore: [DevOps] bump com.github.spotbugs:spotbugs-maven-plugin from 4.8.6.5 to 4.8.6.6 in the plugins group by @dependabot in #164
• chore: [DevOps] bump the production-minor-patch group with 6 updates by @dependabot in #163
• don't need /v2 by @Terry-Huang-00 in #159
• fix: Unmasking Output Parsing by @MatKuhr in #165
• Added Response Convenience by @Jonas-Isr in #157
• fix: [DevOps] Release Script by @MatKuhr in #168
• Added Orchestration LLM Config Convenience by @CharlesDuboisSAP in #152

New Contributors

• @bot-sdk-js made their first contribution in #14
• @jjtang1985 made their first contribution in #54
• @rpanackal made their first contribution in #42
• @Jonas-Isr made their first contribution in #153
• @Terry-Huang-00 made their first contribution in #159

Full Changelog: https://github.com/SAP/ai-sdk-java/commits/rel/0.2.0

Release 0.1.0

What's Changed

• Repository Migration by @CharlesDuboisSAP in #1
• Fix e2e test pipeline by @CharlesDuboisSAP in #5
• Fix GitHub action typo by @CharlesDuboisSAP in #6
• Add Dependabot by @CharlesDuboisSAP in #8
• Remove Weekly AI Core specification file update by @CharlesDuboisSAP in #7
• Update AI Core specification by @bot-sdk-js in #14
• chore: [DevOps] bump org.slf4j:slf4j-simple from 2.0.13 to 2.0.16 in the test group by @dependabot in #13
• chore: [DevOps] bump com.puppycrawl.tools:checkstyle from 8.41 to 10.17.0 in the production-major group by @dependabot in #11
• chore: Update SAP Cloud SDK by @newtork in #4
• Changed service key env var to AICORE_SERVICE_KEY by @CharlesDuboisSAP in #16
• [OpenAPI] Enable builder pattern by @newtork in #18
• Added REUSE compliance by @CharlesDuboisSAP in #17
• chore: [ADR] Testing Strategy by @MatKuhr in #2
• chore [ADR] Code Generation by @MatKuhr in #3
• chore: [DevOps] bump the plugins group across 1 directory with 6 updates by @dependabot in #23
• Added CodeQL by @CharlesDuboisSAP in #21
• Added Fosstars by @CharlesDuboisSAP in #22
• Remove requireNonNull by @CharlesDuboisSAP in #24
• Compliance by @CharlesDuboisSAP in #15
• Enable CI on main by @CharlesDuboisSAP in #26
• Enable automatic formatting of generated code by @newtork in #33
• chore: [DevOps] bump the production-minor-patch group across 1 directory with 10 updates by @dependabot in #31
• chore: [DevOps] bump the plugins group across 1 directory with 3 updates by @dependabot in #34
• Fixed e2e tests by @CharlesDuboisSAP in #37
• chore: Update Orchestration Spec by @MatKuhr in #38
• Update SAP Cloud SDK dependency [5.12.0] by @newtork in #44
• feat: Add Metering Header by @MatKuhr in #45
• OpenAI Streaming by @CharlesDuboisSAP in #25
• Fix E2E Test by @MatKuhr in #51
• Use "SAP Cloud SDK for AI" in readme by @jjtang1985 in #54
• doc: Add explanation for service binding options by @newtork in #35
• [OpenAPI] Enable fallback value for nullable=false enum fields by @newtork in #46
• Simple OpenAI API by @CharlesDuboisSAP in #47
• chore: [DevOps] bump slackapi/slack-github-action from 1.26.0 to 1.27.0 in the github-actions group by @dependabot in #39
• Renamed e2e-test-app to sample-code/spring-app by @CharlesDuboisSAP in #61
• Update AI Core specification by @bot-sdk-js in #58
• chore: [DevOps] bump the production-minor-patch group across 1 directory with 7 updates by @dependabot in #59
• Add unit test by @rpanackal in #42
• chore: [DevOps] bump the plugins group across 1 directory with 3 updates by @dependabot in #55
• Add Workaround for backend_details change by @MatKuhr in #60
• Added Contributing with AI-generated code by @CharlesDuboisSAP in #63
• Create issue template by @CharlesDuboisSAP in #62
• Extending unit tests by @rpanackal in #65
• Dependabot automerge by @CharlesDuboisSAP in #69
• [OpenAPI] Trim operation name prefixes by @newtork in #20
• Added release script by @CharlesDuboisSAP in #64
• Release fix by @CharlesDuboisSAP in #78
• Test OpenAI Model Availability by @rpanackal in #80
• Update OpenAI test payload by @CharlesDuboisSAP in #70
• Notify when main branch fails by @CharlesDuboisSAP in #81
• chore: [DevOps] bump the plugins group across 1 directory with 5 updates by @dependabot in #74
• chore: [DevOps] bump the production-minor-patch group across 1 directory with 2 updates by @dependabot in #75
• Added Orchestration Data Masking tests by @MatKuhr in #52
• chore: [DevOps] bump the test group with 2 updates by @dependabot in #89
• chore: [DevOps] bump the plugins group across 1 directory with 3 updates by @dependabot in #90
• Dependabot Auto-Merge fix by @CharlesDuboisSAP in #91
• Added OWASP Dependency check by @CharlesDuboisSAP in #82
• Refactor docs by @rpanackal in #92
• Update Orchestration specification by @bot-sdk-js in #85
• chore: [DevOps] bump the plugins group with 2 updates by @dependabot in #94
• chore: [DevOps] bump the production-minor-patch group with 3 updates by @dependabot in #93
• Release 0.1.0 by @bot-sdk-js in #97
• Fix release by @CharlesDuboisSAP in #98
• Refactor Core class by @newtork in #79
• chore: Include License in Release JAR Files by @MatKuhr in #101
• Refactor AiCoreDeployment by @CharlesDuboisSAP in #100
• Update docs by @newtork in #102
• Added resource group isolation to DeploymentCache by @CharlesDuboisSAP in #103

New Contributors

• @bot-sdk-js made their first contribution in #14
• @dependabot made their first contribution in #13
• @MatKuhr made their first contribution in #2
• @jjtang1985 made their first contribution in #54
• @rpanackal made their first contribution in #42

Full Changelog: https://github.com/SAP/ai-sdk-java/commits/rel/0.1.0