Key Concepts
Key Concepts
-
Nodes: Nodes are the building blocks of Databraid. They represent individual units of functionality, such as data processing, manipulation, and visualization. Nodes can be connected together to create complex workflows.
-
Beads: Beads are specialized nodes that provide additional functionality and integration with external services. They allow you to extend the capabilities of Databraid by leveraging third-party APIs, libraries, and tools.
-
Braids: Braids are the visual representation of your workflows in Databraid. They consist of nodes and beads connected together to define the flow of data and the sequence of operations.
-
Events: Events are triggers that allow you to control the execution of your braids. They can be based on time, data changes, user interactions, or external triggers.
-
Data Types: Databraid supports a wide range of data types, including primitives, arrays, objects, and custom data structures. Understanding data types is crucial for building effective workflows.
-
Execution: Execution refers to the process of running your braids and processing data through the connected nodes and beads. Databraid provides a robust execution engine that ensures efficient and reliable execution of your workflows.
-
Prompts: Prompts are essential in Databraid for guiding language models and generating desired outputs in natural language processing tasks. They act as instructions or questions that direct the language model to perform specific tasks or provide targeted outputs. Databraid supports various types of prompts, enabling users to leverage the power of language models for a wide range of NLP tasks within their workflows.
-
Third-Party Services: Databraid integrates with various third-party services, such as databases, APIs, and cloud platforms. These integrations enable you to extend the functionality of your braids and connect with external systems seamlessly.
-
Tokens: Tokens are used for authentication and authorization when interacting with external services or APIs. Databraid provides a secure token management system to ensure the confidentiality and integrity of your data.
-
API: Databraid offers a comprehensive API that allows you to programmatically interact with the platform, automate tasks, and integrate Databraid with your existing systems and workflows.
Getting Started
To get started with Databraid, follow these steps:
- Sign up for a Databraid account and log in to the platform.
- Familiarize yourself with the Databraid interface and the available nodes, beads, and braids.
- Create a new braid and start building your workflow by connecting nodes and configuring their properties.
- Test your braid by executing it with sample data and verifying the results.
- Integrate third-party services and APIs as needed to extend the functionality of your braid.
- Deploy your braid to a production environment and monitor its performance and reliability.
Documentation Structure
The Databraid documentation is organized into the following sections:
-
Concepts: Dive deeper into the core concepts of Databraid, including nodes, beads, events, data types, execution, prompts, third-party services, tokens, braids, and API.
-
Nodes: Explore the available nodes in Databraid, including audio, basic, events, graph, graphics, logic, math, network, and widget nodes.
-
Beads: Learn about the different types of beads in Databraid, such as component beads, data beads, flow beads, LLM beads, source beads, TTS beads, test beads, and viewers beads.
-
Braids: Understand the execution flow, inputs, outputs, and templates of braids in Databraid.
-
API Documentation: Get detailed information about the Databraid API, including secrets management and available interfaces.
We recommend starting with the Concepts section to gain a solid understanding of the core principles and terminology used in Databraid. From there, you can explore the specific nodes, beads, and braids that are relevant to your use case.
If you have any questions or need further assistance, please refer to our support channels or reach out to our community forums.
Happy braiding!