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 invokefrom 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:
jaz.hooks— theHookprimitive and the built-in hooks (ReturnType,PrintLogger,BudgetPool,IterationLimit, …), plus thejaz.hooks.eventsandjaz.hooks.effectsvocabularies a handler receives and returns.jaz.repl— the REPL component: the baseBaseREPLand defaultPythonREPL, plus the execution-result taxonomy (ExecResultand its members).jaz.llm— the LLM-backend component: the baseBaseLLM, theLLMResponseit returns, the three shipped backends (LiteLLMby default, plusGitHubCopilotLLMandSGLangLLM), and the chat-format seam.jaz.protocol— the interaction-protocol component: the baseBaseProtocoland defaultCodeOnlyProtocol.jaz.exceptions— the exception taxonomy every JAZ failure belongs to.
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
Core (jaz)
Section titled “Core (jaz)”jaz—invoke,ainvoke,configure,ConfigOverride,get_config,Config,UNSET,UnsetType,scope,add_template_loader
Extension APIs (public submodules)
Section titled “Extension APIs (public submodules)”jaz.hooks—Hook,TrajectoryRecorder,TrajectoryDirectoryRecorder,TrajectoryReplay,BudgetForcing,BudgetPool,ContextWindowWarning,IterationLimit,RecursionLimit,PrintLogger,FileLogger,ReturnType,RolloutRecorder,Rollout,Sample,ValidateReturn,ValidateREPLCode,OTelTracing,JaegerTracing,LangfuseTracingjaz.hooks.events—Event,Completed,Aborted,Failed,LLMQueryOutcome,REPLExecOutcome,InvokeOutcome,REPLExecEnter,REPLExecSend,ResolvedCodeEdits,ResolvedNamespaceEdits,CodeInsertRecord,CodeDeleteRecord,NamespaceAddRecord,NamespaceDropRecord,REPLExecComplete,REPLExecExit,LLMQueryEnter,LLMQuerySend,LLMQueryComplete,LLMQueryExit,ResolvedMessageEdits,MessageDropRecord,MessageAddRecord,InvokeEnter,InvokeSend,ResolvedInputEdits,InputAddRecord,InputDropRecord,InvokeComplete,InvokeExit,LLMQueryRetryjaz.hooks.effects—Effect,SupplyExecResult,ModifyExecResult,ModifyInvokeResult,SupplyInvokeResult,Abort,BlackboardWrite,DisableRecursion,WithholdREPLHistory,AddInputs,DropInputs,AddToNamespace,DropFromNamespace,InsertCode,DeleteCode,DropMessages,AddMessages,SupplyLLMResponse,ModifyLLMResponse
jaz.repl—BaseREPL,PythonREPL,PythonREPLState,TracebackVerbosity,REPLHistoryEntry,ExecResult,Continue,Return,Raise,TerminalExecResultjaz.llm—BaseLLM,ChatFormat,GitHubCopilotLLM,HFChatFormat,LLMResponse,LiteLLM,MockLLM,ModelInfo,RetryPolicy,SGLangLLM,TokenStamp,TurnRecordjaz.protocol—BaseProtocol,CodeOnlyProtocoljaz.exceptions—JazException,FatalError,UnknownRequestParamWarning,ReturnTypeError,FileAccessDeniedError,BudgetExhaustedError,IterationLimitExhaustedError,BudgetPoolExhaustedError,RecursionLimitError,InputRenderError,BudgetForcingError,REPLInputConflictError,REPLTimeoutPragmaError,KeyEditDeniedError,InvalidEffectError,LLMResponseConflictError,ReturnValueConflictError,BlackboardSeedConflictError,BlackboardWriteConflictError,HookActivationError,ModelPricingUnavailableError,ConfigOverrideActivationError,CodeEditOffsetError,MessageEditIndexError,MissingDropTargetError,LLMError,RateLimitError,QuotaExceededError,AuthenticationError,NotFoundError,PermissionDeniedError,BadRequestError,UnsupportedParamsError,ContextWindowExceededError,ContentPolicyViolationError,ServerError,InternalServerError,OverloadedError,APIResponseValidationError,APIConnectionError,APITimeoutError,RequestAbortedError,is_fataljaz.credentials—API_KEY_FIELD,credentials_path,load_credentials,resolve_credential