Go to MPAI-OSD V1.5 Data Types

Definition
Functional Requirements
Syntax
Semantics
Conformance Testing
Performance Assessment

1 Definition

A Data Type that lets a property carry either an Object or the identifier (ID) of an Object, by media type. It is defined by the four alternatives of Table 1.

2 Functional Requirements

  1. The Data shall have Header “OSD-OBI-V1.5”.
  2. The Data may include the other properties of Table 1, each as specified there.
  3. The Data shall validate against the JSON Schema of Section 3.

3 Syntax

https://schemas.mpai.community/OSD/V1.5/data/ObjectOrID.json

4 Semantics

Table 1 – Semantics of the Object or ID Data Type

Label
Description
Header Object or ID Header – Standard “OSD-OBI-Vx.y”.
3DModelObjectOrID Either one of the Objects 3DModelObject, or the ID (string) of the Object.
AudioObjectOrID Either one of the Objects BasicAudioObject or AudioObject, or the ID (string) of the Object.
SpeechObjectOrID Either one of the Objects BasicSpeechObject or SpeechObject, or the ID (string) of the Object.
VisualObjectOrID Either one of the Objects VisualObject, or the ID (string) of the Object.

5 Conformance Testing

A Data instance conforms with Object or ID (OSD-OBI) if it validates against the JSON 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.

6 Performance Assessment

Not part of this specification.

Go to MPAI-OSD V1.5 Data Types