Build a chatbot connected to a Knowledge Graph

Drag and drop a Chatbot block onto the Interface canvas.

In the block’s configuration panel, update the following fields:

• Conversation: @{chat}. This is the state variable that stores the chat conversation.
• Assistant initials: AI. This is the text that appears next to the assistant’s messages in the chat.
• User initials: YOU. This is the text that appears next to the user’s messages in the chat.
• Use markdown: no. You can change this to yes if you want to parse Markdown formatting in messages.
• Enable file upload: no. This disables the file uploads in the chatbot.
• Placeholder: Type your message here.... This is the text that appears in the input field when it is empty.

To run the blueprint when a user enters a chat message, add a UI trigger block to the canvas. In the block’s configuration panel, update the following fields:

• Component Id: select the Chatbot component from the dropdown of UI blocks
• Event type: wf-chatbot-message

Add a Start chat conversation block to the canvas, which runs after the UI trigger block and creates a new chat conversation if it doesn’t already exist. In the block’s configuration panel, update the following fields:

• Conversation state element: chat
• Model: Palmyra X5

You can also update the Temperature and Max output tokens fields to control the output of the chat conversation.

Add an Add chat message block to the canvas after the Start chat conversation block. In the block’s configuration panel, update the following fields:

• Conversation state element: chat
• Message: @{payload}. This references the payload variable set by the previous UI trigger. The payload variable created by the UI trigger contains the message from the user in the following format: {"message": "<user's message>", "role": "user"}.

Add a Generate chat response block to the canvas after the chat message event triggers. This passes the chat conversation to the Palmyra X5 model to generate a response. In the block’s configuration panel, update the following fields:

• Conversation state element: chat
• Use streaming: yes. This configures the block to stream the response from the model to the chat in real time, rather than waiting for the entire response to be generated before displaying it.

Once the response is generated, the block adds a new message to the chat conversation with the following format: {"message": "<assistant's response>", "role": "assistant"}.

This block is where you would add additional tools to the chatbot, under the Add tool section of the configuration panel. See Connect a Knowledge Graph to the chatbot for an example.

Click the Generate chat reply block to open its configuration panel.

Click the Add tool button and select Knowledge graph under Tool type.

Under Graph id(s), select one or more Knowledge Graphs you want to connect to the chatbot. The example below connects the chatbot to a Knowledge Graph that contains developer docs at https://dev.writer.com.