AxProgramForwardOptions

TypeScript

type AxProgramForwardOptions<MODEL> = AxAIServiceOptions & object;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/dsp/types.ts#L186

Type declaration

Name	Type	Description
`_mcpContextPrompt?`	`AxChatRequest`[`"chatPrompt"`]	`Internal` Resolved MCP prompt/resource context for this run.
`_mcpExecutionContext?`	`AxMCPExecutionContext`	`Internal` Shared run-scoped MCP context.
`ai?`	`AxAIService`	-
`asserts?`	`AxAssertion`<`any`>[]	-
`cachingFunction()?`	(`key`: `string`, `value?`: `AxGenOut`) => \| `AxGenOut` \| `undefined` \| `Promise`<`AxGenOut` \| `undefined`>	-
`customTemplate?`	`string`	-
`description?`	`string`	-
`disableMemoryCleanup?`	`boolean`	-
`eventContext?`	`AxEventContext`	Immutable provenance and delivery context for event-driven execution.
`eventInheritance?`	`AxEventInheritance`	Controls propagation of event context to nested programs. Defaults to all.
`excludeContentFromTrace?`	`boolean`	-
`fastFail?`	`boolean`	-
`functionCall?`	`AxChatRequest`[`"functionCall"`]	-
`functionCallMode?`	`"auto"` \| `"native"` \| `"prompt"`	-
`functionResultFormatter()?`	(`result`: `unknown`) => `string`	-
`functions?`	`AxInputFunctionType`	-
`includeOptionalInputFieldsInSystemPrompt?`	`boolean`	-
`maxRetries?`	`number`	-
`maxSteps?`	`number`	-
`mcp?`	\| `AxMCPClient` \| readonly `AxMCPClient`[]	MCP clients attached natively to this execution.
`mcpContext?`	readonly `AxMCPContextRequest`[]	MCP prompts/resources to resolve into attributed run context.
`mcpInheritance?`	`AxMCPInheritance`	Controls propagation of MCP clients to nested programs.
`mem?`	`AxAIMemory`	-
`model?`	`MODEL`	-
`modelConfig?`	`AxModelConfig`	-
`onFunctionCall()?`	(`call`: `Readonly`<`AxFunctionCallTrace`>) => `void` \| `Promise`<`void`>	-
`promptTemplate?`	typeof `AxPromptTemplate`	-
`resultPicker?`	`AxResultPickerFunction`<`AxGenOut`>	-
`sampleCount?`	`number`	-
`selfTuning?`	`boolean` \| `AxSelfTuningConfig`	-
`showThoughts?`	`boolean`	-
`speech?`	`AxSpeechConfig`	-
`stepHooks?`	`AxStepHooks`	-
`stopFunction?`	`string` \| `string`[]	-
`streamingAsserts?`	`AxStreamingAssertion`[]	-
`strictMode?`	`boolean`	-
`structuredOutputMode?`	`"auto"` \| `"native"` \| `"function"`	-
`thoughtFieldName?`	`string`	-
`traceLabel?`	`string`	-
`ucp?`	\| `AxUCPClient` \| readonly `AxUCPClient`[]	UCP clients attached through their negotiated MCP services.

Type Parameters

Type Parameter
`MODEL`