How do I activate a public-facing chat dialog?#
A public-facing chat dialog can be generated for any pathway that includes a chat trigger connected to: * An Agent or Chain * A Large Language Model (LLM)
Note
This process should be performed only when your pathway has been tested and is ready for activation
Before you begin#
- Learn about the Chat trigger
- Learn how to add a basic authentication credential for users to login to the chat dialog
- Learn how to add Ensemble users to allow them to access the chat dialog using their account
Step 1 - open the chat trigger#
- Double-click the Chat trigger on your pathway
- Toggle Make chat publicly available to on
Step 2 - choose how the chat will be made available#
Choose one of the following:
- Hosted chat for the dialog to be available via Ensemble
- Embedded chat to add the dialog to your own website
Step 3 - Setup authentication if required#
The chat can be made available to users in three ways:
| Authentication type | Description | Additional information |
|---|---|---|
| Basic Auth | Create a specific Ensemble credential for the chat dialog | Learn how to add a chat credential |
| Ensemble User Auth | Users must first authenticate using their Ensemble account | Learn how to invite users to Ensemble |
| None | Chat dialog is available to the entire internet |
Step 4 - Configure the initial welcome message#
You can write a welcome message for Embedded chat which is automatically added to the dialog.
Step 5 - Add specific settings#
Click Add field then choose from the following then add your own settings.
| Setting | Description | Available for | Additional information |
|---|---|---|---|
| Title | Title displayed at the top of the chat dialog | Hosted | |
| Subtitle | Subtitle displayed beneath the title | Hosted | |
| Allowed origins (CORS) | A comma-separated list of addresses permitted to access the chat dialog.* allows all origins |
Both | Learn about CORS |
Step 6 - configure chat functionality#
Click Add field then choose from the following:
| Function | Option | Description | Additional information |
|---|---|---|---|
| Load previous session | Off | Chat resets each time it is loaded | |
| From memory | Available chat is reloaded from memory on reload | Requires a Memory node to be attached Learn about memory nodes |
|
| Manually | |||
| Require button click to start chat | Toggle on so each user message is sent to the Chat trigger when a confirmation button is clicked | ||
| Response Mode | When last node finishes | Returns data from the last node executed in the pathway | |
| Respond to WebHook node | Responses defined in the WebHook node in a pathway |
Step 7 - activate the pathway#
- Click Back to pathway at the top left.
- Click the inactive toggle at top right to activate the pathway.