269 lines
5 KiB
Text
269 lines
5 KiB
Text
import Admonition from "@theme/Admonition";
|
|
|
|
# Experimental
|
|
|
|
Components in the experimental phase are currently in beta. They have been initially developed and tested but haven't yet achieved a stable or fully supported status. We encourage users to explore these components, provide feedback, and report any issues encountered.
|
|
|
|
### Clear Message History Component
|
|
|
|
This component clears the message history for a specified session ID.
|
|
|
|
**Beta:** This component is in beta.
|
|
|
|
**Parameters**
|
|
|
|
- **Session ID:**
|
|
- **Display Name:** Session ID
|
|
- **Info:** Clears the message history for this ID.
|
|
|
|
**Usage**
|
|
|
|
Provide the session ID to clear its message history.
|
|
|
|
---
|
|
|
|
### Extract Key From Record
|
|
|
|
This component extracts specified keys from a record.
|
|
|
|
**Parameters**
|
|
|
|
- **Record:**
|
|
|
|
- **Display Name:** Record
|
|
- **Info:** The record from which to extract keys.
|
|
|
|
- **Keys:**
|
|
|
|
- **Display Name:** Keys
|
|
- **Info:** The keys to be extracted.
|
|
|
|
- **Silent Errors:**
|
|
- **Display Name:** Silent Errors
|
|
- **Info:** Set to true to suppress errors.
|
|
- **Advanced:** True
|
|
|
|
**Usage**
|
|
|
|
Provide the record and specify the keys you want to extract. Optionally, enable silent errors for missing keys.
|
|
|
|
---
|
|
|
|
### Flow as Tool
|
|
|
|
This component turns a function running a flow into a Tool.
|
|
|
|
**Parameters**
|
|
|
|
- **Flow Name:**
|
|
|
|
- **Display Name:** Flow Name
|
|
- **Info:** Select the flow to run.
|
|
- **Options:** List of available flows.
|
|
- **Real-time Refresh:** True
|
|
- **Refresh Button:** True
|
|
|
|
- **Name:**
|
|
|
|
- **Display Name:** Name
|
|
- **Description:** The tool's name.
|
|
|
|
- **Description:**
|
|
|
|
- **Display Name:** Description
|
|
- **Description:** Describes the tool.
|
|
|
|
- **Return Direct:**
|
|
- **Display Name:** Return Direct
|
|
- **Description:** Returns the result directly.
|
|
- **Advanced:** True
|
|
|
|
**Usage**
|
|
|
|
Select a flow, name and describe the tool, and decide if you want to return the result directly.
|
|
|
|
---
|
|
|
|
### Listen
|
|
|
|
This component listens for a specified notification.
|
|
|
|
**Parameters**
|
|
|
|
- **Name:**
|
|
- **Display Name:** Name
|
|
- **Info:** The notification to listen for.
|
|
|
|
**Usage**
|
|
|
|
Specify the notification to listen for.
|
|
|
|
---
|
|
|
|
### List Flows
|
|
|
|
This component lists all available flows.
|
|
|
|
**Usage**
|
|
|
|
Call this component without parameters to list all flows.
|
|
|
|
---
|
|
|
|
### Merge Records
|
|
|
|
This component merges a list of records.
|
|
|
|
**Parameters**
|
|
|
|
- **Records:**
|
|
- **Display Name:** Records
|
|
|
|
**Usage**
|
|
|
|
Provide the records you want to merge.
|
|
|
|
---
|
|
|
|
### Notify
|
|
|
|
This component generates a notification.
|
|
|
|
**Parameters**
|
|
|
|
- **Name:**
|
|
|
|
- **Display Name:** Name
|
|
- **Info:** The notification's name.
|
|
|
|
- **Record:**
|
|
|
|
- **Display Name:** Record
|
|
- **Info:** Optionally, a record to store in the notification.
|
|
|
|
- **Append:**
|
|
- **Display Name:** Append
|
|
- **Info:** Set to true to append the record to the notification.
|
|
|
|
**Usage**
|
|
|
|
Specify the notification name, provide a record if necessary, and indicate whether to append it.
|
|
|
|
---
|
|
|
|
### Run Flow
|
|
|
|
This component runs a specified flow.
|
|
|
|
**Parameters**
|
|
|
|
- **Input Value:**
|
|
|
|
- **Display Name:** Input Value
|
|
- **Multiline:** True
|
|
|
|
- **Flow Name:**
|
|
|
|
- **Display Name:** Flow Name
|
|
- **Info:** Select the flow to run.
|
|
- **Options:** List of available flows.
|
|
- **Refresh Button:** True
|
|
|
|
- **Tweaks:**
|
|
- **Display Name:** Tweaks
|
|
- **Info:** Modifications to apply to the flow.
|
|
|
|
**Usage**
|
|
|
|
Provide the input value, select the flow, and apply any tweaks.
|
|
|
|
---
|
|
|
|
### Runnable Executor
|
|
|
|
This component executes a specified runnable.
|
|
|
|
**Parameters**
|
|
|
|
- **Input Key:**
|
|
|
|
- **Display Name:** Input Key
|
|
- **Info:** The input key.
|
|
|
|
- **Inputs:**
|
|
|
|
- **Display Name:** Inputs
|
|
- **Info:** Inputs for the runnable.
|
|
|
|
- **Runnable:**
|
|
|
|
- **Display Name:** Runnable
|
|
- **Info:** The runnable to execute.
|
|
|
|
- **Output Key:**
|
|
- **Display Name:** Output Key
|
|
- **Info:** The output key.
|
|
|
|
**Usage**
|
|
|
|
Specify the input key, provide inputs, select the runnable, and optionally define the output key.
|
|
|
|
---
|
|
|
|
### SQL Executor
|
|
|
|
This component executes an SQL query.
|
|
|
|
**Parameters**
|
|
|
|
- **Database URL:**
|
|
|
|
- **Display Name:** Database URL
|
|
- **Info:** The database's URL.
|
|
|
|
- **Include Columns:**
|
|
|
|
- **Display Name:** Include Columns
|
|
- **Info:** Whether to include columns in the result.
|
|
|
|
- **Passthrough:**
|
|
|
|
- **Display Name:** Passthrough
|
|
- **Info:** Returns the query instead of raising an exception if an error occurs.
|
|
|
|
- **Add Error:**
|
|
- **Display Name:** Add Error
|
|
- **Info:** Includes the error in the result.
|
|
|
|
**Usage**
|
|
|
|
Provide the SQL query, specify the database URL, and configure settings for columns, error handling, and passthrough.
|
|
|
|
---
|
|
|
|
### SubFlow
|
|
|
|
This component dynamically generates a tool from a flow.
|
|
|
|
**Parameters**
|
|
|
|
- **Input Value:**
|
|
|
|
- **Display Name:** Input Value
|
|
- **Multiline:** True
|
|
|
|
- **Flow Name:**
|
|
|
|
- **Display Name:** Flow Name
|
|
- **Info:** Select the flow to run.
|
|
- **Options:** List of available flows.
|
|
- **Real Time Refresh:** True
|
|
- **Refresh Button:** True
|
|
|
|
- **Tweaks:**
|
|
- **Display Name:** Tweaks
|
|
- **Info:** Modifications to apply to the flow.
|
|
|
|
**Usage**
|
|
|
|
Select a flow, apply any necessary tweaks, and generate a tool.
|