Developer API

Root Request Payload

The top-level ZeroTrain request object. It contains the complete input required for execution, including the feature values, network definition reference, and execution options.

Properties of Root Request Payload

NameTypeDescription
InputSourceJsonElementDefines the feature input values supplied to the ZeroTrain engine. The InputSource must represent a strict two-column tabular structure containing exactly: (1) Feature Name and (2) Feature Value. No additional columns are permitted. Supported value types include string, numeric types (int, decimal, double), datetime, and other compatible scalar types. Additional scalar types may be supported in future versions.
ModelSourceJsonElementDefines the tabular model input for ZeroTrain execution. The ModelSource represents structured, rectangular data used to build or evaluate the decision network. Supported formats include JSON tables, SQL result sets, DataVerse records, ADO XML, CSV, and Base64-encoded representations of these formats. Additional structured data formats may be supported in future versions.
OptionsInputModelOptionsRepresents optional execution settings that influence how ZeroTrain processes the request. This object may include confidence policy configuration, dataset behavior, output formatting, context handling, semantic options, and other runtime controls. All properties within this object are optional. Where not explicitly provided, system defaults will be applied when available.

Syntax

	REQUEST
    MODEL <TABULAR_DATA_SOURCE>
    INPUT <FEATURE_NAME_VALUE_PAIRS>
    OPTIONS <EXECUTION_SETTINGS>

Examples

	{
  "InputSource": {
    "LastPrice": 102.45,
    "Volume": 1500000,
    "VolatilityIndex": 22.8,
    "MovingAverageSpread": 1.35
  },
  "ModelSource": {
    "resultsets": {
      "TradingRules": [
        {
          "ID": "TR-001",
          "VolatilityIndex": ">= 20",
          "MovingAverageSpread": ">= 1.0",
          "Weight": 0.8,
          "IsEnabled": true,
          "Action": "Buy"
        },
        {
          "ID": "TR-002",
          "VolatilityIndex": "< 20",
          "MovingAverageSpread": "< 0",
          "Weight": 0.6,
          "IsEnabled": true,
          "Action": "Sell"
        },
        {
          "ID": "TR-003",
          "Weight": 0.2,
          "IsEnabled": true,
          "Action": "Hold"
        }
      ]
    }
  },
  "Options": {
    "DataSettings": {
      "ActionColumnName": "Action",
      "PriorityColumnName": "VolatilityIndex",
      "WeightColumnName": "Weight",
      "DecisionIdColumnName": "ID",
      "RowFilter": "IsEnabled = true",
      "ModelName": "TradingDecisionModel"
    },
    "ContextOptions": {
      "CustomTag": "Trade-Session-Alpha"
    },    
    "ConfidencePolicy": {
        "FitWeight": 1,
        "SeparationWeight": 0.03
    },
    "OutputSettings": {
      "ExecutionTraceMode": "Compact"
    }
  }
}