Release 1.4.0

What's Changed

🔧 Compatibility Notes

• [Orchestration] The constructors UserMessage(MessageContent) and SystemMessage(MessageContent) are removed. Use Message.user(String), Message.user(ImageItem), or Message.system(String) instead.
• Deprecate getCustomField(String) in favor of toMap() on generated model classes.
  • com.sap.ai.sdk.core.model.*
  • com.sap.ai.sdk.orchestration.model.*

✨ New Functionality

• [Orchestration] Add Spring AI tool calling.
• [Orchestration] Add new convenient methods to set the response format for Orchestration.
• [Document Grounding] Add Document Grounding Client
  • com.sap.ai.sdk:document-grounding:1.4.0
• [OpenAI] New generated model classes introduced for AzureOpenAI specification dated 2024-10-21.
• [OpenAI] Introducing new user interface for chat completion wrapping the generated model classes.
  • OpenAiChatCompletionRequest and OpenAiChatCompletionResponse' for high level request and response handling.
  • OpenAiUserMessage, OpenAiSystemMessage, OpenAiAssistantMessage and OpenAiToolMessage for message creation for different content types.
  • OpenAiToolChoice for configuring chat completion requests with tool selection strategy.
• [OpenAI] Introducing new user interface for embedding calls using OpenAiEmbeddingRequest and OpenAiEmbeddingResponse.

All Commits

click to expand

• chore: Improve Connecitivtiy Docs by @MatKuhr in #332
• fix: [Orchestration] Hide constructors for System- and UserMessage by @Jonas-Isr in #334
• feat: [OpenAI] Generated model classes for OpenAI client by @rpanackal in #322
• chore: [DevOps] bump com.github.spotbugs:spotbugs-maven-plugin from 4.8.6.6 to 4.9.1.0 in the plugins group by @dependabot in #337
• chore: [DevOps] bump org.wiremock:wiremock from 3.11.0 to 3.12.0 in the production-minor-patch group by @dependabot in #336
• fix: [DevOps] Dependency vulnerability scan to 12.1.0 by @CharlesDuboisSAP in #338
• feat: [OpenAI] Stable convenience - Latest by @rpanackal in #323
• chore: [DevOps] enforce Spring AI optional by @CharlesDuboisSAP in #339
• chore: better header documentation by @CharlesDuboisSAP in #344
• feat: Spring AI🍃Tool Calling by @CharlesDuboisSAP in #320
• chore: [DevOps] Update Cloud SDK to 5.17.0 by @CharlesDuboisSAP in #342
• chore: [DevOps] bump the plugins group with 2 updates by @dependabot in #346
• chore: [DevOps] bump the production-minor-patch group with 4 updates by @dependabot in #345
• feat: (Grounding) Initial client classes with generated API and model by @newtork in #317
• feat: [OpenAI] Integrate Messaging Convenience by @rpanackal in #326
• fix: Disable test regarding model availability by @Jonas-Isr in #349
• feat: [OpenAI] Tool Choice Convenience by @rpanackal in #330
• fix: Update docs by @CharlesDuboisSAP in #347
• chore: Enable E2E test for OpenAI models by @newtork in #350
• chore: Rename grounding to document-grounding by @newtork in #352
• feat: [OpenAI] Embedding Request Convenience by @rpanackal in #331
• chore: Consolidate OpenAI convenience methods to set tool-choice by @newtork in #351
• feat: PoC 📚 Prompt Registry client by @rpanackal in #343
• fix: prompt-registry parent pom declaration - release "no" by @newtork in #355
• chore: [OpenAI] Embedding type change to float[] by @rpanackal in #353
• docs: [OpenAI] Update documentation and release notes for new api by @rpanackal in #354
• chore: [OpenAI] Beta tag on toolChoice conv with equals and hashcode by @rpanackal in #358
• fix: Update model lists and model availability test by @TillK17 in #348
• feat: [Orchestration] Convenience for response format by @Jonas-Isr in #341
• fix: Align release notes with JS SDK by @Jonas-Isr in #360

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