← All message topics  ·  schema Agent/Intervention/agent_intervention_text_message.json  ·  matches spec topic agent/intervention/+/chat

header

FieldTypeRequiredAllowed valuesDescription
timestamp string
message_type string agent
version string The message format version

msg

FieldTypeRequiredAllowed valuesDescription
experiment_id string
trial_id string
timestamp string
source string
sub_type string Intervention:Chat
version string
replay_parent_type string|null TRIAL REPLAY null
replay_parent_id string|null
replay_id string|null

data

FieldTypeRequiredAllowed valuesDescription
id string
created string
agent string
start integer
duration integer
content string
type string json string html
receivers array<string>
renderers array<string>
explanation object
Raw JSON Schema (resolved)
{
  "$id": "http://asist.aptima.com/schemas/agent_intervention_message.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {},
  "properties": {
    "data": {
      "$id": "http://asist.aptima.com/schemas/text_intervention_object.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "agent": {
          "$id": "#/properties/agent",
          "examples": [
            "TA2-agent"
          ],
          "title": "Text Intervention agent Schema",
          "type": "string"
        },
        "content": {
          "$id": "#/properties/content",
          "examples": [
            "Time is running low, you should consider exploring unexplored areas."
          ],
          "pattern": "^(.*)$",
          "title": "Text Intervention Content String Schema",
          "type": "string"
        },
        "created": {
          "$id": "#/properties/created",
          "examples": [
            "2019-12-26T14:05:02.3412Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "Text Intervention Created Timestamp Schema",
          "type": "string"
        },
        "duration": {
          "$id": "#/properties/end",
          "examples": [
            10000,
            19400
          ],
          "title": "Text Intervention Duration Schema",
          "type": "integer"
        },
        "explanation": {
          "$id": "#/properties/explanation",
          "examples": [
            {
              "extra_agent_data": {
                "field0": "data0",
                "field1": {
                  "something": "something"
                },
                "field2": {
                  "somethingelse": "somethingelse"
                }
              }
            }
          ],
          "title": "Explanation Schema",
          "type": "object"
        },
        "id": {
          "$id": "#/properties/id",
          "examples": [
            "2daf58ab-f84f-48a6-89fd-c3c5d5558e97"
          ],
          "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}",
          "title": "Unique Text Intervention Id Schema",
          "type": "string"
        },
        "receivers": {
          "$id": "#/properties/receiver",
          "examples": [
            "P100",
            "P101"
          ],
          "items": {
            "type": "string"
          },
          "title": "The Receiver Schema",
          "type": "array"
        },
        "renderers": {
          "$id": "#/properties/renderer",
          "examples": [
            "Minecraft_Chat",
            "Minecraft_Block",
            "Client_Map"
          ],
          "items": {
            "enum": [
              "Minecraft_Chat",
              "Minecraft_Block",
              "Client_Map"
            ],
            "type": "string"
          },
          "title": "The Renderer Schema",
          "type": "array"
        },
        "start": {
          "$id": "#/properties/start",
          "examples": [
            -1,
            1205000,
            530200
          ],
          "title": "Text Intervention Start Schema",
          "type": "integer"
        },
        "type": {
          "$id": "#/properties/type",
          "enum": [
            "json",
            "string",
            "html"
          ],
          "examples": [
            "string"
          ],
          "title": "Text Intervention Type Schema",
          "type": "string"
        }
      },
      "required": [
        "id",
        "created",
        "start",
        "duration",
        "content",
        "receivers",
        "renderers",
        "explanation"
      ],
      "title": "The Text Intervention Object Schema",
      "type": "object",
      "version": "0.1"
    },
    "header": {
      "$id": "http://asist.aptima.com/schemas/common_header.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "message_type": {
          "$id": "#/properties/message_type",
          "const": "agent",
          "enum": [
            "control",
            "observation",
            "chat",
            "status",
            "trial",
            "event",
            "groundtruth",
            "experiment",
            "metadata",
            "agent"
          ],
          "examples": [
            "observation"
          ],
          "pattern": "^([a-z_]*?)$",
          "title": "The Message_type Schema",
          "type": "string"
        },
        "timestamp": {
          "$id": "#/properties/timestamp",
          "examples": [
            "2019-12-26T12:47:23.1234Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "The Timestamp Schema",
          "type": "string"
        },
        "version": {
          "$id": "#/properties/version",
          "examples": [
            "1.0",
            "2.3.1"
          ],
          "pattern": "^([0-9]+\\.)?([0-9]+\\.)?([0-9]+)$",
          "title": "The message format version",
          "type": "string"
        }
      },
      "required": [
        "timestamp",
        "message_type",
        "version"
      ],
      "title": "ASIST message common header Schema",
      "type": "object",
      "version": "0.3"
    },
    "msg": {
      "$id": "http://asist.aptima.com/schemas/event_message.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "experiment_id": {
          "$id": "#/properties/experiment_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|Null|null)",
          "title": "The Experiment Id Schema",
          "type": "string"
        },
        "replay_id": {
          "$id": "#/properties/replay_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Replay Id Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "replay_parent_id": {
          "$id": "#/properties/replay_parent_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Replay Parent Id Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "replay_parent_type": {
          "$id": "#/properties/replay_parent_type",
          "enum": [
            "TRIAL",
            "REPLAY",
            null
          ],
          "title": "The Replay Parent Type Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "source": {
          "$id": "#/properties/source",
          "default": "",
          "examples": [
            "simulator"
          ],
          "pattern": "^(.*)$",
          "title": "The Source Schema",
          "type": "string"
        },
        "sub_type": {
          "$id": "#/properties/sub_type",
          "const": "Intervention:Chat",
          "default": "",
          "examples": [
            "equip",
            "triage"
          ],
          "pattern": "^([a-zA-Z0-9_:]*?)$",
          "title": "The Sub Type Schema",
          "type": "string"
        },
        "timestamp": {
          "$id": "#/properties/timestamp",
          "default": "",
          "examples": [
            "2019-12-26T14:05:02.3412Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "The Timestamp Schema",
          "type": "string"
        },
        "trial_id": {
          "$id": "#/properties/trial_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Trial Id Schema",
          "type": "string"
        },
        "version": {
          "$id": "#/properties/version",
          "default": "",
          "examples": [
            "0.1",
            "1.0.1"
          ],
          "pattern": "^([.]*)|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
          "title": "The Version Schema",
          "type": "string"
        }
      },
      "required": [
        "experiment_id",
        "timestamp",
        "source",
        "sub_type",
        "version"
      ],
      "title": "The Event Message Schema",
      "type": "object",
      "version": "0.5"
    }
  },
  "required": [
    "header",
    "msg",
    "data"
  ],
  "title": "The Agent Intervention Message Schema",
  "type": "object",
  "version": "0.5"
}