Skip to main content

Interface: ObjectOptions<TTools>

Defined in: packages/workflow-engine/src/ai/types.ts:415

Type Parameters​

TTools​

TTools extends ToolSet = ToolSet

Properties​

abortSignal?​

optional abortSignal?: AbortSignal

Defined in: packages/workflow-engine/src/ai/types.ts:421

Abort signal to cancel the AI SDK call (pass-through)


maxRetries?​

optional maxRetries?: number

Defined in: packages/workflow-engine/src/ai/types.ts:419

Maximum number of retries for the AI SDK call (pass-through)


maxTokens?​

optional maxTokens?: number

Defined in: packages/workflow-engine/src/ai/types.ts:417


onStepEnd?​

optional onStepEnd?: GenerateTextOnStepEndCallback<NoInfer<ToolSet>, NoInfer<Context>>

Defined in: packages/workflow-engine/src/ai/types.ts:429

Callback fired when each step completes (for collecting tool results)


providerOptions?​

optional providerOptions?: Record<string, Record<string, unknown>>

Defined in: packages/workflow-engine/src/ai/types.ts:434

Provider-specific options passed directly to the AI SDK call (e.g. { anthropic: { thinking: { type: "disabled" } } }).


stopWhen?​

optional stopWhen?: Arrayable<StopCondition<NoInfer<ToolSet>, Context>>

Defined in: packages/workflow-engine/src/ai/types.ts:427

Condition to stop tool execution (e.g., stepCountIs(3))


temperature?​

optional temperature?: number

Defined in: packages/workflow-engine/src/ai/types.ts:416


timeoutMs?​

optional timeoutMs?: number

Defined in: packages/workflow-engine/src/ai/types.ts:423

Override the helper-level per-call timeout.


tools?​

optional tools?: TTools

Defined in: packages/workflow-engine/src/ai/types.ts:425

Tool definitions for the model to use