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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202511160236.tar.gz
Algorithm Hash digest
SHA256 c674dc3f6939f0964b38186ff9b14a2f445c39fc6f4e7fa76ccd1cd65adc94da
MD5 4a9e16f2576bc6b05a45e7b6bdc88fcb
BLAKE2b-256 b5698376f4a48b2afdfd32974bd98e514053f39650fdf8433c4bd93881decd3a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202511160236-py3-none-any.whl
Algorithm Hash digest
SHA256 f4b1fb67c324974b80951884f95efdba57870c68c875b08c1872eb8736f5bc3a
MD5 075f1539e4485327b0a7358555c57897
BLAKE2b-256 01ad104cf3d3e31b6919e7bd88e60833dc8294b65514cfc6399e41b7a78bf6cd

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