Skip to content

Module index

New to JAZ? This is generated API reference. Start with the docs and the concepts overview.

An agent runs as a conversation with a Python REPL: the LLM writes code, sees what it evaluated to, and iterates until it finishes with a native return (or raise):

from jaz import invoke
from jaz.hooks import ReturnType
total = invoke(instruction="Return the sum of the numbers", numbers=[1, 2, 3])
num_people: int = invoke(ReturnType(int), question="How many people are there on Earth?")

The v1 public API is exactly __all__ below, in two parts.

Core symbols — reached flat as jaz.<name>:

  • invoke / ainvoke — run an agent on the given inputs and return its result.
  • configure / ConfigOverride / get_config — set the global defaults, override them for a scope or a single call, and read the effective config.
  • scope — bind variables that propagate into sub-invokes.

Public submodules — reached as jaz.<mod>.<name>, not re-exported flat:

Everything outside __all__ lives in a _-prefixed module and is not part of the official public API. It is reachable — Python has no enforcement — but it is internal, and may change or be removed without notice.

Package version: 0.2.0b1