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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602130304.tar.gz
Algorithm Hash digest
SHA256 b25f7902853b92a7548294abb021b42346a4b06b9f26479b3d2fb309f187faf4
MD5 4bd7c601c900f67093210139389d8076
BLAKE2b-256 cb310922ca41e85d8f754b23264c40a9ed1ffd1c04420cd914eeab985046791c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602130304-py3-none-any.whl
Algorithm Hash digest
SHA256 67f26de7ed899c010bfb59026c8cfe24e261db78c316f407f2b41f9c3ec05d50
MD5 8f90a1dced8fbe85e5bd5f70ccb4740f
BLAKE2b-256 56af49e0c99f2feeb5cca3a740f328ab794a1bf852efb9ada10bef3c5c8ce473

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