Output

Important: Agents is currently in private beta and is not yet available to all customers.

Use Output to define how the agent returns responses. You can configure the response as either a structured output or a user message.

Jump to:

Return response as

Specify the format used for the agent response.

Field or selection Description
Return responses as

The format used to return the agent response. Available options include Structured output and User message. Available options include:

  • User message: User message to return the response as a message without defining a structured schema.

  • Structured output: Structured output to define a JSON schema for the response generated by the large language model (LLM). For more details, see Structured output.

Structured output

Select Structured output to define a JSON schema for the response generated by the large language model (LLM). Structured output allows the response to follow a defined format, which helps agentflows or downstream steps process the response consistently.

Field or selection Description
Manual edit mode Enable Manual edit mode to edit the JSON schema directly instead of using the field configuration interface.
Field name Name of the output field returned by the agent.
Field type

Data type for the output field. Available options include:

  • Number: Returns a numeric value.

  • String: Returns text.

  • Boolean: Returns true or false.

  • Enum: Returns one value from a predefined list.
Description The expected content of the field. This helps the model generate the correct output.
Optional Indicates that the field is optional. If selected, the model may omit this field in the response.
Add field Add additional fields to the output schema.

Output

Select the output variable where the agent response is stored.

Field or selection Description Variable types
Output

Select the variable used to store the response returned by the agent.

 Text, Decimal, Integer, Boolean, DateTime, Collection