Huginn/schemas/cultnet/epiphany.pipeline.memory.v2.schema.json

{
  "$defs": {
    "Label": {
      "description": "A key label: `[A-Za-z0-9_-]{1,64}`.",
      "maxLength": 64,
      "type": "string"
    },
    "Line": {
      "description": "Text of at most 1,000 UTF-8 bytes.",
      "maxLength": 1000,
      "type": "string"
    },
    "MemoryOrigin": {
      "description": "Where a memory came from and whom she heard it from. The organ derives it\nfrom the batch of the turn that wrote the memory; the model never writes it.\n`about` names whom a memory concerns, this names the room and the voices.",
      "oneOf": [
        {
          "additionalProperties": false,
          "description": "A turn in rooms: their aliases comma-joined, and the batch's other senders.",
          "properties": {
            "Room": {
              "properties": {
                "heard_from": {
                  "items": {
                    "$ref": "#/$defs/Short"
                  },
                  "maxItems": 8,
                  "type": "array"
                },
                "rooms": {
                  "$ref": "#/$defs/Short"
                }
              },
              "required": [
                "rooms",
                "heard_from"
              ],
              "type": "object"
            }
          },
          "required": [
            "Room"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "description": "A direct message: the DM's room id, and the others who spoke in it (whom\nshe heard it from in confidence).",
          "properties": {
            "Direct": {
              "properties": {
                "room": {
                  "$ref": "#/$defs/Short"
                },
                "with": {
                  "items": {
                    "$ref": "#/$defs/Short"
                  },
                  "maxItems": 8,
                  "type": "array"
                }
              },
              "required": [
                "room",
                "with"
              ],
              "type": "object"
            }
          },
          "required": [
            "Direct"
          ],
          "type": "object"
        },
        {
          "const": "Wake",
          "description": "A wake: no one spoke.",
          "type": "string"
        },
        {
          "additionalProperties": false,
          "description": "A Self run of hers, by its label.",
          "properties": {
            "SelfRun": {
              "properties": {
                "run": {
                  "$ref": "#/$defs/Short"
                }
              },
              "required": [
                "run"
              ],
              "type": "object"
            }
          },
          "required": [
            "SelfRun"
          ],
          "type": "object"
        }
      ]
    },
    "MemorySort": {
      "enum": [
        "Asked",
        "Decided",
        "Committed",
        "Learned",
        "Did",
        "Idea",
        "Rapport"
      ],
      "type": "string"
    },
    "PipelineKind": {
      "enum": [
        "Campaign",
        "Target",
        "Question",
        "Ruling",
        "CutSpec",
        "CutReport",
        "Verdict",
        "Finding",
        "FollowUp",
        "Resolution",
        "Instance",
        "Stewardship",
        "HandOff",
        "Run",
        "Pulse",
        "Memory"
      ],
      "type": "string"
    },
    "PipelineRef": {
      "description": "A reference to another document. The id is parsed as a full pipeline id of\nthe declared `kind`, so the kind and the id's kind segment cannot disagree.",
      "properties": {
        "id": {
          "$ref": "#/$defs/Short"
        },
        "kind": {
          "$ref": "#/$defs/PipelineKind"
        }
      },
      "required": [
        "kind",
        "id"
      ],
      "type": "object"
    },
    "Short": {
      "description": "Text of at most 200 UTF-8 bytes.",
      "maxLength": 200,
      "type": "string"
    },
    "Slug": {
      "description": "A campaign slug or key segment: label parts joined by `.`.",
      "maxLength": 64,
      "type": "string"
    }
  },
  "$id": "https://gamecult.dev/epiphany/cultnet/epiphany.pipeline.memory.v2.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "One thing a Mind keeps for herself, in her own mind: what she was asked,\ndecided, committed to, learned or did, an idea, or the rapport between\nher and another Mind or person. `text` is her own words. `about` names\nthe Matrix users it concerns (Minds included) and nothing about where it\ncame from; `origin` is where and from whom she learned it, and `sources`\nthe event ids, commits or documents it rests on; the organ fills both,\nnot the model. `salience_permille` ranks it and decides nothing.\n`consolidates` names the memories a consolidating memory replaces.\nInstance-rooted: the key is `<instance>:memory:<label>`.",
  "properties": {
    "about": {
      "items": {
        "$ref": "#/$defs/Short"
      },
      "maxItems": 8,
      "type": "array"
    },
    "consolidates": {
      "items": {
        "$ref": "#/$defs/PipelineRef"
      },
      "maxItems": 16,
      "type": "array"
    },
    "instance": {
      "$ref": "#/$defs/Slug"
    },
    "label": {
      "$ref": "#/$defs/Label"
    },
    "origin": {
      "$ref": "#/$defs/MemoryOrigin"
    },
    "salience_permille": {
      "format": "uint16",
      "maximum": 65535,
      "minimum": 0,
      "type": "integer"
    },
    "sort": {
      "$ref": "#/$defs/MemorySort"
    },
    "sources": {
      "items": {
        "$ref": "#/$defs/Short"
      },
      "maxItems": 8,
      "type": "array"
    },
    "text": {
      "$ref": "#/$defs/Line"
    }
  },
  "required": [
    "instance",
    "label",
    "sort",
    "text",
    "about",
    "origin",
    "sources",
    "salience_permille",
    "consolidates"
  ],
  "title": "PipelineMemory",
  "type": "object"
}