Skip to content

API Reference

This section contains the auto-generated API reference for the OpenJarvis Python package. Documentation is extracted directly from the source code docstrings using mkdocstrings.

Each page documents a major module of the framework, including abstract base classes, concrete implementations, and utility functions.

Modules

Module Description
SDK High-level Jarvis class and MemoryHandle proxy
Core Registries, types, configuration, and event bus
Engine Inference engine ABC and backends (Ollama, vLLM, llama.cpp, SGLang, Cloud)
Agents Agent ABC and implementations (Simple, Orchestrator, OpenClaw, Custom)
Memory Memory backend ABC and implementations (SQLite, FAISS, ColBERT, BM25, Hybrid)
Tools Tool ABC, executor, and built-in tools (Calculator, Think, Retrieval, LLM, FileRead)
Intelligence Heuristic router and model catalog
Learning Router policies, reward functions, and trace-driven learning
Traces Trace storage, collection, and analysis
Telemetry Telemetry storage, aggregation, and instrumented wrappers
Benchmarks Benchmark ABC, suite runner, latency and throughput benchmarks
Evals Evaluation framework: backends, dataset providers, scorers, and suite runner
Server FastAPI application, OpenAI-compatible routes, and Pydantic models