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

import asyncio

from ragbits.core.embeddings 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_name="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("local://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-1.5.0.tar.gz (721.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-1.5.0-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-1.5.0.tar.gz
  • Upload date:
  • Size: 721.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for ragbits_document_search-1.5.0.tar.gz
Algorithm Hash digest
SHA256 5cafd675c3b42553ac5b5fd1af76e97f42801e9eaf97f3f184666d079419fd34
MD5 7d50ee776b8e08b88dfb71809edee059
BLAKE2b-256 e0630588f99c9a65a6f0173a0ab9ff29c2d7db287c054e01ae728a551179c7b5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c856adfcb4b595428f026eafd1b5a6f73bd2b4fd0856d06ed6a94bf57d4c15f8
MD5 e0f284ba557303127b6883fc68a22c62
BLAKE2b-256 e0faca89933d20df91a0109a6062703db641efeed26e4d33caa3ae9454386e74

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