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

This version

1.2.0

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.2.0.tar.gz (345.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.2.0-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragbits_document_search-1.2.0.tar.gz
Algorithm Hash digest
SHA256 7a54ba92da8e76e115ca2be34885937ee5f3402e845eeab26a9f176a5c1f4c77
MD5 13df895819591dbfb856f8fe561653fc
BLAKE2b-256 71e21a532cc5dc627502fbae99a34957c551a7ab8c545da53aec85b089e7acfa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f1e10d65078f712c740ee6b146695d3e35f61dfe9c5450e4b9524249d4b619a
MD5 4d98e5246f1c68eba7f0bd0bf0b94701
BLAKE2b-256 2589195cbd99847fa916bb593ecd50d02bcddf6188bb864587e30f6b01ff111f

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