Connect with Database

Overview

The Connect with Database feature enables your CX Genie bot to directly connect to external databases to enrich its knowledge base with real-time data. This allows the bot to understand and retrieve information dynamically from your structured data sources.

Supported database types include PostgreSQL and MySQL.

Figure 1. Connect with database panel

Steps to Use

1. Access the Connect with Database tab

   Navigate to the Training Data section and click on the Connect with database tab.

2. Add a new database connection

   • Click the Add Database button at the top right.

   • In the pop-up form, enter the database details:

     • DB Name: Give your database connection a friendly name.

     • Type: Select either PostgreSQL or MySQL.

     • Host: Enter the database server hostname or IP address.

     • Port: Specify the port number used by the database server.

     • Username and Password: Provide the credentials for database access.

     • Require SSL: Toggle this on if your database requires an SSL connection.

   • Click Create to establish the connection.

3. Manage connected databases

   • After connecting, your database appears in the list with its name, connection string (partially hidden), and last updated timestamp.

   • Use the Edit icon to modify connection details or the Trash icon to delete the connection.

4. View and edit database tables and columns

   • Click on a connected database name to open the detailed view of its tables and columns.

   • Select a table from the sidebar to see its columns listed.

   • Click the information icon (ℹ️) next to any table or column to add or edit descriptions.

   • Use this description to explain the purpose and meaning of each table or column so the bot can better understand and retrieve the correct information.

   • If you do not want the bot to access certain data, leave the description blank.

5. Synchronize data with the bot

   • After adding or updating descriptions, click the Sync to bot's knowledge button to push the latest database structure and metadata into the bot's knowledge base.

   • This step is necessary for the bot to utilize the connected database data in conversations.

Figure 2. Database management panel

Notes

• Column names should use snake_case (lowercase letters with underscores), avoiding uppercase letters or special characters, to ensure compatibility and consistent recognition.

• Clear and meaningful descriptions for tables and columns improve the bot’s ability to understand queries and provide accurate responses.

• Only structured, described data will be used by the bot; columns or tables without descriptions will be ignored.

• Keep database credentials secure and update them if changes to maintain connection integrity.

• Synchronization must be performed after any schema or description changes to refresh the bot’s knowledge.