Get a model's SHAP baselines
The references compare rebases explanations onto, per ip_day: each formation's wells (formation) and all of them (dataset).
Get a model's SHAP baselines
/models/{model_num}/baselinesThe references compare rebases explanations onto, per ip_day: each formation's wells (formation) and all of them (dataset). Use it for a formation × feature heatmap, or to say what typically drives a formation without a well.
What comes back
expected_value is the wells' mean expected value, values each feature's mean SHAP contribution, and value their sum (the mean forecast only where SHAP is additive); null and empty under min_wells wells. wells counts them per ip_day; long ip_days rest on older wells.
Options
formation keeps those formations (dataset always comes back); ip_day keeps one row.
Errors
503 when this dataset has no baselines. On the sample stack, sample numbers.
Parameters
Path parameters
model_numstringRequiredModel number, from GET /models or GET /dataset
models[].model_num.
Query parameters
formationstringOptionalOnly these formations' baselines: one name or a comma-separated list, case-insensitive. The dataset reference always comes back.
ip_dayintegerOptional≥ 1
Only this ip_day's row: one of the model's ip_days (400 otherwise, with them in
details.allowed). Without it, every ip_day.model_setstringOptionalpattern ^[a-z0-9][a-z0-9-]{0,62}$
The model set to answer from, an
idfrom GET /model-sets. Absent: the set GET /model-sets names asdefault, the base dataset unless the server answers from a published set.model_set=defaultreaches the base dataset; once the server retires it, a 400 naming the set answering instead.- An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in
details.allowed(published sets only oncedefaultis retired); a set that can't load, a 503 with the reason. - Plans and exports stay in their set: a call naming them (by path,
plan,ids,source.plan, a scenario'splan.id, or a comparison'sa.planandb.plan, also undersource.comparison) reaches it withoutmodel_set. - An explicit
model_setwins; naming resources of two sets in one request is a 400.
Responses
200 OK
The baselines.
model_numstringRequiredModel number.
sample_databooleanRequiredTrue when the figures come from synthetic sample data.
unitstringRequiredUnit of every value.
"bbl""mcf"sourcestringRequiredThe population the means are over, in words.
min_wellsintegerRequired≥ 1
Fewest wells for a value.
baselinesarray of objectsRequiredEach formation in GET /formations order, then dataset.
ShowHide 4 child fields in each item
referencestringRequiredThe reference.
"formation""dataset"formationstring or nullRequiredThe formation; null for dataset.
labelstringRequiredThe reference in words, as Typical Wolfcamp A well.
rowsarray of objectsRequiredBy ip_day, ascending.
ShowHide 5 child fields in each item
ip_dayintegerRequiredDays since first production.
wellsintegerRequired≥ 0
Reference wells at this ip_day.
expected_valuenumber or nullRequiredThe reference wells' mean expected value at this ip_day.
valuenumber or nullRequiredThe reference's mean SHAP total: expected_value plus values, its mean forecast only where the model's SHAP is additive; null with fewer than min_wells wells.
valuesobjectRequiredEach feature's mean SHAP contribution over the reference's wells (a blank one counts as 0); empty with fewer than min_wells wells.
304 Unchanged since the ETag in If-None-Match.Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
Shared errors400401403500503What they mean