Client to Workflow Manager

Go to paylaod list.

Client to Workflow manager are currently composed with a single JSON describe in above sections.

Client to Workflow Manager payload mandatory keys

Keys processingKeyword, customer, name, startTS, latestUpdateTS, status, processingContext, processingId , processingName, callingContext, editionContext, processingName, dataset, name, project , id, and name are unchanged and follow the classic of mandatory payload, new keys can be added for specific needs and are described as above :

  • dataLocations : It is an array of two keys dictionaries named dataLocationName and dataLocationId which have String values respectively specifying the name associate to his dataLocation and its associated MongoId.
  • hyperParameters : It is an array of three keys dictionaries named hyperParamName and value. Value of hyperParamName key is a String, the hyperParamName value carry the semantic of the hyperparameter. The value key correspod to the hyperparameter value and follow the type given by hyperParamType key.

Payload JSON template example :

{
  "processingKeyword": "distinct_processing_name_to_leverage_exec",
  "customer": "username",
  "name": "user defined name of the representation",
  "creationTS": 17267393322,
  "latestUpdateTS": 17267393344,
  "status": 1,
  "dataLocations": [
    {
      "role": "hardclustering_parquet",
      "dataLocationId": "62bc108b8c51f362811989c8"
    },
    {
      "role": "som_model_mongo",
      "dataLocationId": "62bc108b8c51f362811989c8"
    }
  ],
  "processingContext": {
    "processingName": "user define name, ex SOM",
    "editionContext": "user",
    "callingContext": "hephIA-solution",
    "view": {
      "id": "637ce534dd85c10875c4fe26",
      "name": "view_11-22-2022_15:05:24"
    },
    "dataset": {
      "name": "my_dataset"
    },
    "project": {
      "id": 2,
      "name": "SOM"
    }
  },
  "hyperParameters": {
    "hyperparam1": [
      "domain1",
      "domain2",
      "domain3"
    ],
    "hyperparam2": [
      [
        0.0,
        1.1
      ],
      [
        2.2,
        3.3
      ]
    ],
    "hyperparam3": ","
  }
}

(client_to_workflow_manager_payload_list)=

Payload list

This section gathers every payload between Client and the workflow manager including :