describe_dataset
Describe a NEM dataset by providing its schema, filters, update frequency, and source URL. Get metrics, units, and example invocations.
Instructions
Describe one NEM dataset — schema, filters, cadence, source URL.
Examples: detail = await describe_dataset("dispatch_price") # → filters: [{key: "region", values: ["NSW1", "QLD1", ...]}] # → metrics: {rrp: "$/MWh"} # → cadence: "5 min"
Returns: DatasetDetail with id, name, description, filters, units, source URL, and example invocation strings.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dataset_id | Yes | Dataset ID like 'dispatch_price', 'generation_scada'. Use search_datasets() to discover, or list_curated() to enumerate. Case-insensitive. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| description | Yes | ||
| is_curated | Yes | ||
| cadence | No | ||
| filters | No | ||
| units | No | ||
| source_url | Yes | ||
| examples | No |