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.dev202512160238.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.4.0.dev202512160238.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202512160238.tar.gz
Algorithm Hash digest
SHA256 11d99efc2dbedd17a4364a94ee441fcbfa575a6357a494239303584164a817e9
MD5 94670721974398534b199a829fed9769
BLAKE2b-256 d447e9e936f94ab037e379d2c1ae59d3c099f1a0f7315bade6bf397f99574318

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202512160238-py3-none-any.whl
Algorithm Hash digest
SHA256 c501c2ff13985f56947c0a6494485720a664c0bccba65c973d100979982145e6
MD5 cbdf89b3db109459dc4337764f6dea79
BLAKE2b-256 101251330599280cbff4856452aebd7317a62533a578f43b59c5f870fd4843f5

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