changedInput schema / properties / query / description
Previous value: -"Free-text search terms to match against route names and descriptions. Leading and trailing whitespace is ignored."New value: +"Free-text search terms to match against route names and descriptions, or a legacy APIv1 series ID (e.g. \"PET.RWTC.W\": three or more dot-separated segments ending in a frequency code A, Q, M, W, D, H, HL, or 4; any case). Leading and trailing whitespace is ignored, and only the first 256 characters are searched."
changedOutput schema / properties / effectiveQuery / description
Previous value: -"Query as searched — the submitted text with surrounding whitespace trimmed."New value: +"Query as searched — the submitted text with surrounding whitespace trimmed, cut to its first 256 characters."
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `upstream_invalid_response`: EIA returned an unusable response body or a missing route or data envelope. `upstream_unavailable`: EIA answered with a retryable HTTP service failure. `rate_limited`: EIA rate limit hit (OVER_RATE_LIMIT) while building the route tree on the first call after server start. `upstream_unreachable`: EIA could not be reached (connection refused or reset, DNS failure) while building the route tree on the first call after server start. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `upstream_invalid_response`: EIA returned an unusable response body or a missing route or data envelope. `upstream_unavailable`: EIA answered with a retryable HTTP service failure. `upstream_timeout`: EIA did not answer in time while the first call after server start built the route tree. An index pass that times out does not fail the search; it is reported in indexGaps. `rate_limited`: EIA rate limit hit (OVER_RATE_LIMIT) while building the route tree on the first call after server start. `upstream_unreachable`: EIA could not be reached (connection refused or reset, DNS failure) while building the route tree on the first call after server start. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "upstream_invalid_response",
- "upstream_unavailable",
- "rate_limited",
- "upstream_unreachable"
-]New value: +[
+ "upstream_invalid_response",
+ "upstream_unavailable",
+ "upstream_timeout",
+ "rate_limited",
+ "upstream_unreachable"
+]
changedOutput schema / properties / indexComplete / description
Previous value: -"True when this answer was ranked against the complete corpus. False means part of it is missing (see indexGaps) — results may be short, and a better match may exist that was never scored."New value: +"True when this answer was ranked against the complete warm-time corpus. False means part of it is missing (see indexGaps) — results may be short, and a better match may exist that was never scored. Facet values folded in by eia_describe_route are additional and never count toward completeness. A resolved series ID is answered by EIA, not ranked, so it does not depend on this."
changedOutput schema / properties / notice / description
Previous value: -"Discloses requested/effective limits when clamped, and guidance when no routes matched or more matches exist."New value: +"Discloses requested/effective limits when clamped and says when only the start of the query was searched; names a resolved series ID (saying so when EIA reports no rows for it), or says the lookup of a query shaped like one found nothing or failed (the results are then the text search); and gives guidance when no routes matched or more matches exist."
addedOutput schema / properties / results / items / properties / columns
Added value: +{
+ "description": "Data column IDs the series reads (e.g. [\"price\"]). Present only on a resolved series ID; pass as eia_query_route columns.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}
changedOutput schema / properties / results / items / properties / filter_hint / description
Previous value: -"Pre-built filter for eia_query_route when a specific facet value is required. Present on STEO and SEDS series results and facet-value results — pass directly as filters (e.g. eia_query_route(route=\"seds\", filters=filter_hint))."New value: +"Pre-built filter for eia_query_route when a specific facet value is required. Present on STEO and SEDS series results and facet-value results — fuel, sector, and RTO respondent values, and the series and product values of daily and weekly petroleum and natural-gas routes (e.g. {\"series\": \"RNGWHHD\"} on natural-gas/pri/fut) — and on a resolved series ID, where it holds every facet EIA maps the ID to, values as EIA writes them (e.g. {\"sectorid\": \"RES\", \"stateid\": \"TX\"}). Pass directly as filters (e.g. eia_query_route(route=\"seds\", filters=filter_hint))."
addedOutput schema / properties / results / items / properties / frequency
Added value: +{
+ "description": "Frequency ID the series is published at (e.g. \"weekly\", \"local-hourly\"). Present only on a resolved series ID; pass as eia_query_route frequency.",
+ "type": "string"
+}
changedOutput schema / properties / results / items / properties / score / description
Previous value: -"Match score: 0 = exact, 1 = no match. Lower is better; above 0.72 the match is unreliable. On a multi-term query it is the better of the whole-phrase score and a per-term score that penalizes each query term the entry does not carry."New value: +"Match score: 0 = exact, 1 = no match. Lower is better; above 0.72 the match is unreliable. On a multi-term query it is the better of the whole-phrase score and a per-term score that penalizes each query term the entry does not carry. A resolved series ID scores 0."
changedOutput schema / properties / totalIndexed / description
Previous value: -"Total entries in the search index (routes + STEO and SEDS series names + facet values)."New value: +"Total entries in the search index: routes, STEO and SEDS series names, and the facet values indexed at warm time, plus the facet values of every route described since the server started — so the count grows with describe calls."