Hanzo
OpenapiDataset

List this org's datasets

Datasets lists this org's datasets, each with its newest version.

GET /v1/dataset

Addresshttps://api.hanzo.ai/v1/dataset
MethodGET
OperationriskDatasets
AuthAuthorization: Bearer $HANZO_API_KEY

Datasets lists this org's datasets, each with its newest version. An org that has declared none gets an empty list; a store that cannot be reached gets a refusal, never an empty list, because the two read identically and only one of them is true.

Request

GET /v1/dataset takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200riskDatasetListok

200 body — 31 fields.

FieldInTypeAlwaysDescription
itemsbodyriskDataset[]Items is one entry per dataset, carrying its newest version.
items[].atbodystringAt is when this version last changed state, RFC 3339 UTC.
items[].bybodystringBy is who moved it there: the validated user, or the org itself when the caller is a machine with no user behind it.
items[].countsbodyriskSplitCounts
items[].counts.judgedbodyintegerJudged is how many rows carry a disposition.
items[].counts.productivebodyintegerProductive is how many judged rows carry the one disposition.
items[].counts.rowsbodyintegerRows is how many rows the version holds across every split.
items[].counts.subjectsbodyintegerSubjects is how many distinct subjects the rows belong to.
items[].counts.testbodyintegerTest is how many fall after the second cut — the LATEST slice, and the only one a score is honest about, since the split is temporal.
items[].counts.trainbodyintegerTrain is how many rows fall before the first cut — the EARLIEST slice of the window, which is what a model is fitted on.
items[].counts.unproductivebodyintegerUnproductive is how many carry the other. With Productive it accounts for Judged, so the class imbalance is visible before anyone trains on it; both stay 0…
items[].counts.valbodyintegerVal is how many fall between the two cuts, held out for tuning.
items[].digestbodystringDigest fingerprints the SPEC and the ROWS together.
items[].namebodystringName identifies the dataset across all of its versions.
items[].oversizebodyintegerOversize is how many of the window's subjects this version could NOT carry because their subject identity exceeds the plane's per-subject byte bound.
items[].refusalbodystringRefusal names why there are no bytes, when there are none.
items[].runningbodybooleanRunning is true while THIS process is materialising the version.
items[].sharebodyintegerShare is the fraction of the window's subjects admitted, in thousandths.
items[].specbodyriskDatasetSpec
items[].spec.cutsbodystring[]Cuts are the two RFC 3339 instants dividing train | val | test. Omit them to take 70% and 85% of the window by time.
items[].spec.dimsbodystring[]Dims are the coordinates to carry, by published name. Empty takes the whole surface.
items[].spec.frombodystringFrom is where the event window opens, RFC 3339, INCLUSIVE.
items[].spec.horizonbodyintegerHorizon is how many days a row must have aged before it may be admitted.
items[].spec.kindbodystringKind narrows to one subject kind — person, session or account.
items[].spec.namebodystringName identifies the dataset across its versions: lower-case letters, digits and hyphens, starting with a letter.
items[].spec.rowsbodyintegerRows caps the materialisation.
items[].spec.seedbodystringSeed decides WHICH subjects are admitted when the window holds more rows than the cap allows.
items[].spec.tobodystringTo is where the window ends, EXCLUSIVE, so two datasets meeting at one instant share no row.
items[].statusbodystringStatus is declared, materializing, ready or refused.
items[].truncatedbodybooleanTruncated is true when the row cap bound before the window ran out.
items[].versionbodyintegerVersion is which version this is, from 1 and monotone within the dataset.

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.


Dataset API · All Hanzo APIs · Interactive reference

How is this guide?

On this page