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.15.0.tar.gz (341.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-0.15.0-py3-none-any.whl (40.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.15.0.tar.gz
  • Upload date:
  • Size: 341.6 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.15.0.tar.gz
Algorithm Hash digest
SHA256 98530f3dca5a3a8723df9854f1d5be6b5b95b44ec7af3f3b233e1827b388e236
MD5 4fc256f306e58d348018fda6646bc1a9
BLAKE2b-256 c9b63032dbfc329d457e464139966980b55deab9c2b8648ecfc548fa88318e53

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21ead98d79d4ca146c6196569424f05c99f523f22d7c05da79662821f02a44ce
MD5 e50265720f3e30399dab99ecdfebe475
BLAKE2b-256 c4aaa7b6bec9dda5c831cf207470bd3a3a7a67acb3769e00bfbb711d8e65db19

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