Workflow Builder

The Workflow Builder allows you to create sophisticated, automated processes (e.g. vector store data ingestion, ...) that can integrate AI with various tasks and systems. This page guides you through the process of creating, configuring, and testing your workflows.

Workflow interface Overview

The builder is divided into several key areas:

1. Left Panel: Contains a list of available components you can use in your workflow.

2. Main Canvas: The central area where you build your workflow by adding and connecting nodes.

3. Action Buttons: Located at the top, these buttons allow you to save, publish, and test your workflow.

4. Configuration Popover: Appears when you select a node, allowing you to configure its specific settings.

5. Execution Detail Panel: Shows detailed information about the execution of your workflow during testing.

Creating a Workflow

1. Start with a Template or Blank Canvas:

   • When creating a new workflow, you can choose from pre-built templates or start with a blank canvas.

   • Templates provide a quick starting point for common workflow patterns.

2. Add Components:

   • Drag components from the Left Panel onto the Main Canvas.

   • Available components include various node types such as Input, LLM Model, Knowledge Retrieval, and more.

3. Connect Nodes:

   • Click and drag from one node's output to another node's input to create connections.

   • The flow of data and logic follows these connections.

4. Configure Nodes:

   • Click on a node to open its Configuration Popover.

   • Set parameters specific to each node type (e.g., model selection for LLM nodes, query parameters for knowledge retrieval).

Testing Your Workflow

1. Open Workflow Runner:

   • Click the "Run" button in the Action Buttons area to open the testing interface.

2. Input Data:

   • If your workflow has an Input node, you can enter data in the main input field.

   • For additional inputs defined in your workflow, use the "Additional Inputs" section.

3. Execute Workflow:

   • Click "Execute Workflow" to run your workflow with the provided inputs.

   • Observe the output and any error messages in the runner interface.

4. View Execution Details:

   • The Execution Detail Panel shows how data flows through your nodes during testing.

   • Use this information to debug and optimize your workflow.

Saving and Publishing

• Save: Updates your workflow configuration without making it live.

• Save and Publish: Updates the configuration and makes the latest version of your workflow available for use.

Best Practices

1. Start Simple: Begin with a basic workflow and gradually add complexity.

2. Use Templates: Leverage pre-built templates to quickly set up common patterns.

3. Test Thoroughly: Use the Workflow Runner to test various scenarios and edge cases.

4. Optimize Node Order: Arrange nodes efficiently to minimize unnecessary processing.

5. Document Your Flow: Use clear node names and annotations to make your workflow easy to understand.

Troubleshooting

• If a node is not behaving as expected, check its configuration in the Configuration Popover.

• Use the Execution Detail Panel to trace the flow of data and identify where issues might be occurring.

• Ensure all required fields in node configurations are filled correctly.

• Check for any error messages in the Workflow Runner output for specific issues during execution.

By leveraging the power of Workflows in Waterflai, you can create complex, automated processes that integrate AI capabilities with your existing systems and data sources.