Skip to main content

Module types

Module types 

Source
Expand description

Domain types shared across the crate: document representations, CLI arguments, search results, and provider enums.

Structs§

AttachedDocument
An externally attached document — parsed text injected into the RAG prompt alongside (or instead of) vector store results. Not added to chat memory.
ChatConfig
Chat / generation configuration.
ChunkConfig
Configuration for text chunking — size and overlap in tokens.
ChunkMeta
Positional metadata attached to every chunk for source citation.
DocumentChunk
A single text chunk from a document, tagged with its source file and optional positional metadata.
EmbedConfig
Embedding / retrieval configuration.
FileHashEntry
Metadata for a document file: filename + SHA-256 hash.
GenerationParams
Model generation parameters shared across all providers.
IndexManifest
Reproducibility manifest recorded alongside the vector index.
MemoryConfig
Memory / query-rewrite configuration.
PaperResult
A paper result from academic search APIs (Semantic Scholar, arXiv).
ParseConfig
Document parsing and chunking configuration.
RagrigConfig
Top-level configuration for a ragrig session.
RankScore
Ranker-agnostic score produced by hybrid search.
SourceFile
A document source filename, used consistently across the pipeline.

Enums§

ContextSizeMode
Controls how context-size overflow is handled.
DocumentType
A document file on disk, tagged with its format and path.
EmbeddingProvider
Embedding backend: local Ollama or CPU-only Fastembed.
EpubParserBackend
EPUB parser backend.
PdfParserBackend
PDF parser backend.
Provider
Chat backend: local Ollama or cloud DeepSeek. Chat generation provider.