API Overview

On this page

This section documents every public class, function, dataclass, and enum exported (directly or transitively importable) from the core package, grouped by module.

Public symbols exported from core

Plus, imported best-effort (see Architecture → Package Initialization):

Python · 2 lines
RAGEvaluator, EvalSample, EvalResult, EvalReport, MetricScore          # from evaluation.py
DocumentVersionManager, DocVersion, ContentDiff                        # from document_versioning.py

core.exceptions and core.logger are not re-exported at the top level but are public modules intended for direct import (from core.exceptions import ..., from core.logger import ...).

Module summary table

ModulePublic classesPublic functionsPublic enums
rag_systemRAGSystem, LoadedDocument——
base_rag_systemBaseRAGSystem——
rag_configRAGConfig, RerankerConfig—RerankMode
rerankerReranker——
prompt_routerPromptRouter—QuestionType
query_expansionQueryExpandermerge_retrieval_results—
retrieval_cacheRetrievalCache——
evaluationRAGEvaluator, EvalSample, EvalResult, EvalReport, MetricScore——
document_versioningDocumentVersionManager, DocVersion, ContentDiff——
exceptionsFennecError + 29 subclasses——
loggerFennecLoggersetup_logging, get_logger—

Class hierarchy at a glance

Searchable API index

SymbolKindModule
RAGSystemclassrag_system
LoadedDocumentdataclassrag_system
BaseRAGSystemabstract classbase_rag_system
RAGConfigdataclassrag_config
RerankerConfigdataclassrag_config
RerankModeenumrag_config
Rerankerclassreranker
PromptRouterclassprompt_router
QuestionTypeenumprompt_router
QueryExpanderclassquery_expansion
merge_retrieval_resultsfunctionquery_expansion
RetrievalCacheclassretrieval_cache
RAGEvaluatorclassevaluation
EvalSampledataclassevaluation
EvalResultdataclassevaluation
EvalReportdataclassevaluation
MetricScoredataclassevaluation
DocumentVersionManagerclassdocument_versioning
DocVersiondataclassdocument_versioning
ContentDiffdataclassdocument_versioning
setup_loggingfunctionlogger
get_loggerfunctionlogger

Related pages