Definition
Functional Requirements
Syntax
Semantics
Conformance Testing
Performance Assessment
Definition
Interaction History (PGM-IHI): The Data Type exchanged between any AIM of the A-User and Private Storage, through the Controller, for the content of earlier captures and turns of the session. It has two modes, told apart by Mode: Request (RQ), that states what is to be read and what is to be written, and Response (RS), that returns the content read and the outcome of the writes. SourceAIM states which AIM or Sub-AIM sends the Request or receives the Response, and Subject which medium or User it relates to. All access is under the rules set by A-User Control.
Functional Requirements
- Header: The Data shall have Header “PGM-IHI-V1.0” and Mode equal to RQ for a Request and to RS for a Response; the properties that belong to the other mode shall not be present.
- 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 (ExchangeID, ExchangeTime).
- Correlation: A Response shall carry the identifier (RequestID) of the Request that it answers.
- Source and Subject: The Data shall state in SourceAIM which AIM or Sub-AIM sends the Request or receives the Response, and in Subject which medium or User it relates to.
- Request: A Request may state what is to be read, by Category, capture index and Entity, and what is to be written, by Category; all access to Private Storage is made through the Controller under the rules set by A-User Control.
- Response: A Response shall carry the ExchangeID of its Request and may carry the content read, each item in the Data Type of its Category, and the outcome of the writes.
- Metadata: The Data shall include DataXMData and may include DescrMetadata.
Syntax
https://schemas.mpai.community/PGM1/V1.0/data/InteractionHistory.json
Semantics
Table 1 gives the properties common to the two modes, Table 2 those of the Request and Table 3 those of the Response.
Table 1 – Properties common to the Request and the Response of Interaction History
| Label | Description |
| Header | Header of the Data Type, with the version. (required) |
| Mode | RQ for a Request, RS for a Response. One of: RQ, RS. (required) |
| MInstance | Identifier of the M-Instance. (required) |
| UEnvironment | Identifier of the U-Environment. (required) |
| SessionID | Identifier of the A-User session. (required) |
| ExchangeID | Identifier of this Request or Response. (required) |
| ExchangeTime | Time at which the Data was produced. (required) |
| CaptureIndex | Position of the capture within the session to which the exchange refers. |
| SourceAIM | Header of the AIM or Sub-AIM that sends the Request or the Response (e.g., PGM-ASD-V1.0), or of the AIM to which a Response is sent. (required) |
| Subject | The medium or the entity the exchange relates to: the audio scene, the visual scene, the User, the alignment of audio and visual Entities, or the context, prompt, personality or deliberation of the A-User. One of: audio, visual, user, ava, context, prompt, personality, deliberation. (required) |
| UserIDs | Identifiers of the Users the exchange relates to, where the Subject is user. |
| DataXMData | Data Exchange Metadata of MPAI-PTF: provenance, authorisation, security and confidence of the Data. |
| DescrMetadata | Descriptive metadata (plain text, at most 2048 characters). |
Table 2 – Properties of the Request (Mode RQ)
| Label | Description |
| Read | What is to be read from Private Storage. |
| – Category | Category of the content, which is in the Data Type of the same name. One of: AudioSceneDescriptors, EnhancedAudioSceneDescriptors, AcousticProfile, AudioObjectTypes, SalienceResults, VisualSceneDescriptors, EnhancedVisualSceneDescriptors, VisualProfile, VisualObjectTypes, AffordanceTags, InteractionPotential, SalientObjectMatrix, HarmonisedMultimodalContext, LinguisticParalinguisticEvidence, BehaviouralExpressiveIndicators, CrossModalInterpretativeEvidence, UserState, HarmonisedEntityIDs, AssociationCandidates, EntityCorrespondences, UnmatchedEntities, JointSalience, AlignedEntityIDs, ContextDescriptors, PCPrompt, BKNResponse, Turns. (required) |
| – FromCaptureIndex | From Capture Index. |
| – ToCaptureIndex | To Capture Index. |
| – EntityIDs | Entity IDs. |
| Write | What is to be written to Private Storage. |
| – Category | Category of the content, which is in the Data Type of the same name. One of: AudioSceneDescriptors, EnhancedAudioSceneDescriptors, AcousticProfile, AudioObjectTypes, SalienceResults, VisualSceneDescriptors, EnhancedVisualSceneDescriptors, VisualProfile, VisualObjectTypes, AffordanceTags, InteractionPotential, SalientObjectMatrix, HarmonisedMultimodalContext, LinguisticParalinguisticEvidence, BehaviouralExpressiveIndicators, CrossModalInterpretativeEvidence, UserState, HarmonisedEntityIDs, AssociationCandidates, EntityCorrespondences, UnmatchedEntities, JointSalience, AlignedEntityIDs, ContextDescriptors, PCPrompt, BKNResponse, Turns. (required) |
| – Content | The content, in the Data Type of the Category. (required) |
Table 3 – Properties of the Response (Mode RS)
| Label | Description |
| RequestID | ID of the Request this Response answers. |
| Items | The content read, in the Data Type of its Category. |
| – Category | Category of the content, which is in the Data Type of the same name. One of: AudioSceneDescriptors, EnhancedAudioSceneDescriptors, AcousticProfile, AudioObjectTypes, SalienceResults, VisualSceneDescriptors, EnhancedVisualSceneDescriptors, VisualProfile, VisualObjectTypes, AffordanceTags, InteractionPotential, SalientObjectMatrix, HarmonisedMultimodalContext, LinguisticParalinguisticEvidence, BehaviouralExpressiveIndicators, CrossModalInterpretativeEvidence, UserState, HarmonisedEntityIDs, AssociationCandidates, EntityCorrespondences, UnmatchedEntities, JointSalience, AlignedEntityIDs, ContextDescriptors, PCPrompt, BKNResponse, Turns. (required) |
| – CaptureIndex | Capture Index. |
| – Content | Content. (required) |
| WriteOutcome | Outcome of the writes of the Request. |
| – Category | Category of the content, which is in the Data Type of the same name. One of: AudioSceneDescriptors, EnhancedAudioSceneDescriptors, AcousticProfile, AudioObjectTypes, SalienceResults, VisualSceneDescriptors, EnhancedVisualSceneDescriptors, VisualProfile, VisualObjectTypes, AffordanceTags, InteractionPotential, SalientObjectMatrix, HarmonisedMultimodalContext, LinguisticParalinguisticEvidence, BehaviouralExpressiveIndicators, CrossModalInterpretativeEvidence, UserState, HarmonisedEntityIDs, AssociationCandidates, EntityCorrespondences, UnmatchedEntities, JointSalience, AlignedEntityIDs, ContextDescriptors, PCPrompt, BKNResponse, Turns. (required) |
| – Result | Result of the operation. One of: written, not_authorised, not_attempted. (required) |
Conformance Testing
Data conforms with Interaction History if it validates against the schema of Section 3 and, if the Mode is RQ, contains the properties required for a Request and none of those of a Response, and vice versa. 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.
