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.11.0.tar.gz (491.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-0.11.0-py3-none-any.whl (57.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.11.0.tar.gz
  • Upload date:
  • Size: 491.5 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.11.0.tar.gz
Algorithm Hash digest
SHA256 6a93ed21fb0422d1c412973df33317394872255dd78e71397c024045fb14595d
MD5 423fbe9fe43d19101d06ef4eee4a26b4
BLAKE2b-256 127af23fcd886f9a6230389e3e2335369c39a8292fc3cccc3c4665b91378a6ed

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5acec3c2bd065ce3d634a15e497a8254b7a8e16081667ae26c4b69b808b96a9
MD5 e915c7801ddf5449f3239583be237262
BLAKE2b-256 1abed8c8507dba5ecbd088bbb02f2b40d20e5b23bf6545b771345a4cbe077936

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