Skip to main content

SDK Python para RustKissVDB (state, vector, docstore, sql y stream).

Project description

RAG-client-py

SDK Python oficial para RustKissVDB + ejemplos de referencia (chat RAG + ingestión de PDF).

Instalación

uv pip install -e .
# o
pip install -e .

Extras para las demos (PyMuPDF):

pip install -e .[rag]

Configuración

Copia .env.example.env y ajusta:

RUSTKISS_URL=http://127.0.0.1:9917
RUSTKISS_API_KEY=dev
VDB_COLLECTION=docs_demo
OLLAMA_BASE_URL=http://localhost:11434
OLLAMA_EMBED_MODEL=embeddinggemma:300m
OLLAMA_CHAT_MODEL=gemma3:4b

El SDK también expone Config.from_env() para cargar estas variables automáticamente.

Uso básico

from rustkissvdb import Client, Config

cfg = Config.from_env()
with Client(cfg.base_url, api_key=cfg.api_key, timeout=cfg.timeout) as client:
    client.state.put("foo", {"value": 1})
    hits = client.vector.search("docs", [0.1, 0.2], k=3, include_meta=True)
    client.doc.put("tickets", "tk_1", {"title": "Bug"})
    client.sql.execute("CREATE TABLE IF NOT EXISTS notes(id INTEGER PRIMARY KEY, body TEXT)")

Ejemplos

  • examples/chat_rag_pdf.py: CLI de chat que almacena memoria en RustKissVDB y usa Ollama para embeddings/chat.
  • examples/ingest_pdf_to_vdb.py: chunk + embed de un PDF y lo sube a la colección vectorial.

Ambos se apoyan en el SDK (rustkissvdb.Client) y usan las variables .env.

Scripts legacy

Los scripts originales fueron migrados a examples/. El paquete exporta:

  • Client (client.state, client.vector, client.doc, client.sql, client.stream)
  • Config (Config.from_env())
  • RustKissVDBError

Consulta docs/SDK_PYTHON.md para más detalles.

Project details


Download files

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

Source Distribution

rustkissvdb-0.1.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

rustkissvdb-0.1.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rustkissvdb-0.1.0.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for rustkissvdb-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d85b11d6aed8a076eab8b4d4c28c2a22ef8aa08e9a2dd623be7ab4925a1340cf
MD5 d1dde29728fc8af3b43c2eaefd9611cf
BLAKE2b-256 09bbe97a3990e57c3c3aa7aa26b6509cf9d38e50722277dba3acee09ea81dd78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rustkissvdb-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for rustkissvdb-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b26be83847a749d290988fb98b3734699bf704f16051180dd68de3a43301be82
MD5 b02479af6904ba2d64978c3ff1891a66
BLAKE2b-256 9440e38319a40e15b30d48c88ad2ea594c54f93cec4102171ba672c8c11cd3fb

See more details on using hashes here.

Supported by

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