Azure Blob Storage

Overview

Modzy can run data stored in Azure Blob Storage. Input items stored in Azure service account containers may be accessed one object at a time.

To submit a job request, send input items, a model identifier, and a version number.

Sample request

POST /api/jobs HTTP/1.1
Host: trial.app.modzy.com
Authorization: ApiKey apikey.modzy
Content-Type: application/json
Accept: application/json

{
   "model":{
       "identifier": "ed542963de",
       "version": "1.0.1"
   },
   "input": {
       "type": "azureblob",
         "storageAccount": "myAzureStorageAccount",
       "storageAccountKey": "cvx....ytw==",
         "sources": {
           "myInputItem": {
               "model-input-name": {
                   "container": "textInputs",
                   "filePath": "sentiments/angry.txt"
                } 
            }                   
       }
   }
}

Sample response

{
  "model": {
    "identifier": "ed542963de",
    "version": "0.0.27",
    "name": "Sentiment Analysis"
  },
  "status": "SUBMITTED",
  "totalInputs": 1,
  "jobIdentifier": "2700725a-9c84-40ae-bbeb-4fce0d35424e",
  "accessKey": "apikey",
  "explain": false,
  "jobType": "batch",
  "accountIdentifier": "demo-account",
  "team": {
    "identifier": "demo-team"
  },
  "user": {
    "identifier": "demo-user-id",
    "firstName": "demo",
    "lastName": "user",
    "email": "[email protected]"
  },
  "jobInputs": {
      "identifier": ["texts"]    
  },
  "submittedAt": "2021-08-02T21:19:52.529+00:00",
  "hoursDeleteInput": 1,
  "imageClassificationModel": false
}

Request body parameters for Azure Blob Storage

Parameter	Type	Description
model (required)	object	An object that contains the model parameters `modelID` and `modelVersion`.
input (required)	object	Contains all the input type and sources.
explain	string	Sets the explainability feature when a model offers the option.
timeout	string	A timeout in milliseconds for the job’s status to transition to `TIMEDOUT.` The job doesn’t timeout if this value is not provided.

`input` object

Parameter	Type	Description
type (required)	string	The input type to be processed. **Use `azureblob` to run an inference against an item stored in an Azure storage account container
storageAccount (required)	string	The Storage Account within which the blobstore container resides
storageAccountKey (required)	string	The Storage Account's primary access key
sources (required)	object	Contains all the input item objects to be processed.

`input_item` object

Parameters	Type	Description
input_item (required)	object	Contains the input to be processed by the model. This parameter's key can have any name. Its name matches the output's name.

`model_input_name` object

Parameters	Type	Description
model_input_name (required)	object	Contains an Azure Blob container name and the input file's corresponding key within that container. The container must reside within the specified Storage Account. This parameter's key needs to match the input name that the specified model expects. Add one per container.

For additional information see Jobs.