# DynamoGuard Quickstart Repository

Welcome to the DynamoGuard Quickstart Repository! The DynamoGuard Quickstarts are a collection of examples and tutorials for getting started with DynamoGuard.

To run these examples, you’ll need access to DynamoGuard, either through a SaaS trial or a PaaS deployment. The code examples are all written in Python.

## Quickstart Guide

1. [**Create and Benchmark a Custom Content Policy**](quickstarts/content_policy.ipynb)
    - Learn how to define your own content policy
    - Benchmark the performance of your custom content policy
2. [**Optimize Content Policy Performance with Thresholding**](quickstarts/content_policy_threshold.ipynb)
    - View policy performance trade-offs between metrics at various classification thresholds
    - Adjust thresholds to fine-tune your content policy for optimal results
3. [**Advanced Thresholding for Custom Content Policy**](quickstarts/calibrate-threshold.ipynb)
   - Control policy False Positive Rate (FPR) or False Negative Rate (FNR) on a benchmark dataset with thresholding
   - View policy performance at the specified threshold
4. [**Hallucination Policy Creation and Benchmarking**](quickstarts/hallucination_policy.ipynb)
    - Create a hallucination policy to detect hallucinated model responses
    - Set a threshold for your DynamoGuard hallucination guardrail
    - Benchmark the performance of DynamoGuard guardrails against RAGAS
    - Evaluate the performance of Dynamo and RAGAS hallucination guardrails across different thresholds
5. [**Prompt Injection Benchmarking**](quickstarts/prompt_injection.ipynb)
    - Test DynamoGuard’s pre-configured prompt injection guardrail
    - Benchmark the performance of the prompt injection guardrail (see report generation script for visualizing benchmarking metrics in prompt_injection_benchmark_report.ipynb)
6. [**Input Safety Policy Benchmarking**](quickstarts/safety_input.ipynb)
    - Test DynamoGuard’s pre-configured input safety policy for guardrailing against leading safety models, including LlamaGuard and WildGuard
7. [**PII Policy Benchmarking**](quickstarts/pii_policy.ipynb)
    - Test DynamoGuard’s PII policy for detecting sensitive Personally Identifiable Information (PII) in user-provided inputs or model responses
