new Batch Document Translation API Preview 1.0

custom-words.txt

@@ -187,6 +187,7 @@ BCDR
 BCWG
 beider
 Bfor
+bfqt
 bigint
 Bigram
 bigrams
@@ -1005,6 +1006,7 @@ octokit
 Odata
 odatatype
 ODBC
+officedocument
 OLTP
 onboarded
 Onboarding
@@ -1021,6 +1023,7 @@ openapi
 opencode
 opencontainers
 openid
+openxmlformats
 operationalinsights
 Operationalization
 operationresults
@@ -1290,6 +1293,7 @@ runcounts
 runid
 runsource
 runtimes
+rwdlacup
 rwxrw
 Saas
 salesforcetables
@@ -1429,6 +1433,7 @@ storageaccount
 storageaccounts
 storagedatalake
 storageimportexport
+storagesources
 storagesync
 storagetarget
 storageuri
@@ -1711,6 +1716,7 @@ Widevine
 windowsazuremediaservices
 windowsesu
 wlmengg
+wordprocessingml
 workbooktemplates
 Workernode
 workloadmonitor

specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/batch.json

@@ -0,0 +1,120 @@
+{
+  "parameters": {
+    "api-version": "v1.0-preview.1",
+    "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA",
+    "resourceGroupName": "TestResourceGroup",
+    "endpoint": "{endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "batchRequest": {
+      "inputs": [
+        {
+          "source": {
+            "sourceUrl": "https://myblob.blob.core.windows.net/sourceContainer",
+            "filter": {
+              "prefix": "pre",
+              "suffix": ".txt"
+            },
+            "language": "en",
+            "storageSource": "AzureBlob"
+          },
+          "targets": [
+            {
+              "targetUrl": "https://myblob.blob.core.windows.net/destinationContainer1",
+              "category": "general",
+              "language": "fr",
+              "glossaries": [
+                {
+                  "glossaryUrl": "https://myblob.blob.core.windows.net/myglossary/en_fr_glossary.xlf"
+                }
+              ],
+              "storageSource": "AzureBlob"
+            },
+            {
+              "targetUrl": "https://myblob.blob.core.windows.net/destinationContainer2",
+              "category": "general",
+              "language": "es",
+              "storageSource": "AzureBlob"
+            }
+          ]
+        }
+      ]
+    }
+  },
+  "responses": {
+    "401": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "Unauthorized",
+          "message": "User is not authorized",
+          "innerError": {
+            "code": 401000,
+            "error": "Unauthorized",
+            "message": "Operation is not authorized"
+          }
+        }
+      }
+    },
+    "429": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "RequestRateTooHigh",
+          "message": "User's request rate is too high",
+          "innerError": {
+            "code": 429000,
+            "error": "RateTooHigh",
+            "message": "Request rate is too high"
+          }
+        }
+      }
+    },
+    "500": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "InternalServerError",
+          "message": "Internal Server Error",
+          "innerError": {
+            "code": 500000,
+            "error": "Internal Server Error",
+            "message": "Unexpected internal server error has occurred"
+          }
+        }
+      }
+    },
+    "503": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "ServiceUnavailable",
+          "message": "Service is temporary unavailable",
+          "innerError": {
+            "code": 503000,
+            "error": "ServiceTemporaryUnavailable",
+            "message": "Service is currently unavailable.  Please try again later"
+          }
+        }
+      }
+    },
+    "202": {
+      "headers": {
+        "Operation-Location": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55"
+      }
+    },
+    "400": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "InvalidRequest",
+          "message": "Some argument is incorrect",
+          "innerError": {
+            "code": 400120,
+            "error": "SASTokenInvalid",
+            "message": "SAS token for storage is invalid"
+          }
+        }
+      }
+    }
+  }
+}

specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/cancel.json

@@ -0,0 +1,104 @@
+{
+  "parameters": {
+    "api-version": "v1.0-preview.1",
+    "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA",
+    "resourceGroupName": "TestResourceGroup",
+    "endpoint": "{endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "id": "727BF148-F327-47A0-9481-ABAE6362F11E"
+  },
+  "responses": {
+    "401": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "Unauthorized",
+          "message": "User is not authorized",
+          "target": "Operation",
+          "innerError": {
+            "code": 401000,
+            "error": "Unauthorized",
+            "message": "Operation is not authorized"
+          }
+        }
+      }
+    },
+    "429": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "RequestRateTooHigh",
+          "message": "User's request rate is too high",
+          "target": "Operation",
+          "innerError": {
+            "code": 429000,
+            "error": "RateTooHigh",
+            "message": "Request rate is too high"
+          }
+        }
+      }
+    },
+    "500": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "InternalServerError",
+          "message": "Internal Server Error",
+          "target": "Operation",
+          "innerError": {
+            "code": 500000,
+            "error": "Internal Server Error",
+            "message": "Unexpected internal server error has occurred"
+          }
+        }
+      }
+    },
+    "503": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "ServiceUnavailable",
+          "message": "Service is temporary unavailable",
+          "target": "Operation",
+          "innerError": {
+            "code": 503000,
+            "error": "ServiceTemporaryUnavailable",
+            "message": "Service is currently unavailable.  Please try again later"
+          }
+        }
+      }
+    },
+    "404": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "ResourceNotFound",
+          "message": "id not found",
+          "target": "Operation",
+          "innerError": {
+            "code": 404000,
+            "error": "ResourceNotFound",
+            "message": "Resource requested is not found"
+          }
+        }
+      }
+    },
+    "200": {
+      "headers": {},
+      "body": {
+        "id": "727bf148-f327-47a0-9481-abae6362f11e",
+        "createdDateTimeUtc": "2020-03-26T00:00:00Z",
+        "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
+        "status": "Succeeded",
+        "summary": {
+          "total": 10,
+          "failed": 1,
+          "success": 9,
+          "inProgress": 0,
+          "notYetStarted": 0,
+          "cancelled": 0
+        }
+      }
+    }
+  }
+}

specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/document.json

@@ -0,0 +1,104 @@
+{
+  "parameters": {
+    "api-version": "v1.0-preview.1",
+    "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA",
+    "resourceGroupName": "TestResourceGroup",
+    "endpoint": "{endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "id": "727BF148-F327-47A0-9481-ABAE6362F11E",
+    "documentId": 199800
+  },
+  "responses": {
+    "401": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "Unauthorized",
+          "message": "User is not authorized",
+          "target": "Document",
+          "innerError": {
+            "code": 401000,
+            "error": "Unauthorized",
+            "message": "Operation is not authorized"
+          }
+        }
+      }
+    },
+    "429": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "RequestRateTooHigh",
+          "message": "User's request rate is too high",
+          "target": "Document",
+          "innerError": {
+            "code": 429000,
+            "error": "RateTooHigh",
+            "message": "Request rate is too high"
+          }
+        }
+      }
+    },
+    "500": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "InternalServerError",
+          "message": "Internal Server Error",
+          "target": "Document",
+          "innerError": {
+            "code": 500000,
+            "error": "Internal Server Error",
+            "message": "Unexpected internal server error has occurred"
+          }
+        }
+      }
+    },
+    "503": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "ServiceUnavailable",
+          "message": "Service is temporary unavailable",
+          "target": "Document",
+          "innerError": {
+            "code": 503000,
+            "error": "ServiceTemporaryUnavailable",
+            "message": "Service is currently unavailable.  Please try again later"
+          }
+        }
+      }
+    },
+    "404": {
+      "headers": {},
+      "body": {
+        "error": {
+          "code": "ResourceNotFound",
+          "message": "id not found",
+          "target": "Document",
+          "innerError": {
+            "code": 404000,
+            "error": "ResourceNotFound",
+            "message": "Resource requested is not found"
+          }
+        }
+      }
+    },
+    "200": {
+      "headers": {
+        "retry-after": "30",
+        "ETag": "686897696a7c876b7e"
+      },
+      "body": {
+        "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt",
+        "createdDateTimeUtc": "2020-03-26T00:00:00Z",
+        "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
+        "status": "Running",
+        "detectedLanguage": "en",
+        "to": "fr",
+        "progress": 0.1,
+        "id": "273622bd-835c-4946-9798-fd8f19f6bbf2"
+      }
+    }
+  }
+}