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.dev202602190302.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.dev202602190302.tar.gz.

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602190302.tar.gz
Algorithm Hash digest
SHA256 32c176628a98b458e48e11ccc164dea06911f28185c645705320d7ac21506959
MD5 8a5d6e69320df351fc4aa70d3e26a806
BLAKE2b-256 46f2ecc326ef863ee07a3394625c4c2f2eb8686545c4b053e753ec4d9bf188c6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602190302-py3-none-any.whl
Algorithm Hash digest
SHA256 d7507afcaffb79d19b2e034afa9cdec54be48b37bb096805b10d712dda3aaabe
MD5 f3117ddb91d961f1ac156829ad10bac7
BLAKE2b-256 87dca777d7f77b741462b0825a524f3e8ab6c14cc4db080a47088bff19455a6e

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