API Documentation

// Using @verdic/guard-sdk (recommended)
// npm install @verdic/guard-sdk

const { validate } = require('@verdic/guard-sdk');

// Your ExecutionConfig (from project settings or Contract Composer)
const executionConfig = {
  schemaVersion: "1.0.0",
  domain: "credit_risk",
  audience: "professional",
  output: {
    allowedModalities: ["natural_language", "structured_text"],
    allowExecutableCode: false,
    allowPseudoCode: false,
    allowStructuredData: false
  },
  actionability: "analytical",
  creativity: "low",
  reasoning: "summary",
  dataInteraction: "no_personal_data",
  riskyCapabilities: {
    financial_advice: "blocked",
    credit_eligibility_inference: "blocked",
    pricing_recommendation: "blocked",
    risk_scoring_explanation: "blocked",
    policy_interpretation: "blocked",
    regulatory_advice: "blocked",
    personalized_outcome_prediction: "blocked"
  },
  enforcement: {
    defaultDecision: "HARD_BLOCK",
    logDecisions: true,
    includeReason: true,
    includeAuditTrace: true
  }
};

// Project credentials
const PROJECT_ID = "your-project-uuid";
const API_KEY = "your-api-key"; // Store securely in environment variables

/**
 * Validate AI output before sending to users
 * 
 * @param {string} output - The AI-generated text to validate
 * @returns {Promise<Object>} Validation result with status and details
 */
async function validateAIOutput(output) {
  try {
    const result = await validate({
      apiUrl: 'https://verdic.dev',
      executionConfig,
      output
    });

    if (result.status === 'OK') {
      console.log('✓ Output validated successfully');
      console.log(`  Drift: ${result.drift}`);
      return { allowed: true, output };
    } else if (result.status === 'BLOCKED') {
      console.log('✗ Output blocked by Verdic Guard');
      console.log(`  Reason: ${result.reason}`);
      console.log(`  Detail: ${result.detail}`);
      if (result.hint) {
        console.log(`  Hint: ${result.hint}`);
      }
      return { 
        allowed: false, 
        reason: result.reason,
        fallback: 'I apologize, but I cannot provide that response.' 
      };
    } else {
      console.error('✗ Validation failed:', result.message);
      throw new Error(result.message || 'Validation failed');
    }
  } catch (error) {
    console.error('Validation error:', error);
    throw error;
  }
}

// Example usage
async function example() {
  const aiOutput = "Your AI-generated response here";
  const result = await validateAIOutput(aiOutput);
  
  if (result.allowed) {
    // Safe to send to user
    console.log('Safe output:', result.output);
  } else {
    // Use fallback response
    console.log('Using fallback:', result.fallback);
  }
}

example();