@oddkin/ai 0.0.0-stage → 1.0.0-beta.1

package/schemas/oddkin.ai.message.v1.schema.json

@@ -0,0 +1,339 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/ai/oddkin.ai.message.v1.schema.json",
+  "title": "oddkin.ai.message",
+  "description": "One message. Parts are ordered; ids are stable across updates.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1
+    },
+    "role": {
+      "enum": [
+        "user",
+        "assistant",
+        "system",
+        "tool"
+      ]
+    },
+    "parentId": {
+      "description": "Previous message on this branch; siblings are alternatives.",
+      "type": "string",
+      "minLength": 1
+    },
+    "parts": {
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "const": "text"
+              },
+              "id": {
+                "description": "Stable part id.",
+                "type": "string",
+                "minLength": 1
+              },
+              "text": {
+                "description": "Canonical source text (Markdown for assistant text).",
+                "type": "string"
+              },
+              "state": {
+                "description": "Whether more text may arrive.",
+                "enum": [
+                  "streaming",
+                  "done"
+                ]
+              }
+            },
+            "required": [
+              "type",
+              "id",
+              "text"
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "const": "reasoning"
+              },
+              "id": {
+                "description": "Stable part id.",
+                "type": "string",
+                "minLength": 1
+              },
+              "text": {
+                "description": "Canonical source text (Markdown for assistant text).",
+                "type": "string"
+              },
+              "state": {
+                "description": "Whether more text may arrive.",
+                "enum": [
+                  "streaming",
+                  "done"
+                ]
+              }
+            },
+            "required": [
+              "type",
+              "id",
+              "text"
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "const": "file"
+              },
+              "id": {
+                "type": "string",
+                "minLength": 1
+              },
+              "name": {
+                "description": "Untrusted file name; rendered as text.",
+                "type": "string"
+              },
+              "mediaType": {
+                "type": "string"
+              },
+              "url": {
+                "description": "Where the file can be fetched; checked by the URL policy.",
+                "type": "string",
+                "format": "uri-reference",
+                "pattern": "^(?![\\u0000-\\u0020]*(?:[jJ]\\s*[aA]\\s*[vV]\\s*[aA]\\s*[sS]\\s*[cC]\\s*[rR]\\s*[iI]\\s*[pP]\\s*[tT]|[vV]\\s*[bB]\\s*[sS]\\s*[cC]\\s*[rR]\\s*[iI]\\s*[pP]\\s*[tT])\\s*:)"
+              },
+              "size": {
+                "description": "Bytes.",
+                "type": "integer",
+                "minimum": 0
+              }
+            },
+            "required": [
+              "type",
+              "id",
+              "name",
+              "mediaType"
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "const": "source"
+              },
+              "id": {
+                "type": "string",
+                "minLength": 1
+              },
+              "sourceId": {
+                "description": "Citation key referenced from text as [^sourceId].",
+                "type": "string",
+                "minLength": 1
+              },
+              "title": {
+                "type": "string"
+              },
+              "url": {
+                "type": "string",
+                "format": "uri-reference",
+                "pattern": "^(?![\\u0000-\\u0020]*(?:[jJ]\\s*[aA]\\s*[vV]\\s*[aA]\\s*[sS]\\s*[cC]\\s*[rR]\\s*[iI]\\s*[pP]\\s*[tT]|[vV]\\s*[bB]\\s*[sS]\\s*[cC]\\s*[rR]\\s*[iI]\\s*[pP]\\s*[tT])\\s*:)"
+              },
+              "excerpt": {
+                "type": "string"
+              },
+              "publisher": {
+                "type": "string"
+              },
+              "kind": {
+                "enum": [
+                  "web",
+                  "document",
+                  "file",
+                  "other"
+                ]
+              }
+            },
+            "required": [
+              "type",
+              "id",
+              "sourceId"
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "const": "tool-call"
+              },
+              "id": {
+                "type": "string",
+                "minLength": 1
+              },
+              "toolCallId": {
+                "description": "Key of the tool call record; its state lives there.",
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "type",
+              "id",
+              "toolCallId"
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "const": "approval"
+              },
+              "id": {
+                "type": "string",
+                "minLength": 1
+              },
+              "approvalId": {
+                "description": "Key of the approval record.",
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "type",
+              "id",
+              "approvalId"
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "const": "artifact"
+              },
+              "id": {
+                "type": "string",
+                "minLength": 1
+              },
+              "artifactId": {
+                "description": "Key of the artifact record.",
+                "type": "string",
+                "minLength": 1
+              },
+              "revisionId": {
+                "description": "Revision this message produced.",
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "type",
+              "id",
+              "artifactId"
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "const": "data"
+              },
+              "id": {
+                "type": "string",
+                "minLength": 1
+              },
+              "name": {
+                "description": "Renderer registry key.",
+                "type": "string",
+                "minLength": 1
+              },
+              "data": {
+                "description": "Validated by the registered renderer before use."
+              }
+            },
+            "required": [
+              "type",
+              "id",
+              "name",
+              "data"
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "const": "unsupported"
+              },
+              "id": {
+                "type": "string",
+                "minLength": 1
+              },
+              "originalType": {
+                "description": "Type that could not be rendered.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "type",
+              "id",
+              "originalType"
+            ]
+          }
+        ]
+      }
+    },
+    "attemptId": {
+      "description": "Attempt that produced an assistant message.",
+      "type": "string",
+      "minLength": 1
+    },
+    "createdAt": {
+      "description": "ISO 8601 timestamp.",
+      "type": "string"
+    },
+    "provenance": {
+      "description": "Application-supplied origin information. Displayed as supplied, never verified.",
+      "type": "object",
+      "properties": {
+        "kind": {
+          "description": "How the content was produced.",
+          "enum": [
+            "generated",
+            "assisted",
+            "edited",
+            "human"
+          ]
+        },
+        "label": {
+          "description": "Host-supplied visible label.",
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "provider": {
+          "type": "string"
+        },
+        "generatedAt": {
+          "description": "ISO 8601 timestamp.",
+          "type": "string"
+        },
+        "notes": {
+          "description": "Host-supplied explanation, shown as is.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "kind"
+      ]
+    }
+  },
+  "required": [
+    "id",
+    "role",
+    "parts"
+  ]
+}

package/schemas/oddkin.ai.model-option.v1.schema.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/ai/oddkin.ai.model-option.v1.schema.json",
+  "title": "oddkin.ai.model-option",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1
+    },
+    "label": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "\\S"
+    },
+    "description": {
+      "type": "string"
+    },
+    "provider": {
+      "type": "string"
+    },
+    "capabilities": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "available": {
+      "type": "boolean"
+    },
+    "reason": {
+      "description": "Why the model is unavailable.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "label",
+    "available"
+  ]
+}

package/schemas/oddkin.ai.plan.v1.schema.json

@@ -0,0 +1,98 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/ai/oddkin.ai.plan.v1.schema.json",
+  "title": "oddkin.ai.plan",
+  "type": "object",
+  "properties": {
+    "planId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "title": {
+      "type": "string"
+    },
+    "steps": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1
+          },
+          "title": {
+            "type": "string",
+            "minLength": 1
+          },
+          "detail": {
+            "type": "string"
+          },
+          "status": {
+            "enum": [
+              "pending",
+              "active",
+              "done",
+              "failed",
+              "blocked",
+              "skipped",
+              "needs-input"
+            ]
+          },
+          "blocker": {
+            "description": "Why the step cannot continue.",
+            "type": "string"
+          },
+          "inputRequest": {
+            "description": "What the agent needs from the user.",
+            "type": "string"
+          },
+          "tasks": {
+            "description": "Work running in parallel within the step.",
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "title": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "status": {
+                  "enum": [
+                    "pending",
+                    "active",
+                    "done",
+                    "failed",
+                    "blocked",
+                    "skipped",
+                    "needs-input"
+                  ]
+                },
+                "detail": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "id",
+                "title",
+                "status"
+              ]
+            }
+          }
+        },
+        "required": [
+          "id",
+          "title",
+          "status"
+        ]
+      }
+    }
+  },
+  "required": [
+    "planId",
+    "steps"
+  ]
+}

package/schemas/oddkin.ai.question.v1.schema.json

@@ -0,0 +1,140 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/ai/oddkin.ai.question.v1.schema.json",
+  "title": "oddkin.ai.question",
+  "type": "object",
+  "properties": {
+    "questionId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "revision": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "prompt": {
+      "type": "string",
+      "minLength": 1
+    },
+    "kind": {
+      "enum": [
+        "choice",
+        "multi-choice",
+        "form",
+        "text"
+      ]
+    },
+    "options": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1
+          },
+          "label": {
+            "type": "string",
+            "minLength": 1,
+            "pattern": "\\S"
+          },
+          "description": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "label"
+        ]
+      }
+    },
+    "fields": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1
+          },
+          "label": {
+            "type": "string",
+            "minLength": 1,
+            "pattern": "\\S"
+          },
+          "type": {
+            "enum": [
+              "text",
+              "number",
+              "select",
+              "boolean"
+            ]
+          },
+          "required": {
+            "type": "boolean"
+          },
+          "options": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "id",
+          "label",
+          "type"
+        ]
+      }
+    },
+    "allowCustom": {
+      "description": "Offer a free-text answer.",
+      "type": "boolean"
+    },
+    "status": {
+      "enum": [
+        "requested",
+        "submitting",
+        "submitted",
+        "skipped",
+        "expired",
+        "failed"
+      ]
+    },
+    "answer": {},
+    "expiresAt": {
+      "description": "ISO 8601 timestamp.",
+      "type": "string"
+    },
+    "error": {
+      "description": "An error safe to show to users. Diagnostic details stay in host logs.",
+      "type": "object",
+      "properties": {
+        "code": {
+          "description": "Stable application-defined code.",
+          "type": "string",
+          "minLength": 1
+        },
+        "message": {
+          "description": "User-presentable message, localized by the host.",
+          "type": "string"
+        },
+        "retryable": {
+          "description": "Whether retrying the same operation may succeed.",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "code",
+        "message"
+      ]
+    }
+  },
+  "required": [
+    "questionId",
+    "revision",
+    "prompt",
+    "kind",
+    "status"
+  ]
+}

package/schemas/oddkin.ai.suggestion.v1.schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oddkin.dev/schemas/ai/oddkin.ai.suggestion.v1.schema.json",
+  "title": "oddkin.ai.suggestion",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1
+    },
+    "label": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "\\S"
+    },
+    "prompt": {
+      "description": "Text inserted or submitted.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "label",
+    "prompt"
+  ]
+}