Skip to content

Upgrading Tock

This page describes how to upgrade a Tock platform and the bots that use it to a new version, and lists the changes that require an action.

Procedure

  1. Read the changelog and the GitHub release notes of every version between your current version and the target version, and the version notes below.
  2. Back up the MongoDB databases, for instance with mongodump, and the vector store if you use the RAG.
  3. Upgrade all the components of the platform to the same version: bot_admin, nlp_api, build_worker, bot_api, kotlin_compiler, duckling_bot, and the Gen AI orchestrator. With the tock-docker descriptors, set the TAG variable to the new version.
  4. Upgrade the Tock dependencies of your bots to the same version (see Integrated bot and Bot API).
  5. Restart the components, then check their healthchecks and the logs.
  6. In Tock Studio, check the answers of the bot in Test > Test, and the model builds in Model Quality > Model Builds.

The components and the bots of a platform must use the same version: mixing versions is not supported.

The MongoDB indexes, and the data migrations when there are any, are applied by the components at startup: no migration script needs to be run, unless stated in the version notes.

Version notes

26.9.1

Removed connectors. The connectors for Alexa (connector-alexa), Google Assistant (connector-ga), Twitter (connector-twitter), Apple Business Chat (connector-businesschat) and Rocket.Chat (connector-rocketchat), whose platforms were shut down or are no longer used, are no longer provided. Remove their configurations in Settings > Configurations, and their dependencies from your bots.

Removed module. The Chatbase analytics module (tock-analytics-chatbase), whose service was shut down, is no longer provided: remove its dependency from your bots.

Renamed property. The timeout of the calls to the Bot Framework API of the Teams connector is now set by tock_teams_request_timeout_ms. The former tock_whatsapp_request_timeout_ms property is still read when the new one is not set.

Removed option. The Alexa Export option of the application advanced options has been removed from Tock Studio.

26.9.0

Java 21. Tock is now built for Java 21: the bots and the platform need a Java 21 (or later) runtime, and the Kotlin bots must target the JVM 21 (kotlin.compiler.jvmTarget).

Bill of materials. The new tock-bom artifact aligns the versions of the Tock dependencies in your bots (see Aligning dependency versions).

26.3.0

The RAG answers must be a structured JSON object. The Question answering prompt of every bot, in Gen AI > Rag settings, must be updated before deploying this version, otherwise the bot can no longer answer with the RAG. See the RAG prompt documentation, which describes the expected JSON output and provides prompt examples.

25.10.0

The Kotlin client of the Bot API uses coroutines. The send and end functions of ClientBus are now suspend functions: code that calls them outside of a story handler must be adapted.

Chat with Tock
×