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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601261217.tar.gz
Algorithm Hash digest
SHA256 e0cfc667efa4deff740a4b2428f381c1185b7b4f5823bb3cf2ce4f97776b3463
MD5 d35322b1fc6a85fb2374ff3dfb67012f
BLAKE2b-256 ea599f3d3fcc0c55258aa4e7618589c188c4b4d1f17dcc74d240b88e3af32622

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601261217-py3-none-any.whl
Algorithm Hash digest
SHA256 d0e4f5545c3723d058010a75757a9f0a3208b8f58e217f93bdbde175ffed0ed2
MD5 05845efd1b298d89e48a86c0c91d930c
BLAKE2b-256 419d1ea0a41bedf519293ce4735f0d805ae588d0c572b251ebee2363943e7037

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