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.5.tar.gz (1.1 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.5-py3-none-any.whl (770.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bicardinal-0.0.5.tar.gz
  • Upload date:
  • Size: 1.1 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.5.tar.gz
Algorithm Hash digest
SHA256 8e02d83253f761d17abfc9fbd99c60c56cd805c59a29050911e375373865d9e4
MD5 0e54e75b392d07ae270f545629d3e544
BLAKE2b-256 3ef4972281284569704f74b618f8cfb2af1d09438f376319190afb72d2bea817

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bicardinal-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 770.1 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d594143156981088b1acc5f2f265ec31edeaa3f8e25b613cb30ca395d8eb7fbe
MD5 5dad6da395ca8fecb43bf15784fae620
BLAKE2b-256 41e19f04d49521a2661ae9ff04a87be1598e167a16ee4afb3cd805e0a571b8bc

See more details on using hashes here.

Release history Release notifications | RSS feed

0.0.6

2 files

This release

0.0.5 This release

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