Skip to content

StructuredAgentResult

This docs was updated at: 2026-02-23

com.paragon.agents.StructuredAgentResult  ยท  Record

The result of a structured agent interaction, containing the typed output.

This is the type-safe counterpart to AgentResult for agents with structured output. The output is automatically deserialized to the specified type.

Since: 1.0

Methods

isSuccess

public boolean isSuccess()

Whether the interaction was successful.

Returns

true if no error occurred and no handoff was triggered

isHandoff

public boolean isHandoff()

Whether a handoff to another agent occurred.

Returns

true if handoff was triggered

isError

public boolean isError()

Whether the interaction failed.

Returns

true if an error occurred

errorMessage

public @Nullable String errorMessage()

Returns the error message if one occurred.

Returns

the error message or null

success

public static <T> @NonNull StructuredAgentResult<T> success(
      @NonNull T output,
      @NonNull String rawOutput,
      @NonNull Response response,
      @NonNull List<ResponseInputItem> history,
      @NonNull List<ToolExecution> toolExecutions,
      int turnsUsed)

Creates a successful result.

Parameters

Name Description
output the typed output
rawOutput the raw JSON/text output
response the final response
history the conversation history
toolExecutions the tool executions
turnsUsed number of turns used
<T> the output type

Returns

a success result

success

public static <T> @NonNull StructuredAgentResult<T> success(
      @NonNull T output, @NonNull String rawOutput)

Convenience method for creating a simple successful result (for testing).

Parameters

Name Description
output the typed output
rawOutput the raw JSON/text output
<T> the output type

Returns

a minimal success result

error

public static <T> @NonNull StructuredAgentResult<T> error(
      @NonNull Throwable error,
      @Nullable String rawOutput,
      @Nullable Response response,
      @NonNull List<ResponseInputItem> history,
      @NonNull List<ToolExecution> toolExecutions,
      int turnsUsed)

Creates an error result.

Parameters

Name Description
error the error that occurred
rawOutput the raw output if any
response the last response if any
history the conversation history
toolExecutions the tool executions
turnsUsed number of turns used
<T> the output type

Returns

an error result

error

public static <T> @NonNull StructuredAgentResult<T> error(@NonNull Throwable error)

Convenience method for creating a simple error result (for testing).

Parameters

Name Description
error the error that occurred
<T> the output type

Returns

a minimal error result