Parameters Fields

Available Fields

The metadata specification for a DIGITbrain Parameters has these sections:

name

Required-String- short name for this parameter (should be unique across the Microservice’s parameters)

Example

"detection_threshold"

type

Required-Enumeration [xsd datatypes]- expected input type (may be used to verify the input)

Example

"Integer"

mandatory

Optional-Boolean- whether this parameter is mandatory (default: false)

Example

true

defaultValue

Optional-has to match "type"- a default value, if the parameter is required but not provided

Example

description

Required-String- short description of the parameter and its possible values

Example

"This parameter can be used to configure the included algorithm in a certain way, possible values: 'A', 'B', 'Z'"