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.20.0.tar.gz (345.0 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.20.0-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.20.0.tar.gz
  • Upload date:
  • Size: 345.0 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.20.0.tar.gz
Algorithm Hash digest
SHA256 25077cef8c204caa2717645bed7899f5ba8b06dcb409502fce95e987285e7757
MD5 48b969f67903ec6cd260578a411ac6d4
BLAKE2b-256 e0497b13080e31bbade5db795f55e9e20a83cd7fcc9cc0c43f57a8fb0477c38d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b69fdf9d94f54793e7a32736fa2f1a8a9a8e45b859811f6e40c54e62e2b86d5
MD5 30c5534ea81a54e8d2ec00ca2e1aa848
BLAKE2b-256 c117cbcbfbf8098316dce6d004935e5d46a16a2816515674017cc14826eebc19

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