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

ragbits_document_search-1.4.0.dev202601300258.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.dev202601300258.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601300258.tar.gz
Algorithm Hash digest
SHA256 ab2c5c1bdd926e324723253b53a17d4cbd4a6355bc182fc579b70e0a57289167
MD5 8731fa746eac587b7eb7a6186b395a55
BLAKE2b-256 930b5ce4cb91238d7d2d2e3af33ba21e39c20b8615f48aa3ef6daf0ef684d81f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601300258-py3-none-any.whl
Algorithm Hash digest
SHA256 dcde8146a2ad0e18caaf34df0dd95ca44079d7b23217c540afd3b76686d4732d
MD5 e2a397672f9577cd111e9f92db0430c5
BLAKE2b-256 9076c3e077cab3b1c5135b82513a30bc1df7f43da173a09a5233d8d31fa4d98c

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