Skip to main content

Streaming Text

Streams text content in real-time to chat interfaces, enabling progressive text display.

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​

  • Text - The text content to stream.
  • Stream ID - The unique identifier for the streaming session.
  • Stream Index - The index position for the text in the stream.

Output​

  • Stream - The stream object containing information about the streaming session.

How It Works​

The Streaming Text node enables real-time text streaming in chat interfaces. When executed, the node:

  1. Receives text content and streaming parameters
  2. Establishes a connection to the streaming endpoint
  3. Sends text data in real-time chunks
  4. Maintains the streaming session until completion
  5. Returns stream status information

Requirements​

  • A valid streaming session with a Stream ID
  • Text content to stream
  • A chat interface or messaging platform that supports streaming text

Error Handling​

The node will return specific errors in the following cases:

  • Invalid or missing Stream ID
  • Network connectivity issues
  • Invalid streaming endpoint URL
  • Communication errors with the messaging platform
  • Stream not found errors

Usage Notes​

  • The node is used to progressively display text in chat interfaces
  • Text is streamed in real-time rather than displayed all at once
  • The Stream ID is required to maintain the streaming session
  • The Stream Index helps track the position of text in the stream
  • Streaming text is useful for displaying large amounts of text or real-time updates
  • The node can handle both partial text updates and end-of-stream signals
  • Multiple streaming text nodes can be used in sequence for continuous text streaming