UI Stream Types

Description

UI stream types configure which data a node streams to the user interface during execution. This controls what users see in real-time as the agent processes their query.

Syntax

Configure UI streaming via ui_stream_types on a node:

generate_response:
  type: ResponseGenerationStep
  ui_stream_types:
    generation: true
    retrievals: true
  input_mapping:
    retrievals: search#retrievals
    query: __inputs__#query

Supported Stream Types

Stream Type	Description
`RETRIEVALS`	Search results and citations
`GENERATION`	LLM response text (streams as it’s generated)
`QUERY_REFORMULATION`	Query transformations and expansions
`ATTRIBUTION`	Citation attribution data
`GROUNDEDNESS`	Groundedness scores for the response

Example: Full Response Pipeline

nodes:
  search:
    type: SearchUnstructuredDataStep
    ui_stream_types:
      retrievals: true
      query_reformulation: true
    input_mapping:
      query: __inputs__#query

  generate:
    type: ResponseGenerationStep
    ui_stream_types:
      generation: true
      attribution: true
      groundedness: true
    input_mapping:
      retrievals: search#retrievals
      query: __inputs__#query

Multiple Nodes with Same Stream Type

Multiple nodes can have the same UI streaming type. Events stream sequentially in execution order:

nodes:
  research:
    type: AgenticResearchStep
    ui_stream_types:
      retrievals: true
    # ... config

  generate:
    type: GenerateFromResearchStep
    ui_stream_types:
      generation: true
    # ... config

Multi-Output Workflows

For workflows with multiple outputs, use ui_output at the root level to designate which output displays in the UI:

outputs:
  response: str
  metadata: Dict[str, Any]
  debug_info: str

ui_output: response

Default Behavior

Each step type has default UI stream types. Check the Step Reference Catalog for defaults. Common defaults:

Step Type	Default Streams
`SearchUnstructuredDataStep`	`QUERY_REFORMULATION`
`ResponseGenerationStep`	`RETRIEVALS`, `GENERATION`, `ATTRIBUTION`, `GROUNDEDNESS`
`AgenticResearchStep`	`RETRIEVALS`
`GenerateFromResearchStep`	`GENERATION`

Key Terms & Concepts

Agent Composer

Agent Configs

Datastore Configs

Description

Syntax

Supported Stream Types

Example: Full Response Pipeline

Multiple Nodes with Same Stream Type

Multi-Output Workflows

Default Behavior

​Description

​Syntax

​Supported Stream Types

​Example: Full Response Pipeline

​Multiple Nodes with Same Stream Type

​Multi-Output Workflows

​Default Behavior

​Related

Description

Syntax

Supported Stream Types

Example: Full Response Pipeline

Multiple Nodes with Same Stream Type

Multi-Output Workflows

Default Behavior

Related