Embed the Chat with Your Data Tool

Follow

You can embed the Chat with Your Data tool on a local web page, blog, intranet portal, or any other web-based interface. By forming a custom URL with specific parameters, you can integrate the conversational engine into your web application. The embedded tool allows users to interact with their data conversationally in a seamless manner.

Prerequisites

• You must have the necessary permissions granted by an administrator in Access Manager to access and embed the tool.
• The tool should be available for integration into your platform.
• Ensure that the required datasets are accessible and ready to be used.

Procedure

1. Construct the URL for embedding the tool. This is done by including necessary parameters in the following format:

   [server]/storyboards/?tool=explorations&options=hidesidebar.hidetoolbar&action=chat&datasetid=[datasetId]
   • Replace [server] with the base URL of your instance.
   • Replace [datasetId] with the specific dataset you want pre-selected for the user.
   • The parameter options=hidesidebar.hidetoolbar can be used to hide the sidebar and toolbar, simplifying the interface for a cleaner user experience.
   • The action=chat parameter activates the chat interface by default.

    

2. Paste this URL into your web application, using it to embed the Chat with Your Data component. You can use an iframe, a hyperlink, or any embedding method that suits your application structure.

Optional Customizations

• Pre-select a dataset: You can pre-select a dataset by using the datasetid parameter. Ensure the user has the required access permissions for the dataset.
• Hide UI components: Use the options parameter to hide specific UI elements, such as the sidebar (hidesidebar) or toolbar (hidetoolbar), providing a more streamlined experience.

Important: Ensure that users accessing the embedded tool have the necessary permissions for the dataset being used. The chat tool will be accessible based on these permissions.