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.7.0.dev202605130309.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.7.0.dev202605130309.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.7.0.dev202605130309.tar.gz
Algorithm Hash digest
SHA256 edce6e0ace1afa333f5ee315fe84d93277a3ca366a4f16e8745f79d2b16c3a3f
MD5 8c3c1bcdf45e9a8863ee537d729c7cfa
BLAKE2b-256 48287412e9fd68d645d64791d52d38efddb5d146f5f1f6b706030a4dc6bd10c7

See more details on using hashes here.

File details

Details for the file ragbits_document_search-1.7.0.dev202605130309-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_document_search-1.7.0.dev202605130309-py3-none-any.whl
Algorithm Hash digest
SHA256 45e7dafb6eafa042052b8a3994fb248096a53d71b97e35db77f1a53ab74daed3
MD5 e45b870ae2004ca6770a8f524b201c5c
BLAKE2b-256 35ac77a378e1aab120c2933d3ee1275ee0c99b4dffdc66d98ade3ac7cd5bfb42

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