@objectstack/spec 0.3.0 → 0.3.2

package/json-schema/ai/CostEntry.json

@@ -0,0 +1,106 @@
+{
+  "$ref": "#/definitions/CostEntry",
+  "definitions": {
+    "CostEntry": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique cost entry ID"
+        },
+        "timestamp": {
+          "type": "string",
+          "description": "ISO 8601 timestamp"
+        },
+        "modelId": {
+          "type": "string",
+          "description": "AI model used"
+        },
+        "provider": {
+          "type": "string",
+          "description": "AI provider (e.g., \"openai\", \"anthropic\")"
+        },
+        "operation": {
+          "type": "string",
+          "description": "Operation type (e.g., \"chat_completion\", \"embedding\")"
+        },
+        "promptTokens": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "completionTokens": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "totalTokens": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "requestCount": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 1
+        },
+        "promptCost": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Cost of prompt tokens"
+        },
+        "completionCost": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Cost of completion tokens"
+        },
+        "totalCost": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Total cost in base currency"
+        },
+        "currency": {
+          "type": "string",
+          "default": "USD"
+        },
+        "sessionId": {
+          "type": "string",
+          "description": "Conversation session ID"
+        },
+        "userId": {
+          "type": "string",
+          "description": "User who triggered the request"
+        },
+        "agentId": {
+          "type": "string",
+          "description": "AI agent ID"
+        },
+        "object": {
+          "type": "string",
+          "description": "Related object (e.g., \"case\", \"project\")"
+        },
+        "recordId": {
+          "type": "string",
+          "description": "Related record ID"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "metadata": {
+          "type": "object",
+          "additionalProperties": {}
+        }
+      },
+      "required": [
+        "id",
+        "timestamp",
+        "modelId",
+        "provider",
+        "operation",
+        "totalCost"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/CostMetricType.json

@@ -0,0 +1,17 @@
+{
+  "$ref": "#/definitions/CostMetricType",
+  "definitions": {
+    "CostMetricType": {
+      "type": "string",
+      "enum": [
+        "token",
+        "request",
+        "character",
+        "second",
+        "image",
+        "embedding"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/CostOptimizationRecommendation.json

@@ -0,0 +1,100 @@
+{
+  "$ref": "#/definitions/CostOptimizationRecommendation",
+  "definitions": {
+    "CostOptimizationRecommendation": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "switch_model",
+            "reduce_tokens",
+            "batch_requests",
+            "cache_results",
+            "adjust_parameters",
+            "limit_usage"
+          ]
+        },
+        "title": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "estimatedSavings": {
+          "type": "number",
+          "minimum": 0
+        },
+        "savingsPercentage": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1
+        },
+        "priority": {
+          "type": "string",
+          "enum": [
+            "low",
+            "medium",
+            "high"
+          ]
+        },
+        "effort": {
+          "type": "string",
+          "enum": [
+            "low",
+            "medium",
+            "high"
+          ]
+        },
+        "actionable": {
+          "type": "boolean",
+          "default": true
+        },
+        "actionSteps": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "targetModel": {
+          "type": "string"
+        },
+        "alternativeModel": {
+          "type": "string"
+        },
+        "affectedUsers": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "accepted",
+            "rejected",
+            "implemented"
+          ],
+          "default": "pending"
+        },
+        "implementedAt": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "title",
+        "description",
+        "priority",
+        "effort"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/CostQueryFilters.json

@@ -0,0 +1,112 @@
+{
+  "$ref": "#/definitions/CostQueryFilters",
+  "definitions": {
+    "CostQueryFilters": {
+      "type": "object",
+      "properties": {
+        "startDate": {
+          "type": "string",
+          "description": "ISO 8601 timestamp"
+        },
+        "endDate": {
+          "type": "string",
+          "description": "ISO 8601 timestamp"
+        },
+        "modelIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "providers": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "userIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "agentIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "operations": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "sessionIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "minCost": {
+          "type": "number",
+          "minimum": 0
+        },
+        "maxCost": {
+          "type": "number",
+          "minimum": 0
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "groupBy": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "model",
+              "provider",
+              "user",
+              "agent",
+              "object",
+              "operation",
+              "date",
+              "hour",
+              "tag"
+            ]
+          }
+        },
+        "orderBy": {
+          "type": "string",
+          "enum": [
+            "timestamp",
+            "cost",
+            "tokens"
+          ],
+          "default": "timestamp"
+        },
+        "orderDirection": {
+          "type": "string",
+          "enum": [
+            "asc",
+            "desc"
+          ],
+          "default": "desc"
+        },
+        "limit": {
+          "type": "integer",
+          "exclusiveMinimum": 0
+        },
+        "offset": {
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}