Welcome to VXDF’s documentation!

Vector Xchange Data Format (VXDF) makes it easy to store, compress, and retrieve large collections of vector-indexed text.

Installation

pip install vxdf

Convert a PDF to VXDF via CLI:

python -m vxdf convert my.pdf my.vxdf

Or from Python:

from vxdf.ingest import convert
convert("my.pdf", "my.vxdf")

Note

If this is your first time using an OpenAI model, the CLI will prompt you for an API key and store it in ~/.vxdf/config.toml.

Package Reference