Files
HealthLog/src/lib/ai/schema.ts
T
Marc-André BombeckandClaude Opus 4.7 8a438a0680 feat(ai): schema requires rationale (window + comparedTo + deviation) per recommendation
Each recommendation now carries a 3-field `rationale` object that
powers the upcoming Oura-style "Contributors" expand-card:

  - dataWindow: which time window the rec is based on (matches the
    metricSource.timeRange enum so the UI mini-chart can pin to it)
  - comparedTo: what the user's data is being compared against
    (the user's own baseline or a guideline ceiling)
  - deviation: size + direction of the deviation that triggered
    the rec

Empty `comparedTo` or `deviation` is rejected so the model cannot
emit a placeholder rationale card. Optional `referenceId` rides
along for defence-in-depth; the rec-level referenceId stays the
canonical citation source.

`findRecommendationsMissingRationale()` lets the route detect
legacy (pre-B5c) cached payloads so the UI can show a "regenerate
for new explainability features" CTA. User-initiated regeneration
stays the trigger; nothing auto-runs.

10 new tests in `rationale-schema.test.ts` pin the contract:
- rationale required on every rec
- comparedTo / deviation reject empty strings
- dataWindow rejects unknown enum values
- legacy payload detector returns missing rec ids only
- mixed payloads flag only the legacy entries

Existing test fixtures in `generate-insight.test.ts`,
`reference-id-schema.test.ts`, `citation-enforcement.test.ts`,
and `citation-coverage-logging.test.ts` updated to include
rationale on every well-formed rec — typecheck-clean.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-10 01:17:15 +02:00

312 lines
12 KiB
TypeScript

import { z } from "zod/v4";
import { MEDICAL_REFERENCE_IDS } from "./medical-references";
/**
* Strict response schema for v1.4.15 AI hardening (Phase C1).
*
* Marc, verbatim 2026-05-09: "Es darf null Halluzinationen haben und es
* muss sich halt irgendwie stützen auf medizinische Dinge." ("It must
* have zero hallucinations and must ground on medical facts.")
*
* The schema enforces:
* - A short natural-language summary.
* - A typed `recommendations[]` where each item is structured
* (`id`, `text`, `severity`) and MUST cite the user-data point that
* justified it via `metricSource`. An empty `metricSource.summary`
* fails parse — the model cannot fabricate recommendations without
* pointing to a number from the user's snapshot.
* - A `citations[]` array referencing the metrics the response drew
* on. May be empty when `recommendations[]` is empty (no data → no
* citation), but every recommendation's `metricSource` MUST also
* appear in `citations[]` (cross-check enforced by `validateInsightResponse`).
* - A `warnings[]` array for guideline-flagged values (high BP,
* critical pulse, etc.). Free-form for now; v1.4.16 adds severity
* enum + medical-reference grounding.
*
* Legacy rich fields (`classification`, `findings`, `correlations`,
* `dataQuality`, `disclaimer`) remain accepted via `.passthrough()` so
* cached payloads from v1.4.14 still hydrate the dashboard. The
* v1.4.16 roadmap (`docs/audit/v1416-ai-roadmap.md`) plans the full
* migration to the strict shape once all consumers move over.
*/
// Severity levels — generic for v1.4.15. v1.4.16 adds a clinical
// severity enum keyed to ESH/ESC and AHA guidelines.
export const recommendationSeveritySchema = z.enum([
"info",
"suggestion",
"important",
"urgent",
]);
/**
* Citation-from-data: every recommendation must point to a concrete
* snapshot field that justified it. Empty `summary` is rejected.
*/
export const metricSourceSchema = z.object({
/**
* Snapshot key — e.g. "bloodPressure", "weight", "pulse",
* "medications.compliance30". Free-form because the snapshot shape
* itself is rich; v1.4.16 narrows to a typed enum.
*/
type: z.string().min(1, "metricSource.type required"),
/**
* Time window the value covers — e.g. "last7days", "last30days",
* "allTime". v1.4.16 narrows this enum.
*/
timeRange: z.string().min(1, "metricSource.timeRange required"),
/**
* Human-readable summary of the data point — e.g. "avg 142/88 over
* 12 readings" or "compliance 0.71 / 30d". Empty value rejected so
* the model cannot fake a citation.
*/
summary: z
.string()
.min(1, "metricSource.summary required (zero-hallucination)"),
/** Sample count behind the value, when known. */
n: z.number().int().nonnegative().optional(),
});
export type MetricSource = z.infer<typeof metricSourceSchema>;
/**
* Set of valid `referenceId` values, derived from
* `MEDICAL_REFERENCES` so the two cannot drift. Validated lazily
* inside `superRefine` instead of `z.enum(...)` because the bundle is
* a `string[]` constant — `z.enum` requires a tuple type.
*/
const MEDICAL_REFERENCE_ID_SET: ReadonlySet<string> = new Set(
MEDICAL_REFERENCE_IDS,
);
/**
* v1.4.16 phase B5c — per-recommendation explainability rationale.
*
* Each rec carries a 3-field rationale that powers the Oura-style
* "Contributors" expand-card:
*
* - dataWindow: which time window the rec is based on. Mirrors the
* `metricSource.timeRange` enum so the UI's mini-chart can pin
* to the same window the rec was derived from.
* - comparedTo: the user's own baseline OR a population norm the
* deviation is being measured against — e.g.
* "your 90-day median (73 bpm)" or "ESH ceiling 140/90".
* - deviation: the size + direction of the deviation that triggered
* the rec — e.g. "+5 bpm above baseline over 7 of 7 days".
*
* Empty `comparedTo` or `deviation` is rejected so the model cannot
* emit a placeholder rationale card. Marc's mandate from B5a stays:
* zero hallucinations, every rec must trace back to user data.
*/
export const aiRecommendationRationaleSchema = z.object({
/**
* Time window the rec is based on. Same enum the UI's mini-chart
* uses, so the chart can pin to the rationale's window regardless
* of any parent range tab.
*/
dataWindow: z.enum(["last7days", "last30days", "last90days", "allTime"]),
/**
* What the deviation is being compared against — the user's own
* baseline or a guideline ceiling. Free-form so the model can be
* specific ("your 90-day median (73 bpm)").
*/
comparedTo: z.string().min(1, "rationale.comparedTo required"),
/**
* Size + direction of the deviation. Free-form so the model can be
* specific ("+5 bpm above baseline over 7 of 7 days").
*/
deviation: z.string().min(1, "rationale.deviation required"),
/**
* Optional pointer into the curated medical-reference bundle. The
* rec-level `referenceId` is the canonical citation source; this
* field stays optional so a future provider that wants to attach a
* reference at rationale-grain can do so without a schema bump.
*/
referenceId: z.string().optional(),
});
export type AIRecommendationRationale = z.infer<
typeof aiRecommendationRationaleSchema
>;
export const aiRecommendationSchema = z
.object({
/**
* Stable identifier for the recommendation within this response.
* Used by the future user-feedback loop ("was this helpful?",
* v1.4.16 roadmap). Format: short slug (`rec-1`, `bp-elevated`).
*/
id: z.string().min(1, "recommendation.id required"),
/** Human-readable recommendation text. */
text: z.string().min(1, "recommendation.text required"),
/**
* Mandatory citation — the data point that justified the
* recommendation. Closes the "ungrounded boilerplate" risk Marc
* called out: every recommendation must trace back to user data.
*/
metricSource: metricSourceSchema,
/** Severity — generic for v1.4.15, clinically-keyed in v1.4.16. */
severity: recommendationSeveritySchema,
/**
* v1.4.16 phase B5c — per-recommendation explainability rationale.
* Required on every rec so the UI's expand-card always has WHY +
* WINDOW + COMPARED-TO content to render. Legacy payloads (pre-
* B5c) ride through `findRecommendationsMissingRationale()` for
* the regenerate-CTA migration; the strict parser rejects them.
*/
rationale: aiRecommendationRationaleSchema,
/**
* Optional pointer into the curated medical-reference bundle
* (`src/lib/ai/medical-references.ts`). When set, the value MUST
* be a known id — fabricated ids are rejected.
*
* Optional in v1.4.16 (B5a): the prompt asks the model to cite a
* matching reference for normative claims, but a missing
* referenceId is logged as a citation-coverage warning rather
* than a parse failure. v1.4.16 phase B5c flips it to required
* when `severity >= "important"`.
*/
referenceId: z.string().optional(),
})
.superRefine((rec, ctx) => {
if (rec.referenceId !== undefined) {
if (!MEDICAL_REFERENCE_ID_SET.has(rec.referenceId)) {
ctx.addIssue({
code: "custom",
message: `referenceId "${rec.referenceId}" is not in MEDICAL_REFERENCES`,
path: ["referenceId"],
});
}
}
});
export type AIRecommendation = z.infer<typeof aiRecommendationSchema>;
export const aiCitationSchema = z.object({
/** Snapshot key being cited. */
type: z.string().min(1, "citation.type required"),
/** Window of the value. */
timeRange: z.string().min(1, "citation.timeRange required"),
/** Short description of the data point. */
summary: z.string().min(1, "citation.summary required"),
});
export type AICitation = z.infer<typeof aiCitationSchema>;
export const aiWarningSchema = z.object({
/** Topic — "blood_pressure", "pulse", etc. */
topic: z.string().min(1, "warning.topic required"),
/** What's flagged. */
message: z.string().min(1, "warning.message required"),
/** Severity tag for downstream filtering. */
severity: recommendationSeveritySchema.optional(),
});
export type AIWarning = z.infer<typeof aiWarningSchema>;
/**
* Canonical strict response schema. New strict fields are required;
* legacy rich fields ride along through `.passthrough()` for back-
* compat with cached payloads and the existing dashboard renderer.
*/
export const aiInsightResponseSchema = z
.object({
/** 2-3 sentence overall summary in user-facing locale. */
summary: z.string().min(1, "summary required"),
/** Structured recommendations with mandatory citations. */
recommendations: z.array(aiRecommendationSchema),
/** Citations supporting any claim in summary or recommendations. */
citations: z.array(aiCitationSchema),
/** Guideline-flagged values (e.g. BP > 140/90). May be empty. */
warnings: z.array(aiWarningSchema),
})
.passthrough();
export type AIInsightResponse = z.infer<typeof aiInsightResponseSchema>;
/**
* Tagged error thrown by the schema-enforcement wrapper when even the
* retry attempt fails to produce a valid payload. The route catches
* this and surfaces a 422 to the client.
*/
export class InsightSchemaError extends Error {
readonly httpStatus = 422;
readonly issues: z.ZodIssue[] | null;
readonly attempts: number;
constructor(
message: string,
options: { issues?: z.ZodIssue[]; attempts: number },
) {
super(message);
this.name = "InsightSchemaError";
this.issues = options.issues ?? null;
this.attempts = options.attempts;
}
}
/**
* v1.4.16 phase B5c — legacy-payload detector.
*
* The strict schema now requires `rationale` on every recommendation.
* Cached payloads from v1.4.14/v1.4.15 predate the field — they would
* fail `aiInsightResponseSchema.safeParse()` outright. Rather than
* auto-regenerating on every read (expensive + surprising), we let
* the route call this helper against the legacy-shape JSON so the
* UI can show a "Insights updated — regenerate for new explainability
* features" CTA. User-initiated regeneration stays the trigger.
*
* Input is intentionally typed loosely (the runtime shape is the
* canonical AIInsightResponse, but legacy payloads omit `rationale`
* which the static type now requires). Returns the ids of
* recommendations missing rationale; an empty array means the
* payload is well-shaped under B5c.
*/
export function findRecommendationsMissingRationale(
parsed: AIInsightResponse,
): string[] {
const missing: string[] = [];
for (const rec of parsed.recommendations) {
// Defensive runtime check — the static type asserts rationale is
// present, but the helper exists precisely for legacy payloads
// where it isn't.
const r = (rec as { rationale?: unknown }).rationale;
if (r === undefined || r === null) {
missing.push(rec.id);
}
}
return missing;
}
/**
* Cross-validation beyond zod: every recommendation's `metricSource`
* must also appear in `citations[]` (same `type` + `timeRange`).
* Returns the list of missing-citation issues; an empty list means
* the response is internally consistent.
*/
export function findUncitedRecommendations(parsed: AIInsightResponse): Array<{
recommendationId: string;
missing: { type: string; timeRange: string };
}> {
const cited = new Set(
parsed.citations.map((c) => `${c.type}::${c.timeRange}`),
);
const missing: Array<{
recommendationId: string;
missing: { type: string; timeRange: string };
}> = [];
for (const rec of parsed.recommendations) {
const key = `${rec.metricSource.type}::${rec.metricSource.timeRange}`;
if (!cited.has(key)) {
missing.push({
recommendationId: rec.id,
missing: {
type: rec.metricSource.type,
timeRange: rec.metricSource.timeRange,
},
});
}
}
return missing;
}