Hanzo
OpenapiLabel

How much of the window has matured, and how much of that is judged

Reports how much of a window has matured and how much of that is judged, per source. It is the gate on training.

GET /v1/label/coverage

Addresshttps://api.hanzo.ai/v1/label/coverage
MethodGET
OperationriskLabelCoverage
AuthAuthorization: Bearer $HANZO_API_KEY

Reports how much of a window has matured and how much of that is judged, per source.

It is the gate on training. A supervised fit over a window whose judged count is near zero produces a number, and the number is meaningless; this op is what lets that be stated before the fit rather than discovered after it.

It reads the RECORD plane and folds every assertion at that event's OWN as-of, so the counts obey exactly the leakage rule a materialisation would. It counts only what was ASSERTED: what share of the whole event STREAM carries a label is a question about the feature plane's denominator and is not answerable here.

Request

3 fields.

FieldInTypeRequiredDescription
fromquerystringFrom and To bound the EVENT window, half-open, RFC 3339. Unstated, the window is the 90 days ENDING where maturity begins — to is the horizon ago, not now.
toquerystring
horizonqueryintegerHorizon is the maturity horizon in days the coverage is measured under.

Response

StatusBodyMeaning
200riskLabelCoverageok

200 body — 18 fields.

FieldInTypeAlwaysDescription
contestedbodyintegerContested is how many matured events have two visible assertions that disagree.
eventsbodyintegerEvents is how many DISTINCT judged events those assertions name, keyed on (kind, subject, at).
explorebodynumberExplore is the share of judged events whose winning assertion came from the below-the-line sample.
factsbodyintegerFacts is how many assertions the window holds; Events is how many distinct judged events they cover.
frombodystringFrom is the INCLUSIVE start of the EVENT window these counts were folded over, RFC 3339, echoed with the defaults filled in — the caller's, or 90 days before…
horizonbodyintegerHorizon is the maturity horizon these counts were measured under, IN DAYS — the caller's, or 120.
judgedbodyintegerJudged is how many MATURED events resolve, at their own as-of, to something other than unjudged.
maturedbodyintegerMatured is how many of those events have aged past the horizon and may therefore be admitted to a supervised set at all.
pendingbodyintegerPending is how many of this tenant's assertions the DERIVED columnar copy is not known to hold yet.
productivebodyintegerProductive is how many matured events resolve, at their own as-of, to a WINNING assertion of productive — the event led somewhere: escalated, reported,…
sourcesbodyriskSourceCoverage[]Sources breaks the judged events down by the source that WON, so a plane that looks labelled because one noisy source dominates is visible as such.
sources[].factsbodyintegerFacts is how many assertions this source filed; Won is how many judged events it was the assertion in force for.
sources[].sourcebodystringSource is the asserter these two counts are for — chargeoff, dispute, case, refund, review or sample.
sources[].wonbodyintegerWon is how many JUDGED events this source's assertion was the one IN FORCE for, at that event's own as-of — it beat every other visible claim under the…
tobodystringTo is the EXCLUSIVE end of that window (at < To).
unlabelledbodyintegerUnlabelled is how many MATURED events had no assertion knowable by their own as-of — including every assertion that arrived after that instant.
unmaturedbodyintegerUnmatured is how many events in the window have NOT aged past the horizon.
unproductivebodyintegerUnproductive is every OTHER judged event: the winner claimed unproductive, judged not suspicious.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Label API · All Hanzo APIs · Interactive reference

How is this guide?

On this page