Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
d0c42a8
[Translation] Update azure-ai-translation-document to 2026-03-01 spec
Jul 5, 2026
29afdf9
[Translation] Release azure-ai-translation-document as 2.0.0 GA
Jul 5, 2026
d96c866
[Translation] Add 2026-03-01 live tests; use Entra ID storage auth in…
Jul 6, 2026
7d8dc25
[Translation] Reduce live test batch-job volume; drop unused storage …
Jul 6, 2026
d622b51
[Translation] Move client dispatch/serialization tests off-live to un…
Jul 6, 2026
b8497d3
[Translation] Re-record 2026-03-01 live tests; fix async mixed_filter…
Jul 7, 2026
9816308
[Translation] Add api.md and api.metadata.yml for API.md consistency …
Jul 7, 2026
30fb405
[Translation] Address PR review: honor translate_text_within_image fo…
Jul 7, 2026
8f6c3a0
Regenerate azure-ai-translation-document from spec PR 41433 (getSuppo…
Jul 13, 2026
35c99d0
Migrate azure-ai-translation-document customizations to new emitter (…
Jul 13, 2026
104f8b9
Re-record test_supported_formats and exclude Accept header in test ma…
Jul 13, 2026
067a45b
Fix CI: regenerate api.md, add package cspell for 'deser', harden pol…
Jul 13, 2026
8c7d08b
Harden poller _current_body against transient error responses
Jul 13, 2026
585d4af
Update README: default API version 2026-03-01, drop --pre for GA
Jul 13, 2026
84daff9
Wire patched SingleDocumentTranslationClient to fix duplicate transla…
Jul 22, 2026
d805852
Update api.metadata.yml for regenerated api.md (parser 0.3.30)
Jul 22, 2026
adca72b
Stop re-exporting models from top-level namespace (breaking change)
Jul 22, 2026
fc7ff66
Fix single-document translate multipart contract (ValueError regression)
Jul 22, 2026
cad2942
Require Python 3.9+ (types module uses builtin generics)
Jul 22, 2026
d10341a
Remove empty Bugs Fixed section from 2.0.0 changelog
Jul 22, 2026
c728209
Apply api_version_validation to custom translate overrides
Jul 22, 2026
18fda99
Add TranslationStatusSummary image-totals deserialization test
Jul 22, 2026
c3fb279
Regenerate azure-ai-translation-document from latest spec commit e7ef236
Jul 28, 2026
b1b5b8f
Update api.md for regenerated types
Jul 28, 2026
36ff710
Update api.metadata.yml parserVersion to 0.3.30
Jul 28, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions sdk/translation/azure-ai-translation-document/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,43 @@
# Release History

## 1.1.1 (Unreleased)
## 2.0.0 (2026-08-01)

### Features Added

- Added support for the `2026-03-01` service API version, which is now the default.
- Added image translation support: the `translate_text_within_image` keyword on `begin_translation`
for batch requests, and a `translate_text_within_image` keyword on `SingleDocumentTranslationClient.translate`
for single document requests. When enabled, each document's status also reports image scan usage.
- Added the `deployment_name` property to `TranslationTarget` and the `deployment_name` keyword to
`begin_translation` to specify the deployment name of the custom translation model for a batch
translation request.
- Added the `deployment_name` keyword to `SingleDocumentTranslationClient.translate` for single
document translation requests.
- Added the `deployment_name` property to `DocumentStatus`, exposing the deployment name of the
custom translation model used for the translation.
- Added image scan reporting to `DocumentStatus`: `image_characters_detected`, `images_charged`,
`total_image_scans_succeeded`, and `total_image_scans_failed`.
- Added image scan totals to `TranslationStatusSummary`: `total_image_scans_succeeded`,
`total_image_scans_failed`, and `total_images_charged`.
- Added the `BatchOptions` model for specifying batch translation options.

### Breaking Changes

### Bugs Fixed
- Changed the default service API version from `2024-05-01` to `2026-03-01`. To keep the previous
behavior, pass `api_version="2024-05-01"` when constructing the client.
- Models are no longer re-exported from the top-level `azure.ai.translation.document` namespace and
must now be imported from `azure.ai.translation.document.models`. This affects `TranslationGlossary`,
`TranslationTarget`, `DocumentTranslationInput`, `TranslationStatus`, `DocumentStatus`,
`DocumentTranslationError`, `DocumentTranslationFileFormat`, and `StorageInputType`. For example,
replace `from azure.ai.translation.document import TranslationStatus` with
`from azure.ai.translation.document.models import TranslationStatus`. The clients
(`DocumentTranslationClient`, `SingleDocumentTranslationClient`), `DocumentTranslationApiVersion`,
and `DocumentTranslationLROPoller` remain available at the top level.

### Other Changes

- This version and all future versions will require Python 3.9+. Python 3.8 is no longer supported.

## 1.1.0 (2024-11-15)

### Other Changes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ recursive-include samples *.py *.md
include azure/__init__.py
include azure/ai/__init__.py
include azure/ai/translation/__init__.py
recursive-include doc *.rst
10 changes: 6 additions & 4 deletions sdk/translation/azure-ai-translation-document/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ _Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For
Install the Azure Document Translation client library for Python with [pip][pip]:

```bash
pip install --pre azure-ai-translation-document
pip install azure-ai-translation-document
```

> Note: This version of the client library defaults to the v2024-05-01 version of the service
> Note: This version of the client library defaults to the `2026-03-01` version of the service.

#### Create a Translator resource

Expand Down Expand Up @@ -179,7 +179,8 @@ poller = document_translation_client.begin_translation("<sas_url_to_source>", "<
```python
import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.translation.document import DocumentTranslationClient, DocumentTranslationInput, TranslationTarget
from azure.ai.translation.document import DocumentTranslationClient
from azure.ai.translation.document.models import DocumentTranslationInput, TranslationTarget

endpoint = os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"]
key = os.environ["AZURE_DOCUMENT_TRANSLATION_KEY"]
Expand Down Expand Up @@ -302,7 +303,8 @@ Begin translating with documents in multiple source containers to multiple targe
```python
import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.translation.document import DocumentTranslationClient, DocumentTranslationInput, TranslationTarget
from azure.ai.translation.document import DocumentTranslationClient
from azure.ai.translation.document.models import DocumentTranslationInput, TranslationTarget

endpoint = os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"]
key = os.environ["AZURE_DOCUMENT_TRANSLATION_KEY"]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"apiVersion": "2026-03-01",
"apiVersions": {
"DocumentTranslation": "2026-03-01"
}
}
Loading
Loading