Behaviour Fields

For a more condensed summary this information is available in table view

The specification for Behaviour has these fields:

version

Optional-string
Version number of the MA Pair, defined by the provider

Example

"0.21.0"

derivation

Optional-string
In case of derivation, references to parent / child (optional)

Example

ma_pair_123e4567-e89b-12d3 (auto)

name

Required-string
Short name to identify the MA Pair

Example

Pressure drop

description

Required-string
Short description of the scope of the MA Pair (human readable)

ip_family

Required-string
Identifier of the IP Family the MA Pair is valid for

Example

ip_family_123e4567-e89b-12d3

namespace

Optional-string
Context to interpret the associated information (optional?)

Example

namespace_123e4567-e89b-12d3

m_asset

Required-string
Identifier of the Model Asset associated to the MA Pair (NB: The corresponding model file is indicated in Model metadata (first tab) as Model_URI and the corresponding zip file needs to be served to the Algorithm to evaluate the Model by the Microservice (MODEL_FILENAME))

Note: This is a Foreign Key to model.id.

Example

"MODID_MYMODEL"

a_asset

Required-string
Identifiers of the Algorithm Asset associated to the MA Pair

Note: This is a Foreign Key to algorithm.id.

Example

"ALGID_MYALG"

rules

Optional-string[]
References to recommended Rules to be verified per Evaluation of the MA Pair

Example

rules_123e4567-e89b-12d3

frequency

Optional-integer
Recommended number of evaluations conducted per hour for the MA Pair (optional)

Example

12

payload

Optional-string
User-defined key-value pairs: JSON string with additional information (optional)

Example

{‘minPressure’: 90, ‘maxPressure’: 120}