Type Alias ToolCallResponse<Memory, Out>

Response returned by a ToolHandler.

type ToolCallResponse<Memory extends ChatMemory, Out> = {
    content?: readonly Content[];
    error?: string;
    "x-content"?: Out;
    "x-memLambda"?: string;
    "x-memPatch"?: ChatMemoryPatch<Memory>;
}

Type Parameters

Memory extends ChatMemory
Out

Index

Properties

content? error? x-content? x-memLambda? x-memPatch?

Properties

`Optional`content

content?: readonly Content[]

Preferred rich content payload.

`Optional`error

error?: string

Error string; mutually exclusive with content.

`Optional`x-content

"x-content"?: Out

Structured output for providers lacking content.

`Optional`x-memLambda

"x-memLambda"?: string

Lambdascript program to mutate memory.

`Optional`x-memPatch

"x-memPatch"?: ChatMemoryPatch<Memory>

Internal non‑serialisable mutation.