Upgrade 16.5 to 16.6

Warning: Versions 16.6.0 and 16.6.1 are deprecated. Upgrade to the latest available patch release in the 16.6 series (for example, 16.6.5 or higher).

Overview

This guide describes how to upgrade a Bloomreach Content project from version 16.5.x to 16.6.y.

Key Changes in 16.6

Version 16.6 introduces new features, technical stack updates, and product improvements. Notable changes for developers and administrators upgrading from 16.5 include:

AI Content Assistant: Expanded with contextual awareness (reference multiple CMS documents) and persistent chat history.
LiteLLM Support and Logging: The AI Content Assistant now supports LiteLLM. All AI interactions are logged for auditing and compliance.
llms.txt Plugin: Adds a document type in the CMS for managing llms.txt files, enabling webmasters to provide content for large language models (LLMs).
Homepage 2.0: A new homepage built with Angular, offering a modernized and more responsive UI. Administrators can manage rollout in the Apps 2.0 Configuration GUI (Setup menu) and run it alongside the legacy homepage.

For a complete list of changes, see the 16.6.0 release notes.

Incubating Features

Some new features are released as "Incubating Features" to accelerate innovation. These features are production-ready and tested, but may change significantly—including backward-incompatible changes or removal—outside of major releases.

Incubating features do not affect the default CMS experience. If you customize or extend these features, review and update your customizations after each minor or patch release as needed. All incubating features are clearly marked and documented.

Changes in v16.6.0

Group ID Change: The group ID changed from com.bloomreach.brx.ai to com.bloomreach.xm.ai.
Artifact Naming: The term 'incubating' was added to two artifacts:

<dependency>
      <groupId>com.bloomreach.xm.ai</groupId>
      <artifactId>content-ai-service-impl-incubating</artifactId>
</dependency>

<dependency>
      <groupId>com.bloomreach.xm.ai</groupId>
      <artifactId>content-ai-service-rest-incubating</artifactId>
</dependency>

Group ID Only Change: The following artifacts require only the group ID update:

<dependency>
      <groupId>com.bloomreach.xm.ai</groupId>
      <artifactId>content-ai-service-client-bootstrap</artifactId>
</dependency>

<dependency>
      <groupId>com.bloomreach.xm.ai</groupId>
      <artifactId>content-ai-service-client-assistant-angular</artifactId>
</dependency>

For more information, see the Incubating Features Policy.

Upgrade Procedure

1. Perform Generic Minor Upgrade Steps

Follow the standard procedure for minor version upgrades.

2. Update AI Content Assistant Configuration

Essentials-based Configuration

If you configured the AI Assistant using Essentials and are upgrading to 16.6, update the configuration at /hippo:configuration/hippo:modules/ai-service:

Remove the intermediate node with the model provider name (for example, /OpenAI). Move all properties from this node directly under /hippo:configuration/hippo:modules/ai-service/hipposys:moduleconfig.
Rename the property spring.ai.provider to brxm.ai.provider.

Properties File Configuration

If you use a properties file for configuration, update the property name:

Rename spring.ai.provider to brxm.ai.provider in your properties file.

3. Review Custom Code for Library Compatibility

Upgraded third-party libraries may introduce backward-incompatible changes. If your project code fails to build or run, review the affected libraries and update your code to ensure compatibility.

4. Review Detailed Release Notes

Refer to the detailed release notes for additional information.

Verification

Confirm that the application builds and runs without errors.
Test AI Content Assistant functionality after configuration changes.
Review the CMS UI for expected behavior, especially if enabling Homepage 2.0.

Related topics