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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202603070252.tar.gz
Algorithm Hash digest
SHA256 e29ab40ca96a356e81056f052cd7100c41e598ae0d8a8c01470aaf2a7d6b9391
MD5 2a9d2aa2723baeb303a7e0e14248e421
BLAKE2b-256 b9917d71b5b800f73c3ad956d9fc23606994f20acee04ee8904b8df635c32f5d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202603070252-py3-none-any.whl
Algorithm Hash digest
SHA256 5ee4d2a64064be78784f8c7a03fd768250fb98f21f0552dcda47501fabf9f630
MD5 ac862116c74c4c47d0a703ba180dd167
BLAKE2b-256 e0c6a6a3bed5be278cfbe139ad8658898630cb723f70ae9d7cd1b8cf7f9011db

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