Package: VectrixDB 1.1.2

Kwadwo Daddy Nyame Owusu Boakye

VectrixDB: Lightweight Vector Database with Embedded Machine Learning Models

A lightweight vector database for text retrieval in R with embedded machine learning models and no external API (Application Programming Interface) keys. Supports dense and hybrid search, optional HNSW (Hierarchical Navigable Small World) approximate nearest-neighbor indexing, faceted filters with ACL (Access Control List) metadata, command-line tools, and a local dashboard built with 'shiny'. The HNSW method is described by Malkov and Yashunin (2018) <doi:10.1109/TPAMI.2018.2889473>.

Authors:Kwadwo Daddy Nyame Owusu Boakye [aut, cre]

VectrixDB_1.1.2.tar.gz
VectrixDB_1.1.2.zip(r-4.7)VectrixDB_1.1.2.zip(r-4.6)VectrixDB_1.1.2.zip(r-4.5)
VectrixDB_1.1.2.tgz(r-4.6-any)VectrixDB_1.1.2.tgz(r-4.5-any)
VectrixDB_1.1.2.tar.gz(r-4.7-any)VectrixDB_1.1.2.tar.gz(r-4.6-any)
VectrixDB_1.1.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
VectrixDB/json (API)

# Install 'VectrixDB' in R:

install.packages('VectrixDB', repos = c('https://knowusuboaky.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/knowusuboaky/vectrixdb-r/issues

Pkgdown/docs site:https://knowusuboaky.github.io

On CRAN:

3.00 score 5 scripts 167 downloads 98 exports 33 dependencies

Last updated from:574f3a48e1. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	203
source / vignettes	OK	206
linux-release-x86_64	OK	177
macos-release-arm64	OK	123
macos-oldrel-arm64	OK	133
windows-devel	OK	169
windows-release	OK	167
windows-oldrel	OK	139
wasm-release	OK	152

Exports:acl_config_from_list ACLConfig ACLFilter ACLOperator ACLPrincipal AdvancedReranker AnalyzerChain BaseCache cache_config_from_env CacheBackend CacheConfig CacheEntry CacheStats CLIConfig Collection Community CommunityDetector create_cache create_default_graphrag_config create_hnsw_index create_pipeline create_sentence_embedder create_vector_cache DenseEmbedder DistanceMetric DocumentChunker download_vectors download_word_vectors ENGLISH_STOPWORDS EnhancedSearchResults Entity ExtractionResult ExtractorType FacetAggregator FacetConfig FacetResult FacetValue FileCache Filter GlobalSearcher GlobalSearchResult GraphRAGConfig GraphRAGPipeline GraphSearchType HNSWIndex KeywordAnalyzer KnowledgeGraph LateInteractionEmbedder LLMProvider load_hnsw_index load_word_vectors LocalSearcher LocalSearchResult MemoryCache MMRReranker NoCache parse_acl quick_search RegexExtractor Relationship RerankerEmbedder Result Results SearchMode SentenceEmbedder set_cli_config SimpleStemmer SparseEmbedder SubGraph text_analyzer_english text_analyzer_keyword text_analyzer_simple text_analyzer_standard TextAnalyzer TextUnit vdb_add vdb_add_dir vdb_create vdb_dashboard vdb_dashboard_simple vdb_delete vdb_delete_docs vdb_export vdb_get vdb_import vdb_info vdb_interactive vdb_list vdb_open vdb_search vdb_stats VectorCache Vectrix vectrix_create vectrix_info vectrix_open vectrix_serve VectrixDB

Dependencies:bit bit64 blob cachem cli cpp11 data.table DBI digest fastmap float glue ISOcodes jsonlite lattice lgr lifecycle Matrix MatrixExtra memoise mlapi pkgconfig R6 Rcpp RcppArmadillo RhpcBLASctl rlang rsparse RSQLite stopwords stringi text2vec vctrs

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Create ACL Config from List	acl_config_from_list
ACL Configuration	ACLConfig
ACL Filter	ACLFilter
ACL Operator Types	ACLOperator
ACL Principal	ACLPrincipal
VectrixDB Advanced Search Features	advanced_search
Advanced Reranker with Learned Weights	AdvancedReranker
Analyzer Chain	AnalyzerChain
Base Cache	BaseCache
VectrixDB Cache Layer	cache
Create Cache Config from Environment	cache_config_from_env
Cache Backend Types	CacheBackend
Cache Configuration	CacheConfig
Cache Entry	CacheEntry
Cache Statistics	CacheStats
VectrixDB Command Line Interface	cli
CLI Configuration	CLIConfig
Collection Class	Collection
Community	Community
Simple Community Detector	CommunityDetector
Create Cache	create_cache
Create Default GraphRAG Config	create_default_graphrag_config
Create HNSW Index	create_hnsw_index
Create GraphRAG Pipeline	create_pipeline
Create a sentence embedder with automatic download	create_sentence_embedder
Create Vector Cache	create_vector_cache
Dense Embedder using word2vec or GloVe	DenseEmbedder
Distance Metric Enumeration	DistanceMetric
Document Chunker	DocumentChunker
Download pre-trained word vectors	download_vectors
Download pre-trained word vectors	download_word_vectors
VectrixDB Embedders (Pure R Implementation)	embedders
English Stopwords	ENGLISH_STOPWORDS
Enhanced Search Results	EnhancedSearchResults
Entity	Entity
Extraction Result	ExtractionResult
Extractor Types	ExtractorType
Facet Aggregator	FacetAggregator
Facet Configuration	FacetConfig
Facet Result	FacetResult
Facet Value	FacetValue
File Cache	FileCache
Filter Class for Metadata Filtering	Filter
Global Searcher	GlobalSearcher
Global Search Result	GlobalSearchResult
VectrixDB GraphRAG Module	graphrag
GraphRAG Configuration	GraphRAGConfig
GraphRAG Pipeline	GraphRAGPipeline
Graph Search Types	GraphSearchType
VectrixDB HNSW Index	hnsw
HNSW Index	HNSWIndex
Keyword Analyzer	KeywordAnalyzer
Knowledge Graph	KnowledgeGraph
Late Interaction Embedder (Simplified ColBERT-style)	LateInteractionEmbedder
LLM Provider Types	LLMProvider
Load HNSW Index	load_hnsw_index
Load word vectors into memory	load_word_vectors
Local Searcher	LocalSearcher
Local Search Result	LocalSearchResult
Memory Cache	MemoryCache
Maximal Marginal Relevance (MMR) Reranker	MMRReranker
No-Op Cache	NoCache
Parse ACL String	parse_acl
Quick search - Index texts and search immediately	quick_search
Regex Entity Extractor	RegexExtractor
Relationship	Relationship
Advanced Reranking Module	reranker
Reranker (Cross-Encoder Style Scoring)	RerankerEmbedder
Single Search Result	Result
Search Results Collection	Results
Search Mode Enumeration	SearchMode
Sentence Embedder using Word Vectors	SentenceEmbedder
VectrixDB Server Functions	server
Set CLI Config	set_cli_config
Simple Stemmer	SimpleStemmer
Sparse Embedder (BM25/TF-IDF)	SparseEmbedder
VectrixDB Storage Classes	storage
SubGraph	SubGraph
Create English Text Analyzer	text_analyzer_english
Create Keyword Text Analyzer	text_analyzer_keyword
Create Simple Text Analyzer	text_analyzer_simple
Create Standard Text Analyzer	text_analyzer_standard
Text Analyzer	TextAnalyzer
Text Unit	TextUnit
Add Documents	vdb_add
Batch Add from Directory	vdb_add_dir
Create Collection	vdb_create
Launch VectrixDB Dashboard	vdb_dashboard
Launch Simple Dashboard	vdb_dashboard_simple
Delete Collection	vdb_delete
Delete Documents	vdb_delete_docs
Export Collection	vdb_export
Get Document	vdb_get
Import from File	vdb_import
Collection Info	vdb_info
Start Interactive CLI	vdb_interactive
List Collections	vdb_list
Open Collection	vdb_open
Search Collection	vdb_search
Collection Statistics	vdb_stats
Vector Cache	VectorCache
VectrixDB Easy API - The Simplest Vector Database	Vectrix
Create a new Vectrix collection	vectrix_create
Display VectrixDB information	vectrix_info
Open an existing Vectrix collection	vectrix_open
Start VectrixDB server	vectrix_serve
VectrixDB Database Class	VectrixDB vectrixdb
Word Vector Management	word_vectors