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.

Prerequisites

To run the full local RAG Debugger platform, you must have Docker Desktop installed and running on your machine.

Once installed and running, you can follow the instructions below.

Quickstart

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

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

    ragdebug up
    
  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.1.tar.gz (11.6 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.1-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragdebug-0.1.1.tar.gz
  • Upload date:
  • Size: 11.6 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.1.tar.gz
Algorithm Hash digest
SHA256 67ab064f4fd27973ccf76c6fb6748e5eb54e659d2d40f203865a20490c12a12e
MD5 15eb7363d2e256afa9d45d95b2c41689
BLAKE2b-256 2482a60a286f43b54d7fe55312933f96e24fde3457a798c723668044252a31ee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ragdebug-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 101492a6c3aead82928b8d9348933fd8594bd3bff947dc33d564e2f76115cf85
MD5 338cda8142d292ece07b25339eef1a77
BLAKE2b-256 e0712636473c492bc5ad2c83328c502dff3ba926b443ed6425cd319c12889194

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