The article below provides a comprehensive and detailed understanding of how to use each section of the platform. By following this guide, users will become familiar with the various functionalities and features offered.
Dashboard
Upon registration and logging in, the user will be redirected to the dashboard, which serves as the central hub of the platform. Here, the overall statistics are presented in a clear and organized manner, providing users with valuable insights. This includes the success or fail rate of module or flow executions/requests. Each section of the dashboard comprises:
The total number of requests made, giving users an idea of the platform's usage.
Success and failure rate, which helps in assessing the performance and reliability of the modules or flows.
A graphical representation, which visually depicts the data for better understanding and analysis.
Playground
Triform offers a playground module that allows users to test execution directly without navigating to specific modules or flows. This feature is highly convenient as users can import all published modules and flows seamlessly, with the code being imported automatically. The user will be prompted for input parameters, which can then be executed directly. The result of these executions can be observed and debugged if needed, providing an interactive testing environment. Additionally, the history log is maintained, allowing users to review and monitor overall execution performance.
Modules
Modules are a powerful feature in Triform, enabling users to run custom Python scripts powered by the Langchain framework. Within this section, users can create:
A Blank Module: This option allows users to start from scratch and build their custom scripts.
A Template Library Module: Users can choose from pre-set code and requirements, making it easier to get started with commonly used functionalities.
For more detailed information and step-by-step instructions, users can refer to Working with Modules.
Flows
Flows facilitate the creation of complex sequences of modules that work together to process data and perform various tasks. Users have the flexibility to name the flow and import modules to execute them in their preferred sequence. Once a module is published, it can be invoked externally and integrated into any application, enhancing the platform's versatility. For further details and guidance, users can visit Creating and Managing Flows in Triform.
Environment
This section allows users to create and manage environment variables, which are essential for storing sensitive data securely. These variables can be used within the module's script, ensuring that sensitive information is handled appropriately.
Template Library
Triform offers a diverse range of modules that can be utilized immediately through its Template Library. Users can search or filter templates by tags and view detailed information about each template. To create a module from a template, users simply need to click “Use Template” or “Create Module with this template” from the details view. After naming the module, they can start using it instantly.
Billing
All billing-related information is available in this section. Users can view the overall credit balance along with a graphical representation of monthly request spending. The platform maintains a credit history, allowing users to monitor their spending over time. Additionally, users can manage payment methods and define top-up thresholds, amounts, and monthly budgets to ensure smooth and uninterrupted usage.
Support
The support page is a valuable resource, providing additional articles and documentation for further understanding of the platform. Users can refer to these resources for any assistance or clarification needed while using Triform.