AI Module upgrade instructions

This page describes version-specific changes to the AI modules that you must account for when upgrading brXM.

Please refer to the Incubating Features Policy for more information.

Changes in v17.2

AI Content Assistant Module Spring 2.0 Upgrade

These configuration changes stem from an upstream upgrade to Spring AI 2.0.0 and affect projects that use the AI Content Assistant. Review each item before upgrading.

PromptLoggerAdvisor log level
The log level for PromptLoggerAdvisor has changed from INFO to DEBUG. If your logging configuration only captures INFO and above, update it so these logs remain visible after upgrading.

Usage Audit Logging

The log level for the `UsageLoggingStore` logger has been changed from `INFO` to `DEBUG`. Make sure you update your logging configurations if needed.

Vertex provider renamed
The Vertex AI provider has been renamed from VertexAIGemini to GoogleGenAiVertex, matching the same rename made upstream by Google and Spring AI. If your project configures the Google provider, update any configuration that still references the old name.

Removal of completions-path and embeddings-path
The OpenAI provider no longer supports the completions-path and embeddings-path configuration properties. If your project sets either of these, remove them, as they no longer have any effect.

OpenAI API URL default changed
The default OpenAI API endpoint (spring.ai.openai.api.url) has changed from https://api.openai.com/v1 to https://api.openai.com. If you rely on the default, no action is needed. If you've set this property explicitly, confirm it still points to the endpoint you intend.

Changes in v16.8

In v16.8.0, there's a change in a configuration property for the OpenAI provider.

Breaking Change - OpenAI completions path property renamed 

If you have configured a custom completions path for the OpenAI provider (e.g. when using Azure OpenAI or a compatible endpoint), the property name has changed. Update this property in your properties file or JCR configuration before upgrading.

Before	After
spring.ai.openai.chat.options.completions-path	spring.ai.openai.chat.completions-path

LiteLLM Confuguration Change (Optional)

LiteLLM was configured through the generic OpenAI-compatible connector, which made it impossible to have a separate configuration for OpenAI and LiteLLM, see multiplicity of configurations. LiteLLM now has a dedicated connector under the `spring.ai.litellm.*` property namespace. The migration is optional but recommended if you currently use LiteLLM. 

Changes in v16.6

Following manual changes are needed when upgrading to 16.6

Maven dependencies

The groupId and artifactId has changed for some dependencies.

GroupId

Change from com.bloomreach.brx.ai to com.bloomreach.xm.ai

Artifacts

The term 'incubating' was appended 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>

The following modules only need the <groupId> to change:

<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>

Configuration changes

If you have been using JCR configuration, your AI module configuration requires a few changes:

1. The intermediate node with the model provider name (for example, /OpenAI) is not needed anymore. Move all its properties one level up (that is, move them under /hippo:configuration/hippo:modules/ai-service/hipposys:moduleconfig)
2. Rename property spring.ai.provider to brxm.ai.provider