Skip to main content

Interface: Refusal

A governed answer the platform WITHHELD. Mirrors the API's refusal field.

A deliberate no-answer result, distinct from a provider error or empty query result. Certified-definition refusals, input-policy declines, and terminal generation clarifications have different governance_state values. A clarification does not establish missing data or a violated certified rule.

Mutually exclusive with sql, data and chart. When refusal is set those three are always undefined, so a widget that renders a table whenever data is present cannot paint one under a refusal.

Properties​

code?​

optional code?: string | null

Stable machine token for the specific rule (metric_grain_too_fine, …).


governance_state​

governance_state: string

Which part of the certified definition withheld the answer — certified_metric_grain, certified_metric_filters, or certified_metric_definition when the server has no finer mapping for it. input_policy denotes request admission; clarification_required means generation ended without a supported query and needs source/definition input. Widen your handling rather than exhaustively switching: new states are additive.


metric?​

optional metric?: string | null

The certified metric whose contract was at stake.


reason​

reason: string

The public explanation, addressed to a person. Safe to display.


suggestions​

suggestions: string[]

What the reader can do about it, in the order to try.