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.4.0.dev202601170236.tar.gz (722.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file ragbits_document_search-1.4.0.dev202601170236.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601170236.tar.gz
Algorithm Hash digest
SHA256 6265802f6213e6ad0edf151cf9b98deaa8a08a6a6a893d3e6d9cc21fa9d750d6
MD5 26e32db1e036e54030688463df36c52a
BLAKE2b-256 b882255d36634f2b270cfeb781ff7c8f42e1fd2664979ddf7c798d5cb9ba75f6

See more details on using hashes here.

File details

Details for the file ragbits_document_search-1.4.0.dev202601170236-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202601170236-py3-none-any.whl
Algorithm Hash digest
SHA256 df0d05d5e0fa1c2de9271f136fc0431368ff59474c52ba534d7ed8eef7a263ee
MD5 98b743a0355c1918c5d1708797b78261
BLAKE2b-256 b19bf701a8b44c2f863586359e0516a0976575884e4ea6bc400fe20bf78989f3

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