What and how it can be used:
The Structured Output component ensures that AI agent responses follow a specific, predefined format or schema. It constrains the model’s output to match exact data structures, field types, and validation rules, making responses consistent, parseable, and ready for automated processing.
When/how the component should be used:
- Use when output must match a schema.
- Ideal for extracting specific data fields from unstructured text
- Provide an input message, which is the source material from which you want to extract structured data. This can come from practically any component, but it is typically a Chat Input, Knowledge Base – Files, or other component that provides some unstructured or semi-structured input.
- Define Format Instructions and an Output Schema to specify the data to extract from the source material and how to structure it in the final Data or DataFrame output
- Attach a language model component that is set to emit LanguageModel output.
- Optional: Typically, the structured output is passed to downstream components that use the extracted data for other processes, such as the Parser or Data Operations components
Connections with other components:
- Chat Output
- Batch Run
- Data Operations
- DataFrame Operations
- Parser
- Save File
- Smart Function
- Split Text
- Type Convert
- Loop
- Notify
- Chroma
Default values:
- Format Instructions = You are an AI that extracts structured JSON objects from unstructured text. Use a predefined schema with expected types (str, int, float, bool, dict). Extract ALL relevant instances that match the schema – if multiple patterns exist, capture them all. Fill missing or ambiguous values with defaults: null for missing values. Remove exact duplicates but keep variations that have different field values. Always return valid JSON in the expected format, never throw errors. If multiple objects can be extracted, return them all in the structured format.
- Actions ( In tool mode) = BUILD_STRUCTURED_OUTPUT, BUILD_STRUCTURED_DATAFRAME
Desired Behaviour:
- Best-effort schema compliance
- Clear failure on invalid input