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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202512050236.tar.gz
Algorithm Hash digest
SHA256 39d9477936609ec68bf11b38478ec8edc43f1c0b45d1dd7c0c74a0e66b38a99b
MD5 b150ade8159b5f14a48d5538026478dd
BLAKE2b-256 91627c42e37962d825390daed4db46c12b0135916e25e6d2c2cdc056c4a94ddb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202512050236-py3-none-any.whl
Algorithm Hash digest
SHA256 3b9a18f9eb9d314c2b392958d7f625fe4cdbea2978efa8ab9c6469b1af386031
MD5 bb95298b7fb956500e92503cee6003b6
BLAKE2b-256 736659ceb5d41daacf9b018c440c89673cb165545660a4ae9a50d9d0b3ab7b36

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