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

from ragbits.core.embeddings.litellm 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="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("file://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

ragbits_document_search-1.4.0.dev202509220622.tar.gz (722.5 kB view details)

Uploaded Source

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202509220622.tar.gz
Algorithm Hash digest
SHA256 36e11f4dda6884a9d5d89880742952afee94fb1d9c24e00db814719d0bee8b58
MD5 4bd4007a1a443e0939f7124300f7ec11
BLAKE2b-256 4761bf5c6a2ec2473d569dfb63716e52d392ae274dbc7c6fed89a4853870f2cb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202509220622-py3-none-any.whl
Algorithm Hash digest
SHA256 6a17705270e66eabef06b51cb0ca80377ab39a4144acf74fc15e345909fbff9d
MD5 6c51f6004ff4084c5da8d25766c8637b
BLAKE2b-256 2670a1079baeb048603bf33192bad25e76c49f10c01318120e9066ae44280b92

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