Type Alias AskOptions

Options for a single ask/stream call.

type AskOptions = {
    abortSignal?: AbortSignal;
    brick?: unknown;
    brickName?: string;
    maxSteps?: number;
    onEvent?: (event: LoopEvent) => void;
    onRunEvent?: RunEventHandler;
    onToolApproval?: ApprovalHook;
    runId?: string;
    threadId?: string;
    tools?: ToolDefinition[];
}

Index

Properties

abortSignal? brick? brickName? maxSteps? onEvent? onRunEvent? onToolApproval? runId? threadId? tools?

Properties

`Optional`abortSignal

abortSignal?: AbortSignal

`Optional`brick

brick?: unknown

`Optional`brickName

brickName?: string

Annotates this call's run:start/run:finish RunEvents.

`Optional`maxSteps

maxSteps?: number

`Optional`onEvent

onEvent?: (event: LoopEvent) => void

`Optional`onRunEvent

onRunEvent?: RunEventHandler

`Optional`onToolApproval

onToolApproval?: ApprovalHook

`Optional`runId

runId?: string

`Optional`threadId

threadId?: string

Conversation thread id; requires memory to be set on the constructor.

`Optional`tools

tools?: ToolDefinition[]