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

File metadata

File hashes

Hashes for ragbits_document_search-1.7.0.dev202604240307.tar.gz
Algorithm Hash digest
SHA256 d1d6ee0bc11b9cc6690aeb77b7211b637c5ebb5efb3bb65439ed7fc16385accf
MD5 cf458e918528eb41e3122fe97dd91c7a
BLAKE2b-256 c08eff96f4be6f961745d270d72397d629d210917eef23ce8403d0bd5de60177

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.7.0.dev202604240307-py3-none-any.whl
Algorithm Hash digest
SHA256 3ed4c9356b32c150b5d8a7d05e94be8ac6fd14d90f7d16726d6fbaea4982b241
MD5 5a7afccaa4ce3e1515b7d1f637e50cc4
BLAKE2b-256 d86ed4f371987e3531a69713758f86f1c7bdaebb5e7d4299c36b66dd5ad2d00c

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