@objectstack/spec 0.3.0 → 0.3.1

package/json-schema/ai/BudgetStatus.json

@@ -0,0 +1,91 @@
+{
+  "$ref": "#/definitions/BudgetStatus",
+  "definitions": {
+    "BudgetStatus": {
+      "type": "object",
+      "properties": {
+        "budgetId": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "global",
+            "user",
+            "agent",
+            "object",
+            "project",
+            "department"
+          ]
+        },
+        "scope": {
+          "type": "string"
+        },
+        "periodStart": {
+          "type": "string",
+          "description": "ISO 8601 timestamp"
+        },
+        "periodEnd": {
+          "type": "string",
+          "description": "ISO 8601 timestamp"
+        },
+        "currentCost": {
+          "type": "number",
+          "minimum": 0,
+          "default": 0
+        },
+        "maxCost": {
+          "type": "number",
+          "minimum": 0
+        },
+        "currency": {
+          "type": "string",
+          "default": "USD"
+        },
+        "percentageUsed": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Usage as percentage (can exceed 1.0 if over budget)"
+        },
+        "remainingCost": {
+          "type": "number",
+          "description": "Remaining budget (can be negative if exceeded)"
+        },
+        "isExceeded": {
+          "type": "boolean",
+          "default": false
+        },
+        "isWarning": {
+          "type": "boolean",
+          "default": false
+        },
+        "projectedCost": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Projected cost for period"
+        },
+        "projectedOverage": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Projected overage"
+        },
+        "lastUpdated": {
+          "type": "string",
+          "description": "ISO 8601 timestamp"
+        }
+      },
+      "required": [
+        "budgetId",
+        "type",
+        "periodStart",
+        "periodEnd",
+        "maxCost",
+        "percentageUsed",
+        "remainingCost",
+        "lastUpdated"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/BudgetType.json

@@ -0,0 +1,17 @@
+{
+  "$ref": "#/definitions/BudgetType",
+  "definitions": {
+    "BudgetType": {
+      "type": "string",
+      "enum": [
+        "global",
+        "user",
+        "agent",
+        "object",
+        "project",
+        "department"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/ConversationAnalytics.json

@@ -0,0 +1,86 @@
+{
+  "$ref": "#/definitions/ConversationAnalytics",
+  "definitions": {
+    "ConversationAnalytics": {
+      "type": "object",
+      "properties": {
+        "sessionId": {
+          "type": "string"
+        },
+        "totalMessages": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "userMessages": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "assistantMessages": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "systemMessages": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "totalTokens": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "averageTokensPerMessage": {
+          "type": "number",
+          "minimum": 0
+        },
+        "peakTokenUsage": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "pruningEvents": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0
+        },
+        "summarizationEvents": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0
+        },
+        "tokensSavedByPruning": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0
+        },
+        "tokensSavedBySummarization": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0
+        },
+        "duration": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Session duration in seconds"
+        },
+        "firstMessageAt": {
+          "type": "string",
+          "description": "ISO 8601 timestamp"
+        },
+        "lastMessageAt": {
+          "type": "string",
+          "description": "ISO 8601 timestamp"
+        }
+      },
+      "required": [
+        "sessionId",
+        "totalMessages",
+        "userMessages",
+        "assistantMessages",
+        "systemMessages",
+        "totalTokens",
+        "averageTokensPerMessage",
+        "peakTokenUsage"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/ConversationContext.json

@@ -0,0 +1,48 @@
+{
+  "$ref": "#/definitions/ConversationContext",
+  "definitions": {
+    "ConversationContext": {
+      "type": "object",
+      "properties": {
+        "sessionId": {
+          "type": "string",
+          "description": "Conversation session ID"
+        },
+        "userId": {
+          "type": "string",
+          "description": "User identifier"
+        },
+        "agentId": {
+          "type": "string",
+          "description": "AI agent identifier"
+        },
+        "object": {
+          "type": "string",
+          "description": "Related object (e.g., \"case\", \"project\")"
+        },
+        "recordId": {
+          "type": "string",
+          "description": "Related record ID"
+        },
+        "scope": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Additional context scope"
+        },
+        "systemMessage": {
+          "type": "string",
+          "description": "System prompt/instructions"
+        },
+        "metadata": {
+          "type": "object",
+          "additionalProperties": {}
+        }
+      },
+      "required": [
+        "sessionId"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/ConversationMessage.json

@@ -0,0 +1,209 @@
+{
+  "$ref": "#/definitions/ConversationMessage",
+  "definitions": {
+    "ConversationMessage": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique message ID"
+        },
+        "timestamp": {
+          "type": "string",
+          "description": "ISO 8601 timestamp"
+        },
+        "role": {
+          "type": "string",
+          "enum": [
+            "system",
+            "user",
+            "assistant",
+            "function",
+            "tool"
+          ]
+        },
+        "content": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "enum": [
+                      "text",
+                      "image",
+                      "file",
+                      "code",
+                      "structured"
+                    ],
+                    "default": "text"
+                  },
+                  "text": {
+                    "type": "string",
+                    "description": "Text content"
+                  },
+                  "imageUrl": {
+                    "type": "string",
+                    "format": "uri",
+                    "description": "Image URL for vision models"
+                  },
+                  "fileUrl": {
+                    "type": "string",
+                    "format": "uri",
+                    "description": "File attachment URL"
+                  },
+                  "mimeType": {
+                    "type": "string",
+                    "description": "MIME type for files"
+                  },
+                  "metadata": {
+                    "type": "object",
+                    "additionalProperties": {},
+                    "description": "Additional metadata"
+                  }
+                },
+                "additionalProperties": false
+              }
+            }
+          ],
+          "description": "Message content (text or multimodal)"
+        },
+        "functionCall": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Function name"
+            },
+            "arguments": {
+              "type": "string",
+              "description": "JSON string of function arguments"
+            },
+            "result": {
+              "type": "string",
+              "description": "Function execution result"
+            }
+          },
+          "required": [
+            "name",
+            "arguments"
+          ],
+          "additionalProperties": false,
+          "description": "Legacy function call"
+        },
+        "toolCalls": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Tool call ID"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "function"
+                ],
+                "default": "function"
+              },
+              "function": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "Function name"
+                  },
+                  "arguments": {
+                    "type": "string",
+                    "description": "JSON string of function arguments"
+                  },
+                  "result": {
+                    "type": "string",
+                    "description": "Function execution result"
+                  }
+                },
+                "required": [
+                  "name",
+                  "arguments"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "required": [
+              "id",
+              "function"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Tool calls"
+        },
+        "toolCallId": {
+          "type": "string",
+          "description": "Tool call ID this message responds to"
+        },
+        "name": {
+          "type": "string",
+          "description": "Name of the function/user"
+        },
+        "tokens": {
+          "type": "object",
+          "properties": {
+            "prompt": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Tokens in prompt"
+            },
+            "completion": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Tokens in completion"
+            },
+            "total": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Total tokens"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Token usage for this message"
+        },
+        "pinned": {
+          "type": "boolean",
+          "default": false,
+          "description": "Prevent removal during pruning"
+        },
+        "importance": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1,
+          "description": "Importance score for pruning"
+        },
+        "embedding": {
+          "type": "array",
+          "items": {
+            "type": "number"
+          },
+          "description": "Vector embedding for semantic search"
+        },
+        "metadata": {
+          "type": "object",
+          "additionalProperties": {}
+        }
+      },
+      "required": [
+        "id",
+        "timestamp",
+        "role",
+        "content"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}