Documentation

Compliance

Check content against regulatory frameworks. Supports gdpr, ccpa, hipaa, eu_ai_act, india_dpdp, india_ai_gov.

client.complianceCheck()

Single framework

const result = await client.complianceCheck({
  content: "Our AI system processes user photos to determine creditworthiness and loan eligibility.",
  framework: "gdpr",
  strictMode: true,
  includeExplanations: true
});

console.log(result.compliance_score.score);    // 0-10
console.log(result.compliance_score.label);    // "Critical" | "Poor" | "Fair" | "Good" | "Excellent"
console.log(result.requirements_passed);
console.log(result.requirements_failed);

result.requirements.forEach(req => {
  console.log(`${req.requirement_id}: ${req.status} (${req.score}/10)`);
});

result.issues.forEach(issue => {
  console.log(`[${issue.severity}] ${issue.description}`);
  console.log(`  Remediation: ${issue.remediation_effort}`);
});

Multi-framework

const result = await client.complianceCheck({
  content: "Patient records are processed by our AI diagnostic assistant.",
  frameworks: ["gdpr", "hipaa"],
  context: {
    domain: "healthcare",
    data_types: ["health_records", "patient_identifiers"],
    cross_border: true
  }
});

for (const [framework, check] of Object.entries(result.results)) {
  console.log(`${framework}: ${check.compliance_score.score}/10 — ${check.compliance_score.label}`);
}

console.log(`Average: ${result.cross_framework_summary.average_score}`);
console.log(`Weakest: ${result.cross_framework_summary.weakest_framework}`);

Parameters

ParameterTypeDescription
contentstringText to evaluate (1–50,000 chars)
frameworkstringSingle framework key
frameworksstring[]Multiple framework keys
contextobjectDomain context for accurate requirement matching
strictModebooleanStricter requirement interpretation
includeExplanationsbooleanPer-requirement explanations

Response: ComplianceResult

{
  framework: "gdpr",
  compliance_score: {
    score: 4.2,
    confidence: 0.85,
    label: "Fair"
  },
  requirements_checked: 12,
  requirements_passed: 7,
  requirements_failed: 4,
  requirements_warned: 1,
  requirements: [
    { requirement_id: "...", status: "pass", score: 8.5, article: "Art. 5" }
  ],
  issues: [
    { id: "...", severity: "high", description: "...", remediation_effort: "medium" }
  ],
  improvement_suggestions: ["..."],
  from_cache: false
}

Environment Variables

# Required
RAIL_API_KEY=rail_your_api_key_here

# Optional — for LLM provider wrappers
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...
GOOGLE_API_KEY=AIza...