Migrating from Bot Maker 3.0.0 to ACE Agent 4.0.0#

If you plan to port your bot from Bot Maker 3.0.0 to ACE Agent 4.0.0, perform the following steps:

  1. We have renamed the following microservices.

    • Dialog Manager -> Chat Engine

    • Bot Controller -> Chat Controller

    • Fulfillment server -> Plugin server

  2. Rename all instances of the word fulfillment to plugin in the bot. The fulfillment server in Bot Maker 3.0.0 has been renamed to the plugin server in ACE Agent 4.0.0.

    Note

    You can use the Linux terminal command mentioned below to perform the replacement. This may make unintended changes in the bot, therefore, take caution and review the changes made by the command.

    find /path/to/bot/directory -type f -exec sed -i ‘s/fulfillment/plugin/g’ {} +

  3. The default response mode of the bots has been changed from non-streaming in Bot Maker 3.0.0 to streaming in ACE Agent 4.0.0. If you have not explicitly specified the streaming flag in the bot config file, you need to specify streaming: false to maintain the same behavior as in Bot Maker 3.0.0. If this flag is not mentioned, the ACE Agent server will return a streaming response.

  4. As part of this release we have deprecated Embedding Search and Information retrieval support from the NLP server microservice. Use the Retrieval Augmented Generation (RAG) as an alternative.

  5. If you want to switch to the latest Colang 2.0 syntax, follow instructions from the Building a Bot using Colang 2.0 and Event Interface tutorial.