Definition
Functional Requirements
Syntax
Semantics
Conformance Testing
Performance Assessment
Definition
Functional Requirements
- Header: The Data shall have Header “PGM-ENM-V1.0”.
- Identification: The Data shall carry the identifiers of the M‑Instance, of the U‑Environment and of the session, and a unique identifier and a time (EngagementMetricsID, EngagementMetricsTime).
- UserID: The Data may include identifier of the User.
- Level: The Data shall include engagement level, 0 to 1.
- Basis: The Data may include what the metrics rest on.
- Confidence: The Data may include confidence, 0 to 1.
- Metadata: The Data shall include DataXMData and may include DescrMetadata.
Syntax
https://schemas.mpai.community/PGM1/V1.0/data/EngagementMetrics.json
Semantics
Table 1 – Semantics of Engagement Metrics
| Label | Description |
| Header | Header of the Data Type, with the version. (required) |
| MInstance | Identifier of the M-Instance. (required) |
| UEnvironment | Identifier of the U-Environment. (required) |
| SessionID | Identifier of the A-User session. (required) |
| EngagementMetricsID | Identifier of this instance. (required) |
| EngagementMetricsTime | Time at which the Data was produced. (required) |
| UserID | Identifier of the User. |
| Level | Engagement level, 0 to 1. (required) |
| Mode | RQ for a Request, RS for a Response. (required) |
| Basis | What the metrics rest on. Each one of: baseline_state, cadence_history, request. |
| Confidence | Confidence, 0 to 1. |
| DataXMData | Data Exchange Metadata of MPAI-PTF: provenance, authorisation, security and confidence of the Data. |
| DescrMetadata | Descriptive metadata (plain text, at most 2048 characters). |
Conformance Testing
Data conforms with Engagement Metrics if it validates against the schema of Section 3. If a schema contains references to other schemas, conformance of data for the primary schema implies that any data referencing a secondary schema shall also validate against the relevant schema.
Performance Assessment
Not part of this specification.