Model response
The response to the model request is the optimized route plan, metadata about the model dataset, and key performance indicators (KPIs).
Id | Format | Description |
---|---|---|
metadata |
object |
The model dataset metadata. |
modelOutput |
object |
The model output containing the optimized route plan. |
kpis |
object |
Overall Key performance indicators (KPIs) of the vehicle route plan. |
1. Model metadata
Contains metadata about the model solving dataset.
The metadata object contain five key timestamps, each marking a distinct phase in the process:
-
submitDateTime
: The moment the dataset is submitted. At this stage, the dataset is queued and has not yet begun solving. The dataset status isSOLVING_SCHEDULED
. -
startDateTime
: The moment the run begins initializing. During this phase, the dataset is not solving yet, but the model is being built and enriched with external data (e.g., incorporating map information for models involving geographical locations). The dataset status isSOLVING_STARTED
. -
activeDateTime
: The moment the solving phase begins. At this stage, the actual problem-solving process starts. The dataset status isSOLVING_ACTIVE
. -
completeDateTime
: The moment the solving phase concludes. At this point, the dataset has finished solving but has not yet undergone any post-processing (e.g., score analysis or waypoint enrichment for geographical models). The dataset status is eitherSOLVING_COMPLETED
orSOLVING_FAILED
. -
shutdownDateTime
: The moment the post-processing phase finishes. All tasks, including post-processing, are completed, and the dataset optimization is fully finalized.
Id | Format | Description | Example |
---|---|---|---|
activeDateTime |
string (ISO 8601 date, time and time zone offset) |
The time solving the model changed to active state. |
|
completeDateTime |
string (ISO 8601 date, time and time zone offset) |
The time solving the model request completed. |
|
id |
string |
Unique identifier of the dataset |
|
name |
string |
Name of the solver dataset |
|
score |
string |
The current score of the route plan, as calculated by the solver. |
|
shutdownDateTime |
string (ISO 8601 date, time and time zone offset) |
The time solving the model solution was stored. |
|
solverStatus |
string (one of: "NOT_SOLVING", "SOLVING_SCHEDULED", "SOLVING_ACTIVE", "SOLVING_COMPLETED", "SOLVING_FAILED", "SOLVING_DISABLED") |
The status of the solver. |
|
startDateTime |
string (ISO 8601 date, time and time zone offset) |
The time solving the model request started. |
|
submitDateTime |
string (ISO 8601 date, time and time zone offset) |
The time the model request was accepted. |
|