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.dev202601010248.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601010248.tar.gz
Algorithm Hash digest
SHA256 5b82aae2bae1419dac36b28a45fc3d137571cbe17ebba24c58af744f3f57adb9
MD5 91a77f72d22156a66cacf864731b2cba
BLAKE2b-256 f419bbcbf713dff02197b3c4295ea8d0bea46d83fc159580d2c83fc0704d6890

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601010248-py3-none-any.whl
Algorithm Hash digest
SHA256 60997e0f648a440a54997df9bc76a676d4f8813781d2b367c7e76ffcbba4a3f9
MD5 fe5cf963966d202c4988895159f4f881
BLAKE2b-256 4fee82cc0e9724743bdb47ddb7dd79b51d274da24da09c03faf2b8a443bf12f0

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