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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.19.1.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.1.tar.gz
Algorithm Hash digest
SHA256 0a04f7bcef8ea04db1f5ec598c0591b234ada7a8a05e3a1b3e20fbd29114643d
MD5 ca9ee9b44974cecab4960d890a152a37
BLAKE2b-256 18773854884e02fffe96030c102c5b86749a823c5cf690aa1998748363d9ccc4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e4be2881703e5185ef7ed87845bfb06273bff4ad496efaad59d149f447ce640
MD5 5549b3aa82fe68770186ff097fa0c85b
BLAKE2b-256 a4bc7be449a06df8f94993714d1ce155aa40dc3e95b11ff1c927548f6c0d0dad

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