Skip to content

Commit 60556b0

Browse files
authored
Merge pull request #276859 from laujan/launch-253516-unified-document-translation-api
document translation unified urls
2 parents 217e901 + 5d4988b commit 60556b0

30 files changed

+499
-603
lines changed

articles/ai-services/.openpublishing.redirection.ai-services-from-applied.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -660,6 +660,39 @@
660660
"source_path_from_root": "/articles/ai-services/document-intelligence/concept-retrieval-augumented-generation.md",
661661
"redirect_url": "/azure/ai-services/document-intelligence/concept-retrieval-augmented-generation",
662662
"redirect_document_id": true
663+
},
664+
{
665+
"source_path_from_root": "/articles/ai-services/translator/document-translation/quickstarts/asynchronous-rest-api.md",
666+
"redirect_url": "/azure/ai-services/translator/document-translation/how-to-guides/use-rest-api-programmatically",
667+
"redirect_document_id": true
668+
},
669+
{
670+
"source_path_from_root": "/articles/ai-services/translator/document-translation/quickstarts/synchronous-rest-api.md",
671+
"redirect_url": "/azure/ai-services/translator/document-translation/how-to-guides/use-rest-api-programmatically",
672+
"redirect_document_id": false
673+
},
674+
{
675+
"source_path_from_root": "/articles/ai-services/translator/document-translation/quickstarts/asynchronous-sdk.md",
676+
"redirect_url": "/azure/ai-services/translator/document-translation/quickstarts/client-library-sdks",
677+
"redirect_document_id": true
678+
},
679+
{
680+
"source_path_from_root": "/articles/ai-services/translator/document-translation/reference/synchronous-rest-api-guide.md",
681+
"redirect_url": "/azure/ai-services/translator/document-translation/reference/translate-document",
682+
"redirect_document_id": true
683+
684+
},
685+
{
686+
"source_path_from_root": "/articles/ai-services/translator/document-translation/reference/start-translation.md",
687+
"redirect_url": "/azure/ai-services/translator/document-translation/reference/start-batch-translation",
688+
"redirect_document_id": true
689+
690+
},
691+
{
692+
"source_path_from_root": "/articles/ai-services/translator/document-translation/reference/get-supported-storage-sources.md",
693+
"redirect_url": "/azure/ai-services/translator/document-translation/reference/rest-api-guide",
694+
"redirect_document_id": false
695+
663696
}
664697

665698
]

articles/ai-services/.openpublishing.redirection.ai-services-from-cog.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3593,7 +3593,7 @@
35933593
{
35943594
"source_path_from_root": "/articles/cognitive-services/translator/reference/rest-api-guide.md",
35953595
"redirect_url": "/azure/ai-services/translator/reference/rest-api-guide",
3596-
"redirect_document_id": true
3596+
"redirect_document_id": false
35973597
},
35983598
{
35993599
"source_path_from_root": "/articles/cognitive-services/translator/reference/v3-0-break-sentence.md",
@@ -4343,7 +4343,7 @@
43434343
{
43444344
"source_path_from_root": "/articles/cognitive-services/translator/document-translation/how-to-guides/use-rest-api-programmatically.md",
43454345
"redirect_url": "/azure/ai-services/translator/document-translation/how-to-guides/use-rest-api-programmatically",
4346-
"redirect_document_id": true
4346+
"redirect_document_id": false
43474347
},
43484348
{
43494349
"source_path_from_root": "/articles/cognitive-services/translator/document-translation/quickstarts/document-translation-rest-api.md",
@@ -4398,7 +4398,7 @@
43984398
{
43994399
"source_path_from_root": "/articles/cognitive-services/translator/document-translation/reference/rest-api-guide.md",
44004400
"redirect_url": "/azure/ai-services/translator/document-translation/reference/rest-api-guide",
4401-
"redirect_document_id": true
4401+
"redirect_document_id": false
44024402
},
44034403
{
44044404
"source_path_from_root": "/articles/cognitive-services/translator/document-translation/reference/start-translation.md",

articles/ai-services/reference/rest-api-resources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: eric-urban
66
manager: nitinme
77
ms.service: azure-ai-services
88
ms.topic: reference
9-
ms.date: 03/07/2024
9+
ms.date: 05/15/2024
1010
ms.author: lajanuar
1111
---
1212

@@ -32,7 +32,7 @@ Select a service from the table to learn how it can help you meet your developme
3232
| ![Face icon](../media/service-icons/face.svg) [Face](../computer-vision/overview-identity.md) | Detect and identify people and emotions in images | [Face API](../computer-vision/identity-api-reference.md) |
3333
| ![Language icon](../media/service-icons/language.svg) [Language](../language-service/index.yml) | Build apps with industry-leading natural language understanding capabilities | [REST API](/rest/api/language/) |
3434
| ![Speech icon](../media/service-icons/speech.svg) [Speech](../speech-service/index.yml) | Speech to text, text to speech, translation, and speaker recognition | **Speech APIs**<br>&bullet; [speech to text](../speech-service/rest-speech-to-text.md)<br>&bullet; [text to speech](../speech-service/rest-text-to-speech.md) |
35-
| ![Translator icon](../media/service-icons/translator.svg) [Translator](../translator/index.yml) | Translate more than 100 in-use, at-risk, and endangered languages and dialects | **Translator APIs**<br>&bullet; [text translation](../translator/reference/rest-api-guide.md) <br>&bullet; [batch translation](../translator/document-translation/reference/rest-api-guide.md) <br>&bullet; [synchronous translation](../translator/document-translation/reference/synchronous-rest-api-guide.md)|
35+
| ![Translator icon](../media/service-icons/translator.svg) [Translator](../translator/index.yml) | Translate more than 100 in-use, at-risk, and endangered languages and dialects | **Translator APIs**<br>&bullet; [text translation](../translator/reference/rest-api-guide.md) <br>&bullet; [document translation](../translator/document-translation/reference/rest-api-guide.md)|
3636
| ![Video Indexer icon](../media/service-icons/video-indexer.svg) [Video Indexer](/azure/azure-video-indexer) | Extract actionable insights from your videos | [Video Indexer API](/rest/api/videoindexer/accounts?view=rest-videoindexer-2024-01-01&preserve-view=true) |
3737
| ![Vision icon](../media/service-icons/vision.svg) [Vision](../computer-vision/index.yml) | Analyze content in images and videos | [Vision API](https://eastus.dev.cognitive.microsoft.com/docs/services/Cognitive_Services_Unified_Vision_API_2024-02-01/operations/61d65934cd35050c20f73ab6) |
3838

articles/ai-services/translator/containers/translate-document-parameters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ curl -v "http://localhost:5000/translator/document:translate?sourceLanguage=en&t
8282
## Next steps
8383

8484
> [!div class="nextstepaction"]
85-
> [Learn more about synchronous document translation](../document-translation/reference/synchronous-rest-api-guide.md)
85+
> [Learn more about synchronous document translation](../document-translation/reference/rest-api-guide.md)

articles/ai-services/translator/create-translator-resource.yml

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ metadata:
77
author: laujan
88
ms.author: lajanuar
99
manager: nitinme
10-
ms.date: 09/06/2023
10+
ms.date: 05/17/2024
1111
ms.service: azure-ai-translator
1212
ms.topic: how-to
1313
ms.custom:
@@ -26,16 +26,16 @@ procedureSection:
2626
Create your resource
2727
summary: |
2828
With your Azure account, you can access the Translator service through two different resource types:
29-
steps:
29+
steps:
3030
- |
31-
[**Single-service**](https://portal.azure.com/#create/Microsoft.CognitiveServicesTextTranslation) resource types enable access to a single service API key and endpoint.
31+
[**Single-service**](https://portal.azure.com/#create/Microsoft.CognitiveServicesTextTranslation) resource types enable access to a single service API key and endpoint. ***Document Translation is only supported in the single-service resources type***.
3232
- |
33-
[**Multi-service**](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource types enable access to multiple Azure AI services by using a single API key and endpoint.
34-
- title:
33+
[**Multi-service**](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource types enable access to multiple Azure AI services by using a single API key and endpoint. Document Translation is not supported in the multi-service resource type.
34+
- title:
3535
Complete your project and instance details
3636
summary: |
3737
After you decide which resource type you want use to access the Translator service, you can enter the details for your project and instance.
38-
steps:
38+
steps:
3939
- |
4040
**Subscription**. Select one of your available Azure subscriptions.
4141
- |
@@ -53,7 +53,7 @@ procedureSection:
5353
* Each subscription has a free tier.
5454
* The free tier has the same features and functionality as the paid plans and doesn't expire.
5555
* Only one free tier resource is available per subscription.
56-
* Document Translation is supported in paid tiers. The Language Studio only supports the S1 or D3 instance tiers. If you just want to try Document Translation, select the Standard S1 instance tier.
56+
* Document Translation is supported in paid tier only. The Language Studio only supports the S1 or D3 instance tiers. If you just want to try Document Translation, select the Standard S1 instance tier.
5757
- |
5858
If you create a multi-service resource, the links at the bottom of the **Basics** tab provide technical documentation regarding the appropriate operation of the service.
5959
- |
@@ -73,21 +73,21 @@ procedureSection:
7373
- title: |
7474
Get your authentication keys and endpoint
7575
summary: |
76-
To authenticate your connection to your Translator resource, you'll need to find its keys and endpoint.
76+
To authenticate your connection to your Translator resource, you need to find its keys and endpoint.
7777
steps:
7878
- |
7979
After your new resource deploys, select **Go to resource** or go to your resource page.
80-
- |
80+
- |
8181
In the left navigation pane, under **Resource Management**, select **Keys and Endpoint**.
82-
- |
82+
- |
8383
Copy and paste your keys and endpoint URL in a convenient location, such as Notepad.
8484
8585
:::image type="content" source="media/keys-and-endpoint-resource.png" alt-text="Screenshot of the Azure portal showing the Keys and Endpoint page of a Translator resource. The keys and endpoints are highlighted.":::
8686
- title: |
8787
Create a Text Translation client
8888
summary: |
8989
Text Translation supports both [global and regional endpoints](#complete-your-project-and-instance-details). Once you have your [authentication keys](#authentication-keys-and-endpoint-url), you need to create an instance of the `TextTranslationClient`, using an `AzureKeyCredential` for authentication, to interact with the Text Translation service:
90-
steps:
90+
steps:
9191
- |
9292
To create a `TextTranslationClient` using a global resource endpoint, you need your resource **API key**:
9393
@@ -102,39 +102,50 @@ procedureSection:
102102
AzureKeyCredential credential = new('<apiKey>');
103103
TextTranslationClient client = new(credential, '<region>');
104104
```
105+
- title: |
106+
Create a Document Translation client
107+
summary: |
108+
Use the Document Translation API to asynchronously translate large volumes of text and multiple documents across languages. The batch translation process requires an Azure Blob storage account with storage containers for your source and translated documents.
109+
steps:
110+
- |
111+
Document Translation is currently supported in the Translator (single-service) resource using S1 Standard Service Plan (Pay-as-you-go) or in the D3 Volume Discount Plan.
112+
113+
- |
114+
"For more information on creating a Translator resource for Document Translation, see [Prerequisites: Use Document Translation](document-translation/how-to-guides/use-rest-api-programmatically.md#prerequisites)".
115+
105116
- title: |
106117
How to delete a resource or resource group
107118
summary: |
108119
> [!WARNING]
109120
>
110121
> Deleting a resource group also deletes all resources contained in the group.
111-
122+
112123
To delete the resource:
113124
114-
1. Search and select **Resource groups** in the Azure portal, and select your resource group.
125+
1. Search and select ***Resource groups*** in the Azure portal, and select your resource group.
115126
116127
2. Select the resources to be deleted by selecting the adjacent check box.
117128
118-
3. Select **Delete** from the top menu near the right edge.
129+
3. Select ***Delete*** from the top menu near the right edge.
119130
120-
4. Enter *delete* in the **Delete Resources** dialog box.
131+
4. Enter **delete** in the ***Delete Resources*** dialog box.
132+
133+
5. Select ***Delete***.
121134
122-
5. Select **Delete**.
123-
124135
125136
To delete the resource group:
126-
steps:
127-
- |
137+
steps:
138+
- |
128139
Go to your Resource Group in the Azure portal.
129140
- |
130141
Select **Delete resource group** from the top menu bar.
131-
- |
142+
- |
132143
Confirm the deletion request by entering the resource group name and selecting **Delete**.
133-
144+
134145
nextStep:
135-
text: Get started with Translator
146+
text: Get started with Translator.
136147
url: quickstart-text-rest-api.md
137-
148+
138149
# - text: Get started with Translator
139150
# url: quickstart-text-rest-api.md
140151
# - text: Microsoft Translator code samples

articles/ai-services/translator/document-translation/document-sdk-overview.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ manager: nitinme
77
ms.service: azure-ai-translator
88
ms.custom: devx-track-python
99
ms.topic: conceptual
10-
ms.date: 02/12/2024
10+
ms.date: 05/21/2024
1111
ms.author: lajanuar
1212
recommendations: false
1313
---
@@ -17,7 +17,7 @@ recommendations: false
1717
<!-- markdownlint-disable MD001 -->
1818
<!-- markdownlint-disable MD051 -->
1919

20-
# Document Translation SDK
20+
# Document Translation SDKs
2121

2222
Document Translation is a cloud-based REST API feature of the Azure AI Translator service. The Document Translation API enables quick and accurate source-to-target whole document translations, asynchronously, in supported languages and various file formats. The Document Translation software development kit (SDK) is a set of libraries and tools that enable you to easily integrate Document Translation REST API capabilities into your applications.
2323

@@ -27,28 +27,28 @@ Document Translation SDK supports the following programming languages:
2727

2828
| Language → SDK version | Package|Client library| Supported API version|
2929
|:----------------------:|:----------|:----------|:-------------|
30-
|[.NET/C# → 1.0.0](https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.Translation.Document/1.0.0/index.html)| [NuGet](https://www.nuget.org/packages/Azure.AI.Translation.Document) | [Azure SDK for .NET](/dotnet/api/overview/azure/AI.Translation.Document-readme?view=azure-dotnet&preserve-view=true) | Document Translation v1.1|
31-
|[Python → 1.0.0](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-translation-document/1.0.0/index.html)|[PyPi](https://pypi.org/project/azure-ai-translation-document/1.0.0/)|[Azure SDK for Python](/python/api/overview/azure/ai-translation-document-readme?view=azure-python&preserve-view=true)|Document Translation v1.1|
30+
|🆕 [.NET/C# → 2.0.0-beta.1](https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.Translation.Document/2.0.0-beta.1/index.html)| [NuGet](https://www.nuget.org/packages/Azure.AI.Translation.Document/2.0.0-beta.1) | [Azure SDK for .NET](/dotnet/api/overview/azure/ai.translation.document-readme?branch=main&view=azure-dotnet-preview&preserve-view=true) | Document Translation `api-version=2024-05-01`|
31+
|🆕 [Python → 1.1.0b1](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-translation-document/1.1.0b1/index.html)|[PyPi](https://pypi.org/project/azure-ai-translation-document/1.1.0b1/)|[Azure SDK for Python](/python/api/overview/azure/ai-translation-document-readme?view=azure-python&preserve-view=true)|Document Translation `api-version=2024-05-01`|
3232

3333
## Changelog and release history
3434

3535
This section provides a version-based description of Document Translation feature and capability releases, changes, updates, and enhancements.
3636

3737
### [C#/.NET](#tab/csharp)
3838

39-
**Version 1.0.0 (GA)** </br>
40-
**2022-06-07**
39+
**Version 2.0.0-beta.1** </br>
40+
**2024-05-07**
4141

42-
##### [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.Translation.Document_1.0.0/sdk/translation/Azure.AI.Translation.Document/CHANGELOG.md)
42+
##### [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/translation/Azure.AI.Translation.Document/CHANGELOG.md#200-beta1-2024-05-07)
4343

44-
##### [README](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.Translation.Document_1.0.0/sdk/translation/Azure.AI.Translation.Document/README.md)
44+
##### [README](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/translation/Azure.AI.Translation.Document/README.md)
4545

46-
##### [Samples](https://github.com/Azure/azure-sdk-for-net/tree/Azure.AI.Translation.Document_1.0.0/sdk/translation/Azure.AI.Translation.Document/samples)
46+
##### [Samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/translation/Azure.AI.Translation.Document/samples)
4747

4848
### [Python](#tab/python)
4949

50-
**Version 1.0.0 (GA)** </br>
51-
**2022-06-07**
50+
**Version 1.1.0b1** </br>
51+
**2024-05-07**
5252

5353
##### [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-translation-document_1.0.0/sdk/translation/azure-ai-translation-document/CHANGELOG.md)
5454

@@ -67,11 +67,11 @@ The Document Translation SDK enables the use and management of the Translation s
6767
### [C#/.NET](#tab/csharp)
6868

6969
```dotnetcli
70-
dotnet add package Azure.AI.Translation.Document --version 1.0.0
70+
dotnet add package Azure.AI.Translation.Document --version 2.0.0-beta.1
7171
```
7272

7373
```powershell
74-
Install-Package Azure.AI.Translation.Document -Version 1.0.0
74+
Install-Package Azure.AI.Translation.Document -Version 2.0.0-beta.1
7575
```
7676

7777
### [Python](#tab/python)
@@ -180,4 +180,4 @@ The [`Microsoft Q&A`](/answers/tags/132/azure-translator) and [Stack Overflow](h
180180
## Next steps
181181

182182
>[!div class="nextstepaction"]
183-
> [**Document Translation SDK quickstart**](quickstarts/asynchronous-sdk.md) [**Document Translation v1.1 REST API reference**](reference/rest-api-guide.md)
183+
> [**Document Translation SDK quickstart**](quickstarts/client-library-sdks.md) [**Document Translation v1.1 REST API reference**](reference/rest-api-guide.md)

articles/ai-services/translator/document-translation/how-to-guides/create-sas-tokens.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,5 +184,5 @@ That's it! You just learned how to create SAS tokens to authorize how clients ac
184184
## Next steps
185185

186186
> [!div class="nextstepaction"]
187-
> [Get Started with Document Translation](../quickstarts/asynchronous-rest-api.md)
187+
> [Get Started with Document Translation](../how-to-guides/use-rest-api-programmatically.md)
188188
>

articles/ai-services/translator/document-translation/how-to-guides/create-use-managed-identities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ Great! You just learned how to enable and use a system-assigned managed identity
251251
## Next steps
252252

253253
> [!div class="nextstepaction"]
254-
> [Quickstart: Get started with Document Translation](../quickstarts/asynchronous-rest-api.md)
254+
> [Quickstart: Get started with Document Translation](../how-to-guides/use-rest-api-programmatically.md)
255255
256256
> [!div class="nextstepaction"]
257257
> [Tutorial: Access Azure Storage from a web app using managed identities](../../../../app-service/scenario-secure-app-access-storage.md?bc=%2fazure%2fcognitive-services%2ftranslator%2fbreadcrumb%2ftoc.json&toc=%2fazure%2fcognitive-services%2ftranslator%2ftoc.json)

articles/ai-services/translator/document-translation/how-to-guides/use-rest-api-programmatically.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-translator
88
ms.topic: quickstart
9-
ms.date: 02/12/2024
9+
ms.date: 05/15/2024
1010
ms.author: lajanuar
1111
recommendations: false
1212
ms.devlang: csharp
@@ -322,15 +322,13 @@ gradle init --type basic
322322
323323
#### Locating the `id` value
324324
325-
* You find the job `id` in the POST method response Header `Operation-Location` URL value. The last parameter of the URL is the operation's job **`id`**:
325+
* You can find the job `id` in the POST `start-batch-translation` method response Header `Operation-Location` URL value. The alphanumeric string following the `/document/` parameter is the operation's job **`id`**:
326326

327-
|**Response header**|**Result URL**|
327+
|**Response header**|**Response URL**|
328328
|-----------------------|----------------|
329-
Operation-Location | https://<<span>NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec</span>
329+
|Operation-Location | {document-translation-endpoint}/translator/document/`9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec`?api-version=2024-05-01|
330330

331-
* You can also use a **GET Jobs** request to retrieve a Document Translation job `id` .
332-
333-
>
331+
* You can also use a [get-translations-status](../reference/get-translations-status.md) request to retrieve a list of translation _**jobs**_ and their `id`s.
334332

335333
## Translate documents
336334

0 commit comments

Comments
 (0)