Swarmauri Vectorstore FS

A Swarmauri community vector store that indexes filesystem trees for BM25F retrieval over file paths, file names, extensions, chunk identity, and file content.

Features

• Filesystem-aware retrieval with weighted BM25F fields
• Chunk, file, and chunk-plus-file indexing modes
• Stable chunk identity metadata for global, path-level, and file-level chunk numbering
• CLI for ad hoc lexical search over source trees and document corpora
• No embedding vocabulary dependency for query handling

Installation

pip install swarmauri_vectorstore_fs

Usage

from swarmauri_vectorstore_fs import FsVectorStore

store = FsVectorStore(root_path=".", mode="chunk")
store.build_index()
results = store.retrieve("vector store registration", top_k=3)

for document in results:
    print(document.id, document.metadata["relative_path"])

CLI

fsvs --root . query --query "vector store registration" --top-k 5

To inspect a specific retrieved document:

fsvs --root . show --document-id <document-id>

Want to help?

If you want to contribute to swarmauri-sdk, read up on our guidelines for contributing.