Bloomreach

Bloomreach Documentation version

AI Module upgrade instructions

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

As of v16.6.0, the AI Module includes Incubating features 

Please refer to the Incubating Features Policy for more information.

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
Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?