Upgrade 16.7 to 16.8
Overview
This guide describes how to upgrade a Bloomreach Content implementation from version 16.7.x to 16.8.y.
Significant Changes
Version 16.8 introduces new features, technical stack updates, and product improvements. Key updates for developers and users upgrading from 16.7 to 16.8 include:
- Search Agent: Enables conversational natural language search across the content repository, integrated with the AI Content Assistant. Requires a vector store connection. For setup and configuration, see the AI Content Assistant initialization and configuration guide.
- AI Extensibility - VectorStoreFactory (Incubating): Provides a new SPI for connecting a custom or self-managed vector store to the Search Agent. Implement and register this as a Spring
@Component. For details, refer to the AI Module Extensibility Guide. - AI Extensibility - ClientToolPackage: Introduces a new SPI to register custom AI-callable tools in the chat assistant. These tools can access the current user and document context at runtime. See the AI Module Extensibility Guide for implementation guidance.
- Revision Restoration Control: Adds a date threshold to block restoration of revisions created before a migration. This feature is disabled by default. Configure it using a JCR property or system variable. For configuration steps, see Configure a Revision Compatibility Date on Document Types.
- LiteLLM Configuration Update: LiteLLM now uses a dedicated connector under the
spring.ai.litellm.*property namespace. Previously, LiteLLM was configured through the generic OpenAI-compatible connector, which prevented separate configurations for OpenAI and LiteLLM. Migration to the new namespace is optional but recommended if you use LiteLLM. For more information, see Multiplicity of configurations.
For a complete list of changes, see the 16.8.0 release notes.
Upgrade Steps
1. Perform Generic Minor Upgrade Steps
Follow the generic instructions for minor upgrades.
2. Review and Update Custom Project Code
Third-party library upgrades in this release may introduce backward compatibility issues. If your project code fails to build or run after the upgrade, review the affected libraries and update your code as needed to ensure compatibility.
3. Update OpenAI Completions Path Property
In version 16.8.0, the configuration property for the OpenAI provider's custom completions path has changed. If you have set a custom completions path for the OpenAI provider (such as when using Azure OpenAI or a compatible endpoint), update the property name in your JCR configuration before upgrading.
| Previous Property Name | New Property Name |
|---|---|
| spring.ai.openai.chat.options.completions-path | spring.ai.openai.chat.completions-path |
For additional details, refer to the upgrade instructions for AI Module.
4. Review Detailed Release Notes
See the detailed release notes for more information about this release.