AIDK API Reference / aidk/engine / EngineResponse
Interface: EngineResponse ​
Defined in: packages/core/src/engine/engine-response.ts:12
Represents the delta/effects returned by a Model execution that should be applied to the Engine's state.
Properties ​
| Property | Type | Description | Defined in |
|---|---|---|---|
executedToolResults? | ToolResult[] | Tool results from provider or adapter-executed tools. These tools were already executed (by LLM provider like code interpreter, or by the adapter library like AI SDK with maxSteps > 1). Engine should NOT re-execute these - just add them to the timeline. | packages/core/src/engine/engine-response.ts:36 |
newTimelineEntries? | COMTimelineEntry[] | New timeline entries to append. | packages/core/src/engine/engine-response.ts:16 |
shouldStop | boolean | Whether the engine should stop the tick loop. | packages/core/src/engine/engine-response.ts:41 |
stopReason? | StopReasonInfo | Structured stop reason information. Provides context about why execution stopped, allowing components to handle graceful recovery, retries, etc. | packages/core/src/engine/engine-response.ts:48 |
toolCalls? | ToolCall[] | Tool calls that need execution by Engine. These are tool_use blocks from the model that don't have corresponding tool results in the response (i.e., not already executed by provider/adapter). | packages/core/src/engine/engine-response.ts:28 |
updatedSections? | COMSection[] | Sections to update or add. | packages/core/src/engine/engine-response.ts:21 |
usage? | TokenUsage | Token usage from this model execution. Contains inputTokens, outputTokens, totalTokens, and optional reasoning/cache tokens. | packages/core/src/engine/engine-response.ts:54 |