AxPromptTemplateOptions Generated TypeScript API reference. typescript api api/reference build/apidocs/Interface.AxPromptTemplateOptions.md interface AxPromptTemplateOptions

AxPromptTemplateOptions

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/prompt.ts#L24

Properties

PropertyTypeDescription
contextCache?AxContextCacheOptions-
customTemplate?stringCustom Ax template-engine string to use instead of the built-in dspy.md. Uses Mustache-style syntax with {{ var }}, {{ if cond }} / {{ else }} / {{ /if }}. Receives the same variables as the default template (identityText, taskDefinitionText, etc.). Useful for reordering prompt sections to enable cross-signature prompt caching.
functions?readonly ( | AxFunction | { toFunction: () => | AxFunction | AxFunction[]; })[]-
ignoreBreakpoints?booleanWhen true, cacheBreakpoint is ignored and cache is applied to all positions (for providers with auto-lookback like Anthropic)
includeOptionalInputFieldsInSystemPrompt?booleanWhen true, optional input fields stay in the system prompt field list even when values omit them.
structuredOutputFunctionName?stringWhen set, indicates structured output should be delivered via a function call with this name
thoughtFieldName?string-
Docs