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.6.0.tar.gz (721.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ragbits_document_search-1.6.0-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

Details for the file ragbits_document_search-1.6.0.tar.gz.

File metadata

  • Download URL: ragbits_document_search-1.6.0.tar.gz
  • Upload date:
  • Size: 721.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for ragbits_document_search-1.6.0.tar.gz
Algorithm Hash digest
SHA256 6c918477986fc7052a23e85adeb36825a42658c1b88d4c4e4448fc43e272ed82
MD5 93b611a389467b05beaaf143c33bd28f
BLAKE2b-256 7595b00d55758cf6666cc5074a0a4d120e351dcd63b5df6e9fa33324e45b8574

See more details on using hashes here.

File details

Details for the file ragbits_document_search-1.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_document_search-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 01e204ec7774a5ea7ef400b0d6b97430d3b8005a0c727afdef9320a30ed3e39c
MD5 6adf645ae8f4359dc17b6c910b0bab3f
BLAKE2b-256 08d750c0220d30509c43921181f241cb904e526e734e77982e117761eeb62fb0

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