Interface GuardrailOutputVerdict

The verdict on a reply, as GuardrailOutputOptions.onVerdict receives it.

interface GuardrailOutputVerdict {
    streamId: string;
    action: GuardrailAction;
    guardrailId?: string;
    reasonCode?: string;
    finalText: null | string;
    originalText: null | string;
    toolCallIds?: string[];
}

Properties

streamId action guardrailId? reasonCode? finalText originalText toolCallIds?

Properties

streamId

streamId: string

action

action: GuardrailAction

Optional guardrailId

guardrailId?: string

The id of the guard that blocked, when it has one.

Optional reasonCode

reasonCode?: string

finalText

finalText: null | string

The text the caller receives: the replacement after a block with one, the reply after a pass, else null.

originalText

originalText: null | string

The reply's text as the guards judged it, before any rewrite; null for a verdict on a streamed delta, which judged no whole reply.

Optional toolCallIds

toolCallIds?: string[]

The ids of the actionable tool calls (executionMode: 'external') a block withheld from the caller: the calls of the tool-call chunk it ended the stream in place of, or, in hold mode, of the tool-call chunk after the text it blocked. AgentOS drops the pause the runtime saved for them when the turn stopped for them. Unset when a verdict withheld no actionable call; after such a block AgentOS drops the pause the turn saves later, once the turn ends, and never offers it meanwhile.

Settings

Member Visibility

Theme

On This Page

streamIdactionguardrailIdreasonCodefinalTextoriginalTexttoolCallIds