Interface AskOptions

Options for agent.ask.

interface AskOptions {
    context?: unknown;
    onText?: (text: string) => void;
    signal?: AbortSignal;
}

Index

Properties

context? onText? signal?

Properties

`Optional`context

context?: unknown

Data the assistant needs, such as the mod's state. Sent as JSON beside the question.

`Optional`onText

onText?: (text: string) => void

Called with each piece of the answer as it is written, for showing it while it streams.

`Optional`signal

signal?: AbortSignal

Stops the question. The promise then rejects.