Skip to main content

Document Search module for Ragbits

Project description

Ragbits Document Search

Ragbits Document Search is a Python package that provides tools for building RAG applications. It helps ingest, index, and search documents to retrieve relevant information for your prompts.

Installation

You can install the latest version of Ragbits Document Search using pip:

pip install ragbits-document-search

Quickstart

import asyncio

from ragbits.core.embeddings import LiteLLMEmbedder
from ragbits.core.vector_stores.in_memory import InMemoryVectorStore
from ragbits.document_search import DocumentSearch

async def main() -> None:
    """
    Run the example.
    """
    embedder = LiteLLMEmbedder(
        model_name="text-embedding-3-small",
    )
    vector_store = InMemoryVectorStore(embedder=embedder)
    document_search = DocumentSearch(
        vector_store=vector_store,
    )

    # Ingest all .txt files from the "biographies" directory
    await document_search.ingest("local://biographies/*.txt")

    # Search the documents for the query
    results = await document_search.search("When was Marie Curie-Sklodowska born?")
    print(results)


if __name__ == "__main__":
    asyncio.run(main())

Documentation

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

Built Distribution

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

File details

Details for the file ragbits_document_search-1.4.0.dev202512090236.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202512090236.tar.gz
Algorithm Hash digest
SHA256 e2451600c905af103fff0f6984b05e7ea06bb28b96e9179ee1e2b8dacae4d11c
MD5 780018ea17d4f33345336d5d4da3b1c8
BLAKE2b-256 2b6719d0103194df5a1a0b15df2f0e5437a1792059fdf8c0db9318b75163edfd

See more details on using hashes here.

File details

Details for the file ragbits_document_search-1.4.0.dev202512090236-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202512090236-py3-none-any.whl
Algorithm Hash digest
SHA256 b7607e1adc170d31376bcddabf3d41c7eab28f092e310c15862feaa7f8e1de62
MD5 a042a717fbd17ec76afbf3447bfc7722
BLAKE2b-256 8fc8dd390d32712a43bee90172b2dbc9d121db786e8aa8787e050e73faab0557

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