Skip to main content

Swarmauri Logo

PyPI - Python Version PyPI - License PyPI - swarmauri_vectorstore_fs


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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

swarmauri_vectorstore_fs-0.1.0.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

swarmauri_vectorstore_fs-0.1.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file swarmauri_vectorstore_fs-0.1.0.tar.gz.

File metadata

  • Download URL: swarmauri_vectorstore_fs-0.1.0.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for swarmauri_vectorstore_fs-0.1.0.tar.gz
Algorithm Hash digest
SHA256 05c4c485a5d70e85251dc6c6ac5be1b9c8d2de0121f590dcbb85a32fd83d5955
MD5 c80eca2992529e69e81d40b747823f67
BLAKE2b-256 59b8a1699f58d70a52e684fd0c99bba5385419dfd2c366b02b3035d34a9cd55d

See more details on using hashes here.

File details

Details for the file swarmauri_vectorstore_fs-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: swarmauri_vectorstore_fs-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for swarmauri_vectorstore_fs-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3f60c6b294a38fad6547975360bcefb95deced177d75b79daf7d14843500fcc3
MD5 fe44fea60ebee3c3a4ec7a592a3e7730
BLAKE2b-256 ec2526811c1071ebc974c314460fc50a562556ea26a08502e679f8ad3ecb4c96

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page