flow() API
Flow builder, workflow graph, execution plan, and mermaid APIs.
Most Used
Ax.flow
Create an AxFlow program graph or compile the portable Mermaid shorthand.
| Field | Value |
|---|---|
| Kind | function |
| Ax concept | flow |
| API section | Flow |
| Form | Ax.flow(options) / Ax.flow(mermaid, bindings) |
| Returns | AxFlow |
Important Options
nodesexecute mappersconditionscachereturnsMermaid roundtrip
Examples
AxFlow wf = Ax.flow(Map.of());AxFlow
Workflow graph with Core-owned planning, cache keys, state merge, child aggregation, optimization, and returns projection.
| Field | Value |
|---|---|
| Kind | type |
| Ax concept | AxFlow |
| API section | Flow |
| Form | new AxFlow(optionsOrMermaid, bindings) |
| Returns | flow program |
Important Options
stepsstateparallel groupsreturns
Advanced / internals / full reference
AxProgram.ownedWorkerFactory
Optional factory for independent program state. Parallel groups require both client and program factories; otherwise the whole group runs serially with a fallback trace.
| Field | Value |
|---|---|
| Kind | method |
| Ax concept | owned_program_factory |
| API section | Flow |
| Form | AxProgram.ownedWorkerFactory() |
| Returns | worker factory or unavailable |
Important Options
owned memoryper-node controlsdeterministic result mergecooperative cancellation
Full Reference
Open the full Java reference. This page highlights the flow symbols most relevant to everyday use.