Jobs

Overview

The Jobs service provides the APIs needed to run and manage inference jobs that process data through a model. Modzy is able to access data from different sources, such as text, embedded, and data stored in AWS S3 buckets.

Also, this service monitors active jobs and accesses the job history. To see job details, call the API using the same key that submitted the job. The job history route supports pagination.

A job can process multiple items containing data. To run a job, declare a reference input item name and then include the input name the model requires. The reference name is useful to identify the item’s results. Add the data under the model’s input name.

Once submitted, the API returns the job identifier and additional job metadata. Jobs are processed asynchronously according to priority and resource requirements. To check the status call the job details route. Jobs start off as “Submitted” and move to “In Progress” when they begin to run. Once finished, the status is set as “Completed” or “Error”. If a user cancels the job before it finishes, the status is set as “Canceled”.

To retrieve results call the get results route with the job identifier. Results are keyed on the user’s input item names provided upon job submittal. Each model has its own result MIME type, found in the model’s details.

The jobs object

{
    "jobIdentifier": "...",
    "submittedBy": "...",
    "accountIdentifier": "...",
    "model": {},
    "status": "...",
    "createdAt": "...",
    "updatedAt": "...",
    "submittedAt": "...",
    "total": 1,
    "pending": 1,
    "completed": 0,
    "failed": 0,
    "elapsedTime": 12345,
    "queueTime": 12345,
    "timeout": 99999,
    "user": {},
    "jobInputs": [],
    "inputByteAmount": 12345,
    "imageClassificationModel": true
}

Inputs

The input object holds the input items sent to the model to be processed. Most models only require one input to run successfully but some require more. Input object parameters change based on how the data is stored.

Text inputs

The inputs object - text

{
  "input": {
    "type": "text",
    "sources": {
      "my-input-reference-name-1": {
        "model-x-input-name": "A string to run."
      },
      "my-input-reference-name-2": {
        "model-x-input-name": "Another string to run."
      }
    }
  }
}

The sources object

{
  "my-input-reference-name-1": {}
}

The input name object

"model-x-input-name": "A string to run."

Embedded inputs

The inputs object - embedded

{
  "input": {
    "type": "embedded",
    "sources": {
      "my-image": {
        "image": "data:image/jpeg;base64,/.../2Q=="
      }
    }
  }
}

The sources object

{
  "my-input-reference-name-1": {}
}

The input item name object

{
  "model-x-input-name": "A string to run."
}

AWS S3 inputs

The inputs object - aws-s3 / aws-s3-folder

{
  "input": {
    "type": "aws-s3",
    "accessKeyID": "...",
    "secretAccessKey": "...",
    "region": "...",
    "sources": {
      "my-input-reference-name-1": {
          "model-x-input-name": {
            "bucket": "...",
            "key": "..."
          }
      }
    }
  }
}

The sources object

{
  "my-input-reference-name-1": {}
 }

The input item name object

"model-x-input-name": {
  "bucket": "...",
  "key": "..."
}

JDBC inputs

The inputs object - jdbc

{
  "input": {
    "type": "jdbc",
    "url": "...",
    "username": "...",
    "password": "...",
    "driver": "...",
    "query":"..."
  }
}