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.7.0.dev202604280307.tar.gz (722.6 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.7.0.dev202604280307.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.7.0.dev202604280307.tar.gz
Algorithm Hash digest
SHA256 355880444c445b4501e6b34d8cb520e932f09fd4667796f0c23a6fec8d0a4fee
MD5 098826efd172decb770230a95b8ae88c
BLAKE2b-256 1788f44f65ee11f4e0d0183f81a90f096daeb8c9c5cf993347ffef3814d900cc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.7.0.dev202604280307-py3-none-any.whl
Algorithm Hash digest
SHA256 86a4f461c089aca4d8ddee9e76c27ab1f76129dd350b6d4cacb7748ebf21707c
MD5 6d5661ac6aa5e01b712176b6fac85a9f
BLAKE2b-256 752b22ccd1634d4e4240ca18d04878e004e2de00435cbac946a7b0c98a824e10

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