API Reference

The public API is organized by module. Every class and function listed here is exported from vector_database/__init__ or is a public method (no leading underscore) on an exported class.

A note on scope for this reference

The source code discovered by static analysis is a single package with four files and one free function, not a multi-package library. To keep this reference navigable, each concrete backend class gets one comprehensive page (constructor, every public method, attributes, lifecycle, examples) rather than one page per method — splitting a 30-method class into 30 one-line files would create more navigation overhead than it removes. The abstract base class and the one module-level function (sanitize_metadata) share a page since they're defined in the same file and used together throughout.

Quick index of every public symbol

base

• sanitize_metadata(metadata) — function

• VectorDatabaseBase — abstract class

  • __init__, add, search, remove_by_doc_id, get_stats, __len__*
  • clear, save, load, get_chunk_by_id, get_chunks_by_doc_id
  • asearch, aadd, aremove_by_doc_id
  • __enter__/__exit__, __aenter__/__aexit__, __repr__

  (* = abstract method, must be implemented by subclasses)

faiss

• FAISSVectorDatabase (extends VectorDatabaseBase)
  • __init__, add_chunk, add, search, search_by_doc_id
  • remove_by_chunk_id, remove_by_doc_id, clear
  • save, load, get_stats, get_chunk_by_id, get_chunks_by_doc_id, list_document_ids
  • __len__, __repr__, __contains__
  • asearch, aadd, aremove_by_doc_id, asave, __aenter__, __aexit__

chroma

• normalize_metadata(metadata) — module-level helper (not exported in __all__)
• ChromaVectorDatabase (extends VectorDatabaseBase)
  • __init__, client (property), collection (property)
  • add, search, delete_by_ids, delete_by_filter, clear_collection
  • stats, get_by_ids, remove_by_doc_id, get_stats
  • batch_operation (context manager)
  • __len__, __repr__
  • asearch, aadd, __aenter__, __aexit__

pinecone

• PineconeVectorDatabase (extends VectorDatabaseBase)
  • __init__, index (property)
  • add_chunk, add, search, search_by_id
  • delete_by_ids, delete_by_doc_id, delete_by_filter, delete_all
  • fetch_by_ids, get_stats, list_namespaces
  • get_chunk_by_id, get_chunks_by_doc_id, remove_by_doc_id, clear
  • batch_operation (context manager)
  • __len__, __repr__, __contains__
  • asearch, aadd, __aenter__, __aexit__