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

from ragbits.core.embeddings.litellm 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="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("file://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-0.17.0.tar.gz (344.7 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-0.17.0-py3-none-any.whl (42.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.17.0.tar.gz
  • Upload date:
  • Size: 344.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for ragbits_document_search-0.17.0.tar.gz
Algorithm Hash digest
SHA256 2df54b5ee11c86593ca43afb40eab1ae4a84766c9df9b7bdcbffa95ae22d5e49
MD5 72f04bfa2558e2c914ae6d8fd1a89fb2
BLAKE2b-256 412e3a0a3066ca8bd6686eafe3974a73f0b67116d356cdd1e55f681114019553

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8867a568c80cac97985c351830c7447d0079117b93d571da1313f188607df21c
MD5 63cef113f844e60e4679cb8025a8ff56
BLAKE2b-256 a5e89cf1fe287af92c6f6a2e8b3eaac628518cbd7fd4f8a4209aaed7ec3add9c

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