Skip to content
AgentsKit

@agentskit/core β€” Interfaces

API interfaces for @agentskit/core.

#Interface: ActivateSkillsResult

Defined in: packages/core/src/agent-loop.ts:35

System prompt and tools produced while activating chat skills.

#Properties

#skillTools

skillTools: ToolDefinition<Record<string, unknown>>[]

Defined in: packages/core/src/agent-loop.ts:37


#systemPrompt

systemPrompt: string | undefined

Defined in: packages/core/src/agent-loop.ts:36


#Interface: AdapterCapabilities

Defined in: packages/core/src/types/adapter.ts:34

Hints about what an adapter supports. Every field is optional; an adapter may omit the whole capabilities object, and consumers should treat omission as 'unknown β€” assume the feature works and handle errors if it doesn't'.

This is an additive extension to the Adapter contract (ADR 0001) β€” adapters without capabilities remain fully compliant. Consumers that care (router / ensemble adapters, UI that hides the tool toggle when the provider can't use tools) can read the hints.

#Properties

#extensions?

optional extensions?: Record<string, unknown>

Defined in: packages/core/src/types/adapter.ts:48

Anything else β€” e.g. provider-specific hints.


#multiModal?

optional multiModal?: boolean

Defined in: packages/core/src/types/adapter.ts:42

Accepts image inputs in the message list?


#reasoning?

optional reasoning?: boolean

Defined in: packages/core/src/types/adapter.ts:40

Does it emit a separate reasoning/thinking stream (o1/o3 style)?


#streaming?

optional streaming?: boolean

Defined in: packages/core/src/types/adapter.ts:36

Does the adapter stream responses natively?


#structuredOutput?

optional structuredOutput?: boolean

Defined in: packages/core/src/types/adapter.ts:44

Supports confirmations / structured-output primitives?


#tools?

optional tools?: boolean

Defined in: packages/core/src/types/adapter.ts:38

Does it support tool calling (function calling)?


#usage?

optional usage?: boolean

Defined in: packages/core/src/types/adapter.ts:46

Emits token/usage data in chunk metadata?


#Interface: AdapterContext

Defined in: packages/core/src/types/adapter.ts:7

Optional model settings and metadata supplied with an adapter request.

#Properties

#maxTokens?

optional maxTokens?: number

Defined in: packages/core/src/types/adapter.ts:10


#metadata?

optional metadata?: Record<string, unknown>

Defined in: packages/core/src/types/adapter.ts:12


#systemPrompt?

optional systemPrompt?: string

Defined in: packages/core/src/types/adapter.ts:8


#temperature?

optional temperature?: number

Defined in: packages/core/src/types/adapter.ts:9


#tools?

optional tools?: ToolDefinition<Record<string, unknown>>[]

Defined in: packages/core/src/types/adapter.ts:11


#Interface: AdapterRequest

Defined in: packages/core/src/types/adapter.ts:16

Messages and context passed to an adapter when creating a stream.

#Properties

#context?

optional context?: AdapterContext

Defined in: packages/core/src/types/adapter.ts:18


#correlation?

optional correlation?: AgentEventContext

Defined in: packages/core/src/types/adapter.ts:20

Optional identity propagated to adapters without coupling them to a runtime.


#messages

messages: Message[]

Defined in: packages/core/src/types/adapter.ts:17


#Interface: AgentEventContext

Defined in: packages/core/src/types/agent.ts:7

IDs that correlate events across an operation, run, session, or turn.

#Properties

#actionId?

readonly optional actionId?: string

Defined in: packages/core/src/types/agent.ts:12


#operationId

readonly operationId: string

Defined in: packages/core/src/types/agent.ts:8


#runId?

readonly optional runId?: string

Defined in: packages/core/src/types/agent.ts:9


#sessionId?

readonly optional sessionId?: string

Defined in: packages/core/src/types/agent.ts:10


#traceId?

readonly optional traceId?: string

Defined in: packages/core/src/types/agent.ts:13


#turnId?

readonly optional turnId?: string

Defined in: packages/core/src/types/agent.ts:11


#Interface: ArgsValidationError

Defined in: packages/core/src/types/tool.ts:36

One tool-argument validation issue and its field path.

#Properties

#message

message: string

Defined in: packages/core/src/types/tool.ts:39


#path

path: string

Defined in: packages/core/src/types/tool.ts:38

JSON pointer / dotted path to the offending field, or '' for root.


#Interface: ArgsValidationResult

Defined in: packages/core/src/types/tool.ts:43

Result returned by an injected tool-argument validator.

#Properties

#errors?

optional errors?: ArgsValidationError[]

Defined in: packages/core/src/types/tool.ts:45


#message?

optional message?: string

Defined in: packages/core/src/types/tool.ts:47

Optional pre-built human summary; used verbatim in the thrown error.


#valid

valid: boolean

Defined in: packages/core/src/types/tool.ts:44


#Interface: AudioPart

Defined in: packages/core/src/types/content.ts:26

Audio content referenced by a URL, data URL, or provider identifier.

#Properties

#durationSec?

optional durationSec?: number

Defined in: packages/core/src/types/content.ts:31

Duration in seconds, if known.


#mimeType?

optional mimeType?: string

Defined in: packages/core/src/types/content.ts:29


#source

source: string

Defined in: packages/core/src/types/content.ts:28


#type

type: "audio"

Defined in: packages/core/src/types/content.ts:27


#Interface: ChatConfig

Defined in: packages/core/src/types/chat.ts:40

Configuration for a headless chat controller and its integrations.

#Example

const chat = createChatController({ adapter: openai({ apiKey, model: 'gpt-4o' }) })
await chat.send('Hello')

#Properties

#adapter

adapter: AdapterFactory

Defined in: packages/core/src/types/chat.ts:41


#authorizeToolCall?

optional authorizeToolCall?: ToolAuthorizer

Defined in: packages/core/src/types/chat.ts:64


#correlation?

optional correlation?: AgentEventContext

Defined in: packages/core/src/types/chat.ts:43

Optional identity propagated to adapter requests and runtime events.


#decisionStore?

optional decisionStore?: ToolDecisionStore

Defined in: packages/core/src/types/chat.ts:51

Required by decide; scope this store to the authorized conversation.


#initialMessages?

optional initialMessages?: Message[]

Defined in: packages/core/src/types/chat.ts:53


#maxTokens?

optional maxTokens?: number

Defined in: packages/core/src/types/chat.ts:46


#maxToolIterations?

optional maxToolIterations?: number

Defined in: packages/core/src/types/chat.ts:60

Maximum number of LLM ↔ tool feedback turns per send(). After a tool call, the controller feeds the result back to the model so it can continue reasoning. This caps that loop to prevent runaway cost if a model keeps requesting tools. Default: 5. Set to 1 to disable.


#memory?

optional memory?: ChatMemory

Defined in: packages/core/src/types/chat.ts:49


#observers?

optional observers?: Observer[]

Defined in: packages/core/src/types/chat.ts:65


#onError?

optional onError?: (error) => void

Defined in: packages/core/src/types/chat.ts:62

#Parameters

error

Error

#Returns

void


#onMessage?

optional onMessage?: (message) => void

Defined in: packages/core/src/types/chat.ts:61

#Parameters

message

Message

#Returns

void


#onToolCall?

optional onToolCall?: (toolCall, context) => MaybePromise<void>

Defined in: packages/core/src/types/chat.ts:63

#Parameters

toolCall

ToolCall

context

ToolCallHandlerContext

#Returns

MaybePromise<void>


#retriever?

optional retriever?: Retriever

Defined in: packages/core/src/types/chat.ts:52


#skills?

optional skills?: SkillDefinition[]

Defined in: packages/core/src/types/chat.ts:48


#systemPrompt?

optional systemPrompt?: string

Defined in: packages/core/src/types/chat.ts:44


#temperature?

optional temperature?: number

Defined in: packages/core/src/types/chat.ts:45


#tools?

optional tools?: ToolDefinition<Record<string, unknown>>[]

Defined in: packages/core/src/types/chat.ts:47


#validateArgs?

optional validateArgs?: ArgsValidator

Defined in: packages/core/src/types/chat.ts:73

Opt-in runtime validator for tool-call arguments (ADR-0008). When set, args produced by the model are checked against each tool's JSON Schema before execution; mismatches raise AK_TOOL_INVALID_INPUT. Omit for the default passthrough behaviour. Use createAjvValidator() from @agentskit/tools/validation.


#Interface: ChatController

Defined in: packages/core/src/types/chat.ts:100

Imperative API for reading and controlling a chat session.

#Properties

#approve

approve: (toolCallId) => Promise<void>

Defined in: packages/core/src/types/chat.ts:126

#Parameters

toolCallId

string

#Returns

Promise<void>

#Deprecated

Generation-local only. Use decide with a decisionStore for durable decisions.


#clear

clear: () => Promise<void>

Defined in: packages/core/src/types/chat.ts:120

#Returns

Promise<void>


#decide

decide: (toolCallId, decision, reason?) => Promise<ToolCall>

Defined in: packages/core/src/types/chat.ts:124

Resume a durable confirmation; terminal replay does not call tool or model again.

#Parameters

toolCallId

string

decision

"approve" | "deny"

reason?

string

#Returns

Promise<ToolCall>


#deny

deny: (toolCallId, reason?) => Promise<void>

Defined in: packages/core/src/types/chat.ts:128

#Parameters

toolCallId

string

reason?

string

#Returns

Promise<void>

#Deprecated

Generation-local only. Use decide for durable decisions.


#edit

edit: (messageId, newContent, opts?) => Promise<void>

Defined in: packages/core/src/types/chat.ts:111

Edit a message by id. For user messages, truncates all subsequent turns and regenerates (unless opts.regenerate === false). For assistant messages, updates the content in place.

#Parameters

messageId

string

newContent

string

opts?

EditOptions

#Returns

Promise<void>


#getState

getState: () => ChatState

Defined in: packages/core/src/types/chat.ts:101

#Returns

ChatState


#proposeToolCall

proposeToolCall: (proposal) => Promise<ToolCall>

Defined in: packages/core/src/types/chat.ts:122

#Parameters

proposal

Pick<ToolCall, "id" | "name" | "args">

#Returns

Promise<ToolCall>


#regenerate

regenerate: (messageId?) => Promise<void>

Defined in: packages/core/src/types/chat.ts:117

Regenerate the assistant response. If messageId names an assistant message, that one is replaced. Otherwise regenerates the last assistant turn (same as retry()).

#Parameters

messageId?

string

#Returns

Promise<void>


#retry

retry: () => Promise<void>

Defined in: packages/core/src/types/chat.ts:105

#Returns

Promise<void>


#send

send: (text) => Promise<void>

Defined in: packages/core/src/types/chat.ts:103

#Parameters

text

string | ContentPart[]

#Returns

Promise<void>


#setInput

setInput: (value) => void

Defined in: packages/core/src/types/chat.ts:118

#Parameters

value

string

#Returns

void


#setMessages

setMessages: (messages) => void

Defined in: packages/core/src/types/chat.ts:119

#Parameters

messages

Message[]

#Returns

void


#stop

stop: () => void

Defined in: packages/core/src/types/chat.ts:104

#Returns

void


#subscribe

subscribe: (listener) => () => void

Defined in: packages/core/src/types/chat.ts:102

#Parameters

listener

() => void

#Returns

() => void


#updateConfig

updateConfig: (config) => void

Defined in: packages/core/src/types/chat.ts:121

#Parameters

config

Partial<ChatConfig>

#Returns

void


#Interface: ChatMemory

Defined in: packages/core/src/types/memory.ts:6

Persistence contract for loading, saving, and clearing chat messages.

#Properties

#clear?

optional clear?: (options?) => MaybePromise<void>

Defined in: packages/core/src/types/memory.ts:11

#Parameters

options?

MemoryOperationOptions

#Returns

MaybePromise<void>


#load

load: (options?) => MaybePromise<Message[]>

Defined in: packages/core/src/types/memory.ts:9

#Parameters

options?

MemoryOperationOptions

#Returns

MaybePromise<Message[]>


#region?

optional region?: DataRegion

Defined in: packages/core/src/types/memory.ts:8

Data-residency region for this memory backend, when known.


#save

save: (messages, options?) => MaybePromise<void>

Defined in: packages/core/src/types/memory.ts:10

#Parameters

messages

Message[]

options?

MemoryOperationOptions

#Returns

MaybePromise<void>


#Interface: ChatReturn

Defined in: packages/core/src/types/chat.ts:132

Chat state combined with the actions exposed by framework bindings.

#Extends

#Properties

#approve

approve: (toolCallId) => Promise<void>

Defined in: packages/core/src/types/chat.ts:141

#Parameters

toolCallId

string

#Returns

Promise<void>


#clear

clear: () => Promise<void>

Defined in: packages/core/src/types/chat.ts:139

#Returns

Promise<void>


#deny

deny: (toolCallId, reason?) => Promise<void>

Defined in: packages/core/src/types/chat.ts:142

#Parameters

toolCallId

string

reason?

string

#Returns

Promise<void>


#edit

edit: (messageId, newContent, opts?) => Promise<void>

Defined in: packages/core/src/types/chat.ts:136

#Parameters

messageId

string

newContent

string

opts?

EditOptions

#Returns

Promise<void>


#error

error: Error | null

Defined in: packages/core/src/types/chat.ts:81

#Inherited from

ChatState.error


#input

input: string

Defined in: packages/core/src/types/chat.ts:80

#Inherited from

ChatState.input


#messages

messages: Message[]

Defined in: packages/core/src/types/chat.ts:78

#Inherited from

ChatState.messages


#proposeToolCall

proposeToolCall: (proposal) => Promise<ToolCall>

Defined in: packages/core/src/types/chat.ts:140

#Parameters

proposal

Pick<ToolCall, "id" | "name" | "args">

#Returns

Promise<ToolCall>


#regenerate

regenerate: (messageId?) => Promise<void>

Defined in: packages/core/src/types/chat.ts:137

#Parameters

messageId?

string

#Returns

Promise<void>


#retry

retry: () => Promise<void>

Defined in: packages/core/src/types/chat.ts:135

#Returns

Promise<void>


#send

send: (text) => Promise<void>

Defined in: packages/core/src/types/chat.ts:133

#Parameters

text

string | ContentPart[]

#Returns

Promise<void>


#setInput

setInput: (value) => void

Defined in: packages/core/src/types/chat.ts:138

#Parameters

value

string

#Returns

void


#status

status: StreamStatus

Defined in: packages/core/src/types/chat.ts:79

#Inherited from

ChatState.status


#stop

stop: () => void

Defined in: packages/core/src/types/chat.ts:134

#Returns

void


#usage

usage: TokenUsage

Defined in: packages/core/src/types/chat.ts:87

Token usage accumulated across every LLM call in this chat session. Populated when the adapter surfaces usage (OpenAI, Anthropic, Gemini, Ollama all do). Zeroed by clear().

#Inherited from

ChatState.usage


#Interface: ChatState

Defined in: packages/core/src/types/chat.ts:77

Current messages, input, stream status, error, and accumulated usage.

#Extended by

#Properties

#error

error: Error | null

Defined in: packages/core/src/types/chat.ts:81


#input

input: string

Defined in: packages/core/src/types/chat.ts:80


#messages

messages: Message[]

Defined in: packages/core/src/types/chat.ts:78


#status

status: StreamStatus

Defined in: packages/core/src/types/chat.ts:79


#usage

usage: TokenUsage

Defined in: packages/core/src/types/chat.ts:87

Token usage accumulated across every LLM call in this chat session. Populated when the adapter surfaces usage (OpenAI, Anthropic, Gemini, Ollama all do). Zeroed by clear().


#Interface: CompileBudgetInput

Defined in: packages/core/src/budget.ts:9

Inputs for estimating and trimming a model request to a token budget.

#Properties

#budget

budget: number

Defined in: packages/core/src/budget.ts:11

Hard upper bound (model context limit - reserveForOutput).


#counter?

optional counter?: TokenCounter

Defined in: packages/core/src/budget.ts:16

Token counter. Defaults to approximateCounter (chars/4 heuristic).


#keepRecent?

optional keepRecent?: number

Defined in: packages/core/src/budget.ts:27

Minimum number of recent messages to keep regardless of strategy. Protects against dropping the turn that actually matters. Default 1.


#messages

messages: Message[]

Defined in: packages/core/src/budget.ts:12


#reserveForOutput?

optional reserveForOutput?: number

Defined in: packages/core/src/budget.ts:22

Tokens reserved for the model's output. Subtracted from budget.


#strategy?

optional strategy?: BudgetStrategy

Defined in: packages/core/src/budget.ts:18

Trimming strategy. Default 'drop-oldest'.


#summarizer?

optional summarizer?: (dropped) => Message | Promise<Message>

Defined in: packages/core/src/budget.ts:20

Required when strategy === 'summarize'.

#Parameters

dropped

Message[]

#Returns

Message | Promise<Message>


#systemPrompt?

optional systemPrompt?: string

Defined in: packages/core/src/budget.ts:13


#tools?

optional tools?: ToolDefinition<Record<string, unknown>>[]

Defined in: packages/core/src/budget.ts:14


#Interface: CompileBudgetResult

Defined in: packages/core/src/budget.ts:31

Trimmed request, token breakdown, and messages removed to fit the budget.

#Properties

#dropped

dropped: Message[]

Defined in: packages/core/src/budget.ts:41


#fits

fits: boolean

Defined in: packages/core/src/budget.ts:42


#messages

messages: Message[]

Defined in: packages/core/src/budget.ts:32


#strategy

strategy: BudgetStrategy

Defined in: packages/core/src/budget.ts:43


#systemPrompt?

optional systemPrompt?: string

Defined in: packages/core/src/budget.ts:33


#tokens

tokens: object

Defined in: packages/core/src/budget.ts:34

#budget

budget: number

#messages

messages: number

#system

system: number

#tools

tools: number

#total

total: number


#Interface: ConsumeStreamHandlers

Defined in: packages/core/src/primitives.ts:320

Callbacks for each event emitted by a model response stream.

#Properties

#onDone

onDone: (accumulatedText) => void

Defined in: packages/core/src/primitives.ts:327

#Parameters

accumulatedText

string

#Returns

void


#onError?

optional onError?: (error) => void

Defined in: packages/core/src/primitives.ts:326

#Parameters

error

Error

#Returns

void


#onReasoning?

optional onReasoning?: (accumulated) => void

Defined in: packages/core/src/primitives.ts:322

#Parameters

accumulated

string

#Returns

void


#onText?

optional onText?: (accumulated) => void

Defined in: packages/core/src/primitives.ts:321

#Parameters

accumulated

string

#Returns

void


#onToolCall?

optional onToolCall?: (chunk) => void | Promise<void>

Defined in: packages/core/src/primitives.ts:323

#Parameters

chunk

StreamChunk

#Returns

void | Promise<void>


#onToolResult?

optional onToolResult?: (content) => void

Defined in: packages/core/src/primitives.ts:324

#Parameters

content

string

#Returns

void


#onUsage?

optional onUsage?: (usage) => void

Defined in: packages/core/src/primitives.ts:325

#Parameters

usage

TokenUsage

#Returns

void


#Interface: DefineToolConfig<TSchema>

Defined in: packages/core/src/types/tool.ts:131

Config for defineTool: schema is narrowed to a const type for inference.

#Type Parameters

#TSchema

TSchema extends JSONSchema7

#Properties

#category?

optional category?: string

Defined in: packages/core/src/types/tool.ts:143


#description?

optional description?: string

Defined in: packages/core/src/types/tool.ts:133


#dispose?

optional dispose?: () => MaybePromise<void>

Defined in: packages/core/src/types/tool.ts:141

#Returns

MaybePromise<void>


#execute?

optional execute?: (args, context) => unknown

Defined in: packages/core/src/types/tool.ts:136

#Parameters

args

InferSchemaType<TSchema>

context

ToolExecutionContext

#Returns

unknown


#init?

optional init?: () => MaybePromise<void>

Defined in: packages/core/src/types/tool.ts:140

#Returns

MaybePromise<void>


#name

name: string

Defined in: packages/core/src/types/tool.ts:132


#requiresConfirmation?

optional requiresConfirmation?: boolean

Defined in: packages/core/src/types/tool.ts:135


#schema?

optional schema?: TSchema

Defined in: packages/core/src/types/tool.ts:134


#tags?

optional tags?: string[]

Defined in: packages/core/src/types/tool.ts:142


#Interface: EditOptions

Defined in: packages/core/src/types/chat.ts:91

Options controlling how a user-message edit affects later turns.

#Properties

#regenerate?

optional regenerate?: boolean

Defined in: packages/core/src/types/chat.ts:96

When editing a user message, also regenerate the assistant response that followed it (truncating any later turns). Default: true.


#Interface: EvalResult

Defined in: packages/core/src/types/eval.ts:9

Aggregate score and per-case outcomes from an evaluation run.

#Properties

#accuracy

accuracy: number

Defined in: packages/core/src/types/eval.ts:13


#failed

failed: number

Defined in: packages/core/src/types/eval.ts:12


#passed

passed: number

Defined in: packages/core/src/types/eval.ts:11


#results

results: object[]

Defined in: packages/core/src/types/eval.ts:14

#error?

optional error?: string

#input

input: string

#latencyMs

latencyMs: number

#output

output: string

#passed

passed: boolean

#tokenUsage?

optional tokenUsage?: object

tokenUsage.completion

completion: number

tokenUsage.prompt

prompt: number


#totalCases

totalCases: number

Defined in: packages/core/src/types/eval.ts:10


#Interface: EvalSuite

Defined in: packages/core/src/types/eval.ts:25

Named collection of evaluation cases.

#Properties

#cases

cases: EvalTestCase[]

Defined in: packages/core/src/types/eval.ts:27


#name

name: string

Defined in: packages/core/src/types/eval.ts:26


#Interface: EvalTestCase

Defined in: packages/core/src/types/eval.ts:2

Input and expected-output check used by an evaluation suite.

#Properties

#expected

expected: string | ((result) => boolean)

Defined in: packages/core/src/types/eval.ts:4


#input

input: string

Defined in: packages/core/src/types/eval.ts:3


#metadata?

optional metadata?: Record<string, unknown>

Defined in: packages/core/src/types/eval.ts:5


#Interface: ExecuteSafeToolOptions

Defined in: packages/core/src/agent-loop.ts:79

Dependencies and callbacks used to execute and report a tool call.

#Properties

#authorize?

optional authorize?: ToolAuthorizer

Defined in: packages/core/src/agent-loop.ts:89


#context

context: ToolExecutionContext

Defined in: packages/core/src/agent-loop.ts:82


#correlation?

optional correlation?: AgentEventContext

Defined in: packages/core/src/agent-loop.ts:90


#emitter

emitter: object

Defined in: packages/core/src/agent-loop.ts:83

#addObserver()

addObserver(observer): () => void

Parameters
observer

Observer

Returns

() => void

#emit()

emit(event): void

Parameters
event

AgentEvent

Returns

void


#lifecycle

lifecycle: object

Defined in: packages/core/src/agent-loop.ts:84

#disposeAll()

disposeAll(): Promise<void>

Returns

Promise<void>

#init()

init(tool): Promise<void>

Parameters
tool

ToolDefinition

Returns

Promise<void>


#onConfirm?

optional onConfirm?: (toolCall) => MaybePromise<boolean>

Defined in: packages/core/src/agent-loop.ts:86

#Parameters

toolCall

ToolCall

#Returns

MaybePromise<boolean>


#onPartial?

optional onPartial?: (result) => void

Defined in: packages/core/src/agent-loop.ts:85

#Parameters

result

string

#Returns

void


#tool

tool: ToolDefinition<Record<string, unknown>> | undefined

Defined in: packages/core/src/agent-loop.ts:80


#toolCall

toolCall: ToolCall

Defined in: packages/core/src/agent-loop.ts:81


#validate?

optional validate?: ArgsValidator

Defined in: packages/core/src/agent-loop.ts:88

Opt-in arg validation against tool.schema (ADR-0008).


#Interface: FilePart

Defined in: packages/core/src/types/content.ts:43

File content referenced by a URL, data URL, or provider identifier.

#Properties

#filename?

optional filename?: string

Defined in: packages/core/src/types/content.ts:48

Original filename, when available.


#mimeType?

optional mimeType?: string

Defined in: packages/core/src/types/content.ts:46


#source

source: string

Defined in: packages/core/src/types/content.ts:45


#type

type: "file"

Defined in: packages/core/src/types/content.ts:44


#Interface: ImagePart

Defined in: packages/core/src/types/content.ts:16

Image content referenced by a URL, data URL, or provider identifier.

#Properties

#detail?

optional detail?: "low" | "high" | "auto"

Defined in: packages/core/src/types/content.ts:22

Provider-neutral hint, e.g. 'low' / 'high'.


#mimeType?

optional mimeType?: string

Defined in: packages/core/src/types/content.ts:20


#source

source: string

Defined in: packages/core/src/types/content.ts:19

Data URL, http(s) URL, or provider-hosted reference id.


#type

type: "image"

Defined in: packages/core/src/types/content.ts:17


#Interface: MemoryRecord

Defined in: packages/core/src/types/message.ts:29

Versioned JSON-safe representation of messages stored by a memory backend.

#Properties

#messages

messages: (Omit<Message, "createdAt"> & object)[]

Defined in: packages/core/src/types/message.ts:31


#version

version: 1

Defined in: packages/core/src/types/message.ts:30


#Interface: Message

Defined in: packages/core/src/types/message.ts:10

Conversation message with optional tool calls and multi-modal parts.

#Properties

#content

content: string

Defined in: packages/core/src/types/message.ts:14

Text projection of the message. Always populated, even for multi-modal.


#createdAt

createdAt: Date

Defined in: packages/core/src/types/message.ts:25


#id

id: string

Defined in: packages/core/src/types/message.ts:11


#metadata?

optional metadata?: Record<string, unknown>

Defined in: packages/core/src/types/message.ts:24


#parts?

optional parts?: ContentPart[]

Defined in: packages/core/src/types/message.ts:20

Multi-modal parts. When provided, content is a text projection of these parts (see partsToText). Adapters that support the relevant modality should prefer parts over content.


#role

role: MessageRole

Defined in: packages/core/src/types/message.ts:12


#status

status: MessageStatus

Defined in: packages/core/src/types/message.ts:21


#toolCallId?

optional toolCallId?: string

Defined in: packages/core/src/types/message.ts:23


#toolCalls?

optional toolCalls?: ToolCall[]

Defined in: packages/core/src/types/message.ts:22


#Interface: Observer

Defined in: packages/core/src/types/agent.ts:41

Observer callback registered to receive agent lifecycle events.

#Properties

#name

name: string

Defined in: packages/core/src/types/agent.ts:42


#on

on: (event) => void | Promise<void>

Defined in: packages/core/src/types/agent.ts:43

#Parameters

event

AgentEvent

#Returns

void | Promise<void>


#Interface: ParsedToolArgs

Defined in: packages/core/src/primitives.ts:150

Parsed tool arguments and whether the input passed bounded JSON checks.

#Properties

#args

args: Record<string, unknown>

Defined in: packages/core/src/primitives.ts:151


#valid

valid: boolean

Defined in: packages/core/src/primitives.ts:152


#Interface: ProgressiveArgParser

Defined in: packages/core/src/progressive.ts:17

Incremental parser state and methods for streamed tool-argument JSON.

#Properties

#buffer

readonly buffer: string

Defined in: packages/core/src/progressive.ts:27

Accumulated raw buffer.


#end

end: () => ProgressiveFieldEvent[]

Defined in: packages/core/src/progressive.ts:21

Mark the stream finished β€” validates the object closed cleanly. Returns any final events.

#Returns

ProgressiveFieldEvent[]


#events

readonly events: readonly ProgressiveFieldEvent[]

Defined in: packages/core/src/progressive.ts:23

All events seen so far, in order.


#push

push: (chunk) => ProgressiveFieldEvent[]

Defined in: packages/core/src/progressive.ts:19

Append a new chunk of JSON text. Emits onField for each top-level field that completes.

#Parameters

chunk

string

#Returns

ProgressiveFieldEvent[]


#value

readonly value: Record<string, unknown>

Defined in: packages/core/src/progressive.ts:25

Current parsed partial object (fields completed so far).


#Interface: ProgressiveExecOptions

Defined in: packages/core/src/progressive.ts:207

Callbacks and field requirements for progressive tool execution.

#Properties

#onField?

optional onField?: (event) => void

Defined in: packages/core/src/progressive.ts:211

Called for each field event, including those after execution starts.

#Parameters

event

ProgressiveFieldEvent

#Returns

void


#triggerFields?

optional triggerFields?: string[]

Defined in: packages/core/src/progressive.ts:209

Start executing after these fields have been received. Default: first field.


#Interface: ProgressiveExecResult

Defined in: packages/core/src/progressive.ts:215

Parsed fields and execution promise returned by progressive execution.

#Properties

#execution

execution: Promise<unknown>

Defined in: packages/core/src/progressive.ts:219

Resolves with the tool's return value.


#fields

fields: ProgressiveFieldEvent[]

Defined in: packages/core/src/progressive.ts:216


#finalArgs

finalArgs: Record<string, unknown>

Defined in: packages/core/src/progressive.ts:217


#Interface: ProgressiveFieldEvent

Defined in: packages/core/src/progressive.ts:5

Parsed top-level JSON field emitted as soon as its value is complete.

#Properties

#field

field: string

Defined in: packages/core/src/progressive.ts:7

Top-level field name whose value just finished being streamed.


#offset

offset: number

Defined in: packages/core/src/progressive.ts:13

Byte offset in the accumulated buffer where this field ended.


#raw

raw: string

Defined in: packages/core/src/progressive.ts:11

Raw JSON text for that field.


#value

value: unknown

Defined in: packages/core/src/progressive.ts:9

Parsed value (string / number / boolean / array / object / null).


#Interface: RetrievedDocument

Defined in: packages/core/src/types/retrieval.ts:5

Document returned by a retriever for a query.

#Properties

#content

content: string

Defined in: packages/core/src/types/retrieval.ts:7


#id

id: string

Defined in: packages/core/src/types/retrieval.ts:6


#metadata?

optional metadata?: Record<string, unknown>

Defined in: packages/core/src/types/retrieval.ts:10


#score?

optional score?: number

Defined in: packages/core/src/types/retrieval.ts:9


#source?

optional source?: string

Defined in: packages/core/src/types/retrieval.ts:8


#Interface: Retriever

Defined in: packages/core/src/types/retrieval.ts:20

Retrieval contract used to add relevant documents to a chat request.

#Properties

#retrieve

retrieve: (request) => MaybePromise<RetrievedDocument[]>

Defined in: packages/core/src/types/retrieval.ts:21

#Parameters

request

RetrieverRequest

#Returns

MaybePromise<RetrievedDocument[]>


#Interface: RetrieverRequest

Defined in: packages/core/src/types/retrieval.ts:14

Query and conversation context supplied to a retriever.

#Properties

#messages

messages: Message[]

Defined in: packages/core/src/types/retrieval.ts:16


#query

query: string

Defined in: packages/core/src/types/retrieval.ts:15


#Interface: SkillDefinition

Defined in: packages/core/src/types/skill.ts:5

Prompt, metadata, and optional activation hook contributed by a skill.

#Properties

#delegates?

optional delegates?: string[]

Defined in: packages/core/src/types/skill.ts:11


#description

description: string

Defined in: packages/core/src/types/skill.ts:7


#examples?

optional examples?: object[]

Defined in: packages/core/src/types/skill.ts:9

#input

input: string

#output

output: string


#metadata?

optional metadata?: Record<string, unknown>

Defined in: packages/core/src/types/skill.ts:13


#name

name: string

Defined in: packages/core/src/types/skill.ts:6


#onActivate?

optional onActivate?: () => MaybePromise<{ tools?: ToolDefinition<Record<string, unknown>>[]; }>

Defined in: packages/core/src/types/skill.ts:14

#Returns

MaybePromise<{ tools?: ToolDefinition<Record<string, unknown>>[]; }>


#systemPrompt

systemPrompt: string

Defined in: packages/core/src/types/skill.ts:8


#temperature?

optional temperature?: number

Defined in: packages/core/src/types/skill.ts:12


#tools?

optional tools?: string[]

Defined in: packages/core/src/types/skill.ts:10


#Interface: StreamChunk

Defined in: packages/core/src/types/stream.ts:20

One text, tool, reasoning, usage, error, or completion event from a stream.

#Properties

#content?

optional content?: string

Defined in: packages/core/src/types/stream.ts:22


#metadata?

optional metadata?: Record<string, unknown>

Defined in: packages/core/src/types/stream.ts:25


#toolCall?

optional toolCall?: StreamToolCallPayload

Defined in: packages/core/src/types/stream.ts:23


#type

type: "error" | "text" | "tool_call" | "tool_result" | "reasoning" | "usage" | "done"

Defined in: packages/core/src/types/stream.ts:21


#usage?

optional usage?: TokenUsage

Defined in: packages/core/src/types/stream.ts:24


#Interface: StreamSource

Defined in: packages/core/src/types/stream.ts:29

Abortable asynchronous source of model response chunks.

#Properties

#abort

abort: () => void

Defined in: packages/core/src/types/stream.ts:31

#Returns

void


#stream

stream: () => AsyncIterableIterator<StreamChunk>

Defined in: packages/core/src/types/stream.ts:30

#Returns

AsyncIterableIterator<StreamChunk>


#Interface: StreamToolCallPayload

Defined in: packages/core/src/types/stream.ts:5

Tool call data carried by a streamed response chunk.

#Properties

#args

args: string

Defined in: packages/core/src/types/stream.ts:8


#id

id: string

Defined in: packages/core/src/types/stream.ts:6


#name

name: string

Defined in: packages/core/src/types/stream.ts:7


#result?

optional result?: string

Defined in: packages/core/src/types/stream.ts:9


#Interface: TextPart

Defined in: packages/core/src/types/content.ts:10

Plain text content in a multi-modal message.

#Properties

#text

text: string

Defined in: packages/core/src/types/content.ts:12


#type

type: "text"

Defined in: packages/core/src/types/content.ts:11


#Interface: TokenCounter

Defined in: packages/core/src/types/token-counter.ts:33

Universal token counter contract.

Implementations range from zero-dep approximate counters (chars/4) to provider-specific tokenizers (e.g. tiktoken for OpenAI models).

#Example

const result = await counter.count(messages, { model: 'gpt-4o' })
console.log(`Estimated tokens: ${result.total}`)

#Properties

#name

readonly name: string

Defined in: packages/core/src/types/token-counter.ts:35

Human-readable name of the counter (e.g. "approximate", "tiktoken").

#Methods

#count()

count(messages, options?): number | Promise<number>

Defined in: packages/core/src/types/token-counter.ts:41

Count (or estimate) the number of tokens for a list of messages. May be async to allow lazy-loading of tokenizer WASM modules.

#Parameters

messages

readonly Pick<Message, "role" | "content">[]

options?

TokenCounterOptions

#Returns

number | Promise<number>


#countDetailed()?

optional countDetailed(messages, options?): TokenCountResult | Promise<TokenCountResult>

Defined in: packages/core/src/types/token-counter.ts:47

Count with per-message breakdown. Falls back to calling count once when not overridden.

#Parameters

messages

readonly Pick<Message, "role" | "content">[]

options?

TokenCounterOptions

#Returns

TokenCountResult | Promise<TokenCountResult>


#Interface: TokenCounterOptions

Defined in: packages/core/src/types/token-counter.ts:6

Options passed to a token counter implementation.

#Properties

#model?

optional model?: string

Defined in: packages/core/src/types/token-counter.ts:8

Model identifier β€” used by provider-specific counters to pick the right tokenizer.


#Interface: TokenCountResult

Defined in: packages/core/src/types/token-counter.ts:14

Result returned by a token counter.

#Properties

#perMessage?

optional perMessage?: number[]

Defined in: packages/core/src/types/token-counter.ts:18

Per-message breakdown (same order as input).


#total

total: number

Defined in: packages/core/src/types/token-counter.ts:16

Total token count across all input messages.


#Interface: TokenUsage

Defined in: packages/core/src/types/stream.ts:13

Token counts reported for a model response.

#Properties

#completionTokens

completionTokens: number

Defined in: packages/core/src/types/stream.ts:15


#promptTokens

promptTokens: number

Defined in: packages/core/src/types/stream.ts:14


#totalTokens

totalTokens: number

Defined in: packages/core/src/types/stream.ts:16


#Interface: ToolAuthorizationContext

Defined in: packages/core/src/types/tool.ts:162

Tool-call context annotated with the authorization stage.

#Extends

#Properties

#messages

messages: Message[]

Defined in: packages/core/src/types/tool.ts:155

#Inherited from

ToolCallHandlerContext.messages


#phase

phase: ToolAuthorizationPhase

Defined in: packages/core/src/types/tool.ts:162


#tool?

optional tool?: ToolDefinition<Record<string, unknown>>

Defined in: packages/core/src/types/tool.ts:156

#Inherited from

ToolCallHandlerContext.tool


#Interface: ToolAuthorizationDecision

Defined in: packages/core/src/types/tool.ts:164

Allow or reject a tool call, with an optional explanation.

#Properties

#allowed

allowed: boolean

Defined in: packages/core/src/types/tool.ts:164


#reason?

optional reason?: string

Defined in: packages/core/src/types/tool.ts:164


#Interface: ToolCall

Defined in: packages/core/src/types/tool.ts:9

Tool call requested by a model, including parsed arguments and outcome.

#Properties

#args

args: Record<string, unknown>

Defined in: packages/core/src/types/tool.ts:12


#error?

optional error?: string

Defined in: packages/core/src/types/tool.ts:14


#id

id: string

Defined in: packages/core/src/types/tool.ts:10


#name

name: string

Defined in: packages/core/src/types/tool.ts:11


#result?

optional result?: string

Defined in: packages/core/src/types/tool.ts:13


#status

status: ToolCallStatus

Defined in: packages/core/src/types/tool.ts:15


#Interface: ToolCallHandlerContext

Defined in: packages/core/src/types/tool.ts:154

Messages and resolved tool supplied to call and authorization handlers.

#Extended by

#Properties

#messages

messages: Message[]

Defined in: packages/core/src/types/tool.ts:155


#tool?

optional tool?: ToolDefinition<Record<string, unknown>>

Defined in: packages/core/src/types/tool.ts:156


#Interface: ToolDecisionRecord

Defined in: packages/core/src/types/chat.ts:13

A persisted decision, scoped by the application to one authorized conversation.

#Properties

#decision?

optional decision?: "approve" | "deny"

Defined in: packages/core/src/types/chat.ts:17


#messages

messages: Message[]

Defined in: packages/core/src/types/chat.ts:15


#outcome?

optional outcome?: ToolCall

Defined in: packages/core/src/types/chat.ts:19


#reason?

optional reason?: string

Defined in: packages/core/src/types/chat.ts:18


#status

status: "pending" | "complete" | "claimed" | "failed" | "denied"

Defined in: packages/core/src/types/chat.ts:16


#toolCallId

toolCallId: string

Defined in: packages/core/src/types/chat.ts:14


#Interface: ToolDecisionStore

Defined in: packages/core/src/types/chat.ts:23

Durable, linearizable admission boundary. Never reset claimed or terminal records.

#Properties

#claim

claim: (toolCallId, decision, reason?) => Promise<ToolDecisionRecord | undefined>

Defined in: packages/core/src/types/chat.ts:28

Atomic pending β†’ claimed transition; only the winner receives the stored snapshot.

#Parameters

toolCallId

string

decision

"approve" | "deny"

reason?

string

#Returns

Promise<ToolDecisionRecord | undefined>


#get

get: (toolCallId) => Promise<ToolDecisionRecord | undefined>

Defined in: packages/core/src/types/chat.ts:26

#Parameters

toolCallId

string

#Returns

Promise<ToolDecisionRecord | undefined>


#putPending

putPending: (record) => Promise<void>

Defined in: packages/core/src/types/chat.ts:25

Insert only if absent; a duplicate must not overwrite the original snapshot.

#Parameters

record

ToolDecisionRecord

#Returns

Promise<void>


#settle

settle: (record) => Promise<void>

Defined in: packages/core/src/types/chat.ts:30

Persist the winner's terminal outcome; reject writes without a matching claim.

#Parameters

record

ToolDecisionRecord

#Returns

Promise<void>


#Interface: ToolDefinition<TArgs>

Defined in: packages/core/src/types/tool.ts:111

Executable tool contract, including optional schema and lifecycle hooks.

#Type Parameters

#TArgs

TArgs = Record<string, unknown>

#Properties

#category?

optional category?: string

Defined in: packages/core/src/types/tool.ts:123


#description?

optional description?: string

Defined in: packages/core/src/types/tool.ts:113


#dispose?

optional dispose?: () => MaybePromise<void>

Defined in: packages/core/src/types/tool.ts:121

#Returns

MaybePromise<void>


#execute?

optional execute?: (args, context) => unknown

Defined in: packages/core/src/types/tool.ts:116

#Parameters

args

TArgs

context

ToolExecutionContext

#Returns

unknown


#init?

optional init?: () => MaybePromise<void>

Defined in: packages/core/src/types/tool.ts:120

#Returns

MaybePromise<void>


#name

name: string

Defined in: packages/core/src/types/tool.ts:112


#requiresConfirmation?

optional requiresConfirmation?: boolean

Defined in: packages/core/src/types/tool.ts:115


#schema?

optional schema?: JSONSchema7

Defined in: packages/core/src/types/tool.ts:114


#tags?

optional tags?: string[]

Defined in: packages/core/src/types/tool.ts:122


#Interface: ToolExecResult

Defined in: packages/core/src/agent-loop.ts:71

Outcome and duration of one safe tool execution attempt.

#Properties

#durationMs

durationMs: number

Defined in: packages/core/src/agent-loop.ts:75


#error?

optional error?: string

Defined in: packages/core/src/agent-loop.ts:74


#result?

optional result?: string

Defined in: packages/core/src/agent-loop.ts:73


#status

status: "complete" | "error" | "skipped"

Defined in: packages/core/src/agent-loop.ts:72


#Interface: ToolExecutionContext

Defined in: packages/core/src/types/tool.ts:19

Conversation context passed to a tool's execute function.

#Properties

#call

call: ToolCall

Defined in: packages/core/src/types/tool.ts:21


#messages

messages: Message[]

Defined in: packages/core/src/types/tool.ts:20


#runId?

optional runId?: string

Defined in: packages/core/src/types/tool.ts:23

Stable parent run identifier when the caller can provide one.


#Interface: UseStreamOptions

Defined in: packages/core/src/types/stream.ts:35

Callbacks for observing chunks and completion from a stream hook.

#Properties

#onChunk?

optional onChunk?: (chunk) => void

Defined in: packages/core/src/types/stream.ts:36

#Parameters

chunk

StreamChunk

#Returns

void


#onComplete?

optional onComplete?: (text) => void

Defined in: packages/core/src/types/stream.ts:37

#Parameters

text

string

#Returns

void


#onError?

optional onError?: (error) => void

Defined in: packages/core/src/types/stream.ts:38

#Parameters

error

Error

#Returns

void


#Interface: UseStreamReturn

Defined in: packages/core/src/types/stream.ts:42

Latest chunk and accumulated text exposed by a stream hook.

#Properties

#data

data: StreamChunk | null

Defined in: packages/core/src/types/stream.ts:43


#error

error: Error | null

Defined in: packages/core/src/types/stream.ts:46


#status

status: StreamStatus

Defined in: packages/core/src/types/stream.ts:45


#stop

stop: () => void

Defined in: packages/core/src/types/stream.ts:47

#Returns

void


#text

text: string

Defined in: packages/core/src/types/stream.ts:44


#Interface: VectorDocument

Defined in: packages/core/src/types/memory.ts:19

Embedded content record stored by a vector-memory backend.

#Properties

#content

content: string

Defined in: packages/core/src/types/memory.ts:21


#embedding

embedding: number[]

Defined in: packages/core/src/types/memory.ts:22


#id

id: string

Defined in: packages/core/src/types/memory.ts:20


#metadata?

optional metadata?: Record<string, unknown>

Defined in: packages/core/src/types/memory.ts:23


#Interface: VectorFilterCompound

Defined in: packages/core/src/types/memory.ts:57

Boolean combination of nested vector metadata filters.

#Properties

#$and?

optional $and?: VectorFilter[]

Defined in: packages/core/src/types/memory.ts:58


#$or?

optional $or?: VectorFilter[]

Defined in: packages/core/src/types/memory.ts:59


#Interface: VectorMemory

Defined in: packages/core/src/types/memory.ts:76

Contract for storing, searching, and optionally deleting embedded documents.

#Properties

#delete?

optional delete?: (ids) => MaybePromise<void>

Defined in: packages/core/src/types/memory.ts:84

#Parameters

ids

string[]

#Returns

MaybePromise<void>


#region?

optional region?: DataRegion

Defined in: packages/core/src/types/memory.ts:78

Data-residency region for this vector backend, when known.


search: (embedding, options?) => MaybePromise<RetrievedDocument[]>

Defined in: packages/core/src/types/memory.ts:80

#Parameters

embedding

number[]

options?

VectorSearchOptions

#Returns

MaybePromise<RetrievedDocument[]>


#store

store: (docs) => MaybePromise<void>

Defined in: packages/core/src/types/memory.ts:79

#Parameters

docs

VectorDocument[]

#Returns

MaybePromise<void>


#Interface: VectorSearchOptions

Defined in: packages/core/src/types/memory.ts:68

Result limit, similarity threshold, and metadata filter for vector search.

#Properties

#filter?

optional filter?: VectorFilter

Defined in: packages/core/src/types/memory.ts:72

Metadata filter applied to candidates before / during similarity search.


#threshold?

optional threshold?: number

Defined in: packages/core/src/types/memory.ts:70


#topK?

optional topK?: number

Defined in: packages/core/src/types/memory.ts:69


#Interface: VideoPart

Defined in: packages/core/src/types/content.ts:35

Video content referenced by a URL, data URL, or provider identifier.

#Properties

#durationSec?

optional durationSec?: number

Defined in: packages/core/src/types/content.ts:39


#mimeType?

optional mimeType?: string

Defined in: packages/core/src/types/content.ts:38


#source

source: string

Defined in: packages/core/src/types/content.ts:37


#type

type: "video"

Defined in: packages/core/src/types/content.ts:36


#Interface: VirtualizedMemoryOptions

Defined in: packages/core/src/virtualized-memory.ts:5

Active-window and retrieval settings for virtualized chat memory.

#Properties

#maxActive?

optional maxActive?: number

Defined in: packages/core/src/virtualized-memory.ts:7

Maximum number of recent messages to keep "hot" (always loaded). Default 50.


#maxRetrieved?

optional maxRetrieved?: number

Defined in: packages/core/src/virtualized-memory.ts:19

Maximum retrieved cold messages per load. Default 10.


#retriever?

optional retriever?: (input) => Message[] | Promise<Message[]>

Defined in: packages/core/src/virtualized-memory.ts:13

Optional retriever used to surface relevant "cold" messages on each load(). Given the hot window, returns up to maxRetrieved older messages to splice back in (in chronological order).

#Parameters

input
cold

Message[]

hot

Message[]

maxRetrieved

number

#Returns

Message[] | Promise<Message[]>

Explore nearby

On this page

Interface: ActivateSkillsResultPropertiesskillToolssystemPromptInterface: AdapterCapabilitiesPropertiesextensions?multiModal?reasoning?streaming?structuredOutput?tools?usage?Interface: AdapterContextPropertiesmaxTokens?metadata?systemPrompt?temperature?tools?Interface: AdapterRequestPropertiescontext?correlation?messagesInterface: AgentEventContextPropertiesactionId?operationIdrunId?sessionId?traceId?turnId?Interface: ArgsValidationErrorPropertiesmessagepathInterface: ArgsValidationResultPropertieserrors?message?validInterface: AudioPartPropertiesdurationSec?mimeType?sourcetypeInterface: ChatConfigExamplePropertiesadapterauthorizeToolCall?correlation?decisionStore?initialMessages?maxTokens?maxToolIterations?memory?observers?onError?ParameterserrorReturnsonMessage?ParametersmessageReturnsonToolCall?ParameterstoolCallcontextReturnsretriever?skills?systemPrompt?temperature?tools?validateArgs?Interface: ChatControllerPropertiesapproveParameterstoolCallIdReturnsDeprecatedclearReturnsdecideParameterstoolCallIddecisionreason?ReturnsdenyParameterstoolCallIdreason?ReturnsDeprecatededitParametersmessageIdnewContentopts?ReturnsgetStateReturnsproposeToolCallParametersproposalReturnsregenerateParametersmessageId?ReturnsretryReturnssendParameterstextReturnssetInputParametersvalueReturnssetMessagesParametersmessagesReturnsstopReturnssubscribeParameterslistenerReturnsupdateConfigParametersconfigReturnsInterface: ChatMemoryPropertiesclear?Parametersoptions?ReturnsloadParametersoptions?Returnsregion?saveParametersmessagesoptions?ReturnsInterface: ChatReturnExtendsPropertiesapproveParameterstoolCallIdReturnsclearReturnsdenyParameterstoolCallIdreason?ReturnseditParametersmessageIdnewContentopts?ReturnserrorInherited frominputInherited frommessagesInherited fromproposeToolCallParametersproposalReturnsregenerateParametersmessageId?ReturnsretryReturnssendParameterstextReturnssetInputParametersvalueReturnsstatusInherited fromstopReturnsusageInherited fromInterface: ChatStateExtended byPropertieserrorinputmessagesstatususageInterface: CompileBudgetInputPropertiesbudgetcounter?keepRecent?messagesreserveForOutput?strategy?summarizer?ParametersdroppedReturnssystemPrompt?tools?Interface: CompileBudgetResultPropertiesdroppedfitsmessagesstrategysystemPrompt?tokensbudgetmessagessystemtoolstotalInterface: ConsumeStreamHandlersPropertiesonDoneParametersaccumulatedTextReturnsonError?ParameterserrorReturnsonReasoning?ParametersaccumulatedReturnsonText?ParametersaccumulatedReturnsonToolCall?ParameterschunkReturnsonToolResult?ParameterscontentReturnsonUsage?ParametersusageReturnsInterface: DefineToolConfig<TSchema>Type ParametersTSchemaPropertiescategory?description?dispose?Returnsexecute?ParametersargscontextReturnsinit?ReturnsnamerequiresConfirmation?schema?tags?Interface: EditOptionsPropertiesregenerate?Interface: EvalResultPropertiesaccuracyfailedpassedresultserror?inputlatencyMsoutputpassedtokenUsage?tokenUsage.completiontokenUsage.prompttotalCasesInterface: EvalSuitePropertiescasesnameInterface: EvalTestCasePropertiesexpectedinputmetadata?Interface: ExecuteSafeToolOptionsPropertiesauthorize?contextcorrelation?emitteraddObserver()ParametersobserverReturnsemit()ParameterseventReturnslifecycledisposeAll()Returnsinit()ParameterstoolReturnsonConfirm?ParameterstoolCallReturnsonPartial?ParametersresultReturnstooltoolCallvalidate?Interface: FilePartPropertiesfilename?mimeType?sourcetypeInterface: ImagePartPropertiesdetail?mimeType?sourcetypeInterface: MemoryRecordPropertiesmessagesversionInterface: MessagePropertiescontentcreatedAtidmetadata?parts?rolestatustoolCallId?toolCalls?Interface: ObserverPropertiesnameonParameterseventReturnsInterface: ParsedToolArgsPropertiesargsvalidInterface: ProgressiveArgParserPropertiesbufferendReturnseventspushParameterschunkReturnsvalueInterface: ProgressiveExecOptionsPropertiesonField?ParameterseventReturnstriggerFields?Interface: ProgressiveExecResultPropertiesexecutionfieldsfinalArgsInterface: ProgressiveFieldEventPropertiesfieldoffsetrawvalueInterface: RetrievedDocumentPropertiescontentidmetadata?score?source?Interface: RetrieverPropertiesretrieveParametersrequestReturnsInterface: RetrieverRequestPropertiesmessagesqueryInterface: SkillDefinitionPropertiesdelegates?descriptionexamples?inputoutputmetadata?nameonActivate?ReturnssystemPrompttemperature?tools?Interface: StreamChunkPropertiescontent?metadata?toolCall?typeusage?Interface: StreamSourcePropertiesabortReturnsstreamReturnsInterface: StreamToolCallPayloadPropertiesargsidnameresult?Interface: TextPartPropertiestexttypeInterface: TokenCounterExamplePropertiesnameMethodscount()Parametersmessagesoptions?ReturnscountDetailed()?Parametersmessagesoptions?ReturnsInterface: TokenCounterOptionsPropertiesmodel?Interface: TokenCountResultPropertiesperMessage?totalInterface: TokenUsagePropertiescompletionTokenspromptTokenstotalTokensInterface: ToolAuthorizationContextExtendsPropertiesmessagesInherited fromphasetool?Inherited fromInterface: ToolAuthorizationDecisionPropertiesallowedreason?Interface: ToolCallPropertiesargserror?idnameresult?statusInterface: ToolCallHandlerContextExtended byPropertiesmessagestool?Interface: ToolDecisionRecordPropertiesdecision?messagesoutcome?reason?statustoolCallIdInterface: ToolDecisionStorePropertiesclaimParameterstoolCallIddecisionreason?ReturnsgetParameterstoolCallIdReturnsputPendingParametersrecordReturnssettleParametersrecordReturnsInterface: ToolDefinition<TArgs>Type ParametersTArgsPropertiescategory?description?dispose?Returnsexecute?ParametersargscontextReturnsinit?ReturnsnamerequiresConfirmation?schema?tags?Interface: ToolExecResultPropertiesdurationMserror?result?statusInterface: ToolExecutionContextPropertiescallmessagesrunId?Interface: UseStreamOptionsPropertiesonChunk?ParameterschunkReturnsonComplete?ParameterstextReturnsonError?ParameterserrorReturnsInterface: UseStreamReturnPropertiesdataerrorstatusstopReturnstextInterface: VectorDocumentPropertiescontentembeddingidmetadata?Interface: VectorFilterCompoundProperties$and?$or?Interface: VectorMemoryPropertiesdelete?ParametersidsReturnsregion?searchParametersembeddingoptions?ReturnsstoreParametersdocsReturnsInterface: VectorSearchOptionsPropertiesfilter?threshold?topK?Interface: VideoPartPropertiesdurationSec?mimeType?sourcetypeInterface: VirtualizedMemoryOptionsPropertiesmaxActive?maxRetrieved?retriever?ParametersinputcoldhotmaxRetrievedReturns