jevrecipes

Recipe catalog / summary-coverage

Check summary coverage

Check whether a summary preserves each supplied point.

You need to check whether a summary preserves each important source point.

Explore this recipe interactively ยท Source and implementation guide

Use summary-coverage in TypeScript

Install with npm install jev-recipes. Requires Node.js 22.9 or newer and ES modules. Set TYPESAFE_API_KEY in your server environment for live calls, which send input to TypeSafe and use API quota. See the installation guide.

import { summaryCoverage } from 'jev-recipes/summary-coverage';

const result = await summaryCoverage({
  "summary": "We agreed to keep the API unchanged.",
  "points": [
    {
      "id": "api",
      "text": "Keep the public API unchanged."
    },
    {
      "id": "docs",
      "text": "Update the installation instructions."
    }
  ]
});
console.log(result);

Input contract

FieldTypeNeeded
summarystringRequired
pointsarrayRequired
minConfidencenumberOptional
Full input and result schemas
{
  "input": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "summary": {
        "type": "string"
      },
      "points": {
        "minItems": 1,
        "maxItems": 50,
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "text": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "text"
          ]
        }
      },
      "minConfidence": {
        "type": "number",
        "minimum": 0,
        "maximum": 1
      }
    },
    "required": [
      "summary",
      "points"
    ]
  },
  "result": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "model": {
        "type": "string"
      },
      "usage": {
        "type": "object",
        "properties": {
          "input_tokens": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "output_tokens": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "input_tokens",
          "output_tokens"
        ],
        "additionalProperties": false
      },
      "status": {
        "type": "string",
        "enum": [
          "ready",
          "review"
        ]
      },
      "allPreserved": {
        "type": "boolean"
      },
      "checks": {
        "minItems": 1,
        "maxItems": 50,
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "ready",
                "review"
              ]
            },
            "verdict": {
              "type": "string",
              "enum": [
                "preserved",
                "partial",
                "missing",
                "unclear"
              ]
            },
            "confidence": {
              "type": "number",
              "minimum": 0,
              "maximum": 1
            },
            "probabilities": {
              "type": "object",
              "propertyNames": {
                "type": "string",
                "enum": [
                  "preserved",
                  "partial",
                  "missing",
                  "unclear"
                ]
              },
              "additionalProperties": {
                "type": "number",
                "minimum": 0,
                "maximum": 1
              },
              "required": [
                "preserved",
                "partial",
                "missing",
                "unclear"
              ]
            }
          },
          "required": [
            "id",
            "status",
            "verdict",
            "confidence",
            "probabilities"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "model",
      "usage",
      "status",
      "allPreserved",
      "checks"
    ],
    "additionalProperties": false
  }
}

Saved example result

This hand-authored response demonstrates the contract. It is not a model accuracy measurement. Run it without an API key: npx jev-recipes demo summary-coverage.

{
  "model": "demo-fixture",
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0
  },
  "status": "ready",
  "allPreserved": false,
  "checks": [
    {
      "id": "api",
      "status": "ready",
      "verdict": "preserved",
      "confidence": 0.96,
      "probabilities": {
        "preserved": 1,
        "partial": 0,
        "missing": 0,
        "unclear": 0
      }
    },
    {
      "id": "docs",
      "status": "ready",
      "verdict": "missing",
      "confidence": 0.96,
      "probabilities": {
        "preserved": 0,
        "partial": 0,
        "missing": 1,
        "unclear": 0
      }
    }
  ]
}

Evaluation evidence

Fixture only

No verified live accuracy measurement is available. Evaluate representative cases before using this decision in your workflow.

Use the evaluation guide to measure this decision on your own labeled cases.

Limitations

Related recipes