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

This version

1.2.2

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-1.2.2.tar.gz (345.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-1.2.2-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-1.2.2.tar.gz
  • Upload date:
  • Size: 345.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for ragbits_document_search-1.2.2.tar.gz
Algorithm Hash digest
SHA256 5be14428fff7d8df9c2df69ca5c260c2de0a22814bcb2e49cb0af5c8b505b040
MD5 58e9b1c3e959222b78b498dca0ac9aa8
BLAKE2b-256 20b76094c3c276d926c94e999e901b1ebf967ddf1fdccfb90cf63afc38673124

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 76c1e47c4f631e29633676ad644d5b7e6c54d408f7a0a116c5b193979c07819c
MD5 87cbbed84a08f57b7acac875d4e03a40
BLAKE2b-256 2d360b0975bdbe0f8ab813014232cddc35d20c3b55da3a40408741b5289c846a

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