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-0.0.30.dev29302392.tar.gz (722.3 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-0.0.30.dev29302392.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-0.0.30.dev29302392.tar.gz
Algorithm Hash digest
SHA256 4bc29dfbedd7da79068a5a16ad14051ebc7604aeaff8c54206e70ce83f527a00
MD5 a5ef6d3d46c9bf5963ee26e482934578
BLAKE2b-256 d89ab787fdf7c5e49e04a5c2091f04e8e9580020cb3206c571a852c0e4fbf268

See more details on using hashes here.

File details

Details for the file ragbits_document_search-0.0.30.dev29302392-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_document_search-0.0.30.dev29302392-py3-none-any.whl
Algorithm Hash digest
SHA256 a048389455c19ae07002a0a9c6a06501774768f7a589e417197e886158244688
MD5 919033238db26a03885eccac8366d086
BLAKE2b-256 850f9b23708dcfdaad8f7a33faa0444e5478d41cb4128d7ba32453f057e59c42

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