Skip to content

Commit 4073ac9

Browse files
Merge pull request #231794 from laujan/72694-update-qs-screenshot-storage-container
update screenshot and container
2 parents 0b4b9b7 + 237bda2 commit 4073ac9

File tree

5 files changed

+30
-40
lines changed

5 files changed

+30
-40
lines changed

articles/cognitive-services/Translator/create-translator-resource.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,12 @@ All Cognitive Services API requests require an endpoint URL and a read-only key
7070
1. In the left rail, under *Resource Management*, select **Keys and Endpoint**.
7171
1. Copy and paste your keys and endpoint URL in a convenient location, such as *Microsoft Notepad*.
7272

73-
:::image type="content" source="../media/cognitive-services-apis-create-account/get-cog-serv-keys.png" alt-text="Get key and endpoint.":::
73+
:::image type="content" source="media/keys-and-endpoint-resource.png" alt-text="Get key and endpoint.":::
7474

7575
## How to delete a resource or resource group
7676

77-
> [!Warning]
77+
> [!WARNING]
78+
>
7879
> Deleting a resource group also deletes all resources contained in the group.
7980
8081
To remove a Cognitive Services or Translator resource, you can **delete the resource** or **delete the resource group**.

articles/cognitive-services/Translator/document-translation/how-to-guides/use-client-sdks.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ ms.author: lajanuar
1515
# Document Translation client-library SDKs
1616
<!-- markdownlint-disable MD024 -->
1717
<!-- markdownlint-disable MD001 -->
18-
[Document Translation](../overview.md) is a cloud-based feature of the [Azure Translator](../../translator-overview.md) service. You can translate entire documents or process batch document translations in various file formats while preserving original document structure and format. In this article, you'll learn how to use the Document Translation service C#/.NET and Python client libraries. For the REST API, see our [Quickstart](../quickstarts/get-started-with-rest-api.md) guide.
18+
[Document Translation](../overview.md) is a cloud-based feature of the [Azure Translator](../../translator-overview.md) service. You can translate entire documents or process batch document translations in various file formats while preserving original document structure and format. In this article, you learn how to use the Document Translation service C#/.NET and Python client libraries. For the REST API, see our [Quickstart](../quickstarts/get-started-with-rest-api.md) guide.
1919

2020
## Prerequisites
2121

22-
To get started, you'll need:
22+
To get started, you need:
2323

2424
* An active [**Azure account**](https://azure.microsoft.com/free/cognitive-services/). If you don't have one, you can [**create a free account**](https://azure.microsoft.com/free/).
2525

@@ -28,7 +28,7 @@ To get started, you'll need:
2828
* An [**Azure blob storage account**](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM). You'll [**create containers**](../../../../storage/blobs/storage-quickstart-blobs-portal.md#create-a-container) in your Azure blob storage account for your source and target files:
2929

3030
* **Source container**. This container is where you upload your files for translation (required).
31-
* **Target container**. This container is where your translated files will be stored (required).
31+
* **Target container**. This container is where your translated files are stored (required).
3232

3333
* You also need to create Shared Access Signature (SAS) tokens for your source and target containers. The `sourceUrl` and `targetUrl` , must include a Shared Access Signature (SAS) token, appended as a query string. The token can be assigned to your container or specific blobs. *See* [**Create SAS tokens for Document Translation process**](create-sas-tokens.md).
3434

@@ -103,7 +103,7 @@ using System;
103103
using System.Threading;
104104
```
105105

106-
In the application's **Program** class, create variables for your key and custom endpoint. For details, *see* [Custom domain name and key](../quickstarts/get-started-with-rest-api.md#your-custom-domain-name-and-key)
106+
In the application's **Program** class, create variables for your key and custom endpoint. For more information, *see* [Retrieve your key and custom domain endpoint](../quickstarts/get-started-with-rest-api.md#retrieve-your-key-and-document-translation-endpoint).
107107

108108
```csharp
109109
private static readonly string endpoint = "<your custom endpoint>";
@@ -112,12 +112,12 @@ private static readonly string key = "<your key>";
112112

113113
### Translate a document or batch files
114114

115-
* To Start a translation operation for one or more documents in a single blob container, you'll call the `StartTranslationAsync` method.
115+
* To Start a translation operation for one or more documents in a single blob container, you call the `StartTranslationAsync` method.
116116

117117
* To call `StartTranslationAsync`, you need to initialize a `DocumentTranslationInput` object that contains the following parameters:
118118

119119
* **sourceUri**. The SAS URI for the source container containing documents to be translated.
120-
* **targetUri** The SAS URI for the target container to which the translated documents will be written.
120+
* **targetUri** The SAS URI for the target container to which the translated documents are written.
121121
* **targetLanguageCode**. The language code for the translated documents. You can find language codes on our [Language support](../../language-support.md) page.
122122

123123
```csharp
@@ -185,8 +185,7 @@ from azure.core.credentials import AzureKeyCredential
185185
from azure.ai.translation.document import DocumentTranslationClient
186186
```
187187

188-
Create variables for your resource key, custom endpoint, sourceUrl, and targetUrl. For
189-
more information, *see* [Custom domain name and key](../quickstarts/get-started-with-rest-api.md#your-custom-domain-name-and-key)
188+
Create variables for your resource key, custom endpoint, sourceUrl, and targetUrl. For more information, *see* [Retrieve your key and custom domain endpoint](../quickstarts/get-started-with-rest-api.md#retrieve-your-key-and-document-translation-endpoint).
190189

191190
```python
192191
key = "<your-key>"

articles/cognitive-services/Translator/document-translation/how-to-guides/use-rest-api-programmatically.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ manager: nitinme
77
ms.service: cognitive-services
88
ms.subservice: translator-text
99
ms.topic: quickstart
10-
ms.date: 03/17/2023
10+
ms.date: 03/22/2023
1111
ms.author: lajanuar
1212
recommendations: false
1313
ms.devlang: csharp, golang, java, javascript, python
@@ -31,7 +31,10 @@ To get started, you need:
3131

3232
* An active [**Azure account**](https://azure.microsoft.com/free/cognitive-services/). If you don't have one, you can [**create a free account**](https://azure.microsoft.com/free/).
3333

34-
* An [**Azure blob storage account**](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM). You create containers to store and organize your blob data within your storage account.
34+
* An [**Azure blob storage account**](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM). You also need to [create containers](#create-azure-blob-storage-containers) in your Azure blob storage account for your source and target files:
35+
36+
* **Source container**. This container is where you upload your files for translation (required).
37+
* **Target container**. This container is where your translated files are stored (required).
3538

3639
* A [**single-service Translator resource**](https://portal.azure.com/#create/Microsoft.CognitiveServicesTextTranslation) (**not** a multi-service Cognitive Services resource):
3740

@@ -56,26 +59,19 @@ To get started, you need:
5659

5760
1. After your resource has successfully deployed, select **Go to resource**.
5861

59-
## Your custom domain name and key
60-
61-
> [!IMPORTANT]
62-
>
63-
> * **All API requests to the Document Translation service require a custom domain endpoint**.
64-
> * You won't use the endpoint found on your Azure portal resource _Keys and Endpoint_ page nor the global translator endpoint—`api.cognitive.microsofttranslator.com`—to make HTTP requests to Document Translation.
62+
### Retrieve your key and custom domain endpoint
6563

66-
### What is the custom domain endpoint?
64+
*Requests to the Translator service require a read-only key and custom endpoint to authenticate access. The custom domain endpoint is a URL formatted with your resource name, hostname, and Translator subdirectories and is available in the Azure portal.
6765

68-
The custom domain endpoint is a URL formatted with your resource name, hostname, and Translator subdirectories:
66+
1. If you've created a new resource, after it deploys, select **Go to resource**. If you have an existing Document Translation resource, navigate directly to your resource page.
6967

70-
```http
71-
https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.0
72-
```
68+
1. In the left rail, under *Resource Management*, select **Keys and Endpoint**.
7369

74-
### Find your custom domain name
70+
1. Copy and paste your **`key`** and **`document translation endpoint`** in a convenient location, such as *Microsoft Notepad*. Only one key is necessary to make an API call.
7571

76-
The **NAME-OF-YOUR-RESOURCE** (also called *custom domain name*) parameter is the value that you entered in the **Name** field when you created your Translator resource.
72+
1. You **`key`** and **`document translation endpoint`** into the code samples to authenticate your request to the Document Translation service.
7773

78-
:::image type="content" source="../../media/instance-details.png" alt-text="Image of the Azure portal, create resource, instant details, name field.":::
74+
:::image type="content" source="../media/document-translation-key-endpoint.png" alt-text="Screenshot showing the get your key field in Azure portal.":::
7975

8076
### Get your key
8177

articles/cognitive-services/Translator/document-translation/quickstarts/get-started-with-rest-api.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ manager: nitinme
77
ms.service: cognitive-services
88
ms.subservice: translator-text
99
ms.topic: quickstart
10-
ms.date: 03/17/2023
10+
ms.date: 03/22/2023
1111
ms.author: lajanuar
1212
recommendations: false
1313
ms.devlang: csharp, golang, java, javascript, python
@@ -32,7 +32,10 @@ To get started, you need:
3232

3333
* An active [**Azure account**](https://azure.microsoft.com/free/cognitive-services/). If you don't have one, you can [**create a free account**](https://azure.microsoft.com/free/).
3434

35-
* An [**Azure blob storage account**](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM). You also need to create containers to store and organize your blob data within your storage account.
35+
* An [**Azure blob storage account**](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM). You also need to [create containers](#create-azure-blob-storage-containers) in your Azure blob storage account for your source and target files:
36+
37+
* **Source container**. This container is where you upload your files for translation (required).
38+
* **Target container**. This container is where your translated files are stored (required).
3639

3740
* A [**single-service Translator resource**](https://portal.azure.com/#create/Microsoft.CognitiveServicesTextTranslation) (**not** a multi-service Cognitive Services resource):
3841

@@ -57,29 +60,20 @@ To get started, you need:
5760

5861
1. After your resource has successfully deployed, select **Go to resource**.
5962

60-
## Your custom domain name and key
61-
62-
The custom domain endpoint is a URL formatted with your resource name, hostname, and Translator subdirectories and is available in the Azure portal.
63-
64-
> [!IMPORTANT]
65-
>
66-
> * **All API requests to the Document Translation service require a custom domain endpoint**.
67-
> * Don't use the Text Translation endpoint found on your Azure portal resource *Keys and Endpoint* page nor the global translator endpoint—`api.cognitive.microsofttranslator.com`—to make HTTP requests to Document Translation.
68-
6963
> [!div class="nextstepaction"]
7064
> [I ran into an issue with the prerequisites.](https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?Pillar=Language&Product=Document-translation&Page=quickstart&Section=Prerequisites)
7165
72-
### Retrieve your key and endpoint
66+
### Retrieve your key and document translation endpoint
7367

74-
Requests to the Translator service require a read-only key and custom endpoint to authenticate access.
68+
*Requests to the Translator service require a read-only key and custom endpoint to authenticate access. The custom domain endpoint is a URL formatted with your resource name, hostname, and Translator subdirectories and is available in the Azure portal.
7569

7670
1. If you've created a new resource, after it deploys, select **Go to resource**. If you have an existing Document Translation resource, navigate directly to your resource page.
7771

7872
1. In the left rail, under *Resource Management*, select **Keys and Endpoint**.
7973

8074
1. Copy and paste your **`key`** and **`document translation endpoint`** in a convenient location, such as *Microsoft Notepad*. Only one key is necessary to make an API call.
8175

82-
1. You **`key`** and **`document translation endpoint`** into the code samples to authenticate your request to the Document Translation service.
76+
1. You paste your **`key`** and **`document translation endpoint`** into the code samples to authenticate your request to the Document Translation service.
8377

8478
:::image type="content" source="../media/document-translation-key-endpoint.png" alt-text="Screenshot showing the get your key field in Azure portal.":::
8579

245 KB
Loading

0 commit comments

Comments
 (0)