Skip to content

ToolsToFinalOutputResult

type ToolsToFinalOutputResult =
  | {
  isFinalOutput: false;
  isInterrupted: undefined;
}
  | {
  interruptions: RunToolApprovalItem[];
  isFinalOutput: false;
  isInterrupted: true;
}
  | {
  finalOutput: string;
  isFinalOutput: true;
  isInterrupted: undefined;
};

Type declaration

Section titled “Type declaration”
{
  isFinalOutput: false;
  isInterrupted: undefined;
}

isFinalOutput

Section titled “isFinalOutput”
isFinalOutput: false;

Wether this is the final output. If false, the LLM will run again and receive the tool call output

isInterrupted

Section titled “isInterrupted”
isInterrupted: undefined;

Wether the agent was interrupted by a tool approval. If true, the LLM will run again and receive the tool call output

{
  interruptions: RunToolApprovalItem[];
  isFinalOutput: false;
  isInterrupted: true;
}

interruptions

Section titled “interruptions”
interruptions: RunToolApprovalItem[];

isFinalOutput

Section titled “isFinalOutput”
isFinalOutput: false;

isInterrupted

Section titled “isInterrupted”
isInterrupted: true;

Wether the agent was interrupted by a tool approval. If true, the LLM will run again and receive the tool call output

{
  finalOutput: string;
  isFinalOutput: true;
  isInterrupted: undefined;
}

finalOutput

Section titled “finalOutput”
finalOutput: string;

The final output. Can be undefined if isFinalOutput is false, otherwise it must be a string that will be processed based on the outputType of the agent.

isFinalOutput

Section titled “isFinalOutput”
isFinalOutput: true;

Wether this is the final output. If false, the LLM will run again and receive the tool call output

isInterrupted

Section titled “isInterrupted”
isInterrupted: undefined;

Wether the agent was interrupted by a tool approval. If true, the LLM will run again and receive the tool call output