Skip to main content

quiver-client

The Python client for Quiver, the security-first vector database. Embeddings are produced by the caller — Quiver is model-agnostic.

Install

uv add quiver-client        # or: pip install quiver-client

Usage

from quiver import Client, Point

# Connect (use https:// and the api_key your server requires).
with Client("http://127.0.0.1:6333", api_key="your-api-key") as q:
    q.create_collection("items", dim=3, metric="cosine")

    q.upsert("items", [
        Point("a", [0.1, 0.2, 0.3], {"color": "red"}),
        Point("b", [0.9, 0.1, 0.0], {"color": "blue"}),
    ])

    hits = q.search(
        "items",
        [0.1, 0.2, 0.25],
        k=5,
        filter={"eq": {"field": "color", "value": "red"}},
    )
    for hit in hits:
        print(hit.id, hit.score, hit.payload)

create_collection also takes index (hnsw | vamana | disk_vamana | ivf) and pq_subspaces to select the memory-frugal disk-resident path.

For late-interaction (ColBERT) retrieval, create a collection with multivector=True, index documents as token sets with upsert_documents, and rank them by MaxSim with search_multi_vector:

q.create_collection("papers", dim=128, metric="cosine", multivector=True)
q.upsert_documents("papers", [Document("p1", token_vectors, {"title": "…"})])
hits = q.search_multi_vector("papers", query_token_vectors, k=10)

Client-side payload encryption

Seal payload fields with a key Quiver never sees (install quiver-client[encryption]). The server stores and returns ciphertext it cannot read; keep fields server-filterable by leaving them in cleartext:

from quiver import Client, Point
from quiver.encryption import PayloadCipher

cipher = PayloadCipher.from_hex("…64 hex chars…")   # a dedicated key, never the at-rest one
with Client("http://127.0.0.1:6333", api_key="…") as q:
    payload = {"tier": "gold", **cipher.seal({"ssn": "078-05-1120"})}  # tier stays filterable
    q.upsert("people", [Point("p1", [0.1, 0.2, 0.3], payload)])
    hit = q.get("people", "p1")
    secret = cipher.open(hit.payload)               # -> {"ssn": "078-05-1120"}

The envelope (XChaCha20-Poly1305) matches the Rust reference and the TypeScript SDK byte-for-byte — see client-side encryption.

Encrypted vector search (DCPE, experimental)

Encrypt the vectors themselves so the server can run nearest-neighbour search without ever seeing the plaintext embeddings (install quiver-client[dcpe]). This is property-preserving (distance-comparison- preserving) encryption — experimental, L2-only, and not semantically secure: it leaks the approximate distance-comparison relation by design. Use a dedicated key, and encrypt both the data and the queries with the same cipher.

from quiver import Client
from quiver.dcpe import DcpeCipher

cipher = DcpeCipher.from_hex("…64 hex chars…", approximation_factor=0.02)
with Client("http://127.0.0.1:6333", api_key="…") as q:
    q.create_collection("vault", dim=8, metric="l2", vector_encryption="dcpe")
    sealed = cipher.encrypt([0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8])
    q.upsert("vault", [{"id": "a", "vector": sealed.ciphertext}])
    hits = q.search("vault", cipher.encrypt_query(my_query), k=10)

See ADR-0031 and docs/security/dcpe.md.

LangChain

A LangChain VectorStore adapter ships in quiver.langchain (install quiver-client[langchain]):

from quiver import Client
from quiver.langchain import QuiverVectorStore

store = QuiverVectorStore.from_texts(
    texts, embedding, client=Client(api_key="…"),
    collection="docs", index="disk_vamana", pq_subspaces=48,
)
docs = store.similarity_search("query", k=4)

Development

uv sync            # create the venv and install dependencies
uv run pytest      # run the test suite (HTTP mocked with respx)

License

AGPL-3.0-only.

Download files

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

Source Distribution

quiver_client-1.0.0.tar.gz (307.0 kB view details)

Uploaded Source

Built Distribution

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

quiver_client-1.0.0-py3-none-any.whl (35.2 kB view details)

Uploaded Python 3

File details

Details for the file quiver_client-1.0.0.tar.gz.

File metadata

  • Download URL: quiver_client-1.0.0.tar.gz
  • Upload date:
  • Size: 307.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","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 quiver_client-1.0.0.tar.gz
Algorithm Hash digest
SHA256 00c779ff9f949c05d1a3f2857ae99502ff0549325e3b56bddc4b0a2313b0f7f8
MD5 ca1b8e162c44047ca5b7c16eab5fd148
BLAKE2b-256 562e846d0e4f68eea4aebd613695dd50cebb7c5c53c4169778615824b43f7afb

See more details on using hashes here.

File details

Details for the file quiver_client-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: quiver_client-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 35.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","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 quiver_client-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8920ab6322365ea043a9194af04642b86550b077eab3a3499b32fd467c8926f5
MD5 eb5334cd68b512af2fbc7769db832350
BLAKE2b-256 0bad52e7b25cba918869a18bf7d29aa52946a143c6fd7aa9a301d311bd2f4e3c

See more details on using hashes here.

Release history Release notifications | RSS feed

1.1.0

2 files

This release

1.0.0 This release

2 files

0.38.0

2 files

0.37.0

2 files

0.36.0

2 files

0.35.0

2 files

0.34.0

2 files

0.33.0

2 files

0.32.0

2 files

0.31.0

2 files

0.30.2

2 files

0.30.1

2 files

0.30.0

2 files

0.29.1

2 files

0.29.0

2 files

0.28.0

2 files

0.27.0

2 files

0.26.0

2 files

0.25.0

2 files

0.24.0

2 files

0.23.0

2 files

0.22.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page