Skip to main content

API Reference Overview

This section documents the public API of each RAG Axis package. Every package follows the same conventions described in Pydantic Usage Boundaries and the invariants checklist: immutable result objects, typed adapters, and explicit error types.

  • Core: the foundational types, including Document, Chunk, RetrievalResult, CostReport, ContextBudget, PipelineResult, and the named error taxonomy.
  • Retrieval: query execution, dense and sparse retrieval, hybrid RRF fusion, and the RetrievalResult type.
  • Synthesis: context assembly, generation, output parsing, and the PipelineResult type.
  • Adapters: the LLMAdapter, EmbedderAdapter, and VectorStoreAdapter Protocols, plus reference implementations.
  • System: system-layer orchestration, RunResult, telemetry, and evaluation hooks.
  • Server: the REST API exposed by ragaxis.server for deploying RAG Axis as a standalone service.

If a package is not yet listed here, it has not reached the part of the build order described in the project's package build order and does not yet have a stable public API.