Skip to main content

Streaming Text

Displays streaming text content in chat interfaces.

Common Properties

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs

  • Session Id - Unique identifier for the UI client connection.
  • Text - Content of the text to stream.
  • Label - Optional label for the text.
  • Description - Optional description for the text.

Options

  • None

Output

  • None (this is a display-only widget)

How It Works

The Streaming Text node creates a widget that displays text content with a streaming effect. When executed, the node:

  1. Validates the provided Session ID and Text
  2. Retrieves the session information for the provided ID
  3. Creates a streaming text widget with the specified text content, label, and description
  4. Sends the widget to the client with the specified session ID

Requirements

  • A valid session ID for an active client connection
  • Valid text content to display
  • Properly configured client interface that can display streaming text widgets

Error Handling

The node will return specific errors in the following cases:

  • Empty or invalid Session ID
  • Session not found for the provided ID
  • Text is required but not provided
  • Text is empty
  • Failed to send widget to client

Usage Notes

  • The Session ID must match an active client connection
  • The streaming text widget is a visual element only and does not collect user input
  • The Label and Description fields are optional but can help users understand what the text content represents
  • The streaming effect simulates typing text character by character for a more engaging user experience