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/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/dsp/prompt.ts#L28

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.
structuredOutput?booleanRender JSON output instructions and examples even for scalar signatures.
structuredOutputFunctionName?stringWhen set, indicates structured output should be delivered via a function call with this name
thoughtFieldName?string-
Docs