Hopp til innhold

MODELL-API

Modeller

Beregninger Approach gjør over de samme åpne dataene som adresse-API-et, for en adresse eller et punkt. Hvert svar oppgir utgivelsen som laget det, metodenivået og advarslene; en screeningberegning er ikke en måling, en juridisk sone eller en forsikringspris. Ett oppslag per modell og adresse per dag, og et avslag («abstained») telles ikke.
API-versjon
1.0.0
Endepunkter
3
Modeller
0
Innhold

Endepunkter

https://api.approach.no/api/v1/predictions · OpenAPI-kontrakt

GET

/catalog

uten nøkkel

Models with an active Datakilde release: card, method, tier, sources, limitations, input and output schema.

Tar ingen parametere.

Svar og feilkoder

HTTPBetydningKoder i svaret
200Model catalogue—
503prediction_service_unavailable
GET

/models/{model}

uten nøkkel

One model's release card and schemas.

Parametere

NavnTypeGrenser og standardBeskrivelse
model
sti · påkrevd
string——

Svar og feilkoder

HTTPBetydningKoder i svaret
200Model—
404model_not_found
503prediction_service_unavailable
POST

/run

Run a served model for one subject. One oppslag per model and subject per day on the lookup allowance; repeats the same day are free, and an abstention or a failure is never counted. The grant must name the model (models capability). The answer names the release that produced it.

Parametere

NavnTypeGrenser og standardBeskrivelse
model
innhold · påkrevd
string^[a-z][a-z0-9_]{2,62}$A model id from /catalog
options
innhold
object—Model-specific; see the model's input_schema
subject
innhold · påkrevd
object—An address id, or a point in EPSG:25833 inside Norway.
version
innhold
string—Optional: the release version you expect. Refused if it is not the active one, so a pinned client notices a new release.

Svar og feilkoder

Modeller

Hvilke modeller som er tilgjengelige avhenger av hvilke utgivelser som er aktive, og står i /catalog med metode, kilder, begrensninger og skjema.

IdTittel og kildeDetaljer