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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602100304.tar.gz
Algorithm Hash digest
SHA256 bcbdec0adc39dbbc4ae91b6a92e7be152dc9be1853cbed5b8628c63aa362d7b2
MD5 3e7ca31ef5c479617bf73f51c0d41070
BLAKE2b-256 48a303a2e100b69c6c31742fdaa1238e6dfa0bda75c3a7fc943971b2be8367d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602100304-py3-none-any.whl
Algorithm Hash digest
SHA256 c820af6cebfba1fe69389b9f927cb73894985a373ccfa789640401d7594c465c
MD5 4328698726946ee2ee5b7703f882dd0f
BLAKE2b-256 23d64234058f05af77a75ba691e041f1b2a39d7252104aa999a540f77ec1415d

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