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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202603100257.tar.gz
Algorithm Hash digest
SHA256 fd4a67600c0bb68facf859a00646a5ed1f86f5ceca33fe8446829cdf150289e3
MD5 dcf9a97c84b336e1402fa4c549f1577b
BLAKE2b-256 1dd70ce7131e1fe5f90ee2c5c8dbffaa4894ad59c9bdafeff6467d9dfac4d3c6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202603100257-py3-none-any.whl
Algorithm Hash digest
SHA256 743e2468e7d6ec881aa07df6bdb1ddd9a60ac154b88160433b777149fe7aeedc
MD5 6dedc28538357d604bb3154b7c7b8adc
BLAKE2b-256 e178fa9ca11757a40b504d1d4d17d23672756695220ee7c4dee68f4914df885b

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