Skip to main content
Back to Components manual

Chat Output

On this page

Purpose

Chat Output displays a Message in the Playground and can store the resulting message for the active session.

When to use it

  • Show an Agent Core response in a chat flow.
  • Display a Message, Data value, or DataFrame as a chat response.
  • End an interactive Playground conversation.

How to use it

  1. Add Chat Input and the component that generates a response.
  2. Connect the response to Inputs.
  3. Place Chat Output at the end of the chat path.
  4. Run the flow in the Playground.

Configuration

SettingWhat it controlsRecommended starting point
InputsThe Message, Data, or DataFrame to display. Required.Connect the response from the previous component.
Store MessagesStores the output when a session ID is available.Leave on for multi-turn chat.
Sender TypeSets the chat role.Keep the default Machine.
Sender NameSets the display name.Keep the default AI.
Session IDSelects the stored-message session.Leave blank to use the current session.
Basic Clean DataAffects conversion of list inputs.Leave on unless a list needs its raw representation.

Expected result

Chat Output returns an Output Message and displays it in the Playground. A connected Data value always becomes the complete JSON object, formatted for reading; Chat Output has no setting to show only selected fields or to reword it as prose. A connected DataFrame becomes a Markdown table. A connected Message keeps its other fields where possible, but Chat Output overwrites its text, sender, sender name, session ID, flow ID, and source.

Storage requires both Store Messages and a session ID. When storage is on, the stored message is the same output shown in the chat, so a stored Data value is the same full JSON object. The component has no direct credential or credit behavior.

Reference details

For a list of inputs, Chat Output converts each compatible item and joins the results into one message. A single DataFrame does not use Basic Clean Data.

If a flow needs only selected fields, or reworded prose instead of the pretty-printed JSON, format that Data before it reaches Chat Output, for example with Parser.

  • Agent Core supplies a conversational response.
  • Chat Input starts the Playground conversation.
  • Parser formats Data into a template or plain text before it reaches Chat Output.
  • Guardrail can route an approved or flagged Message to chat.
Back to Components manual