@threadplane/chatTypeAliasv0.3.7

ToolActivityOutcome

Concise, application-authored result evidence. A missing status means succeeded. failed shows a completed call as failed and may declare a retry the application handles. receipt records a write the application confirmed from the decoded result, never from an approval.

View sourceView Markdown
import type { ToolActivityOutcome } from '@threadplane/chat';

Declaration

export type ToolActivityOutcome = {
    readonly status?: 'succeeded';
    readonly text: string;
    readonly sources?: readonly ToolActivitySource[];
    readonly retry?: never;
} | {
    readonly status: 'failed';
    readonly text: string;
    readonly sources?: readonly ToolActivitySource[];
    readonly retry?: ToolActivityRetry;
} | {
    readonly status: 'receipt';
    readonly text: string;
    readonly lead?: string;
};