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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.18.0.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.18.0.tar.gz
Algorithm Hash digest
SHA256 0e26800321632520611191865c1930697cf2f4bab7f6513bf44454527306957b
MD5 364048146fd5d24bd74109063d1bda07
BLAKE2b-256 01e9ba734647eb41900bb2e83050e6a4c4b5f3b2cef4fcb31db3047510eb3352

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 84ebbd66b85fb1397c6f4d29083452d7bd85b5a2b201ae13a84121519eafad4c
MD5 1a31b22f403fe7caccb0e8a0f59a9c71
BLAKE2b-256 936892f3c12f9807064de259439830cc3cac4998cb975a324f2c9adbad558a25

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