Skip to content
Snippets Groups Projects
Commit 62b8aebb authored by Tor-Einar Skog's avatar Tor-Einar Skog
Browse files

Docs update

parent 428bd89d
Branches
Tags
No related merge requests found
...@@ -2,25 +2,28 @@ ...@@ -2,25 +2,28 @@
Running a model is a matter of creating a client that is able to send a POST request to a common endpoint, and provide Json in the request body and consume the standard Json that is returned from the model. Running a model is a matter of creating a client that is able to send a POST request to a common endpoint, and provide Json in the request body and consume the standard Json that is returned from the model.
The endpoint for running a model is: The **endpoint for running a model** is:
``` ```
{{vipslogic_url}}/models/{{MODEL_ID}}/run {{vipslogic_url}}/models/{{MODEL_ID}}/run
``` ```
Get the model ID by simply connecting to **Get the model ID** by simply connecting to
``` ```
{{vipslogic_url}}/models/ {{vipslogic_url}}/models/
``` ```
So you must create a model configuration object and pass it in the request body. Each model has its own set of input data. To se a configuration example for a specific model, query So you must create a model configuration object and pass it in the request body. Each model has its own set of input data.
To see a **configuration example for a specific model**, query
``` ```
{{vipslogic_url}}/models/{{MODEL_ID}}/sampleconfig {{vipslogic_url}}/models/{{MODEL_ID}}/sampleconfig
``` ```
Here's a sample for the Carrot rust fly temperature model (PSILARTEMP) Here's a sample for the Carrot rust fly temperature model (PSILARTEMP)
**NOTE: Not all models are properly documented. If you find models with missing information, get in touch and we'll
help you out**
``` ```
{ {
...@@ -47,7 +50,7 @@ The `"loginInfo"` property is only relevant when running the model through the V ...@@ -47,7 +50,7 @@ The `"loginInfo"` property is only relevant when running the model through the V
An explanation of the input parameters should be provided for each model from this endpoint: An explanation of the input parameters should be provided for each model from this endpoint:
``` ```
{{vipslogic_url}}/models/{{MODEL_ID}}/sampleconfig {{vipslogic_url}}/models/{{MODEL_ID}}/usage
``` ```
If not, please contact the model provider and notify them. If not, please contact the model provider and notify them.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment