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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.14.0.tar.gz
  • Upload date:
  • Size: 341.5 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.14.0.tar.gz
Algorithm Hash digest
SHA256 657fff4ad9563c825405e8377a0416465ebc6a4af274f40db1e7179925d4f802
MD5 acdcdc4be327da25245a3672ad0fd015
BLAKE2b-256 bf7ec2267dff9eb1a4dbef080668872ae40bb9f4d92a25bf856f1854f3ec0d79

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d8fa846212da2dea810cbb7d93cb4b0d6206f1f3ecc3f125bad67ba9210824dc
MD5 1f5f437bc2e9122676806b1cc72574d3
BLAKE2b-256 dffc4a039bab34b7cff7da9365f40979ef51c32b4095f7ddd025a475bfb8e98e

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