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

AxOptimizableComponent

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

Properties

PropertyTypeDescription
constraints?stringFree-form invariants the proposed value must respect.
currentstringCurrent value snapshot.
dependsOn?readonly string[]Other component keys that should be proposed and evaluated with this one.
description?stringHuman-readable context shown to the reflection LLM.
format?stringOptional generic format hint, e.g. “snake_case” or “handlebars-template”.
keystringGlobally-unique key within the program tree. Stable across calls. Convention: ${programId}::${kind} or ${programId}::${kind}:${subKey}.
kindstringFree-form hint for the reflection prompt. Not interpreted by the optimizer. Examples: “instruction”, “description”, “fn-desc”, “fn-name”, “actor-tpl”, “primitive”, or any user-defined kind.
maxLength?numberOptional generic length hint for reflection and validation.
preserve?readonly string[]Literal tokens/placeholders that proposed values must preserve.
traceId?stringStable identifier used to correlate runtime traces with this component.
validate?AxOptimizableValidatorOptional validator: returns true when the value is acceptable, or an error message string the optimizer can show the LLM on re-roll.
Docs