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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602120304.tar.gz
Algorithm Hash digest
SHA256 5e2e413896a561e55838a24d067215351c3cb9fff7f718a8cd9d03e33b7e22fe
MD5 97c296b85132d87c57d3e5796cf05ec4
BLAKE2b-256 e9f610a7067bc6986e445787e7b6c58e93be1140631e9aec09b2c47521f94444

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602120304-py3-none-any.whl
Algorithm Hash digest
SHA256 cb65f7bba18edf26cecaea5a9aa9fcffcc03891b78fe779f3381e51b7deeb0b0
MD5 82ebc281bd65aef65a20fa69643e2303
BLAKE2b-256 24f90f3c33267a87906ee623a292b8c22ee52605c06bf9e1fee53a03f4546729

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