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.6.1.tar.gz (721.6 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.6.1-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragbits_document_search-1.6.1.tar.gz
Algorithm Hash digest
SHA256 9ba4e14686408b3447bb11f1970c50939acd3a4271e544124e57ddc934082356
MD5 f8b955aad53144da9f67b4e1a78cec13
BLAKE2b-256 a7239d5b2bb0d12628e9d4401bacfff557da38daa2c03f7e26a1a6845fe8c57c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 74123f6edfba331e951bc778245634b036b7eb9d79fabf8d079ef8931e00edc0
MD5 1e8852a8b49163ecc7cf15019327cd19
BLAKE2b-256 c2978f2ea15eb2ad0e1864842724e6c52b7626be27f6e7c5518fe61a43c10dec

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