Skip to Content
Unified docs shell with shared Classifyre tokens and acid-green highlight accents.
Semantic LayerBusiness Glossary

Business Glossary

Configuration Guide

The Business Glossary bridges the gap between technical detection outputs and the language your organization uses. Instead of asking “How many SECRETS and YARA findings do we have?”, stakeholders can ask “What are our Security Threats?”

How It Works

Each glossary term stores a filter mapping — a JSON object that maps to one or more technical dimensions:

Filter KeyMaps ToExample
detectorTypesDetector type enum["SECRETS", "PII", "YARA"]
severitiesSeverity enum["CRITICAL", "HIGH"]
statusesFinding status enum["OPEN"]
findingTypesFinding type strings["aws_key", "ssn"]
customDetectorKeysCustom detector keys["gdpr-scanner"]

When a metric or query is scoped to a glossary term, the filter mapping is automatically applied as a WHERE clause.

Creating a Glossary Term

Navigate to Semantic Layer > Glossary > New in the web app, or use the API:

curl -X POST /semantic/glossary \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "security-threats",
    "displayName": "Security Threats",
    "description": "Findings from security-focused detectors",
    "category": "Security",
    "filterMapping": {
      "detectorTypes": ["SECRETS", "YARA", "PROMPT_INJECTION"]
    }
  }'

Default Glossary Terms

Classifyre ships with pre-built glossary terms that cover common business concepts:

TermCategoryFilter Mapping
Security ThreatsSecuritySECRETS, YARA, PROMPT_INJECTION detectors
PII ExposurePrivacyPII, PHI detectors
Compliance ViolationsComplianceCOMPLIANCE, GDPR, HIPAA detectors
Content Safety IssuesContentTOXIC, NSFW, BIAS detectors
Critical FindingsSecurityCRITICAL severity only
Unresolved IssuesOperationsOPEN status only
Data QualityOperationsCustom detectors: data-quality-checker, schema-validator

Filter Mapping Schema

interface GlossaryFilterMapping {
  detectorTypes?: string[];    // e.g. ["SECRETS", "PII"]
  severities?: string[];       // e.g. ["CRITICAL", "HIGH"]
  statuses?: string[];         // e.g. ["OPEN", "RESOLVED"]
  findingTypes?: string[];     // e.g. ["aws_key", "ssn"]
  customDetectorKeys?: string[]; // For custom detector references
}

The filter mapping supports combining multiple dimensions. For example, a term “Critical Security Threats” could map:

{
  "detectorTypes": ["SECRETS", "YARA"],
  "severities": ["CRITICAL"]
}

This produces an AND condition: findings must match both the detector types AND the severity to be included.

Previewing Matches

Before saving a glossary term, you can preview how many findings match the filter:

POST /semantic/glossary/:slug/preview

This returns the count of matching findings, helping you validate the mapping before associating metrics with it.

Linking to Metrics

Glossary terms can be linked to metric definitions. When a metric is scoped to a glossary term, the term’s filter mapping is automatically applied during evaluation. This means a metric like “Total Findings” becomes “Total Security Threats” when scoped to the security-threats term.

Last updated on