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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601130240.tar.gz
Algorithm Hash digest
SHA256 8df4fc5cd1a94c906d7e2ea360c069bf6143487867012226352f8aa185e6df7b
MD5 c64a6c2f4ca30ee9d42e9edca42f641e
BLAKE2b-256 291e4be8f47652467f7cac6b3b3a4a252a70e9d27015b7b3ea58dfefc44adee8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601130240-py3-none-any.whl
Algorithm Hash digest
SHA256 23677d5da2415d1b400cdf563851d9b1150f8479a93d3e1cecf3094a662eaae3
MD5 54f58247a9dfea790d7cd04e3b576013
BLAKE2b-256 2cdbbc651837499cedb6650716c4dded62b73ddf7b036e74d2ea185093e4c6ac

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