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

File metadata

File hashes

Hashes for ragbits_document_search-1.7.0.dev202604150306.tar.gz
Algorithm Hash digest
SHA256 c19438abd4834a22475bf7acac1ebd050f697b0f05d1c52eab0a0e87e32966b5
MD5 2311a61b57926b47e816ea9a48b01400
BLAKE2b-256 6d02d087797b49b81790e2d84348d56c2ef4ad98485578e66749e877b24ff0a2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.7.0.dev202604150306-py3-none-any.whl
Algorithm Hash digest
SHA256 410976c19ac78875d031f32e6b68250a52fdc133c47376d4c207b0a8de5794f2
MD5 e952f924e05ad192c17134c02f2505ce
BLAKE2b-256 2ba057cb557ae0828996b4814d5c3877eb04d0e4436b8c2532f18016a3be0364

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