API reference

This section is generated from the source docstrings. It documents the public surface — the objects you import and call directly. For the why behind them, read the Concepts; for task recipes, the Guides.

The surface is small and layered:

  • FoodScholar — the facade. One object that owns the stores, the ontology, the LLM, and every build phase (ingest, build_layer_a, …). Almost everything you do starts here.

  • Configuration — the FoodScholarConfig model and its sections, with every field, type, and default.

  • Data model — the Pydantic contracts that flow through the pipeline: Chunk, Mention, EntityLink, Shelf, Theme, Card, Entity.

  • Graph viewfs.graph, the fluent read/write surface and its navigation handles.

  • Ontologyfs.ontology, the FoodOn lookup API.

  • Visualizationfs.viz, the renderable graph views.

  • Storage protocols — the interfaces every store backend implements.