Scorecards Module

import { Chanl } from '@chanl/sdk';

const chanl = new Chanl({
  apiKey: process.env.CHANL_API_KEY,
});

const { scorecards, pagination } = await chanl.scorecard.list();

// Filter by status
const { scorecards } = await chanl.scorecard.list({
  status: 'active',
});

scorecards.forEach((scorecard) => {
  console.log(`${scorecard.name}: ${scorecard.categories.length} categories`);
});

const scorecard = await chanl.scorecard.get('scorecard_abc123');

console.log('Name:', scorecard.name);
console.log('Passing threshold:', scorecard.passingThreshold);

scorecard.categories.forEach((category) => {
  console.log(`\n${category.name} (${category.weight}%)`);
  category.criteria.forEach((criterion) => {
    console.log(`  - ${criterion.name} (${criterion.type})`);
  });
});

const scorecard = await chanl.scorecard.create({
  name: 'Customer Service Quality',
  description: 'Evaluates customer service call quality',
  status: 'active',
  passingThreshold: 75,
});

console.log('Created:', scorecard.id);

const category = await chanl.scorecard.createCategory(scorecard.id, {
  name: 'Communication',
  description: 'Evaluates communication skills',
  weight: 40,
});

// AI-evaluated criterion
await chanl.scorecard.createCriteria(scorecard.id, {
  categoryId: category.id,
  key: 'proper_greeting',
  name: 'Proper Greeting',
  type: 'prompt',
  settings: {
    description: 'Agent greeted the customer professionally with name and company',
  },
});

// Keyword-based criterion
await chanl.scorecard.createCriteria(scorecard.id, {
  categoryId: category.id,
  key: 'recording_disclosure',
  name: 'Recording Disclosure',
  type: 'keyword',
  settings: {
    matchType: 'must_contain',
    keywords: ['this call may be recorded', 'call is being recorded'],
  },
});

const updated = await chanl.scorecard.update('scorecard_abc123', {
  name: 'Updated Quality Scorecard',
  passingThreshold: 80,
  status: 'active',
});

await chanl.scorecard.delete('scorecard_abc123');

const result = await chanl.scorecard.evaluate(
  '695d6957e21c0ceb325c394d',
  {
    scorecardId: 'scorecard_abc123',
    force: false, // Set true to re-evaluate
  }
);

console.log('Score:', result.score);
console.log('Passed:', result.passed);
console.log('Status:', result.status);
console.log('Category Scores:', result.categoryScores);

const { results } = await chanl.scorecard.getResults(
  '695d6957e21c0ceb325c394d'
);

results.forEach((result) => {
  console.log(`${result.scorecardName}: ${result.score}%`);

  result.criteriaResults.forEach((cr) => {
    const status = cr.passed ? 'PASS' : 'FAIL';
    console.log(`  ${status} ${cr.name}: ${cr.score}`);
    if (cr.evidence) {
      console.log(`    Evidence: ${cr.evidence}`);
    }
  });
});

// Filter to a specific scorecard
const { results: filtered } = await chanl.scorecard.getResults(
  '695d6957e21c0ceb325c394d',
  { scorecardId: 'scorecard_abc123' }
);

import type {
  Scorecard,
  ScorecardCategory,
  ScorecardCriteria,
  ScorecardResult,
  ScorecardStatus,
  CriteriaType,
  CreateScorecardRequest,
  UpdateScorecardRequest,
  EvaluateOptions,
} from '@chanl/sdk';