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.11.tar.gz (13.6 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.11-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: donkit_retriever-0.1.11.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.13.0 Linux/6.8.0-1044-azure

File hashes

Hashes for donkit_retriever-0.1.11.tar.gz
Algorithm Hash digest
SHA256 b0238c7af27164426c00a7e53bd904e67c0386fd5d5488e4e83310d90468b1d7
MD5 f10a5b77002e102cc328ad5cd46593c0
BLAKE2b-256 58468b71cb16c2c48ca879bff97f9946b19a9599e55d8407f66f0148454a9379

See more details on using hashes here.

File details

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

File metadata

  • Download URL: donkit_retriever-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.13.0 Linux/6.8.0-1044-azure

File hashes

Hashes for donkit_retriever-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 e7276563b08f12fc9c0b3b7473729f008cef7a167b5ef1030cb1c11b3e2306c6
MD5 895b41f1e33755498d687fe31c0ffd52
BLAKE2b-256 d0765fd93b04e67413aa0b7f846a4afbe902575be8b8fd6565a95fd28205124d

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