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.dev202512110238.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.4.0.dev202512110238.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202512110238.tar.gz
Algorithm Hash digest
SHA256 d8b333a14ebc6d5262a96447c6281165e89d5174adfa0a7f3504faa16c8e8e26
MD5 f0eb172eed869419d2f45614f6be9567
BLAKE2b-256 5819632c6cafc51293182e60bfb69cf4fc3a8269643e0c667352bb59d4df95a4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202512110238-py3-none-any.whl
Algorithm Hash digest
SHA256 13a27d577010d1e01712bc580e67d02f151d0fa2bc2617ec3ba3e2df70c0ef8f
MD5 1a620c589002789f7170c18405567fe7
BLAKE2b-256 21e4ab86d2d4ea0d8abe1e9f1b3bb5ee3b7a24f0688c3dc450463d7899a98b83

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