Azure Ai Translation Document Py

microsoft/skills/.github/plugins/azure-sdk-python/skills/azure-ai-translation-document-py

by microsoft3898ec894e90afdfdae982a925db28b6a7b334e3MIT3.2K starsListed Nov 20, 2026Updated Nov 20, 2026Repository updated today

Azure AI Document Translation SDK for batch translation of documents with format preservation. Use for translating Word, PDF, Excel, PowerPoint, and other document formats at scale. Triggers: "document translation", "batch translation", "translate documents", "DocumentTranslationClient".

FeaturedInstructions onlySoftware DevelopmentWriting & Content
AI-generated overview

Guides use of the Azure AI Document Translation Python SDK to batch-translate Word, PDF, Excel and PowerPoint files with format preserved.

What it does
Provides Python code patterns for the azure-ai-translation-document SDK: authenticating with DefaultAzureCredential or a legacy API key, starting batch translation jobs from Azure Blob Storage containers into one or more target languages, and translating a single document. It also covers polling job status, listing per-document results, cancelling operations, applying CSV glossaries, and querying supported formats and languages, plus sync and async client usage.
When to use it
Use when translating documents such as DOCX, PDF, PPTX or XLSX at scale, or when writing Python code that calls DocumentTranslationClient or SingleDocumentTranslationClient. Also relevant for monitoring or cancelling translation jobs and enforcing domain terminology with glossaries.
Requirements
Requires the azure-ai-translation-document Python package and azure-identity, an Azure AI Translator resource endpoint, and Azure Blob Storage containers with SAS tokens for source and target documents. Credentials come from DefaultAzureCredential or an API key; network access to Azure is needed. Instructions only, no bundled scripts.

Azure AI Document Translation SDK for Python

Client library for Azure AI Translator document translation service for batch document translation with format preservation.

Installation

bash
pip install azure-ai-translation-document

Environment Variables

bash
AZURE_DOCUMENT_TRANSLATION_ENDPOINT=https://<resource>.cognitiveservices.azure.com  # Required for all auth methods# Storage for source and target documentsAZURE_SOURCE_CONTAINER_URL=https://<storage>.blob.core.windows.net/<container>?<sas>  # Required for all auth methodsAZURE_TARGET_CONTAINER_URL=https://<storage>.blob.core.windows.net/<container>?<sas>  # Required for all auth methodsAZURE_TOKEN_CREDENTIALS=prod # Required only if DefaultAzureCredential is used in productionAZURE_DOCUMENT_TRANSLATION_KEY=<your-api-key>  # Only required for the legacy API-key auth path below

Authentication & Lifecycle

🔑 Two rules apply to every code sample below:

  1. Prefer DefaultAzureCredential. It works locally (Azure CLI / VS Code / Developer CLI) and in Azure (managed identity, workload identity) with no code change. Avoid connection strings, account/API keys — they bypass Entra audit and rotation.
    • Local dev: DefaultAzureCredential works as-is.
    • Production: set AZURE_TOKEN_CREDENTIALS=prod (or AZURE_TOKEN_CREDENTIALS=<specific_credential>) to constrain the credential chain to production-safe credentials.
  2. Wrap every client in a context manager so HTTP transports, sockets, and token caches are released deterministically:
    • Sync: with <Client>(...) as client:
    • Async: async with <Client>(...) as client: and async with DefaultAzureCredential() as credential: (from azure.identity.aio)

Snippets may abbreviate this setup, but production code should always follow both rules.

python
import osfrom azure.identity import DefaultAzureCredential, ManagedIdentityCredentialfrom azure.ai.translation.document import DocumentTranslationClient
# Local dev: DefaultAzureCredential. Production: set AZURE_TOKEN_CREDENTIALS=prod or AZURE_TOKEN_CREDENTIALS=<specific_credential>credential = DefaultAzureCredential()# Or use a specific credential directly in production:# See https://learn.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python#credential-classes# credential = ManagedIdentityCredential()
with DocumentTranslationClient(    endpoint=os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"],    credential=credential,) as client:    statuses = list(client.list_translation_statuses())

Legacy: API Key (existing keyed deployments)

New code should use DefaultAzureCredential above. Use AzureKeyCredential only if you have an existing keyed deployment that hasn't been migrated to Entra ID yet — for example, regulated environments still completing their Entra rollout.

python
import osfrom azure.core.credentials import AzureKeyCredentialfrom azure.ai.translation.document import DocumentTranslationClient, SingleDocumentTranslationClient
with DocumentTranslationClient(    endpoint=os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"],    credential=AzureKeyCredential(os.environ["AZURE_DOCUMENT_TRANSLATION_KEY"]),) as client:    statuses = list(client.list_translation_statuses())
# SingleDocumentTranslationClient accepts the same key-based credential.

Basic Document Translation

python
import osfrom azure.ai.translation.document import DocumentTranslationClient, DocumentTranslationInput, TranslationTargetfrom azure.core.exceptions import HttpResponseErrorfrom azure.identity import DefaultAzureCredential
credential = DefaultAzureCredential()
with DocumentTranslationClient(    endpoint=os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"],    credential=credential,) as client:    source_url = os.environ["AZURE_SOURCE_CONTAINER_URL"]    target_url = os.environ["AZURE_TARGET_CONTAINER_URL"]
    try:        # Start translation job        poller = client.begin_translation(            inputs=[                DocumentTranslationInput(                    source_url=source_url,                    targets=[                        TranslationTarget(                            target_url=target_url,                            language="es"  # Translate to Spanish                        )                    ]                )            ]        )
        # Wait for completion        result = poller.result()
        print(f"Status: {poller.status()}")        print(f"Documents translated: {poller.details.documents_succeeded_count}")        print(f"Documents failed: {poller.details.documents_failed_count}")    except HttpResponseError as e:        print(f"Translation failed: {e.message}")        raise

Multiple Target Languages

python
poller = client.begin_translation(    inputs=[        DocumentTranslationInput(            source_url=source_url,            targets=[                TranslationTarget(target_url=target_url_es, language="es"),                TranslationTarget(target_url=target_url_fr, language="fr"),                TranslationTarget(target_url=target_url_de, language="de")            ]        )    ])

Translate Single Document

python
from azure.ai.translation.document import SingleDocumentTranslationClientfrom azure.identity import DefaultAzureCredential
with open("document.docx", "rb") as f:    document_content = f.read()
with SingleDocumentTranslationClient(endpoint, DefaultAzureCredential()) as single_client:    result = single_client.translate(        body=document_content,        target_language="es",        content_type="application/vnd.openxmlformats-officedocument.wordprocessingml.document"    )
# Save translated documentwith open("document_es.docx", "wb") as f:    f.write(result)

Check Translation Status

python
# Get all translation operationsoperations = client.list_translation_statuses()
for op in operations:    print(f"Operation ID: {op.id}")    print(f"Status: {op.status}")    print(f"Created: {op.created_on}")    print(f"Total documents: {op.documents_total_count}")    print(f"Succeeded: {op.documents_succeeded_count}")    print(f"Failed: {op.documents_failed_count}")

List Document Statuses

python
# Get status of individual documents in a joboperation_id = poller.iddocument_statuses = client.list_document_statuses(operation_id)
for doc in document_statuses:    print(f"Document: {doc.source_document_url}")    print(f"  Status: {doc.status}")    print(f"  Translated to: {doc.translated_to}")    if doc.error:        print(f"  Error: {doc.error.message}")

Cancel Translation

python
# Cancel a running translationclient.cancel_translation(operation_id)

Using Glossary

python
from azure.ai.translation.document import TranslationGlossary
poller = client.begin_translation(    inputs=[        DocumentTranslationInput(            source_url=source_url,            targets=[                TranslationTarget(                    target_url=target_url,                    language="es",                    glossaries=[                        TranslationGlossary(                            glossary_url="https://<storage>.blob.core.windows.net/glossary/terms.csv?<sas>",                            file_format="csv"                        )                    ]                )            ]        )    ])

Supported Document Formats

python
# Get supported formatsformats = client.get_supported_document_formats()
for fmt in formats:    print(f"Format: {fmt.format}")    print(f"  Extensions: {fmt.file_extensions}")    print(f"  Content types: {fmt.content_types}")

Supported Languages

python
# Get supported languageslanguages = client.get_supported_languages()
for lang in languages:    print(f"Language: {lang.name} ({lang.code})")

Async Client

python
from azure.ai.translation.document.aio import DocumentTranslationClientfrom azure.identity.aio import DefaultAzureCredential
async def translate_documents():    async with DefaultAzureCredential() as credential:        async with DocumentTranslationClient(            endpoint=endpoint,            credential=credential,        ) as client:            poller = await client.begin_translation(inputs=[...])            result = await poller.result()

Supported Formats

CategoryFormats
DocumentsDOCX, PDF, PPTX, XLSX, HTML, TXT, RTF
StructuredCSV, TSV, JSON, XML
LocalizationXLIFF, XLF, MHTML

Storage Requirements

  • Source and target containers must be Azure Blob Storage
  • Use SAS tokens with appropriate permissions:
    • Source: Read, List
    • Target: Write, List

Best Practices

  1. Pick sync OR async and stay consistent. Do not mix azure.xxx sync clients with azure.xxx.aio async clients in the same call path. Choose one mode per module.
  2. Always use context managers for clients and async credentials. Wrap every client in with Client(...) as client: (sync) or async with Client(...) as client: (async). For async DefaultAzureCredential from azure.identity.aio, also use async with credential: so tokens and transports are cleaned up.
  3. Use SAS tokens with minimal required permissions
  4. Monitor long-running operations with poller.status()
  5. Handle document-level errors by iterating document statuses
  6. Use glossaries for domain-specific terminology
  7. Separate target containers for each language
  8. Use async client for multiple concurrent jobs
  9. Check supported formats before submitting documents

Reference Files

FileContents
references/capabilities.md [blocked]Additional non-hero capabilities, operation-group coverage, and production checklists.
references/non-hero-scenarios.md [blocked]Dedicated non-hero examples for secondary/advanced scenarios.

Source and attribution

Source:microsoft/skillsin.github/plugins/azure-sdk-python/skills/azure-ai-translation-document-pyat commit3898ec8

License: MIT

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Add a badge to your README

Show readers this skill is listed on SourceWeft. The badge links to this page.

Preview of the “Listed on SourceWeft” badge
[![Listed on SourceWeft](https://sourceweft.com/badge/skills/gh-microsoft-skills-azure-ai-translation-document-py.svg)](https://sourceweft.com/skills/gh-microsoft-skills-azure-ai-translation-document-py?utm_source=readme&utm_medium=badge)

Report or request removal