Module types

Module types

Expand description

Core types for RAGFS.

This module contains all shared data structures used across RAGFS:

§File Management

FileRecord: Metadata about an indexed file
FileStatus: Current indexing state of a file
FileEvent: File system events for the watcher

§Content Chunks

Chunk: A segment of content with its embedding
ContentType: Type classification for chunk content
ChunkConfig: Configuration for chunking behavior

§Extraction

ExtractedContent: Content extracted from a file
ContentElement: Structural elements (headings, paragraphs, etc.)

§Embeddings

Modality: Supported embedding modalities (text, image, audio)
EmbeddingConfig: Configuration for embedding generation
EmbeddingOutput: Result of embedding a text

§Search

SearchQuery: Parameters for a vector search
SearchResult: A matching chunk with similarity score
SearchFilter: Filters to narrow search results
DistanceMetric: Vector distance calculation method

Structs§

Chunk: A chunk of content from a file.
ChunkConfig: Configuration for chunking.
ChunkMetadata: Metadata associated with a chunk.
ChunkOutput: Output from a chunker.
ChunkOutputMetadata: Metadata for chunk output.
CodeSymbol: Code symbol information.
ContentMetadataInfo: Metadata extracted from file content.
EmbeddingConfig: Configuration for embedding.
EmbeddingOutput: Output from embedding.
ExtractedContent: Content extracted from a file.
ExtractedImage: An image extracted from a document.
FileRecord: Metadata about an indexed file.
IndexStats: Overall index statistics.
SearchQuery: A search query.
SearchResult: A search result.
StoreStats: Vector store statistics.

Enums§

ContentElement: A structural element in extracted content.
ContentType: Type of chunk content.
DistanceMetric: Distance metric for vector search.
FileEvent: File system event for indexing.
FileStatus: File indexing status.
Modality: Supported modalities for embedding.
SearchFilter: Search filters.
SymbolKind: Types of code symbols.