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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601310254.tar.gz
Algorithm Hash digest
SHA256 2311284d67e117f9474d0f94e52c4a077c8e41046b62362f9ccc5830fabc3d14
MD5 b383bf10d03afc08076f29f3c8f9e2b5
BLAKE2b-256 e243f65628ebc0df3daaef89f84bd297715d337a9f6eb0d70675fe2c1493da7a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601310254-py3-none-any.whl
Algorithm Hash digest
SHA256 b4c1ca058dc4383653c0eb7250305bd19d04a30dc6dbab271b4d27af4b69bfc6
MD5 1d78bd4c82da35aafa0e749e5a384c18
BLAKE2b-256 25ffd773d045e5ad3e521b7069913b292a0ee052384f900380993cc19c58662f

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