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.1.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.1-py3-none-any.whl (42.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.17.1.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.1.tar.gz
Algorithm Hash digest
SHA256 f0535ab7bc90c8635bfa9e383122c94885b7872df35619d46b38d6048e65e3b8
MD5 cea85c4366e4e600cc3aa02e8cbcb4f1
BLAKE2b-256 d46ba7a2b997b146e6349032ce01b7031bf34b76f3a8318ee772827fbe56d77b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.17.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0890aaab30a8a69765a52c9afed3ed708afbd622018d0a743ecb0105b97a3e72
MD5 0c2e5473447b42ee7a97fd9a5d2b6435
BLAKE2b-256 30901e41f188b8e501c89323fd5cf057386fa5e584bb0c9075e5c34ae9e9bcd3

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