ax() API Structured generation APIs. rust api api/ax packages/rust/axir-api.json api ax() API

ax() API

Structured generation APIs for typed programs.

Most Used

ax

Create an AxGen program from a string or parsed signature.

FieldValue
Kindfunction
Ax conceptax
API sectionAxGen
Formax(spec: &str)
ReturnsAxResult

Important Options

  • functions
  • examples
  • demos
  • sample count
  • result picker
  • modelConfig
  • maxRetries
  • streaming assertions
  • field processors
  • control
  • asyncMode

Examples

Rust
let qa = ax("question:string -> answer:string")?;

Full reference

AxGen

Structured generation program with indexed multi-sampling, winner selection, forward, streaming, optimization, trace, usage, and tool-call behavior.

FieldValue
Kindtype
Ax conceptAxGen
API sectionAxGen
FormAxGen
Returnsprogram object

Important Options

  • signature
  • functions
  • examples
  • demos
  • sample count
  • result picker
  • memory
  • prompt template

Full reference

tool

Build a typed function tool. Rust uses tool because fn is reserved.

FieldValue
Kindfunction
Ax conceptfn
API sectionTools
Formtool(name).description(...).arg(...).handler(...).build()
ReturnsToolBuilder

Important Options

  • name
  • description
  • args
  • returns
  • handler
  • execution: blocking or background
  • cancellation-aware handler

Examples

Rust
let search = tool("search").description("Search docs").build();

Full reference

Advanced / internals / full reference

run_control

Create a controller for scoped steering, reasoning updates, cancellation, and queued/applied lifecycle events. Pass it through forward options.

FieldValue
Kindfunction
Ax conceptrun_control
API sectionAxGen
Formrun_control()
ReturnsAxRunControl

Examples

Rust
let control = run_control();

Full reference

AxRunControl

Run control shared by active and future descendant programs. Cancellation reports unresolved work and does not undo external effects.

FieldValue
Kindtype
Ax conceptAxRunControl
API sectionAxGen
FormAxRunControl
Returnsrun controller

Important Options

  • steer
  • thinking token budget
  • target path
  • abort
  • event listener

Full reference

Tool

Callable tool descriptor with JSON-schema-compatible parameters and a host handler.

FieldValue
Kindtype
Ax conceptTool
API sectionTools
FormTool
Returnstool descriptor

Important Options

  • parameters
  • returns
  • handler

Full reference

Full Reference

Open the full Rust reference. This page highlights the ax symbols most relevant to everyday use.

Docs