GuidesRecipesAPI ReferenceChangelogDiscussions
Log In

modzy jobs

Work with jobs

$ modzy jobs [command] allows you to work with jobs, which are groupings of predictions or inferences run through Modzy. The jobs command group offers four specific commands.

Command within Jobs Command GroupDescription
cancelCancel a job that's currently running or waiting to run
getGet detailed information about a job
listList jobs
resultsGet job results

Flags
-h, --help help for jobs

Usage

In all of the following examples, authentication is being handled by command flags. To use these examples makes the following substitutions:
Replace BASE_URL with the URL of your instance of Modzy, such as https://trial.app.modzy.com
Replace API_KEY with a valid API key string

Cancel command

$ modzy jobs cancel [jobIdentifier] [flags] cancels a job that is either processing data, or still in queue.

Enter the following code into the terminal.

$ modzy jobs cancel JOB_IDENTIFIER --base-url BASE_URL --api-key API_KEY

Replace JOB_IDENTIFIER with a valid job identifier, which has the following format 12efd314-nd8c-5972-b324-fd40401de562

Flags specific to the jobs cancel command

FlagTypeDescription
-h, --helpHelp for cancel

Get command

$ modzy jobs get [jobIdentifier] [flags] retrieves detailed information about a job

Enter the following code into the terminal.

$ modzy jobs get JOB_IDENTIFIER --base-url BASE_URL --api-key API_KEY
           ID: 12efd314-nd8c-5972-b324-fd40401de562
       Status: COMPLETED
        Model: Image Classification: Explainable
               [email protected]
   Queue Time: 1m36.255s
 Elapsed Time: 2m47.777s

Replace JOB_IDENTIFIER with a valid job identifier, which has the following format 12efd314-nd8c-5972-b324-fd40401de562

Flags specific to the jobs get command

FlagTypeDescription
-h, --helpHelp for get
-o, --outputstring

List command

$ modzy jobs list [flags] lists recently submitted jobs.

Enter the following code into the terminal.

$ modzy jobs list --base-url BASE_URL --api-key API_KEY
ID                                   Status    Submitted By         Team Submitted At                 Model
--                                   ------    ------------         ---- ------------                 -----
f8248a60-771b-4c06-8b57-cb431f4d0069 SUBMITTED bGHreiUUhQjwVTWhtLOs      2021-09-09T18:51:38.832+0000 Russian to English Translation
e51ee699-067f-4d71-8c20-20a0e2652ff0 COMPLETED VrOui58DWEm1flNfHbOQ      2021-09-09T18:51:24.634+0000 Language Identification: Explainable
ffddd0a2-2293-4704-a44f-aeb659f07a37 COMPLETED VrOui58DWEm1flNfHbOQ      2021-09-09T18:50:44.43+0000  Multi-language OCR
5904dd37-2354-4cbd-92bc-b05306a62a21 CANCELED  bGHreiUUhQjwVTWhtLOs      2021-09-09T18:50:17.315+0000 Multi-language OCR
918b4c20-6b55-4524-b5fa-978638fc2332 CANCELED  bGHreiUUhQjwVTWhtLOs      2021-09-09T18:49:43.332+0000 Multi-language OCR
8c79a7cf-36db-4579-a476-3ad3f0e666db COMPLETED Q4xuuOnQlFHY4Tw0FdTE      2021-09-09T17:56:40.266+0000 Image-Based Geolocation
3b3e047d-fcf6-490a-a376-4f97eec91f85 COMPLETED Q4xuuOnQlFHY4Tw0FdTE      2021-09-09T17:50:58.628+0000 Image Classification: Explainable
956c7b8f-8de7-440a-8ed6-e311e5538bf1 COMPLETED VrOui58DWEm1flNfHbOQ      2021-09-08T17:33:12.048+0000 Sentiment Analysis
35ea0ea9-64ab-4197-90d7-0614d1dfdf8e COMPLETED VrOui58DWEm1flNfHbOQ      2021-09-08T17:23:13.641+0000 Sentiment Analysis
03c2b419-b4e1-44d2-89a0-b7096858b32c COMPLETED VrOui58DWEm1flNfHbOQ      2021-09-07T19:48:53.165+0000 Sentiment Analysis

Flags specific to the jobs list command

FlagTypeDescription
--filterstringArray(default [startDate=T-30,endDate=T])
-h, --helpHelp for list
-o, --outputstring
--pageint(default 1)
--sortstring(default "createdAt:desc")
--takeint(default 10)

Results command

$ modzy jobs results [flags] retrieves job results.

Enter the following code into the terminal.

$ modzy jobs results JOB_IDENTIFIER --base-url BASE_URL --api-key API_KEY
              ID: 12dfd314-ad8c-4972-b304-fd40401de561
        Finished: true (6 Total, 6 Completed, 0 Failed)
           Start: 2021-09-17T00:43:23.223+0000
 Processing Time: 0s

Results:
Input                    Status     Start Time                   Elapsed Time
-----                    ------     ----------                   ------------
46831593625_31f47ea42e_c SUCCESSFUL 2021-09-17T00:54:58.577+0000 0s
35202317695_e11250eb90_c SUCCESSFUL 2021-09-17T00:54:58.574+0000 0s
35778480241_1ac24a527e_c SUCCESSFUL 2021-09-17T00:54:58.498+0000 0s
32255637731_6d87d91684_c SUCCESSFUL 2021-09-17T00:54:58.575+0000 0s
27468984627_56209eb7ab_c SUCCESSFUL 2021-09-17T00:54:58.576+0000 0s
40120467922_3f076a1501_c SUCCESSFUL 2021-09-17T00:54:58.577+0000 0s

Replace JOB_IDENTIFIER with a valid job identifier, which has the following format 12efd314-nd8c-5972-b324-fd40401de562

Flags specific to the jobs list command

FlagTypeDescription
-h, --helpHelp for results
-o, --outputstring