@crvouga/atlas 1.20.0 → 1.22.0

package/packages/schema/schemas/critic-review-result.schema.json

@@ -0,0 +1,397 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/critic-review-result.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean",
+      "const": true
+    },
+    "server": {
+      "type": "string"
+    },
+    "critic": {
+      "description": "The critic whose opinions are listed; null when none has judged anything",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "critics": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Every critic with an opinion, most opinions first"
+    },
+    "reviewer": {
+      "type": "string",
+      "description": "The name marks are recorded under"
+    },
+    "rankedBy": {
+      "type": "string",
+      "enum": [
+        "standing-within-kind",
+        "score"
+      ]
+    },
+    "summary": {
+      "type": "object",
+      "properties": {
+        "ranked": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "unranked": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Judged at an earlier picture, or the critic could not judge"
+        },
+        "unjudged": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "ranked",
+        "unranked",
+        "unjudged"
+      ],
+      "additionalProperties": {}
+    },
+    "entries": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "rank": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "exclusiveMinimum": 0,
+                "maximum": 9007199254740991
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "Null for an entry that is not ranked"
+          },
+          "key": {
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          },
+          "state": {
+            "type": "string"
+          },
+          "imageSha256": {
+            "type": "string"
+          },
+          "score": {
+            "type": [
+              "number",
+              "null"
+            ]
+          },
+          "percentile": {
+            "description": "Standing among the scores of the same state kind, 0..100, higher is better",
+            "type": [
+              "number",
+              "null"
+            ]
+          },
+          "label": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "currency": {
+            "type": "string",
+            "enum": [
+              "current",
+              "earlier-image"
+            ]
+          },
+          "failure": {
+            "description": "The reason code, when the critic could not judge it",
+            "type": "string"
+          },
+          "marks": {
+            "type": "object",
+            "properties": {
+              "state": {
+                "type": "string",
+                "enum": [
+                  "accepted",
+                  "dismissed",
+                  "disputed",
+                  "unmarked"
+                ],
+                "description": "`disputed`: reviewers disagree. `unmarked`: nobody has marked it at the current picture"
+              },
+              "accepted": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Reviewers who accepted it"
+              },
+              "dismissed": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Reviewers who dismissed it"
+              },
+              "earlier": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991,
+                "description": "Marks made about an earlier picture, which count for nothing now"
+              },
+              "notes": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "required": [
+              "state",
+              "accepted",
+              "dismissed",
+              "earlier",
+              "notes"
+            ],
+            "additionalProperties": {},
+            "description": "The marks of the whole opinion"
+          },
+          "findings": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "description": "A finding without an id cannot be marked on its own",
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                },
+                "category": {
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                },
+                "severity": {
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                },
+                "region": {
+                  "type": "object",
+                  "properties": {
+                    "unit": {
+                      "type": "string"
+                    },
+                    "x": {
+                      "type": "number"
+                    },
+                    "y": {
+                      "type": "number"
+                    },
+                    "w": {
+                      "type": "number"
+                    },
+                    "h": {
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "unit",
+                    "x",
+                    "y",
+                    "w",
+                    "h"
+                  ],
+                  "additionalProperties": {}
+                },
+                "rationale": {
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                },
+                "suggestion": {
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                },
+                "marks": {
+                  "anyOf": [
+                    {
+                      "type": "object",
+                      "properties": {
+                        "state": {
+                          "type": "string",
+                          "enum": [
+                            "accepted",
+                            "dismissed",
+                            "disputed",
+                            "unmarked"
+                          ],
+                          "description": "`disputed`: reviewers disagree. `unmarked`: nobody has marked it at the current picture"
+                        },
+                        "accepted": {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          },
+                          "description": "Reviewers who accepted it"
+                        },
+                        "dismissed": {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          },
+                          "description": "Reviewers who dismissed it"
+                        },
+                        "earlier": {
+                          "type": "integer",
+                          "minimum": 0,
+                          "maximum": 9007199254740991,
+                          "description": "Marks made about an earlier picture, which count for nothing now"
+                        },
+                        "notes": {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          }
+                        }
+                      },
+                      "required": [
+                        "state",
+                        "accepted",
+                        "dismissed",
+                        "earlier",
+                        "notes"
+                      ],
+                      "additionalProperties": {}
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                }
+              },
+              "required": [
+                "id",
+                "category",
+                "severity",
+                "rationale",
+                "suggestion",
+                "marks"
+              ],
+              "additionalProperties": {}
+            }
+          }
+        },
+        "required": [
+          "rank",
+          "key",
+          "title",
+          "state",
+          "imageSha256",
+          "score",
+          "percentile",
+          "label",
+          "currency",
+          "marks",
+          "findings"
+        ],
+        "additionalProperties": {}
+      }
+    },
+    "marked": {
+      "description": "Present when this call recorded (or, with --dry-run, would record) marks",
+      "type": "object",
+      "properties": {
+        "dryRun": {
+          "type": "boolean"
+        },
+        "reviewer": {
+          "type": "string"
+        },
+        "layer": {
+          "description": "The layer the marks were published as; null on a dry run or when nothing was marked",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "marks": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "entry": {
+                "type": "string"
+              },
+              "critic": {
+                "type": "string"
+              },
+              "finding": {
+                "description": "Null: the whole opinion",
+                "type": [
+                  "string",
+                  "null"
+                ]
+              },
+              "decision": {
+                "type": "string",
+                "enum": [
+                  "accept",
+                  "dismiss"
+                ]
+              }
+            },
+            "required": [
+              "entry",
+              "critic",
+              "finding",
+              "decision"
+            ],
+            "additionalProperties": {}
+          }
+        }
+      },
+      "required": [
+        "dryRun",
+        "reviewer",
+        "layer",
+        "marks"
+      ],
+      "additionalProperties": {}
+    }
+  },
+  "required": [
+    "ok",
+    "server",
+    "critic",
+    "critics",
+    "reviewer",
+    "rankedBy",
+    "summary",
+    "entries"
+  ],
+  "additionalProperties": {}
+}

package/packages/schema/schemas/critic-run-result.schema.json

@@ -0,0 +1,249 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/critic-run-result.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean",
+      "description": "False when a critic failed on any entry or a gate was crossed (the exit code is then 1)"
+    },
+    "dryRun": {
+      "type": "boolean"
+    },
+    "server": {
+      "type": "string"
+    },
+    "scope": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "type": "string"
+      },
+      "description": "The choices that narrowed the catalog, as given"
+    },
+    "critics": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "critic": {
+            "type": "string"
+          },
+          "version": {
+            "type": "string"
+          },
+          "sendsImagesTo": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "entries": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991,
+            "description": "Entries in the chosen scope"
+          },
+          "judged": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          },
+          "skipped": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991,
+            "description": "Entries that already had a current critique of the same identity (critic, version, model, parameters, image hash): no call was made"
+          },
+          "failed": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991,
+            "description": "Entries recorded as failed with a reason code; the next run retries them"
+          },
+          "waiting": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991,
+            "description": "Entries left unjudged because the run stopped"
+          },
+          "stoppedBy": {
+            "type": "string",
+            "enum": [
+              "budget",
+              "aborted"
+            ]
+          },
+          "failures": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "entry": {
+                  "type": "string"
+                },
+                "reason": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "entry",
+                "reason"
+              ],
+              "additionalProperties": {}
+            },
+            "description": "Each failed entry and its reason code"
+          },
+          "spent": {
+            "type": "object",
+            "properties": {
+              "images": {
+                "type": "number"
+              },
+              "tokens": {
+                "type": "number"
+              },
+              "costUsd": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "images",
+              "tokens",
+              "costUsd"
+            ],
+            "additionalProperties": {}
+          },
+          "published": {
+            "type": "object",
+            "properties": {
+              "layer": {
+                "description": "The layer id of the critiques, or null when nothing was published (a dry run, or nothing to publish)",
+                "type": [
+                  "string",
+                  "null"
+                ]
+              },
+              "critiques": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              }
+            },
+            "required": [
+              "layer",
+              "critiques"
+            ],
+            "additionalProperties": {}
+          },
+          "gate": {
+            "type": "object",
+            "properties": {
+              "mode": {
+                "type": "string",
+                "enum": [
+                  "report",
+                  "warn",
+                  "gate"
+                ]
+              },
+              "exitCode": {
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              },
+              "below": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991,
+                "description": "Scores below their state kind's threshold"
+              },
+              "warnings": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "refusal": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Why `gate` was refused, when it was"
+              }
+            },
+            "required": [
+              "mode",
+              "exitCode",
+              "below",
+              "warnings",
+              "refusal"
+            ],
+            "additionalProperties": {}
+          }
+        },
+        "required": [
+          "critic",
+          "version",
+          "sendsImagesTo",
+          "entries",
+          "judged",
+          "skipped",
+          "failed",
+          "waiting",
+          "failures",
+          "spent",
+          "published"
+        ],
+        "additionalProperties": {}
+      }
+    },
+    "spool": {
+      "type": "object",
+      "properties": {
+        "flushed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Objects from an earlier run that were sent now"
+        },
+        "spooled": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Objects of this run kept locally because the server could not be reached; the next invocation sends them"
+        },
+        "pending": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Objects still waiting in the spool"
+        }
+      },
+      "required": [
+        "flushed",
+        "spooled",
+        "pending"
+      ],
+      "additionalProperties": {}
+    },
+    "warnings": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "ok",
+    "dryRun",
+    "server",
+    "scope",
+    "critics",
+    "spool",
+    "warnings"
+  ],
+  "additionalProperties": {}
+}

package/packages/schema/schemas/critic-setup-result.schema.json

@@ -0,0 +1,34 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/critic-setup-result.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean"
+    },
+    "critic": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string"
+    },
+    "details": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "What was provisioned or checked. A checkpoint is verified against its pinned SHA-256; inference never downloads anything"
+    },
+    "error": {
+      "description": "Why setup failed, with no credential in it. The exit code is then 1",
+      "type": "string"
+    }
+  },
+  "required": [
+    "ok",
+    "critic",
+    "type",
+    "details"
+  ],
+  "additionalProperties": {}
+}