Skip to main content

Unified retrieval module for RAG system with multiple vector database support

Project description

Retriever

Unified retrieval module for RAG system with support for multiple vector databases.

Features

  • Multiple vector database backends: Qdrant, ChromaDB, Milvus
  • Filename search: Separate collection for efficient filename-based search
  • Context enrichment: Fetch neighboring chunks for better context
  • Category filtering: Filter results by accessible categories
  • Unified interface: Single API for all vector stores

Installation

poetry add donkit-retriever

Usage

Basic Setup

from donkit.retriever import create_vectorstore_service, RetrievalConfig
from langchain.embeddings import OpenAIEmbeddings

# Configure retrieval options
config = RetrievalConfig(
    vector_database="qdrant",
    retriever_options={
        "filename_search": True,
        "partial_search": True,
        "max_retrieved_docs": 10,
    }
)

# Create service
embeddings = OpenAIEmbeddings()
service = create_vectorstore_service(
    db_type="qdrant",
    embeddings=embeddings,
    config=config,
    collection_name="my_collection",
    database_uri="http://localhost:6333",
)

# Search documents
documents = await service.search_documents(
    query="What is RAG?",
    k=5
)

Supported Vector Databases

Qdrant

service = create_vectorstore_service(
    db_type="qdrant",
    embeddings=embeddings,
    config=config,
    database_uri="http://localhost:6333",
)

ChromaDB

service = create_vectorstore_service(
    db_type="chroma",
    embeddings=embeddings,
    config=config,
    database_uri="http://localhost:8000",
)

Milvus

service = create_vectorstore_service(
    db_type="milvus",
    embeddings=embeddings,
    config=config,
    database_uri="http://localhost:19530",
)

Configuration Options

from donkit.retriever import RetrievalConfig, RetrieverOptions

config = RetrievalConfig(
    vector_database="qdrant",  # qdrant | chroma | milvus
    retriever_options=RetrieverOptions(
        filename_search=True,  # Enable filename-based search
        partial_search=True,   # Fetch neighboring chunks
        max_retrieved_docs=10, # Max documents to retrieve
    ),
    ranker="http://ranker-service:8000",  # Optional reranker URL
)

Architecture

VectorstoreModule

Each database has its own module implementing VectorstoreModuleAbstract:

  • QdrantVectorstoreModule
  • ChromaVectorstoreModule
  • MilvusVectorstoreModule

VectorstoreService

Orchestrates search operations:

  1. Filename search (if enabled)
  2. Vector search
  3. Neighbor fetching (if partial_search enabled)
  4. Document combination and deduplication

Development

# Install dependencies
poetry install

# Run tests
poetry run pytest

# Run linter
poetry run ruff check .

License

Proprietary

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

donkit_retriever-0.1.13.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

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

donkit_retriever-0.1.13-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file donkit_retriever-0.1.13.tar.gz.

File metadata

  • Download URL: donkit_retriever-0.1.13.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.13.1 Darwin/25.3.0

File hashes

Hashes for donkit_retriever-0.1.13.tar.gz
Algorithm Hash digest
SHA256 268cedff318c9df5dcbb2c1adf281dfa17123465258067879593e50807cb0c4d
MD5 c2d0c9a98b0d25383d9d3e2881da36e0
BLAKE2b-256 e7151b1429f26ec152cc86877b2b1f9330c6f8732931b071897ebf3dd5c73c20

See more details on using hashes here.

File details

Details for the file donkit_retriever-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: donkit_retriever-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.13.1 Darwin/25.3.0

File hashes

Hashes for donkit_retriever-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 922babcab2b29092293f31df4d321015f672d1cf5495fe90ca29c70effcc7389
MD5 0cfc505de02ee55b62f3218505207778
BLAKE2b-256 790dc8b4b22ce35b7a3f2411f74e103603d4a7bf9bba66ec58fb465855df1659

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