Skip to content
2 min read · 305 words

Interface: RequiredMetadataRule

Defined in: src/batteries/validation/types.ts:46

Requires provider-specific metadata on selected primitives.

Properties

PropertyTypeDescriptionDefined in
applyTo"every" | "first-in-group"Whether metadata is required only on the group leader or on every matching primitive.src/batteries/validation/types.ts:54
fallbackPayloadValue?unknownVendor-documented sentinel used when the genuine metadata is unavailable (for example, Gemini's skip_thought_signature_validator for translated or model-switched history). Consumed only by mutate-mode repair, and only with OrderingGuardOptions.allowMetadataFallbackRepair; it must never be applied by ordinary mutate mode because it represents a provenance claim.src/batteries/validation/types.ts:74
fallbackReplayCompatibility?stringReplay-adapter convention to attach alongside fallbackPayloadValue. A payload requires this tag so the ADK knows which adapter may replay it. Consumed only by the separately opted-in mutate-mode fallback repair, never by validation or ordinary mutation.src/batteries/validation/types.ts:80
gatedByReplayCompatibility?string[]Optional producer tags that gate this check; metadata is required only when the primitive's replay-compatibility tag identifies one of these wire formats.src/batteries/validation/types.ts:67
idstringStable identifier used in violations.src/batteries/validation/types.ts:50
kindOrderingPrimitiveKindPrimitive whose payload is required to carry the metadata.src/batteries/validation/types.ts:52
requiredPayloadKeystringDot-path into value.payload for the required provider metadata.src/batteries/validation/types.ts:56
severity?"blocking" | "advisory"Whether a missing value blocks dispatch. Omitted means blocking; advisory records the same metadata check without allowing it to reject a dispatch. This models Gemini 3's hard thought_signature requirement versus Gemini 2.5's advisory version of the same check.src/batteries/validation/types.ts:62
type"requiredMetadata"Discriminator selecting the metadata-presence evaluator.src/batteries/validation/types.ts:48