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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202509220615.tar.gz
Algorithm Hash digest
SHA256 366daa4341ff3f5c21eb5a096fccf273e47d6fe0709ba6a28a83a9b2a6994808
MD5 8ec0f6f514c97f6e587aa49b54cc75da
BLAKE2b-256 0c201c0477134e50aa4470bcbed968e3de1c76a5f9adc0e21424931f7b65f6cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202509220615-py3-none-any.whl
Algorithm Hash digest
SHA256 6a3083f1aab3d60ffe175899d9b0ad7c52f0192d7ba73076c693c7349f4e2c94
MD5 69a20d2b3c8c94cbc891885b4f17d53d
BLAKE2b-256 2afcdacc49c5ee59d79891e03dfe3942f3ad1acd2c933434f87d296f7ea3465a

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