# Lightweight Vector Database with Embedded Machine Learning Models

## Documentation for package ‘VectrixDB’ version 1.1.2

- DESCRIPTION file
- Package README

## Help Pages

A B C D E F G H K L M N P Q R S T V W

## -- A --

ACLConfig | ACL Configuration
ACLFilter | ACL Filter
ACLOperator | ACL Operator Types
ACLPrincipal | ACL Principal
acl_config_from_list | Create ACL Config from List
AdvancedReranker | Advanced Reranker with Learned Weights
advanced_search | VectrixDB Advanced Search Features
AnalyzerChain | Analyzer Chain

## -- B --

BaseCache | Base Cache

## -- C --

cache | VectrixDB Cache Layer
CacheBackend | Cache Backend Types
CacheConfig | Cache Configuration
CacheEntry | Cache Entry
CacheStats | Cache Statistics
cache_config_from_env | Create Cache Config from Environment
cli | VectrixDB Command Line Interface
CLIConfig | CLI Configuration
Collection | Collection Class
Community | Community
CommunityDetector | Simple Community Detector
create_cache | Create Cache
create_default_graphrag_config | Create Default GraphRAG Config
create_hnsw_index | Create HNSW Index
create_pipeline | Create GraphRAG Pipeline
create_sentence_embedder | Create a sentence embedder with automatic download
create_vector_cache | Create Vector Cache

## -- D --

DenseEmbedder | Dense Embedder using word2vec or GloVe
DistanceMetric | Distance Metric Enumeration
DocumentChunker | Document Chunker
download_vectors | Download pre-trained word vectors
download_word_vectors | Download pre-trained word vectors

## -- E --

embedders | VectrixDB Embedders (Pure R Implementation)
ENGLISH_STOPWORDS | English Stopwords
EnhancedSearchResults | Enhanced Search Results
Entity | Entity
ExtractionResult | Extraction Result
ExtractorType | Extractor Types

## -- F --

FacetAggregator | Facet Aggregator
FacetConfig | Facet Configuration
FacetResult | Facet Result
FacetValue | Facet Value
FileCache | File Cache
Filter | Filter Class for Metadata Filtering

## -- G --

GlobalSearcher | Global Searcher
GlobalSearchResult | Global Search Result
graphrag | VectrixDB GraphRAG Module
GraphRAGConfig | GraphRAG Configuration
GraphRAGPipeline | GraphRAG Pipeline
GraphSearchType | Graph Search Types

## -- H --

hnsw | VectrixDB HNSW Index
HNSWIndex | HNSW Index

## -- K --

KeywordAnalyzer | Keyword Analyzer
KnowledgeGraph | Knowledge Graph

## -- L --

LateInteractionEmbedder | Late Interaction Embedder (Simplified ColBERT-style)
LLMProvider | LLM Provider Types
load_hnsw_index | Load HNSW Index
load_word_vectors | Load word vectors into memory
LocalSearcher | Local Searcher
LocalSearchResult | Local Search Result

## -- M --

MemoryCache | Memory Cache
MMRReranker | Maximal Marginal Relevance (MMR) Reranker

## -- N --

NoCache | No-Op Cache

## -- P --

parse_acl | Parse ACL String

## -- Q --

quick_search | Quick search - Index texts and search immediately

## -- R --

RegexExtractor | Regex Entity Extractor
Relationship | Relationship
reranker | Advanced Reranking Module
RerankerEmbedder | Reranker (Cross-Encoder Style Scoring)
Result | Single Search Result
Results | Search Results Collection

## -- S --

SearchMode | Search Mode Enumeration
SentenceEmbedder | Sentence Embedder using Word Vectors
server | VectrixDB Server Functions
set_cli_config | Set CLI Config
SimpleStemmer | Simple Stemmer
SparseEmbedder | Sparse Embedder (BM25/TF-IDF)
storage | VectrixDB Storage Classes
SubGraph | SubGraph

## -- T --

TextAnalyzer | Text Analyzer
TextUnit | Text Unit
text_analyzer_english | Create English Text Analyzer
text_analyzer_keyword | Create Keyword Text Analyzer
text_analyzer_simple | Create Simple Text Analyzer
text_analyzer_standard | Create Standard Text Analyzer

## -- V --

vdb_add | Add Documents
vdb_add_dir | Batch Add from Directory
vdb_create | Create Collection
vdb_dashboard | Launch VectrixDB Dashboard
vdb_dashboard_simple | Launch Simple Dashboard
vdb_delete | Delete Collection
vdb_delete_docs | Delete Documents
vdb_export | Export Collection
vdb_get | Get Document
vdb_import | Import from File
vdb_info | Collection Info
vdb_interactive | Start Interactive CLI
vdb_list | List Collections
vdb_open | Open Collection
vdb_search | Search Collection
vdb_stats | Collection Statistics
VectorCache | Vector Cache
Vectrix | VectrixDB Easy API - The Simplest Vector Database
VectrixDB | VectrixDB Database Class
vectrixdb | VectrixDB Database Class
vectrix_create | Create a new Vectrix collection
vectrix_info | Display VectrixDB information
vectrix_open | Open an existing Vectrix collection
vectrix_serve | Start VectrixDB server

## -- W --

word_vectors | Word Vector Management