Document Translation operations
Reference
Feature: Azure AI Translator → Document Translation
Document Translation is a cloud-based feature of the Azure AI Translator service and is part of the Azure AI service family of REST APIs. The Batch Document Translation API translates documents across all supported languages and dialects while preserving document structure and data format. The available methods are listed in the following tables:
API Version: 2024-05-01
Note
The current version is backward compatible with the legacy version.
Starting with this current version, the
get supported storage sourcesmethod is no longer supported. The Translator service only supports Azure Blob storage.
| Request | Method | Description | API path |
|---|---|---|---|
| Single | Synchronous | Document | Translation |
| Translate document | POST | Synchronously translate a single document. | {document-translation-endpoint}/translator/document:translate?targetLanguage={target_language}&api-version={date} |
| Batch | Asynchronous | Documents | Translation |
| Start translation | POST | Start a batch document translation job. | {document-translation-endpoint}/translator/document/batches?api-version={date} |
| Get status for all translation jobs | GET | Request a list and the status of translation jobs submitted by the user. | {document-translation-endpoint}/translator/document/batches?api-version={date} |
| Get status for a specific translation job | GET | Request a summary of the status for a specific translation job. The response includes the overall job status and the status for documents that are being translated as part of that job. | {document-translation-endpoint}/translator/document/batches/{id}?api-version={date} |
| Get status for all documents | GET | Request the status of all documents in a translation job. | {document-translation-endpoint}/translator/document/batches/{id}/documents?api-version={date} |
| Get status for a specific document | GET | Request the status for a specific document in a job. | {document-translation-endpoint}/translator/document/batches/{id}/documents/{documentId}?api-version={date} |
| Cancel translation | DELETE | Cancel a document translation job that is currently processing or queued. | {document-translation-endpoint}/translator/document/batches/{id}?api-version={date} |
| Get supported document formats | GET | Request a list of supported document formats. | {document-translation-endpoint}/translator/document/formats?api-version={date}&type=document |
| Get supported glossary formats | GET | Request a list of supported glossary formats. | {document-translation-endpoint}/translator/document/formats?api-version={date}&type=glossary |
Legacy
Note
- The legacy version is backward compatible with the current version. You can use either version's operations to translate documents.
- We recommend migrating your applications to the newest version to benefit from an enhanced experience and advanced capabilities.
| Request | Method | Description | API path |
|---|---|---|---|
| Single | Synchronous | Document | Translation |
| Translate document | POST | Synchronously translate a single document. | {document-translation-endpoint}/translator/document:translate?sourceLanguage={source language}&targetLanguage={target language}&api-version=2024-05-01" -H "Ocp-Apim-Subscription-Key:{your-key}" -F "document={path-to-your-document-with-file-extension};type={ContentType}/{file-extension}" -F "glossary={path-to-your-glossary-with-file-extension};type={ContentType}/{file-extension}" -o "{path-to-output-file}" |
| Batch | Asynchronous | Documents | Translation |
| Start translation | POST | Start a batch document translation job. | {document-translation-endpoint}.cognitiveservices.azure.com/translator/text/batch/v1.1/batches |
| Get status for all translation jobs | GET | Request a list and the status of translation jobs submitted by the user. | {document-translation-endpoint}.cognitiveservices.azure.com/translator/text/batch/v1.1/batches |
| Get status for a specific translation job | GET | Request a summary of the status for a specific translation job. The response includes the overall job status and the status for documents that are being translated as part of that job. | {document-translation-endpoint}.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id} |
| Get status for all documents | GET | Request the status for a specific document in a job. | {document-translation-endpoint}.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}/documents |
| Get status for a specific document | GET | Request the status for a specific document in a job. | {document-translation-endpoint}.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}/documents/{documentId} |
| Cancel translation | DELETE | Cancel a document translation job that is currently processing or queued. | {document-translation-endpoint}.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id} |
| Get supported document formats | GET | Request a list of supported document formats. | {document-translation-endpoint}.cognitiveservices.azure.com/translator/text/batch/v1.1/documents/formats |
| Get supported glossary formats | GET | Request a list of supported glossary formats. | {document-translation-endpoint}.cognitiveservices.azure.com/translator/text/batch/v1.1/glossaries/formats |
| Get supported storage sources | GET | Request a list of supported storage sources/options. Currently, Translator service only supports Azure Blob storage. | {document-translation-endpoint}.cognitiveservices.azure.com/translator/text/batch/v1.1/storagesources |