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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602170301.tar.gz
Algorithm Hash digest
SHA256 620cfaf8d126faeeb5d060f006876b0739a15181841b5ee0c92aac99d32cc744
MD5 19e287ad141a721a649b7d74535699b1
BLAKE2b-256 944082bf403e77382e3d6fb4ead5527c9a93a9d6a98350ac800e2294c23313ee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0.dev202602170301-py3-none-any.whl
Algorithm Hash digest
SHA256 0aa6e57581c540420bc33a9e97215a5813ba7b9d1efad6a31ec80f4dafceec97
MD5 48b07e34a1c140f8caa450562841eea0
BLAKE2b-256 a41fbefe53e6a3a62dc9e7744f1c3850f7696ceea755c3ea5b8e6525b8612dcf

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