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

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602030301.tar.gz
Algorithm Hash digest
SHA256 b42ae54a756ec5dd4c1958e61e6571d31ef36f360cd9f1ff5b960ca145a40f55
MD5 23eec9350b7521d659cc67f27d2d0e65
BLAKE2b-256 48f3864790d8420aba812a6ceb7caa434d63fa50f7c8985908682283161acaae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602030301-py3-none-any.whl
Algorithm Hash digest
SHA256 afdf7d88528c5b8fb9414d4666c06d3516b2da10505001c9cd432de7a5783bed
MD5 a9ce45544a9a3c2ff58493bfc5afeef9
BLAKE2b-256 93d046fa55e40b1aa0ff73fd51eeca76a78dd3ff6884484c64040ec3f9b57726

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