0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/DebugConfig.md
github-actions[bot] 5701bf5184
docs: regenerate API documentation (#1141)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-18 19:53:35 +02:00

4.3 KiB

id title
DebugConfig DebugConfig

Interface: DebugConfig

Defined in: packages/ai/src/logger/types.ts:73

Granular debug configuration combining per-category toggles with an optional custom logger. Any unspecified category flag defaults to true.

Extends

Properties

agentLoop?

optional agentLoop?: boolean;

Defined in: packages/ai/src/logger/types.ts:50

Iteration markers and phase transitions in the chat agent loop. Chat-only.

Inherited from

DebugCategories.agentLoop


config?

optional config?: boolean;

Defined in: packages/ai/src/logger/types.ts:54

Config transforms returned by middleware onConfig hooks. Chat-only.

Inherited from

DebugCategories.config


errors?

optional errors?: boolean;

Defined in: packages/ai/src/logger/types.ts:58

Caught errors throughout the pipeline. Unlike other categories, defaults to true even when debug is unspecified. Explicitly set errors: false or debug: false to silence.

Inherited from

DebugCategories.errors


logger?

optional logger?: Logger;

Defined in: packages/ai/src/logger/types.ts:77

Custom Logger implementation. When omitted, a default ConsoleLogger routes output to console.debug/info/warn/error.


middleware?

optional middleware?: boolean;

Defined in: packages/ai/src/logger/types.ts:42

Inputs and outputs around each middleware hook invocation. Chat-only.

Inherited from

DebugCategories.middleware


output?

optional output?: boolean;

Defined in: packages/ai/src/logger/types.ts:38

Chunks/results yielded to the consumer after all middleware. For streaming activities this fires per chunk; for non-streaming activities it fires once per result.

Inherited from

DebugCategories.output


provider?

optional provider?: boolean;

Defined in: packages/ai/src/logger/types.ts:34

Raw chunks/frames received from a provider SDK (OpenAI, Anthropic, Gemini, Ollama, Grok, Groq, OpenRouter, fal, ElevenLabs, BytePlus). Emitted inside every streaming adapter's chunk loop.

Inherited from

DebugCategories.provider


request?

optional request?: boolean;

Defined in: packages/ai/src/logger/types.ts:62

Outgoing call metadata (provider, model, message/tool counts) emitted before each adapter SDK call.

Inherited from

DebugCategories.request


sandbox?

optional sandbox?: boolean;

Defined in: packages/ai/src/logger/types.ts:67

Sandbox internals: watcher start/stop + mechanism, file events, sandbox hook dispatch, ensure/bootstrap and lifecycle transitions. Chat-only.

Inherited from

DebugCategories.sandbox


tools?

optional tools?: boolean;

Defined in: packages/ai/src/logger/types.ts:46

Before/after tool-call execution in the chat agent loop. Chat-only.

Inherited from

DebugCategories.tools