Skip to content

Dataset product files

A product file with $type Dataset declares one Noun's curated records, the Sources they come from, how often they refresh and what they cover.

A product file with $type: [Dataset] declares a Dataset: curated records of one Noun and the Sources they come from.

  • products/
  • rates.mdxRatebook's US sales-tax rates
  • nouns/
  • Rate.mdxthe one Noun it holds

Reference

KeyTypeHoldsRequiredStatus
$typelistOne or more of App, API, Agent, Dataset, Servicerequiredlive
nounsNoun namesThe Nouns it exposes; a Dataset holds Things of exactly onelive
verbsVerb idsThe Verbs a Customer may calllive
interfaceslistThe Interfaces it ships on; every kind by defaultlive
sourcesSource idsWhere its records come from, each owned, wrapped or recruitedrequiredbeta
refreshhourly, daily, weekly or monthlyHow often it re-reads every Sourcebeta
coveragelist of sentencesThe population and date range it answers for, never "complete"requiredbeta

Examples

Minimal

products/rates.mdx
---
$type: [Dataset]
nouns: [Rate]
sources: [state-bulletins]
coverage: [Every US taxing jurisdiction]
---

Ratebook

products/rates.mdx
---
$type: [Dataset, API]
nouns: [Rate]
sources: [state-bulletins, county-ordinances]
refresh: daily
coverage: [Every US taxing jurisdiction, from 2024 on]
---
A rate for any US address in under 100 milliseconds.

What it builds

The SoftwareBuilder compiles the file.

  • the Dataset, its records as Resources at their Sources, each with its provenance
  • for API: keyed lookups on the API and as MCP tools, with free misses and a free coverage check
  • the Dataset's facts beside its price: record count, coverage, last refresh, Source and license

Good to know