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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202512021005.tar.gz
Algorithm Hash digest
SHA256 885999cb78cb84f7d036a7774ad9fcda81812771784b536721217521a27074bd
MD5 c128ddd36e942cb9432a4b652de232e5
BLAKE2b-256 13fef60fb118abe80642e42e95a5319f4d91da2c329c2f1cc6d50fc536650486

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202512021005-py3-none-any.whl
Algorithm Hash digest
SHA256 3cca051b64fc41e9c20e055aaa8e505d6ef0ffcbee5aade72116dacf4ed79367
MD5 deb916e61d702f153e63bc57f2cbd460
BLAKE2b-256 aa297107bb28e2e588b475ec378da8065dcd63a25e8aceffc2564f4813c3f9be

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