Swagger for Form Recognizer 2021-09-30-preview. (#16234)

* Swagger for Form Recognizer 2021-09-30-preview. * Fix styling issues. * Fix styling. * Remove yml version.
Azure · Oct 12, 2021 · 5591f02 · 5591f02
1 parent cac5414
commit 5591f02
Show file tree

Hide file tree

Showing 16 changed files with 9,610 additions and 0 deletions.
diff --git a/...ognitiveservices/data-plane/FormRecognizer/preview/2021-09-30-preview/FormRecognizer.json b/...ognitiveservices/data-plane/FormRecognizer/preview/2021-09-30-preview/FormRecognizer.json
diff --git a/...data-plane/FormRecognizer/preview/2021-09-30-preview/examples/AnalyzeDocument_Base64.json b/...data-plane/FormRecognizer/preview/2021-09-30-preview/examples/AnalyzeDocument_Base64.json
@@ -0,0 +1,20 @@
+{
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "{apiVersion}",
+    "modelId": "prebuilt-layout",
+    "pages": "1-2,4",
+    "locale": "en-US",
+    "stringIndexType": "textElements",
+    "analyzeRequest": {
+      "base64Source": "{base64EncodedPdf}"
+    }
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "Operation-Location": "{endpoint}/formrecognizer/documentModels/prebuilt-layout/analyzeResults/{resultId}?api-version={apiVersion}"
+      }
+    }
+  }
+}
diff --git a/...es/data-plane/FormRecognizer/preview/2021-09-30-preview/examples/AnalyzeDocument_Url.json b/...es/data-plane/FormRecognizer/preview/2021-09-30-preview/examples/AnalyzeDocument_Url.json
@@ -0,0 +1,20 @@
+{
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "{apiVersion}",
+    "modelId": "customModel",
+    "pages": "1-2,4",
+    "locale": "en-US",
+    "stringIndexType": "textElements",
+    "analyzeRequest": {
+      "urlSource": "http://host.com/doc.pdf"
+    }
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "Operation-Location": "{endpoint}/formrecognizer/documentModels/customModel/analyzeResults/{resultId}?api-version={apiVersion}"
+      }
+    }
+  }
+}
diff --git a/...-plane/FormRecognizer/preview/2021-09-30-preview/examples/AuthorizeCopyDocumentModel.json b/...-plane/FormRecognizer/preview/2021-09-30-preview/examples/AuthorizeCopyDocumentModel.json
@@ -0,0 +1,22 @@
+{
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "{apiVersion}",
+    "authorizeCopyRequest": {
+      "modelId": "{targetModelId}",
+      "description": "{targetModelDescription}"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "targetResourceId": "{targetResourceId}",
+        "targetResourceRegion": "{targetResourceRegion}",
+        "targetModelId": "{targetModelId}",
+        "targetModelLocation": "{targetEndpoint}/formrecognizer/documentModels/{targetModelId}?api-version={apiVersion}",
+        "accessToken": "{accessToken}",
+        "expirationDateTime": "2021-09-23T09:12:54.552Z"
+      }
+    }
+  }
+}
diff --git a/...ces/data-plane/FormRecognizer/preview/2021-09-30-preview/examples/BuildDocumentModel.json b/...ces/data-plane/FormRecognizer/preview/2021-09-30-preview/examples/BuildDocumentModel.json
@@ -0,0 +1,21 @@
+{
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "{apiVersion}",
+    "buildRequest": {
+      "modelId": "{modelId}",
+      "description": "{modelDescription}",
+      "azureBlobSource": {
+        "containerUrl": "https://{storageAccount}.blob.core.windows.net/{containerName}?{sasToken}",
+        "prefix": "{blobNamePrefix}"
+      }
+    }
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "Operation-Location": "{endpoint}/formrecognizer/operations/{operationId}?api-version={apiVersion}"
+      }
+    }
+  }
+}
diff --git a/...s/data-plane/FormRecognizer/preview/2021-09-30-preview/examples/ComposeDocumentModel.json b/...s/data-plane/FormRecognizer/preview/2021-09-30-preview/examples/ComposeDocumentModel.json
@@ -0,0 +1,25 @@
+{
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "{apiVersion}",
+    "composeRequest": {
+      "modelId": "{composedModelId}",
+      "description": "{composedModelDescription}",
+      "componentModels": [
+        {
+          "modelId": "{modelId1}"
+        },
+        {
+          "modelId": "{modelId2}"
+        }
+      ]
+    }
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "Operation-Location": "{endpoint}/formrecognizer/operations/{operationId}?api-version={apiVersion}"
+      }
+    }
+  }
+}
diff --git a/...es/data-plane/FormRecognizer/preview/2021-09-30-preview/examples/CopyDocumentModelTo.json b/...es/data-plane/FormRecognizer/preview/2021-09-30-preview/examples/CopyDocumentModelTo.json
@@ -0,0 +1,22 @@
+{
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "{apiVersion}",
+    "modelId": "sourceModel",
+    "copyToRequest": {
+      "targetResourceId": "{targetResourceId}",
+      "targetResourceRegion": "{targetResourceRegion}",
+      "targetModelId": "targetModel",
+      "targetModelLocation": "{targetEndpoint}/formrecognizer/documentModels/targetModel?api-version={apiVersion}",
+      "accessToken": "{accessToken}",
+      "expirationDateTime": "2021-09-23T09:12:54.552Z"
+    }
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "Operation-Location": "{endpoint}/formrecognizer/operations/{operationId}?api-version={apiVersion}"
+      }
+    }
+  }
+}
diff --git a/...veservices/data-plane/FormRecognizer/preview/2021-09-30-preview/examples/DeleteModel.json b/...veservices/data-plane/FormRecognizer/preview/2021-09-30-preview/examples/DeleteModel.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "{apiVersion}",
+    "modelId": "{modelId}"
+  },
+  "responses": {
+    "204": {}
+  }
+}