Submit Feedback

Chatbots

A chatbot is a conversational frontend for your agents. You define the set of agents it can call, give it a branded look and a few standard messages, then deploy it as a chat widget on Liferay DXP pages or external sites. Where an agent performs a single task, a chatbot handles a multi-turn conversation, coordinating its assigned agents to answer each message. It works like the AI Assistant supervisor, but scoped to the agents you assign it and deployed as a widget rather than running inside Liferay CMS.

Because a chatbot works through the agents you assign it, it draws on whatever data sources those agents use. Build the agents first, then create the chatbot that calls them.

Creating a Chatbot

Open Chatbots in the AI Hub left navigation to see your account’s chatbots and their status.

The Chatbots list shows each chatbot with its status, above a Filter control, search box, and New Chatbot button.

Click New Chatbot and complete the form:

  1. Use the Enable Chatbot toggle to make the chatbot active.

  2. Enter a Title and Description.

  3. Enter a unique External Reference Code to identify the chatbot.

  4. Optionally, set an Avatar for the chatbot: click Select File and choose a JPEG, JPG, or PNG image no larger than 500 KB. The form then shows the file name beside a Clear button. Click Clear to remove the image and restore the default icon. The avatar brands the chatbot in its deployed Click to Chat widget, in the chat header and beside each response.

  5. In Assigned Agents, select the agents the chatbot can call. If the list is empty, create the agents first (see Agents).

  6. Set the messages the widget shows visitors: Intro Message, Placeholder Message, Notification Message, and Disclaimer Message.

  7. Click Save.

The Create Chatbot form shows the Details fields and a Chatbot Code snippet for embedding.

The chatbot appears in the Chatbots list, where you can see its status and use its Actions menu to view or delete it.

Deploying a Chatbot

You can embed a saved chatbot directly with its generated code, or serve it through Liferay DXP’s Click to Chat.

Embedding the Widget

To embed the chatbot in an external site,

  1. Open the saved chatbot and copy its Chatbot Code snippet.

  2. Paste the snippet into the HTML of the page where you want the chat widget.

The snippet loads the widget and connects it to your chatbot by its External Reference Code. To add the chatbot to a Liferay DXP site, use Click to Chat instead.

Serving the Chatbot Through Click to Chat

Liferay DXP’s Click to Chat feature can add the chatbot to a site without editing page HTML. To set it up,

  1. Open Control Panel → Instance Settings → Content & Data → Click To Chat, and enable it.

  2. Select AI Hub as the chat provider.

  3. Enter the chatbot’s External Reference Code in the Chat Provider Account ID field.

For the general Click to Chat setup, see Enabling Automated Live Chat Systems.