Skip to main content

Observability SDK for RAG pipelines — auto-trace every stage of your RAG app.

Project description

RAG Debugger SDK

Observability & Debugging Platform for RAG Pipelines

ragdebug allows you to auto-trace every stage of your RAG application and start a comprehensive local dashboard for analysis with a single command.

Quickstart

  1. Install the SDK with the CLI power-ups:

    pip install "ragdebug[cli]"
    
  2. Start the local RAG Debugger platform:

    ragdebug up
    

    Note: This requires Docker Desktop to be running.

  3. Open the dashboard at http://localhost:8000

Integrating Tracing

Add the @trace decorator to your RAG pipeline functions:

from ragdebug import init, trace, Prompt

init(project="my-project")

test_prompt = Prompt(name="QA Prompt", template="Context: {{context}}\n\nQ: {{query}}")

@trace(name="qa_pipeline")
def answer_question(query: str):
    # Your RAG logic here
    return "Answer"

answer_question("What is RAG?")

Advanced CLI Usage

Command Description
ragdebug up Start all 4 containers (mongo, postgres, redis, platform)
ragdebug up --build Force rebuild the platform image
ragdebug down Stop all containers
ragdebug status Show container status + API health check
ragdebug logs Stream container logs

Documentation

For full documentation on Prompts, Evaluations, and more, check the UI dashboard after running ragdebug up.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ragdebug-0.1.0.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

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

ragdebug-0.1.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file ragdebug-0.1.0.tar.gz.

File metadata

  • Download URL: ragdebug-0.1.0.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for ragdebug-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e2dda3c4502de0eaf15b402b417a645ba7e5584e859c4869521081915003ba1a
MD5 c11916df03f5623083c6e52d4af2c902
BLAKE2b-256 cb590413cfc7a10c84d09809e9b6094370946e9a37b03fe0ce8363859a86b78d

See more details on using hashes here.

File details

Details for the file ragdebug-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ragdebug-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for ragdebug-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a6be10a2b3f9d613441494f7b3c35f2694ed774e77cdd50299c49130b8a14859
MD5 d368045a53f36a45593fb32ef100f9f7
BLAKE2b-256 88dd2f5d6ca740cd26586d85d991c9284386dafd4d8a0edb55578db0b782d5d5

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