# AuraGen Documentation

Welcome to AuraGen, a sophisticated data generation engine designed to produce diverse, high-quality risky trajectories for Agentic Systems.

## Overview

AuraGen operates in two distinct stages:

1. Generate Harmless Trajectories: Create clean, task-oriented agent action/response traces across many scenarios

2. Inject Risk: Programmatically mutate the harmless trajectories to introduce realistic risks while maintaining coherence and plausibility

## Key Features

- Flexible API Integration (OpenAI, external APIs, custom providers)

- Dynamic Configuration via YAML (including custom API key types)

- Comprehensive Risk Injection Framework

- Scenario-based Design with Constraints

## Quick Start

    # Clone the repository
    git clone <repository-url>
    cd Agentic-Guardian

    # Install dependencies
    pip install -r requirements.txt

    # Configure API keys
    python config/configure_api_keys.py

    # Generate and inject risks
    python generate_and_inject.py

## Table of Contents

User Guide

- Installation
  - Conda Setup (Recommended)
  - Verify Installation
  - Next Steps
- Quick Start Guide
  - Prerequisites
  - Step 1: Configure API Keys
  - Step 2: Basic Configuration
  - Step 3: Generate Your First Dataset
  - Step 4: Examine the Results
  - Understanding the Data Structure
  - Next Steps
  - Common Issues
  - Need Help?
- Configuration
  - Configuration Files Overview
  - API Key Configuration
  - Generation Configuration
  - Risk Injection Configuration
  - Scenario Configuration
  - Environment Variables
  - Configuration Validation
  - Best Practices
  - Configuration Examples
  - Troubleshooting Configuration
  - Next Steps
- Scenarios
  - Overview
  - Scenario Structure
  - Built-in Scenarios
  - Creating Custom Scenarios
  - Advanced Scenario Features
  - Scenario Templates
  - Scenario Best Practices
  - Performance Considerations
  - Troubleshooting
  - Next Steps
- Risk Injection
  - Overview
  - Configuration Source
  - Risk Categories (from config/risk_injection.yaml)
  - Injection Modes
  - Basic Usage
  - Manual vs. Automatic Target Selection
  - Outputs

# Indices and Tables

- Index

- Module Index

- Search Page