Skip to content

SummarizeOptions

Defined in: src/models/model.ts:314

Options for Model.summarize.

systemPrompt?: SystemPrompt;

Defined in: src/models/model.ts:318

The request’s system prompt.


toolSpecs?: ToolSpec[];

Defined in: src/models/model.ts:323

The request’s tool specifications.


instructions?: string;

Defined in: src/models/model.ts:329

Summarization instructions replacing the default ones, which undefined or '' keeps. The base implementation’s instruction not to act on the request or call tools is always sent.


cancelSignal?: AbortSignal;

Defined in: src/models/model.ts:334

Signal that aborts the call.


agentMetadata?: AgentMetadata;

Defined in: src/models/model.ts:340

Metadata of the invoking agent, as passed to stream(). A provider may consult it to derive a prompt-cache routing key, so a replay can share the agent’s cache.