Azure · sergey-shandar · May 1, 2019 · Apr 17, 2019 · Apr 18, 2019 · Apr 18, 2019
@@ -0,0 +1,110 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "id": "{Model Id}",
+    "body": {
+        "formData": {
+        }
+    },
+	"form_stream": "{Image or Pdf file stream}"
+  },
+  "responses": {
+    "200": {
+      "body":{
+          "status": "success",
+          "pages": [
+            {
+              "number": 1,
+              "height": 800,
+              "width": 600,
+              "clusterId": 0,
+              "keyValuePairs": [
+                {
+                  "key": [
+                    {
+                      "text": "Address:",
+                      "boundingBox": [
+                        57.4,
+                        683.1,
+                        100.5,
+                        683.1,
+                        100.5,
+                        673.7,
+                        57.4,
+                        673.7
+                      ]
+                    }
+                  ],
+                  "value": [
+                    {
+                      "text": "1 Microsoft Way",
+                      "boundingBox": [
+                        57.4,
+                        672.2,
+                        126.6,
+                        672.2,
+                        126.6,
+                        658.9,
+                        57.4,
+                        658.9
+                      ],
+                      "confidence": 0.9
+                    }
+                  ]
+                }
+              ],
+              "tables": [
+                {
+                  "id": "table_0",
+                  "columns": [
+                    {
+                      "header": [
+                        {
+                          "text": "InvoiceNumber",
+                          "boundingBox": [
+                            38.5,
+                            585.2,
+                            113.4,
+                            585.2,
+                            113.4,
+                            575.8,
+                            38.5,
+                            575.8
+                          ]
+                        }
+                      ],
+                      "entries": [
+                        [
+                          {
+                            "text": "38772349",
+                            "boundingBox": [
+                              305.6,
+                              692.1,
+                              403.5,
+                              692.1,
+                              403.5,
+                              684.2,
+                              305.6,
+                              684.2
+                            ],
+                            "confidence": 0.9
+                          }
+                        ]
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          ],
+          "errors": [
+            {
+              "errorMessage": "Page1: Field not extracted"
+            }
+          ]
+        }
+    }
+  }
+}
@@ -0,0 +1,14 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "id": "{Model Id}",
+    "body": {
+    }
+  },
+  "responses": {
+    "204": {
+    }
+  }
+}
@@ -0,0 +1,26 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "id": "{Model Id}",
+    "body": {
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+          "clusters": {
+            "0": [
+              "Invoice",
+              "123112313"
+            ],
+            "1": [
+              "Please remit payment to:",
+              "Microsoft"
+            ]
+          }
+        }
+    }
+  }
+}
@@ -0,0 +1,20 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "id": "{Model Id}",
+    "body": {
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+          "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
+          "status": "ready",
+          "createdDateTime": "2019-05-01T10:53:21+00:00",
+          "lastUpdatedDateTime": "2019-05-01T10:53:23+00:00"
+      }
+    }
+  }
+}
@@ -0,0 +1,30 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "id": "{Model Id}",
+    "body": {
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+          "models": [
+            {
+              "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
+              "status": "ready",
+              "createdDateTime": "2019-05-01T10:53:21+00:00",
+              "lastUpdatedDateTime": "2019-05-01T10:53:23+00:00"
+            },
+            {
+              "modelId": "8dd53a98-bc73-43da-8533-60183824eb8e",
+              "status": "ready",
+              "createdDateTime": "2019-04-30T21:39:41+00:00",
+              "lastUpdatedDateTime": "2019-04-30T21:39:44+00:00"
+            }
+          ]
+        }
+    }
+  }
+}
@@ -0,0 +1,52 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "body": {
+    },
+    "trainRequest" : {
+        "source": "/input/data"
+    }
+  },
+  "responses": {
+    "200": {
+      "body":{
+          "modelId": "ad1901b6-ddaa-4249-8938-3f03f65cc893",
+          "trainingDocuments": [
+            {
+              "documentName": "0.pdf",
+              "pages": 1,
+              "errors": [],
+              "status": "success"
+            },
+            {
+              "documentName": "1.pdf",
+              "pages": 1,
+              "errors": [],
+              "status": "success"
+            },
+            {
+              "documentName": "2.pdf",
+              "pages": 1,
+              "errors": [],
+              "status": "success"
+            },
+            {
+              "documentName": "3.pdf",
+              "pages": 1,
+              "errors": [],
+              "status": "success"
+            },
+            {
+              "documentName": "4.pdf",
+              "pages": 1,
+              "errors": [],
+              "status": "success"
+            }
+          ],
+          "errors": []
+        }
+    }
+  }
+}
@@ -0,0 +1,47 @@
+Form Recognizer: API Review Feedback
+
+PR Link: https://github.com/Azure/azure-rest-api-specs/pull/5684
+
+Feedback:
+---------
+1. [shahabhijeet] Don't specify x-nullable: false.
+2. [shahabhijeet] Use x-ms-enum for Status field (or other enums)
+3. [shahabhijeet] Consider modeling error responses to something like: 
+{
+    "error": {
+        "code": "",
+        "message": "",
+        "target": "",
+        "additionalInfo": [],
+        "details": [
+            {
+                "code": "",
+                "target": "",
+               "message": "",
+                "additionalInfo": [
+                    {
+                        "type": "PolicyViolation",
+                        "info": {
+                            "policySetDefinitionDisplayName": "Secure the environment",
+                            "policySetDefinitionId":"/subscriptions/00000-00000-0000-000/providers/Microsoft.Authorization/policySetDefinitions/TestPolicySet",
+                            "policyDefinitionDisplayName": "Allowed locations",
+                            "policyDefinitionId":"/subscriptions/00000-00000-0000-000/providers/Microsoft.Authorization/policyDefinitions/TestPolicy1",
+                            "policyAssignmentDisplayName": "Allow Central US and WEU only",
+                            "policyAsssignmentId":"/subscriptions/00000-00000-0000-000/providers/Microsoft.Authorization/policyAssignments/TestAssignment1",
+                            ...
+                            ...
+                            ...
+                        }
+                    }
+                ]
+            }
+        ]
+    }
+}
+Also: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content 
+(this is not the updated link, as I am trying to find the updated model, will post as soon as I find it, hence provided an actual example.
+The format I am recommending allows you to have multiple error information objects as an array and "info" object is nothing but a generic JObject for dumping information like innerException.
+
+4. [johanste] /TrainCustomModel operation creates an addressable resource (keyed by the modelId in the response)
+This should probably return a 201 with a Location header pointing to the result.
+
@@ -0,0 +1,26 @@
+## Go
+
+These settings apply only when `--go` is specified on the command line.
+
+``` yaml $(go)
+go:
+  license-header: MICROSOFT_APACHE_NO_VERSION
+  namespace: formrecognizer 
+  clear-output-folder: true
+```
+
+### Go multi-api
+
+``` yaml $(go) && $(multiapi)
+batch:
+  - tag: release_1_0
+```
+
+### Tag: release_1_0 and go
+
+These settings apply only when `--tag=release_1_0 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.
+
+``` yaml $(tag) == 'release_1_0' && $(go)
+output-folder: $(go-sdk-folder)/services/cognitiveservices/v1.0/$(namespace)
+```