| 1. Definition | 2. Functional Requirements | 3. Syntax | 4. Semantics | 5. Conformance Testing |
1 Definition
What the instances of a flow of one Data Type on one Port have in common, given once by a Controller as a Zstandard dictionary (RFC 8878), so that each instance of the flow travels as one Zstandard frame compressed with it (Communication 9.1).
2 Functional Requirements
- A Bout applies to one Data Type, identified by its Header, on one Port, identified by its Data Type and Port Number.
- Its BoutID is an integer from 32768 to 2147483647, the range RFC 8878 leaves to private Dictionary_IDs. It is the Dictionary_ID of the Dictionary of the Bout and of every frame compressed with it.
- Its Dictionary is a Zstandard dictionary in the format of RFC 8878, section 5, written in Hexadecimal ASCII: its Dictionary_ID is the BoutID, its content the canonical form (PTF-JSON-CANON-V1) of an instance of the Data Type with its Data Exchange Metadata.
- Its SigningMode is EachInstance – every instance is signed – or Chain – every instance carries its chain value, and the instances whose Sequence is a multiple of ChainInterval, and the last, are signed (MPAI-PTF).
- Its MaxInstanceLength is the largest size, in bytes, of the canonical form of an instance.
- It carries its Data Exchange Metadata, with its Binding Data Type#Port Number@stamp/BoutID and the Signature of the Controller that gives it.
3 Syntax
https://schemas.mpai.community/AIF/V3.0/data/Bout.json
4 Semantics
| Label | Description |
|---|---|
| Header | Bout Header – Standard “AIF-BOU-Vx.y”. |
| MInstanceID | Identifier of the M-Instance where the Bout is defined. |
| UEnvironmentID | Identifier of the U-Environment where the Bout is defined. |
| BoutID | Identifier of the Bout and Dictionary_ID of its Dictionary and of its frames: an integer from 32768 to 2147483647, not reused by the Controller that gives it while its anchor is valid, nor by a User Agent while its Instance Credential is valid. |
| BoutTime | Time the Bout was given. |
| DataType | Header of the Data Type of the instances of the flow. |
| PortNumber | Port Number of the Port of that Data Type that the flow is on. |
| Method | The compression method: Zstandard (RFC 8878). |
| Dictionary | The Zstandard dictionary, in Hexadecimal ASCII. |
| SigningMode | EachInstance or Chain. |
| ChainInterval | In Chain mode, the number N of Functional Requirement 4. |
| RepeatInterval | Milliseconds between repetitions of the Bout; absent or 0: given on request only. |
| MaxInstanceLength | The largest size in bytes of the canonical form of an instance. |
| DataXMData | Data Exchange Metadata (MPAI-PTF) of the Bout: Source, Binding, Signature and KeyID. |
| DescrMetadata | Descriptive text. |
5 Conformance Testing
A Data instance conforms with Bout (AIF-BOU) if it validates against the Bout JSON Schema, its Dictionary is a Zstandard dictionary whose Dictionary_ID is its BoutID, and its Signature verifies as MPAI-PTF specifies. The test vectors (Bout-test-vectors.zip) give a Bout of each SigningMode with its instances and their frames.