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.dev202602261352.tar.gz (722.5 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.dev202602261352.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602261352.tar.gz
Algorithm Hash digest
SHA256 26237f9e7ce669e5f0e14325d1905cb7d0c00316aaf0f5c823beb0ee2908f140
MD5 0b2d09abd0f8b15338d932118abfef43
BLAKE2b-256 c450e6be907277d4ea03141064999551d1bc93555d4ee37c7408ae53a2f0e0b8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602261352-py3-none-any.whl
Algorithm Hash digest
SHA256 04aa82c9e014da6bb086ed8d049a3cbc7de9a1e3c993092e932dc1cdbde51844
MD5 3277780e3657c3f688586b387ff1f814
BLAKE2b-256 5e60744c464186bc953508ef1e9c0920ec8c597891145923ca519870c19ea968

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