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.12.0.tar.gz (355.1 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.12.0-py3-none-any.whl (54.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragbits_document_search-0.12.0.tar.gz
Algorithm Hash digest
SHA256 dcce5840670154f14c368f9c9a2451e5084510b78451c10ac59d567d03a4b6bb
MD5 fcb24c1ca0150bed7a14fd2f2ed4c545
BLAKE2b-256 93a3fc917e79076a5a97165da259565fe6ce2f86daf81f2b96052c9b0fd63979

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a39422e9596d4803a1172186b7fdfabab049fb780e1ab4e121ced139040e01e
MD5 465c616e01864f38c5a6aa8caa5582b8
BLAKE2b-256 d3df82846e49b51b4cb2a48b5bc8d4039d48ecaacdd3a830fb7fa48cd7164ccf

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