Dust
Dust is an AI platform that enhances team collaboration and efficiency with customizable AI assistants integrated with internal data. It supports multiple AI models, enabling businesses to streamline workflows and foster innovation. With enterprise-grade security, Dust ensures data privacy while offering seamless collaboration through features like shared conversations and Slack integration.
How to Integrate Dust with ZBrain Flow
Click the '+' button in ZBrain Flow.
Search for Dust in the available integrations.
Select any Dust action to configure it.
How to Connect Dust to ZBrain Flow
Provide a Connection Name – Enter a name to identify your Dust connection.
Enter API Key – Obtain an API Key from Dust.
Steps to Get an API Key from Dust:
Log in to your Dust account.
Navigate to the API section:
Click on your profile picture or settings icon.
Select API from the menu.
Generate a New API Key:
Click the ‘Generate New API Key’ button.
Provide a name for the API Key (to remember its purpose).
Click ‘Generate’ to create the key.
Copy the API Key:
The key will be displayed once. Copy it immediately, as it won't be shown again.
Enter the Dust Workspace ID
Steps to Find Your Workspace ID:
Go to the Workspaces Section:
Click on ‘Workspaces’ in the main menu.
Select the Workspace:
Click on the workspace for which you need the ID.
Find the Workspace ID:
The Workspace ID is displayed in the URL of the workspace page or the workspace settings.
Click 'Save' – Your Dust connection is now ready for use in ZBrain Flow.
Actions Available in ZBrain Flow
1. Create a Conversation
Start a new conversation with a specific Dust assistant.
Configuration Steps:
Select a connection or create a new one.
Choose the Agent – Select the AI assistant that will handle the conversation.
Enter the Username – The user initiating the conversation.
Enter the Time Zone – Specify the user's time zone.
Enter the Title – Define the topic of the conversation.
Enter the Query – The initial message for the conversation.
Enter the Fragment – Add a content fragment (optional).
Enter the Fragment Name – Give a name to the content fragment (optional).
Enter Timeout (in seconds) – Specify the maximum wait time for a response.
2. Get an Existing Conversation
Retrieve details of a previously started conversation.
Configuration Steps:
Select a connection or create a new one.
Enter the Conversation ID – The unique identifier of the conversation.
Enter Timeout (in seconds) – Define how long to wait for a response.
3. Reply to a Conversation
Send a message in an ongoing conversation.
Configuration Steps:
Select a connection or create a new one.
Enter the Conversation ID – The ID of the ongoing conversation.
Choose the Agent – Select the AI assistant responding to the message.
Enter the Query – The message content to send as a reply.
Enter the Username – Identify the sender of the message.
Enter the Time Zone – Specify the user’s time zone.
Enter Timeout (in seconds) – Define the response wait time.
4. Add a Fragment to a Conversation
Create a new content fragment within a conversation.
What are Fragments?
A fragment is a piece of contextual information inserted into a conversation. It provides background data that an assistant can use while generating responses. For example, a fragment can include:
Product details in a customer support chat.
Company policies for an HR assistant.
Summarized meeting notes for an AI-powered meeting assistant.
Configuration Steps:
Select a connection or create a new one.
Enter the Conversation ID – Specify the conversation where the fragment should be added.
Enter the Fragment – Provide the contextual information.
Enter the Fragment Name – Assign a name to the fragment for reference.
5. Add or Update a Document
Insert a new document into a data source or update an existing document.
What is a Data Source?
A data source in Dust stores structured and unstructured content. AI assistants reference these documents when responding to queries.
Configuration Steps:
Select a connection or create a new one.
Enter the Data Source Name – Specify the source where the document will be stored.
Enter the Document ID – Assign a unique identifier for the document.
Enter the Document Content – Provide the text content of the document.
Enter the Source URL – If the document is cited from an external source, enter the URL.
Enter the Document Title – Provide a title for the document.
Enter Tags – Add metadata tags to categorize the document.
Click '+ Add Item' to add multiple tags.
6. Custom API Call
Perform a custom API request to a Dust endpoint.
Configuration Steps:
Select a connection or create a new one.
Enter the API Endpoint URL – Include the full URL or relative path.
Select the HTTP Method:
GET – Retrieve data.
POST – Send new data.
PATCH – Modify existing data.
PUT – Update or replace data.
DELETE – Remove data.
HEAD – Fetch headers only.
Add Headers – Define request headers (Authorization headers are auto-injected).
Add Query Parameters – Specify API parameters.
Enter JSON Body – Provide the request payload in JSON format.
Set Timeout (in seconds) – Define the request timeout duration.
Last updated