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.7.0.dev202604020305.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.7.0.dev202604020305.tar.gz
Algorithm Hash digest
SHA256 98a3b3be9bd098794ea8c40c5723928f6596ad179b0bf30357936769e60c8ca6
MD5 00bfe3c650527718c7afd4499897b573
BLAKE2b-256 c2a70aec7bfd33dcbe4660e1ca6d15da24f26c0264515d9cc2eac0473f359052

See more details on using hashes here.

File details

Details for the file ragbits_document_search-1.7.0.dev202604020305-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_document_search-1.7.0.dev202604020305-py3-none-any.whl
Algorithm Hash digest
SHA256 849db09f2414f73c15d2b5ebdeb56f0f8671226e471216ce369e51ee572ee1bc
MD5 bd6f9c0aeb4af1ce88f7fcf2b5323a92
BLAKE2b-256 bd3754c5ae6e57ca58d5cbdb163d91d8514ee4ee9ebe177785594c221f3f8e47

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