Add ai field to result

pixee · Apr 24, 2024 · b3b0832 · b3b0832
1 parent 65f8fce
commit b3b0832
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/codetf.schema.json b/codetf.schema.json
@@ -102,6 +102,10 @@
           "type": "array",
           "description": "A set of file paths for files that the tool failed to fix",
           "items": { "$ref": "#/definitions/unfixedFinding" }
+        },
+        "ai": {
+          "description": "Metadata about AI tool used to generate the fix",
+          "$ref": "#/definitions/ai"
         }
       },
       "required": ["codemod", "summary", "description", "changeset"]
@@ -212,6 +216,24 @@
       "required": ["action", "result", "package"]
     },
 
+    "ai": {
+      "type": "object",
+      "properties": {
+        "provider": {
+          "type": "string",
+          "description": "Name of the AI provider used to generate this fix"
+        },
+        "model": {
+          "type": "string",
+          "description": "Name of the model used to generate this fix"
+        }
+        "tokens": {
+          "type": "integer",
+          "description": "Total number of tokens used to generate the fix" 
+        }
+      }
+    }
+
     "detectionTool": {
       "type": "object",
       "properties": {