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-0.0.8.dev23005.tar.gz (721.9 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-0.0.8.dev23005.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-0.0.8.dev23005.tar.gz
Algorithm Hash digest
SHA256 0b06571322866d3b561ef5c6aceccacd9363302e5c6e37a90b30a7e0e7f91202
MD5 f8239c3a327f00ec8f85184536508fa1
BLAKE2b-256 cef1f27fa65f729fa2782a95fce9100cccac657b849b3bc6a74962a1662ec4c0

See more details on using hashes here.

File details

Details for the file ragbits_document_search-0.0.8.dev23005-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_document_search-0.0.8.dev23005-py3-none-any.whl
Algorithm Hash digest
SHA256 15e5fb18079cdfc370d1625d10a7e76e479bb76e0e1ca7bc7d351cdaa01fc959
MD5 4c05fe610fba3cfb38e90192ec3aeec2
BLAKE2b-256 0ce84ceeb5e516e07e3ae8d4381dee2918512ffa035114bdba0f0712ea6616fa

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