Skip to main content

Question answering for local knowledge bases with exact source citations.

Project description

askbase

Question answering for local knowledge bases with exact source citations.

Setup

uv sync

Set these environment variables before indexing or asking questions:

  • ASKBASE_MODEL
  • ASKBASE_MODEL_API_KEY
  • ASKBASE_EMBEDDING_MODEL
  • ASKBASE_EMBEDDING_MODEL_API_KEY
  • ASKBASE_EMBEDDING_BATCH_SIZE

Usage

Build a local SQLite index for a directory:

askbase index -d /path/to/docs

This writes .askbase/askbase.sqlite inside the target directory.

Ask a question against that index:

askbase ask -d /path/to/docs "What does the source say?"

Main Files

  • askbase/cli.py: command-line entry point.
  • askbase/index.py: indexes source files into SQLite.
  • askbase/extract.py: extracts text from Markdown, text, and PDF files.
  • askbase/chunk.py: creates line-preserving chunks.
  • askbase/db.py: stores documents, chunks, FTS rows, and embeddings.
  • askbase/search.py: combines BM25 and embedding retrieval.
  • askbase/answer.py: builds evidence prompts and validates citations.

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

askbase-1.0.0.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

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

askbase-1.0.0-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: askbase-1.0.0.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.11 {"installer":{"name":"uv","version":"0.9.11"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"25.10","id":"questing","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for askbase-1.0.0.tar.gz
Algorithm Hash digest
SHA256 7af0ad977df44d9091dcdca64993011a9d3215af047aa3d6ef86ba3a1228eeb7
MD5 1d0dd6c013968562f41356b5073d05d7
BLAKE2b-256 6e306958ff12bfc131ee147888e9556d8dad163a9a077084012a322bd27b20c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: askbase-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.11 {"installer":{"name":"uv","version":"0.9.11"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"25.10","id":"questing","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for askbase-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 78c53195a1be2076fa16e427ca8334707ddf7559b739daa127ee7771db338b98
MD5 216115a9d7850fcb2c1197e5e3efca74
BLAKE2b-256 6601f7dbc0f258f16f6007b6acf922d32a7a999a3405006c4fb79edd471b43a3

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