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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602070256.tar.gz
Algorithm Hash digest
SHA256 83fa6d9b87b65cd8f30debaab453b74802577515db0645d8d3b44428b1e0c8a8
MD5 a6653c41f4e654d50288d008153a7f51
BLAKE2b-256 d6996d9e0a6c1fd4d0037fb9370cd20850b56b0975cc5465854a6f7035ded50e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602070256-py3-none-any.whl
Algorithm Hash digest
SHA256 b85bfc36ffb8b7501affc53a6a04e96d1491c27de7f42ad488c5c14e8978fe18
MD5 32def81d42a6951a9ef37a357e88eba3
BLAKE2b-256 978bb15b828a09ea5924c0e3ff6ba7f1222eb67901d7210acb89b0a1cb193227

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