Liking cljdoc? Tell your friends :D

fractal-engine.api

Stable public Clojure API for library consumers.

This namespace is the supported facade for starting sessions, running turns, reading run artifacts, and checking claim provenance. It intentionally stays generic: the model-facing runtime surface remains the six functions installed inside a session namespace (FINAL, lm, map-lm, rlm, map-rlm, attach-rlm).

Stable public Clojure API for library consumers.

This namespace is the supported facade for starting sessions, running turns,
reading run artifacts, and checking claim provenance. It intentionally stays
generic: the model-facing runtime surface remains the six functions installed
inside a session namespace (`FINAL`, `lm`, `map-lm`, `rlm`, `map-rlm`,
`attach-rlm`).
raw docstring

auth-statusclj

(auth-status provider-id)

Return auth availability data for provider-id.

Return auth availability data for `provider-id`.
sourceraw docstring

check-claimsclj

(check-claims final)
(check-claims final base)

Check evidenced claims against the filesystem.

base resolves relative evidence paths.

Check evidenced claims against the filesystem.

`base` resolves relative evidence paths.
sourceraw docstring

configclj

(config)
(config opts)

Normalize engine configuration.

Accepts the same generic keys used by the engine, including :runs-dir, :models, :max-turns, :max-fanout, :max-leaf-concurrency, :call-timeout-ms, :retry, and provider-specific test hooks such as :scripted/responses or :scripted/response-fn.

Normalize engine configuration.

Accepts the same generic keys used by the engine, including `:runs-dir`,
`:models`, `:max-turns`, `:max-fanout`, `:max-leaf-concurrency`,
`:call-timeout-ms`, `:retry`, and provider-specific test hooks such as
`:scripted/responses` or `:scripted/response-fn`.
sourceraw docstring

extract-claimsclj

(extract-claims final)

Extract evidenced claims from a final value.

Extract evidenced claims from a final value.
sourceraw docstring

fork-session!clj

(fork-session! cfg source-dir target-dir)
(fork-session! cfg source-dir target-dir opts)

Fork a session from source-dir into target-dir and return a live handle.

opts may include :turn.

Fork a session from `source-dir` into `target-dir` and return a live handle.

`opts` may include `:turn`.
sourceraw docstring

journal-eventsclj

(journal-events dir)

Return the raw append-only journal events for a run directory.

Return the raw append-only journal events for a run directory.
sourceraw docstring

load-atclj

(load-at root-dir address)

Load the node at address within a root run directory.

Load the node at `address` within a root run directory.
sourceraw docstring

load-nodeclj

(load-node dir)
(load-node dir address)

Load one node from a run directory. Defaults to the root node.

Load one node from a run directory. Defaults to the root node.
sourceraw docstring

node-dirclj

(node-dir root-dir address)

Resolve a node address to its on-disk directory, starting at root-dir.

Resolve a node address to its on-disk directory, starting at `root-dir`.
sourceraw docstring

node-provenanceclj

(node-provenance root-dir address)

Return the final value, claims, child refs, and leaf refs for a node address.

Return the final value, claims, child refs, and leaf refs for a node address.
sourceraw docstring

provider-descriptorclj

(provider-descriptor provider-id)

Return the generic provider descriptor for provider-id.

Return the generic provider descriptor for `provider-id`.
sourceraw docstring

resume-session!clj

(resume-session! cfg source-dir)
(resume-session! cfg source-dir opts)

Restore a session from source-dir and return a live session handle.

opts may include :turn, :id, or :dir.

Restore a session from `source-dir` and return a live session handle.

`opts` may include `:turn`, `:id`, or `:dir`.
sourceraw docstring

run-task!clj

(run-task! task)
(run-task! cfg task)
(run-task! cfg task opts)

One-shot helper: start a session, run one task, stop the session, and return the turn result map.

opts is passed to start-session!, so callers can set :id, :dir, and :overlay.

One-shot helper: start a session, run one task, stop the session, and return
the turn result map.

`opts` is passed to `start-session!`, so callers can set `:id`, `:dir`, and
`:overlay`.
sourceraw docstring

run-turn!clj

(run-turn! session user-message)

Run one user message on a live session handle. Returns the turn result map.

Run one user message on a live session handle. Returns the turn result map.
sourceraw docstring

start-session!clj

(start-session! cfg)
(start-session! cfg opts)

Start a fresh live session and return a session handle.

opts may include:

  • :id stable session id
  • :dir explicit run directory
  • :overlay extra session-level system instructions appended to the base behavior prompt in the single system message

The overlay specializes the session transcript; it does not add model-facing functions or change engine behavior.

Start a fresh live session and return a session handle.

`opts` may include:
- `:id` stable session id
- `:dir` explicit run directory
- `:overlay` extra session-level system instructions appended to the base
  behavior prompt in the single system message

The overlay specializes the session transcript; it does not add model-facing
functions or change engine behavior.
sourceraw docstring

stop-session!clj

(stop-session! session)

Mark a live session stopped and flush the session artifacts.

Mark a live session stopped and flush the session artifacts.
sourceraw docstring

summarize-claimsclj

(summarize-claims checks)

Summarize claim check verdicts into totals and an overall trust call.

Summarize claim check verdicts into totals and an overall trust call.
sourceraw docstring

treeclj

(tree dir)
(tree dir address label)

Load the full addressable summary tree for a run directory.

Load the full addressable summary tree for a run directory.
sourceraw docstring

viewclj

(view dir)

Fold a run directory's journal into the materialized view. Pure read; no provider calls.

Fold a run directory's journal into the materialized view. Pure read; no
provider calls.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close