Skip to main content

bicardinal - multimodal retrieval engine

License PyPI version

bicardinal

Multimodal retrieval engine. Drop in PDFs, Word docs, images, audio, or plain text, bicardinal extracts, summarizes, embeds, and indexes them so you can search across everything with one call.

Install

pip install bicardinal

Set your provider keys (used for OCR, vision, transcription, and summaries):

export OPENAI_API_KEY=sk-...
export MISTRAL_API_KEY=...

Deadly simple

from pathlib import Path
from bicardinal import Bicardinal

store = Bicardinal("./data")          # a home for your collections
col = store.create("docs")            # make a collection
col.init("build")                     # open it for ingestion

# Throw any file at it, pdf, docx, png, mp3, txt...
for path in Path("./my_files").glob("*"):
    col.ingest(path.name, path.read_bytes())

col.finalize() # build the index

# Search across everything
for hit in col.search("quarterly revenue growth", k=5):
    print(f"{hit.score:.3f}  {hit.filename}#{hit.chunk_index}  {hit.raw_text[:80]}")

col.close()

That's it. No pipelines to wire, no embedding code to write.

A little more

# Rank whole files by relevance
for f in col.most_similar_files("budget forecast", k=3):
    print(f.score, f.filename)

# Search within a single document
col.search_in_file("conclusion", "report.pdf", k=5)

# Reopen later, it's all on disk
col = store.open("docs")

See examples/quickstart.py for a fuller tour.

License

Apache-2.0

Download files

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

Source Distribution

bicardinal-0.0.6.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

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

bicardinal-0.0.6-py3-none-any.whl (777.9 kB view details)

Uploaded Python 3

File details

Details for the file bicardinal-0.0.6.tar.gz.

File metadata

  • Download URL: bicardinal-0.0.6.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for bicardinal-0.0.6.tar.gz
Algorithm Hash digest
SHA256 6cc94bc1502fd58707513cd993e159cfdd3f5102f7edbb842a6f8953ccd918eb
MD5 a002a4d0d5ccc1432490b4eb1468573b
BLAKE2b-256 ae47c9a0cd36bf9bfd70bdea1c7c70bf2a47f75f4703c4df6f300fbed2a970aa

See more details on using hashes here.

File details

Details for the file bicardinal-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: bicardinal-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 777.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for bicardinal-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7e93069c5add1a5f30ca025e9241bb8dcac708794983c654a29cd72c0ad58cb9
MD5 cff6d14b4c88d080f33a6228bfbe0596
BLAKE2b-256 83b959c21e977f92945686bd1b441992822221e7bd215581fbf4d9e2b22c4d50

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.0.6 This release

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

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