Release 1.10.0

What's Changed

🔧 Compatibility Notes

• The Spring AI version has been increased from 1.0.0-M6 to the GA release 1.0.0.
  • The OrchestrationChatOptions have been, replacing all references to FunctionCallback with ToolCallback.
  • Please follow the official Spring AI upgrade guide for further details.
  • The @Beta annotations on all classes related to Spring AI have been removed.
• [Orchestration] The completion endpoint have been moved to the latest version /v2/completion
  • LLMModuleConfig is replaced by LLMModelDetails in withLLmConfig method of OrchestrationModuleConfig class.
  • PromptTemplatingModuleConfigPrompt replaces TemplatingModuleConfig in the withTemplateConfig method of OrchestrationModuleConfig class.
  • The generated model classes will reflect payload updates including restructuring of the module configurations and renaming of several fields.
• [Document Grounding] Breaking: The message field in RetrievalPerFilterSearchResultWithError is replaced by error and filterId with more specific error details.
• [Document Grounding] Extensive generated model class renaming for better specificity due to API spec changes.
  • SearchResults → VectorSearchResults
  • KeyValueListPair split into context-specific classes:
    • VectorKeyValueListPair for vector operations
    • RetrievalKeyValueListPair for retrieval operations
    • VectorDocumentKeyValueListPair for vector document operations
    • RetrievalDocumentKeyValueListPair for retrieval document operations
  • Chunk → VectorChunk and RetrievalChunk for different contexts
  • SearchFilter → VectorSearchFilter and RetrievalSearchFilter
  • SearchConfiguration → VectorSearchConfiguration and RetrievalSearchConfiguration

✨ New Functionality

• [Core] Added ClientExceptionFactory interface to provide custom exception mapping logic for different service clients.
• Extend OpenAiClientException and OrchestrationClientException to retrieve error diagnostics information received from remote service using getErrorResponse.
• [Orchestration] Introduced filtering related exceptions along with convenience methods to obtain additional contextual information.
  • OrchestrationInputFilterException for prompt filtering and OrchestrationOutputFilterException for response filtering.
    • getFilterDetails(): Returns a map of all filter details.
    • getAzureContentSafetyInput() and getAzureContentSafetyInput() : Returns Azure Content Safety filter scores
    • getLlamaGuard38b(): Returns LlamaGuard filter scores
• [Document Grounding] Extend PipelineApi operations, notably:
  • Added new pipeline creation requests for SDM and WorkZone with SDMPipelineCreateRequest and WorkZonePipelineCreateRequest.
  • S3 and SFTP pipeline configurations extended with S3Configuration and SFTPConfiguration for including data sources.
  • Support /pipelines/trigger endpoint to trigger pipelines on-demand via PipelinesApi#manualTriggerPipeline().

📈 Improvements

• Update AI Core client to 2.40.1
• [Document Grounding] Enhanced pipeline status reporting with additional metadata such as createdAt, modifiedAt, lastCompletedAt.

🐛 Fixed Issues

• OpenAi: Fix AssistantMessage Bug by now being able to send Assistant Messages using our API Client.

All Commits

click to expand

• fix: Grounding getAllPipelines now does not throw anymore by @Jonas-Isr in #509
• chore: Align Document Grounding Pipeline Identifier with JS by @MatKuhr in #512
• feat: Upgrade to Spring AI 1.0.0 (GA Version) by @MatKuhr in #503
• fix: Fix dependency tree field in bug-report.yml by @Jonas-Isr in #510
• chore: [DevOps] bump the plugins group with 5 updates by @dependabot[bot] in #517
• chore: [DevOps] bump the production-minor-patch group with 14 updates by @dependabot[bot] in #516
• fix: Bug OpenAI AssistantMessage by @n-o-u-r-h-a-n in #511
• chore: [OpenAI] Temporarily disable failing OpenAi model integration test by @newtork in #521
• chore: [DevOps] bump slackapi/slack-github-action from 2.1.0 to 2.1.1 in the github-actions group by @dependabot[bot] in #522
• chore: [DevOps] bump the production-minor-patch group with 3 updates by @dependabot[bot] in #524
• chore: [DevOps] bump the plugins group with 2 updates by @dependabot[bot] in #525
• feat: Sample Code for MCP Support by @MatKuhr in #513
• feat: [DevOps] Update core specification by @bot-sdk-js in #446
• feat: [Orchestration] Filtering details and additional convenience on exception by @rpanackal in #497
• fix: [Orchestration] V2 spec update by @rpanackal in #482
• feat: [OpenAI] Sample code for Agentic Workflow tutorial by @Jonas-Isr in #466
• chore: [DevOps] Latest Grounding spec update check by @rpanackal in #518

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