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.19.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.19.0-py3-none-any.whl (41.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.19.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.19.0.tar.gz
Algorithm Hash digest
SHA256 a5a4eb2a4ceaa831d37037d56c6efeb59cbd3a43642c777816c416531e4cff12
MD5 e27c6707753d19413be58de4ccbfb9cf
BLAKE2b-256 61eded950a0da952b4dfc599d6fb0cc5009387e90a0d08f2f8432b48051efdfa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aab13b8221425cef2eb2c313a54529e21beef46df2b8b0a3c632344de69e897a
MD5 f4173d4b1da23d2143bdf3bc4d8d076a
BLAKE2b-256 c52f867f18bfb7c302bc64925a8f37cb16c232fc4cec4fad8c778a7d758a88a8

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