Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.heify.com/llms.txt

Use this file to discover all available pages before exploring further.

An Evaluator is a quality-scoring template made up of criteria. When attached to a transcription, the AI evaluates the conversation against each criterion and produces a score. Evaluators are optional — use them when you need automated quality assurance.

​
Fields

FieldTypeRequiredDescription
evaluator_idstringAuto-generatedUnique identifier (UUID)
tagstringYesName of the evaluator (not updatable after creation) — max 100 chars
descriptionstringNoDescription of the evaluator’s purpose — max 250 chars
languagestringNoLanguage used for evaluation ("df" = auto-detect)
contextstringNoAdditional context to guide the AI evaluation — max 1000 chars
criteriaarray<object>YesList of evaluation criteria (min 1, max 10) — see Criteria
created_atstringAuto-generatedISO 8601 creation timestamp

​
Criteria

Each criterion defines one aspect of the evaluation.
FieldTypeDescription
idstringCriterion UUID (auto-generated)
namestringName of the criterion — 1–100 chars
descriptionstringInstructions for the AI to evaluate this criterion — 5–1000 chars
typestringboolean, scale, or strict — see Criterion Types
weightnumberScore contribution — see Weight Rules
When updating criteria, any criterion not included in the update is permanently removed. Provide the criterion id to update an existing criterion; omit id to add a new one.

​
Criterion Types

TypeAI inputScoringFails when
boolean0 or 1weight if pass, 0 if failresult is 0
scale1–5(value / 5) × weight (proportional)result < 3
strict0 or 1Always 0 — does not affect scoreresult is 0 → sets critical_fail_triggered: true

​
Weight Rules

The sum of weight across all non-strict criteria must equal exactly 100. Non-strict criteria must have weight > 0. strict criteria must have weight: 0 — if you pass a non-zero weight for a strict criterion, it is automatically overridden to 0. The default type is boolean.

​
Example

{
  "evaluator_id": "2abb5563-dd64-47bb-bb17-94252e168b06",
  "tag": "Customer Service Standard",
  "description": "Evaluates call quality for the support team.",
  "language": "en",
  "context": "Inbound customer support calls for a SaaS product.",
  "criteria": [
    {
      "id": "c1d2e3f4-...",
      "name": "Greeting",
      "description": "Did the agent greet the customer with the standard opening phrase?",
      "type": "boolean",
      "weight": 34
    },
    {
      "id": "d2e3f4g5-...",
      "name": "Active Listening",
      "description": "Did the agent listen without interrupting, confirm key details, and ask relevant questions before offering a solution?",
      "type": "scale",
      "weight": 33
    },
    {
      "id": "e3f4g5h6-...",
      "name": "Issue Resolved",
      "description": "Was the customer's issue fully resolved by the end of the call?",
      "type": "scale",
      "weight": 33
    },
    {
      "id": "f4g5h6i7-...",
      "name": "No offensive language",
      "description": "Did the agent use any rude or inappropriate language?",
      "type": "strict",
      "weight": 0
    }
  ],
  "created_at": "2025-01-15T10:00:00.000000"
}