Go to PGM-AUA V1.0 Data Types

Definition
Functional Requirements
Syntax
Semantics
Conformance Testing
Performance Assessment

Definition

CXE Status (PGM‑CES) is the Status produced by Context Enhancement in response to a CXE Directive. It reports, for each requested deliverable, whether Context Enhancement produced it, produced it partially, or could not, with the identifier of the produced result; the data itself flows along the pipeline to Prompt Creation, while only its identifier is reported to A‑User Control. It reports the outcome of each requested semantic property, the state of each installed watch and the time any watch fired, and object‑identity events, including the promotion of an object to a User, so that A‑User Control keeps its references valid. It is correlated to the directive it answers.

Functional Requirements

  1. Status Identification and Traceability: The status shall include a unique identifier (CXEStatusID) and a timestamp (CXEStatusTime) to ensure traceability.
  2. Directive Correlation: The status shall include the CXEDirectiveID of the CXE Directive to which it responds.
  3. Environment Identification: The status shall include identifiers for the M‑Instance (MInstance) and U‑Environment (UEnvironment).
  4. Session Identification: The status shall include a SessionID identifying the A‑User session.
  5. Deliverable Reporting: The status shall report, for each requested deliverable, the deliverable type, the outcome (produced, partial, or failed), and, where produced, the identifier of the produced result.
  6. Reason Reporting: Where a deliverable was not fully produced, the status shall report one or more structured reasons and, where relevant, the identifier of the entity that prevented production.
  7. Property Reporting: The status shall report, for each requested semantic property element, the outcome and the identifier of the produced result.
  8. Watch Reporting: The status shall report, for each installed watch, its state (armed, fired, expired, or unsatisfiable) and the time it fired where applicable.
  9. Identity Event Reporting: The status shall report object‑identity events (spawn, merge, or promotion to a User), with the parent and child identifiers, so that A‑User Control can maintain valid references.
  10. Data Exchange Metadata: The status shall include DataXMData.
  11. Descriptive Metadata: The status may include DescrMetadata.

Syntax

https://schemas.mpai.community/PGM1/V1.0/data/CXEStatus.json

Semantics

Label Description
Header CXE Status header identifier. Value: “PGM-CES-V1.0”.
MInstance Identifier of the M-Instance in which the status applies.
UEnvironment Identifier of the U-Environment associated with the status.
CXEStatusID Unique identifier for this CXE Status instance.
CXEStatusTime Timestamp indicating when the status was produced, compliant with MPAI-OSD V1.5.
SessionID Identifier of the A-User session to which the status belongs.
CXEDirectiveID Identifier of the CXE Directive to which this status responds.
Deliverables Per requested deliverable, the outcome of its production.
– Deliver The deliverable type this entry answers: EnhancedAudioSceneDescriptors | EnhancedVisualSceneDescriptors | UserEntityState.
– Outcome Outcome for this deliverable: produced | partial | failed.
– ProducedID Identifier of the produced result, present when produced. The data itself flows to Prompt Creation.
– Reasons Where not fully produced, one or more structured reasons, each with an optional EntityID.
– – Reason Structured reason: occluded | out_of_range | target_lost | no_signal | insufficient_data | ambiguous | not_a_user.
– – EntityID Identifier of the entity that prevented production, where relevant.
PropertyResults Per requested semantic property element, the outcome of its production.
– Element The element this entry answers, from the Properties vocabulary.
– Outcome Outcome for this element: produced | partial | failed.
– ResultID Identifier of the produced result, where applicable.
– EntityID Identifier of the entity the element concerns.
WatchEvents Per installed watch, its current state.
– WatchID Identifier of the watch this entry reports, correlating to the Directive.
– State State of the watch: armed | fired | expired | unsatisfiable.
– EventTime Time the watch fired, where applicable, compliant with MPAI-OSD V1.5.
IdentityEvents Object-identity events that A-User Control uses to keep its references valid.
– Event The kind of identity event: spawn | merge | promoted_to_user.
– ParentIDs Identifiers of the parent Object(s) involved in the event.
– ChildIDs Identifiers of the child Object(s) involved, or the resulting User identifier on promotion.
DataXMData Data Exchange Metadata compliant with MPAI-PTF V1.0.
DescrMetadata Optional descriptive metadata providing additional human-readable context.

Conformance Testing

Not part of this specification.

Performance Assessment

Not part of this specification.

Go to PGM-AUA V1.0 Data Types