Table of Contents

Class PromptValidator

Namespace
AiDotNet.PromptEngineering.Analysis
Assembly
AiDotNet.dll

Specialized prompt validator with comprehensive validation rules.

public class PromptValidator
Inheritance
PromptValidator
Inherited Members

Remarks

This validator performs detailed validation of prompts, checking for common issues, security concerns, and best practice violations.

For Beginners: Checks your prompt for problems before you use it.

Example:

var validator = new PromptValidator();

// Check for issues
var issues = validator.Validate("Your prompt here {incomplete");

foreach (var issue in issues)
{
    Console.WriteLine($"[{issue.Severity}] {issue.Code}: {issue.Message}");
}
// Output: [Error] PE010: Mismatched braces: 1 opening, 0 closing

What it checks:

  • Syntax errors (missing braces, unclosed quotes)
  • Security issues (potential injection attacks)
  • Best practices (length, clarity)
  • Model compatibility

Constructors

PromptValidator(ValidationOptions?, IPromptAnalyzer?)

Initializes a new instance of the PromptValidator class.

public PromptValidator(ValidationOptions? defaultOptions = null, IPromptAnalyzer? analyzer = null)

Parameters

defaultOptions ValidationOptions

Default validation options to use.

analyzer IPromptAnalyzer

Optional analyzer for additional checks.

Methods

GetSummary(string, ValidationOptions?)

Gets a quick summary of validation results.

public ValidationSummary GetSummary(string prompt, ValidationOptions? options = null)

Parameters

prompt string
options ValidationOptions

Returns

ValidationSummary

Validate(string, ValidationOptions?)

Validates a prompt and returns all detected issues.

public IReadOnlyList<PromptIssue> Validate(string prompt, ValidationOptions? options = null)

Parameters

prompt string

The prompt to validate.

options ValidationOptions

Optional validation options override.

Returns

IReadOnlyList<PromptIssue>

A list of detected issues.

Edit this page