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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202511290233.tar.gz
Algorithm Hash digest
SHA256 a717878992ad7003ca143971e07a0a4360f3bcada1df3a3173c93e1f3e951c14
MD5 cb1920fa6da9dfc043af3dffa461d10b
BLAKE2b-256 dd3b32603e2b3741da990511a6180c8d26c03435be6950bb1f96fa12f1f9f4d6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202511290233-py3-none-any.whl
Algorithm Hash digest
SHA256 674b590599df79795e03a1b313e5004019041fe3a50b4b76539422e40d74aae6
MD5 7db86ac189b85832620833f065357037
BLAKE2b-256 8fbc9b9e5dfe89db698c6922cd41345fb08368e1aea7b4530139ba97c58db7c7

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