Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

ChatMiddlewareContext.md

353 lines8.2 KB

Interface: ChatMiddlewareContext

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:36

Stable context object passed to all middleware hooks. Created once per chat() invocation and shared across all hooks.

Properties

abort()

abort: (reason?) => void;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:63

Abort the chat run with a reason

Parameters

reason?

string

Returns

void


accumulatedContent

accumulatedContent: string;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:107

Accumulated text content for the current iteration


chunkIndex

chunkIndex: number;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:59

Running count of chunks yielded so far


context

context: unknown;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:65

Opaque user-provided value from chat() options


conversationId?

optional conversationId: string;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:53

Deprecated

Use threadId instead. Retained as an alias of threadId so middleware written before the AG-UI rename keeps working unchanged. Will be removed in a future major release.


createId()

createId: (prefix) => string;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:114

Generate a unique ID with the given prefix

Parameters

prefix

string

Returns

string


currentMessageId

currentMessageId: string | null;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:105

Current assistant message ID (changes per iteration)


defer()

defer: (promise) => void;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:71

Defer a non-blocking side-effect promise. Deferred promises do not block streaming and are awaited after the terminal hook (onFinish/onAbort/onError).

Parameters

promise

Promise<unknown>

Returns

void


hasTools

hasTools: boolean;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:100

Whether tools are configured


iteration

iteration: number;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:57

Current agent loop iteration (0-indexed)


messageCount

messageCount: number;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:98

Number of messages at the start of the request


messages

messages: readonly ModelMessage<
  | string
  | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
  | null>[];

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:112

Current messages array (read-only view)


model

model: string;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:78

Model identifier (e.g., 'gpt-4o')


modelOptions?

optional modelOptions: Record<string, unknown>;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:93

Provider-specific model options


options?

optional options: Record<string, unknown>;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:91

Flattened generation options (temperature, topP, maxTokens, metadata)


phase

phase: ChatMiddlewarePhase;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:55

Current lifecycle phase


provider

provider: string;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:76

Provider name (e.g., 'openai', 'anthropic')


requestId

requestId: string;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:38

Unique identifier for this chat request


signal?

optional signal: AbortSignal;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:61

Abort signal from the chat request


source

source: "client" | "server";

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:80

Source of the chat invocation — always 'server' for server-side chat


streamId

streamId: string;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:40

Unique identifier for this stream


streaming

streaming: boolean;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:82

Whether the chat is streaming


systemPrompts

systemPrompts: SystemPrompt[];

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:87

System prompts configured for this chat


threadId

threadId: string;

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:47

AG-UI thread identifier — a stable per-conversation ID used to correlate client and server devtools events. Resolves to the caller-provided threadId (or legacy conversationId), or an auto-generated value when neither is supplied.


toolNames?

optional toolNames: string[];

Defined in: packages/typescript/ai/src/activities/chat/middleware/types.ts:89

Names of configured tools, if any