Sample results

Overview

The sample request snippet is created with the input test file upon Model Deployment. It features on the Model Details page and shows how to read a model’s results. Samples may be updated but need to match their model’s output requirements.

The sample results object

JSON

{
    "jobIdentifier": "...",
    "total": 1,
    "completed": 1,
    "failed": 0,
    "finished": true,
    "submittedByKey": "...",
    "explained": true,
    "results": {
        "inputName": {}
    },
    "failures": {}
}

Parameter	Type	Description
jobIdentifier	string	The job’s identifier.
total	number	Total number of inputs processed by the job request.
completed	number	Total number of inputs fully processed by the model.
failed	number	Total number of inputs that failed to be processed by the model.
finished	boolean	If the job finished processing the outputs.
submittedByKey	string	The API key that submitted the job.
explained	boolean	Defines if the job has explainable results.
results	object	Contains an input object for every input item processed. Input item names can be defined before running the model and used to retrieve individual results.
failures	object	Contains an input object for every input that failed to be processed by the model. Input item names can be defined before running the model and used to retrieve individual results.