@x12i/memorix-scoper-contracts 1.0.0

package/schemas/EvidenceBundle.schema.json

@@ -0,0 +1,469 @@
+{
+  "$ref": "#/definitions/EvidenceBundle",
+  "definitions": {
+    "EvidenceBundle": {
+      "type": "object",
+      "properties": {
+        "requestId": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "complete",
+            "partial",
+            "unavailable",
+            "rejected"
+          ]
+        },
+        "interpretation": {
+          "type": "object",
+          "properties": {
+            "objective": {
+              "type": "string"
+            },
+            "assumptions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "required": [
+            "objective",
+            "assumptions"
+          ],
+          "additionalProperties": false
+        },
+        "execution": {
+          "type": "object",
+          "properties": {
+            "catalogVersion": {
+              "type": "string"
+            },
+            "profiles": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "version": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "version"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "surfaces": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "estate-bag",
+                  "subject",
+                  "knowledge-explore"
+                ]
+              }
+            }
+          },
+          "required": [
+            "catalogVersion",
+            "profiles",
+            "surfaces"
+          ],
+          "additionalProperties": false
+        },
+        "evidence": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "evidenceId": {
+                "type": "string",
+                "minLength": 1
+              },
+              "fact": {
+                "type": "string",
+                "minLength": 1
+              },
+              "value": {},
+              "assertionType": {
+                "type": "string",
+                "minLength": 1
+              },
+              "relevance": {
+                "type": "string",
+                "minLength": 1
+              },
+              "ref": {
+                "anyOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "surface": {
+                        "type": "string",
+                        "const": "subject"
+                      },
+                      "objectType": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "contentType": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "recordId": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "revision": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "contractVersion": {
+                        "type": "string"
+                      },
+                      "field": {
+                        "type": "string",
+                        "minLength": 1
+                      }
+                    },
+                    "required": [
+                      "surface",
+                      "objectType",
+                      "contentType",
+                      "recordId",
+                      "revision",
+                      "field"
+                    ],
+                    "additionalProperties": false
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "surface": {
+                        "type": "string",
+                        "const": "estate-bag"
+                      },
+                      "product": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "variant": {
+                        "type": "string"
+                      },
+                      "recordId": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "field": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "snapshotSetId": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "analysisSnapshotId": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "liveGenerationId": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "surface",
+                      "product",
+                      "recordId",
+                      "field",
+                      "snapshotSetId",
+                      "analysisSnapshotId"
+                    ],
+                    "additionalProperties": false
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "surface": {
+                        "type": "string",
+                        "const": "knowledge-explore"
+                      },
+                      "entityId": {
+                        "type": "string"
+                      },
+                      "queryId": {
+                        "type": "string"
+                      },
+                      "field": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "backendGeneration": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "surface",
+                      "field"
+                    ],
+                    "additionalProperties": false
+                  }
+                ]
+              },
+              "source": {
+                "type": "object",
+                "properties": {
+                  "system": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "producer": {
+                    "type": "string"
+                  },
+                  "contractVersion": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "system"
+                ],
+                "additionalProperties": false
+              },
+              "observedAt": {
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "format": "date-time"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "publishedAt": {
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "format": "date-time"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "classification": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "evidenceId",
+              "fact",
+              "assertionType",
+              "relevance",
+              "ref",
+              "source",
+              "classification"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "coverage": {
+          "type": "object",
+          "properties": {
+            "complete": {
+              "type": "boolean"
+            },
+            "datasetsRead": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "datasetsSkipped": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "reason": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "reason"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "countChecks": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "dataset": {
+                    "type": "string"
+                  },
+                  "expected": {
+                    "type": "number"
+                  },
+                  "actual": {
+                    "type": "number"
+                  },
+                  "matched": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "dataset",
+                  "actual",
+                  "matched"
+                ],
+                "additionalProperties": false
+              }
+            }
+          },
+          "required": [
+            "complete",
+            "datasetsRead",
+            "datasetsSkipped",
+            "countChecks"
+          ],
+          "additionalProperties": false
+        },
+        "conflicts": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "description": {
+                "type": "string"
+              },
+              "evidenceIds": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "resolution": {
+                "type": "string",
+                "enum": [
+                  "unresolved",
+                  "source-precedence",
+                  "different-context"
+                ]
+              }
+            },
+            "required": [
+              "description",
+              "evidenceIds",
+              "resolution"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "unknowns": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "question": {
+                "type": "string"
+              },
+              "reason": {
+                "type": "string"
+              },
+              "missingDatasets": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "required": [
+              "question",
+              "reason"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "warnings": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "code": {
+                "type": "string"
+              },
+              "message": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "code",
+              "message"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "continuation": {
+          "anyOf": [
+            {
+              "type": "object",
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "enum": [
+                    "cursor",
+                    "refinement-required",
+                    "budget-exhausted"
+                  ]
+                },
+                "token": {
+                  "type": "string"
+                },
+                "suggestion": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "kind"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "traceId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "requestId",
+        "status",
+        "interpretation",
+        "execution",
+        "evidence",
+        "coverage",
+        "conflicts",
+        "unknowns",
+        "warnings",
+        "traceId"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/schemas/EvidenceItem.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "EvidenceItem",
+  "type": "object",
+  "properties": {
+    "id": { "type": "string" },
+    "ref": { "type": "object" },
+    "summary": { "type": "string" },
+    "epistemic": { "type": "string" },
+    "confidence": { "type": "number" },
+    "payload": {},
+    "tags": { "type": "array", "items": { "type": "string" } }
+  },
+  "required": ["id", "ref", "summary", "epistemic"]
+}

package/schemas/EvidenceRef.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "EvidenceRef",
+  "oneOf": [
+    { "type": "object", "required": ["kind"], "properties": { "kind": { "const": "subject" } } },
+    { "type": "object", "required": ["kind"], "properties": { "kind": { "const": "estate-bag" } } },
+    { "type": "object", "required": ["kind"], "properties": { "kind": { "const": "knowledge-explore" } } }
+  ]
+}

package/schemas/EvidenceSelection.schema.json

@@ -0,0 +1,83 @@
+{
+  "$ref": "#/definitions/EvidenceSelection",
+  "definitions": {
+    "EvidenceSelection": {
+      "type": "object",
+      "properties": {
+        "selectedEvidenceIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "conflicts": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "description": {
+                "type": "string"
+              },
+              "evidenceIds": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "resolution": {
+                "type": "string",
+                "enum": [
+                  "unresolved",
+                  "source-precedence",
+                  "different-context"
+                ]
+              }
+            },
+            "required": [
+              "description",
+              "evidenceIds",
+              "resolution"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "unknowns": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "question": {
+                "type": "string"
+              },
+              "reason": {
+                "type": "string"
+              },
+              "missingDatasets": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "required": [
+              "question",
+              "reason"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "notes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": [
+        "selectedEvidenceIds"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/schemas/RetrievalPlan.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "RetrievalPlan",
+  "type": "object",
+  "properties": {
+    "planId": { "type": "string" },
+    "rationale": { "type": "string" },
+    "steps": { "type": "array", "minItems": 1 },
+    "selections": { "type": "array" },
+    "answerDraft": { "type": "string" }
+  },
+  "required": ["planId", "rationale", "steps"]
+}

package/schemas/RetrievalPlan.schema.json

@@ -0,0 +1,73 @@
+{
+  "$ref": "#/definitions/RetrievalPlan",
+  "definitions": {
+    "RetrievalPlan": {
+      "type": "object",
+      "properties": {
+        "planId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "objective": {
+          "type": "string",
+          "minLength": 1
+        },
+        "profiles": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "steps": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "stepId": {
+                "type": "string",
+                "minLength": 1
+              },
+              "operationId": {
+                "type": "string",
+                "minLength": 1
+              },
+              "arguments": {
+                "type": "object",
+                "additionalProperties": {}
+              },
+              "dependsOn": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "purpose": {
+                "type": "string"
+              },
+              "optional": {
+                "type": "boolean"
+              }
+            },
+            "required": [
+              "stepId",
+              "operationId",
+              "arguments",
+              "dependsOn",
+              "purpose",
+              "optional"
+            ],
+            "additionalProperties": false
+          }
+        }
+      },
+      "required": [
+        "planId",
+        "objective",
+        "profiles",
+        "steps"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/schemas/RetrievalStep.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "RetrievalStep",
+  "type": "object",
+  "properties": {
+    "id": { "type": "string" },
+    "capability": { "type": "string" },
+    "catalogEntryId": { "type": "string" },
+    "args": { "type": "object" },
+    "parallelGroup": { "type": "string" },
+    "required": { "type": "boolean" }
+  },
+  "required": ["id", "capability", "catalogEntryId"]
+}