0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/ChatMiddlewareConfig.md
github-actions[bot] 273a212bcc
docs: regenerate API documentation (#1265)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-31 18:34:13 +02:00

2.6 KiB

id title
ChatMiddlewareConfig ChatMiddlewareConfig

Interface: ChatMiddlewareConfig

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

Chat configuration that middleware can observe or transform. This is a subset of the chat engine's effective configuration that middleware is allowed to modify.

Properties

messages

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

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

Canonical conversation history. Middleware and persistence read this.


metadata?

optional metadata?: Record<string, unknown>;

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


modelOptions?

optional modelOptions?: Record<string, unknown>;

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


providerMessages?

optional providerMessages?: ModelMessage<
  | string
  | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
  | null>[];

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

Provider-only context. Defaults to messages when it is not set.


resume?

optional resume?: RunAgentResumeItem[];

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


resumeToolState?

optional resumeToolState?: ChatResumeToolState;

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


systemPrompts

systemPrompts: SystemPrompt[];

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


tools

tools: Tool<SchemaInput, SchemaInput, string, unknown>[];

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