API Reference
Complete reference for every public class, function, and dataclass in Director-AI.
Quick Navigation
Entry Points
| Symbol |
Module |
Purpose |
guard() |
director_ai |
Wrap an LLM SDK client with coherence scoring |
score() |
director_ai |
Score a single prompt/response pair |
get_score() |
director_ai |
Retrieve last score from on_fail="metadata" |
VoiceGuard |
director_ai.integrations.voice |
Real-time token filter for voice AI / TTS pipelines |
Core Classes
| Class |
Module |
Purpose |
CoherenceScorer |
director_ai.core.scoring.scorer |
Dual-entropy coherence scoring engine |
StreamingKernel |
director_ai.core.runtime.streaming |
Token-level streaming halt |
AsyncStreamingKernel |
director_ai.core.runtime.async_streaming |
Async variant of StreamingKernel |
InferenceServerHook |
director_ai.integrations.inference_server_hooks |
Server-neutral pre-sampling hook for vLLM, TGI, and llama.cpp |
CoherenceAgent |
director_ai.core.agent |
Orchestrator: generator + scorer + kernel |
BatchProcessor |
director_ai.core.runtime.batch |
Concurrent batch scoring |
Knowledge & Retrieval
| Class |
Module |
Purpose |
GroundTruthStore |
director_ai.core.retrieval.knowledge |
Key-value fact store (prototype) |
VectorGroundTruthStore |
director_ai.core.retrieval.vector_store |
Semantic vector store with pluggable backends |
VectorBackend |
director_ai.core.retrieval.vector_store |
Abstract backend protocol |
Configuration
| Class |
Module |
Purpose |
DirectorConfig |
director_ai.core.config |
Env var / YAML / profile configuration |
Data Types
| Class |
Module |
Purpose |
CoherenceScore |
director_ai.core.types |
Score result with H_logical, H_factual, evidence, task type, confidence |
ReviewResult |
director_ai.core.types |
Agent review output |
ScoringEvidence |
director_ai.core.types |
Retrieved chunks + NLI details |
HaltEvidence |
director_ai.core.types |
Structured halt reason with evidence |
CounterfactualHaltDiagnostic |
director_ai.core.types |
Single-fact halt diagnostic |
SafetyEvent |
director_ai.core.safety_event |
Tenant-safe halt and policy event schema |
TokenEvent |
director_ai.core.runtime.streaming |
Per-token stream event |
StreamSession |
director_ai.core.runtime.streaming |
Complete stream session state |
Verification Gems (v3.10.0)
| Symbol |
Module |
Purpose |
verify_numeric() |
director_ai.core.verification.numeric_verifier |
Numeric consistency checks (arithmetic, dates, probabilities) |
verify_reasoning_chain() |
director_ai.core.verification.reasoning_verifier |
Reasoning chain logic (non-sequiturs, circularity) |
score_temporal_freshness() |
director_ai.core.scoring.temporal_freshness |
Staleness risk for date-sensitive claims |
ConsensusScorer |
director_ai.core.scoring.consensus |
Cross-model factual agreement |
ConformalPredictor |
director_ai.core.calibration.conformal |
Calibrated P(hallucination) intervals |
FeedbackLoopDetector |
director_ai.compliance.feedback_loop_detector |
EU AI Act Art 15(4) feedback loop detection |
LoopMonitor |
director_ai.agentic.loop_monitor |
Agent loop safety (circular, drift, budget) |
AdversarialTester |
director_ai.testing.adversarial_suite |
25-pattern adversarial robustness test |
Interfaces
| Interface |
Purpose |
| REST Server |
FastAPI endpoints (/v1/review, /v1/health, /v1/metrics, 8 gem endpoints) |
| gRPC Server |
Protocol Buffers service (4 RPC methods) |
| CLI |
22 command-line subcommands |
Exceptions
| Symbol |
Module |
Purpose |
compute_meta_confidence() |
core.scoring.meta_confidence |
Verdict confidence from margin + signal agreement |
ContradictionTracker |
core.runtime.contradiction_tracker |
Pairwise cross-turn contradiction matrix |
ContradictionReport |
core.runtime.contradiction_tracker |
Contradiction summary (worst pair, trend) |
See Meta-Confidence Guide.
Structured Output Verification (v3.10.0)
| Function |
Module |
Purpose |
verify_json() |
core.verification.json_verifier |
JSON Schema validation + value grounding |
verify_tool_call() |
core.verification.tool_call_verifier |
Tool existence, arg validation, fabrication detection |
verify_code() |
core.verification.code_verifier |
Python syntax, import existence, hallucinated API detection |
Result types: StructuredVerificationResult, ToolCallResult, CodeCheckResult, FieldVerdict.
See Structured Verification Guide.
Online Calibration (v3.10.0)
| Class |
Module |
Purpose |
FeedbackStore |
core.calibration.feedback_store |
SQLite-backed human correction store |
OnlineCalibrator |
core.calibration.online_calibrator |
Threshold sweep + FPR/FNR with Wilson CIs |
CalibrationReport |
core.calibration.online_calibrator |
Calibration metrics dataclass |
See Online Calibration Guide.
EU AI Act Compliance (v3.10.0+)
| Class |
Module |
Purpose |
AuditLog |
compliance.audit_log |
SQLite audit trail for every scored interaction |
AuditEntry |
compliance.audit_log |
Single interaction record |
ComplianceReporter |
compliance.reporter |
Article 15 report generator |
Article15Report |
compliance.reporter |
Structured report with metrics, drift, incidents |
DriftDetector |
compliance.drift_detector |
Statistical drift detection (two-proportion z-test) |
DriftResult |
compliance.drift_detector |
Drift analysis result with z-score, p-value, severity |
See Compliance Reporting Guide.
Import Patterns
# Top-level convenience imports
from director_ai import guard, score, get_score
from director_ai import CoherenceScorer, StreamingKernel, CoherenceAgent
from director_ai import InferenceHookRequest, build_inference_server_hook
# v3.10.0: Structured verification (stdlib only, no torch)
from director_ai import verify_json, verify_tool_call, verify_code
# v3.10.0: Online calibration
from director_ai import FeedbackStore, OnlineCalibrator, CalibrationReport
# v3.10.0: EU AI Act compliance
from director_ai import AuditLog, AuditEntry, ComplianceReporter, Article15Report
# v3.10.0: Meta-confidence
from director_ai import compute_meta_confidence, ContradictionTracker
# Direct module imports (for type hints and advanced use)
from director_ai.core.config import DirectorConfig
from director_ai.core.types import CoherenceScore, ReviewResult
from director_ai.core.retrieval.vector_store import VectorGroundTruthStore, ChromaBackend
from director_ai.core.runtime.batch import BatchProcessor
# Enterprise (lazy-loaded)
from director_ai.enterprise import TenantRouter, Policy, AuditLogger