Merge pull request #273793 from laujan/250121-translator-container-endpoints-data-residency

update containers and data residency

Author: prmerger-automator[bot]

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

@@ -8,7 +8,7 @@ manager: nitinme
 
 ms.service: azure-ai-translator
 ms.topic: reference
-ms.date: 04/08/2024
+ms.date: 04/29/2024
 ms.author: lajanuar
 ---
 
@@ -25,20 +25,14 @@ ms.author: lajanuar
 
 `POST` request:
 
-```http
-    POST {Endpoint}/translate?api-version=3.0&to={to}
-```
-
-***With optional parameters***
-
-```http
-POST {Endpoint}/translate?api-version=3.0&from={from}&to={to}&textType={textType}&category={category}&profanityAction={profanityAction}&profanityMarker={profanityMarker}&includeAlignment={includeAlignment}&includeSentenceLength={includeSentenceLength}&suggestedFrom={suggestedFrom}&fromScript={fromScript}&toScript={toScript}
+```bash
+    POST "http://localhost:{port}/translator/document:translate?sourceLanguage={sourceLanguage}&targetLanguage={targetLanguage}&api-version=2023-11-01-preview" -F "document=@{path-to-your-document-with-file-extension};type={ContentType}/{file-extension}" -o "{path-to-output-file-with-file-extension}"
 ```
 
 Example:
 
 ```bash
-`curl -i -X POST "http://localhost:5000/translator/document:translate?sourceLanguage=en&targetLanguage=hi&api-version=2023-11-01-preview" -F "document={path-to-your-document-with-file-extension};type={ContentType}/{file-extension" -o "{path-to-output-file-with-file-extension}"`
+curl -i -X POST "http://localhost:5000/translator/document:translate?sourceLanguage=en&targetLanguage=hi&api-version=2023-11-01-preview" -F "document=@C:\Test\test-file.md;type=text/markdown" -o "C:\translation\translated-file.md"
 ```
 
 ## Synchronous request headers and parameters
@@ -53,7 +47,7 @@ Use synchronous translation processing to send a document as part of the HTTP re
 |`sourceLanguage`|Specifies the language of the input document. If the `sourceLanguage` parameter isn't specified, automatic language detection is applied to determine the source language. |*Optional*|
 |`-H` or `--header` `"Ocp-Apim-Subscription-Key:{KEY}`    | Request header that specifies the Document Translation resource key authorizing access to the API.|*Required*|
 |`-F` or `--form` |The filepath to the document that you want to include with your request. Only one source document is allowed.|*Required*|
-|&bull; `document=`<br> &bull; `type={contentType}/fileExtension` |&bull; Path to the file location for your source document.</br> &bull; Content type and file extension.</br></br> Ex: **"document=@C:\Test\test-file.md;type=text/markdown**|*Required*|
+|&bull; `document=`<br> &bull; `type={contentType}/fileExtension` |&bull; Path to the file location for your source document.</br> &bull; Content type and file extension.</br></br> Ex: **"document=@C:\Test\test-file.md;type=text/markdown"**|*Required*|
 |`-o` or `--output`|The filepath to the response results.|*Required*|
 |`-F` or `--form` |The filepath to an optional glossary to include with your request. The glossary requires a separate `--form` flag.|*Optional*|
 | &bull; `glossary=`<br> &bull; `type={contentType}/fileExtension`|&bull; Path to the file location for your optional glossary file.</br> &bull; Content type and file extension.</br></br> Ex: **"glossary=@C:\Test\glossary-file.txt;type=text/plain**|*Optional*|
@@ -77,7 +71,7 @@ For this project, you need a source document to translate. You can download our
 Here's an example cURL HTTP request using localhost:5000:
 
 ```bash
-curl -v "http://localhost:5000/translator/documents:translateDocument?from=en&to=es&api-version=v1.0" -F "document=@document-translation-sample-docx"
+curl -v "http://localhost:5000/translator/document:translate?sourceLanguage=en&targetLanguage=es&api-version=v1.0" -F "document=@document-translation-sample-docx" -o "C:\translation\translated-file.md"
 ```
 
 ***Upon successful completion***:

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

@@ -7,7 +7,7 @@ manager: nitinme
 
 ms.service: azure-ai-translator
 ms.topic: reference
-ms.date: 04/08/2024
+ms.date: 04/29/2024
 ms.author: lajanuar
 ---
 
@@ -20,19 +20,14 @@ ms.author: lajanuar
 Send a `POST` request to:
 
 ```HTTP
-POST {Endpoint}/translate?api-version=3.0&&from={from}&to={to}
+POST http://localhost:{port}/translate?api-version=3.0&&from={from}&to={to}
 ```
 
 ***Example request***
 
-```rest
-POST https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&from=en&to=es
-
-[
-  {
-    "Text": "I would really like to drive your car."
-  }
-]
+```bash
+curl -x POST "https:localhost:5000/translate?api-version=3.0&from=en&to=es" -H "Content-Type: application/json" -d "[{
+'Text': 'I would really like to drive your car.'}]"
 
 ```
 
@@ -51,7 +46,6 @@ POST https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&fro
 ]
 ```
 
-
 ## Request parameters
 
 Request parameters passed on the query string are:
@@ -136,7 +130,7 @@ If an error occurs, the request returns a JSON error response. The error code is
 > * Each sample runs on the `localhost` that you specified with the `docker run` command.
 > * While your container is running, `localhost` points to the container itself.
 > * You don't have to use `localhost:5000`. You can use any port that is not already in use in your host environment.
-> To specify a port, use the `-p` option.
+
 
 ### Translate a single input
 
@@ -285,7 +279,7 @@ namespace TranslateContainer
 Translating multiple strings at once is simply a matter of specifying an array of strings in the request body.
 
 ```bash
-curl -X POST "http://localhost:{port}/translate?api-version=3.0&from=en&to=zh-Hans" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json; charset=UTF-8" -d "[{'Text':'Hello, what is your name?'}, {'Text':'I am fine, thank you.'}]"
+curl -X POST "http://localhost:5000/translate?api-version=3.0&from=en&to=zh-Hans" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json; charset=UTF-8" -d "[{'Text':'Hello, what is your name?'}, {'Text':'I am fine, thank you.'}]"
 ```
 
 The response contains the translation of all pieces of text in the exact same order as in the request.
@@ -311,7 +305,7 @@ The response body is:
 This example shows how to translate the same input to several languages in one request.
 
 ```bash
-curl -X POST "http://localhost:{port}/translate?api-version=3.0&from=en&to=zh-Hans&to=de" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json; charset=UTF-8" -d "[{'Text':'Hello, what is your name?'}]"
+curl -X POST "http://localhost:5000/translate?api-version=3.0&from=en&to=zh-Hans&to=de" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json; charset=UTF-8" -d "[{'Text':'Hello, what is your name?'}]"
 ```
 
 The response body is:
@@ -339,7 +333,7 @@ It's common to translate content that includes markup such as content from an HT
 Here's a sample request to illustrate.
 
 ```bash
-curl -X POST "http://localhost:{port}/translate?api-version=3.0&from=en&to=zh-Hans&textType=html" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json; charset=UTF-8" -d "[{'Text':'<div class=\"notranslate\">This will not be translated.</div><div>This will be translated.</div>'}]"
+curl -X POST "http://localhost:5000/translate?api-version=3.0&from=en&to=zh-Hans&textType=html" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json; charset=UTF-8" -d "[{'Text':'<div class=\"notranslate\">This will not be translated.</div><div>This will be translated.</div>'}]"
 ```
 
 The response is:
@@ -367,7 +361,7 @@ The markup to supply uses the following syntax.
 For example, consider the English sentence "The word wordomatic is a dictionary entry." To preserve the word _wordomatic_ in the translation, send the request:
 
 ```bash
-curl -X POST "http://localhost:{port}/translate?api-version=3.0&from=en&to=de" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json; charset=UTF-8" -d "[{'Text':'The word <mstrans:dictionary translation=\"wordomatic\">word or phrase</mstrans:dictionary> is a dictionary entry.'}]"
+curl -X POST "http://localhost:5000/translate?api-version=3.0&from=en&to=de" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json; charset=UTF-8" -d "[{'Text':'The word <mstrans:dictionary translation=\"wordomatic\">word or phrase</mstrans:dictionary> is a dictionary entry.'}]"
 ```
 
 The result is:

articles/ai-services/translator/containers/transliterate-text-parameters.md

@@ -8,7 +8,7 @@ manager: nitinme
 
 ms.service: azure-ai-translator
 ms.topic: reference
-ms.date: 04/08/2024
+ms.date: 04/29/2024
 ms.author: lajanuar
 ---
 
@@ -21,7 +21,7 @@ Convert characters or letters of a source language to the corresponding characte
 `POST` request:
 
 ```HTTP
- POST {Endpoint}/transliterate?api-version=3.0&language={language}&fromScript={fromScript}&toScript={toScript}
+ POST http://localhost:{port}/transliterate?api-version=3.0&language={language}&fromScript={fromScript}&toScript={toScript}
 
 ```
 
@@ -66,8 +66,8 @@ A successful response is a JSON array with one result for each element in the in
 
 ### Sample request
 
-```http
-https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0&language=ja&fromScript=Jpan&toScript=Latn
+```bash
+curl -X POST "http://localhost:5000/transliterate?api-version=3.0&language=ja&fromScript=Jpan&toScript=Latn"
 ```
 
 ### Sample request body
@@ -107,7 +107,14 @@ The following limitations apply:
 > * Each sample runs on the `localhost` that you specified with the `docker run` command.
 > * While your container is running, `localhost` points to the container itself.
 > * You don't have to use `localhost:5000`. You can use any port that is not already in use in your host environment.
-> To specify a port, use the `-p` option.
+
+### Transliterate with REST API
+
+```bash
+
+  curl -X POST "http://localhost:5000/transliterate?api-version=3.0&language=ja&fromScript=Jpan&toScript=Latn" -H "Content-Type: application/json" -d "[{'Text':'こんにちは'},{'Text':'さようなら'}]"
+
+```
 
 ## Next Steps
 

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

@@ -6,7 +6,7 @@ author: laujan
 manager: nitinme
 ms.service: azure-ai-translator
 ms.topic: overview
-ms.date: 02/12/2024
+ms.date: 05/02/2024
 ms.author: lajanuar
 ms.custom: references_regions
 recommendations: false
@@ -143,20 +143,16 @@ For detailed information regarding Azure AI Translator Service request limits, *
 
 Document Translation data residency depends on the Azure region where your Translator resource was created:
 
-* Translator resources **created** in any region in Europe (except Switzerland) are **processed** at data center in North Europe and West Europe.
-* Translator resources **created** in any region in Switzerland are **processed** at data center in Switzerland North and Switzerland West.
-* Translator resources **created** in any region in Asia Pacific or Australia are **processed** at data center in Southeast Asia and Australia East.
-* Translator resource **created** in all other regions including Global, North America, and South America are **processed** at data center in East US and West US 2.
-
 ✔️ Feature: **Document Translation**</br>
 ✔️ Service endpoint:  **Custom:** &#8198;&#8198;&#8198; **`<name-of-your-resource.cognitiveservices.azure.com/translator/text/batch/v1.1`**
 
-|Resource region| Request processing data center |
+|Resource created region| Request processing data center |
 |----------------------------------|-----------------------|
-|**Any region within Europe (except Switzerland)**| Europe: North Europe &bull; West Europe|
-|**Switzerland**|Switzerland: Switzerland North &bull; Switzerland West|
-|**Any region within Asia Pacific and Australia**| Asia: Southeast Asia &bull; Australia East|
-|**All other regions including Global, North America, and South America**  | US: East US &bull; West US 2|
+|**Global**|Closest available data center.|
+|**Americas**|East US 2 &bull; West US 2|
+|**Asia Pacific**| Japan East &bull; Southeast Asia|
+|**Europe (except Switzerland)**| France Central &bull; West Europe|
+|**Switzerland**|Switzerland North &bull; Switzerland West|
 
 ## Next steps
 

articles/ai-services/translator/reference/v3-0-reference.md

@@ -7,7 +7,7 @@ author: laujan
 manager: nitinme
 ms.service: azure-ai-translator
 ms.topic: reference
-ms.date: 02/14/2024
+ms.date: 04/29/2024
 ms.author: lajanuar
 ---
 
@@ -29,14 +29,19 @@ Requests to Translator are, in most cases, handled by the datacenter that is clo
 
 To force the request to be handled within a specific geography, use the desired geographical endpoint. All requests are processed among the datacenters within the geography.
 
-|Geography|Base URL (geographical endpoint)|Datacenters|
-|:--|:--|:--|
-|Global (`non-regional`)|    api.cognitive.microsofttranslator.com|Closest available datacenter|
-|Asia Pacific|    api-apc.cognitive.microsofttranslator.com|Korea South, Japan East, Southeast Asia, and Australia East|
-|Europe|    api-eur.cognitive.microsofttranslator.com|North Europe, West Europe|
-|United States|    api-nam.cognitive.microsofttranslator.com|East US, South Central US, West Central US, and West US 2|
+✔️ Feature: **Translator Text** </br>
 
-<sup>`1`</sup> Customers with a resource located in Switzerland North or Switzerland West can ensure that their Text API requests are served within Switzerland. To ensure that requests are handled in Switzerland, create the Translator resource in the `Resource region` `Switzerland North` or `Switzerland West`, then use the resource's custom endpoint in your API requests. 
+| Service endpoint | Request processing data center |
+|------------------|--------------------------|
+|**Global (recommended):**</br>**`api.cognitive.microsofttranslator.com`**|Closest available data center.|
+|**Americas:**</br>**`api-nam.cognitive.microsofttranslator.com`**|East US 2 &bull; West US 2|
+|**Asia Pacific:**</br>**`api-apc.cognitive.microsofttranslator.com`**|Japan East &bull; Southeast Asia|
+|**Europe (except Switzerland):**</br>**`api-eur.cognitive.microsofttranslator.com`**|France Central &bull; West Europe|
+|**Switzerland:**</br> For more information, *see* [Switzerland service endpoints](#switzerland-service-endpoints).|Switzerland North &bull; Switzerland West|
+
+#### Switzerland service endpoints
+
+Customers with a resource located in Switzerland North or Switzerland West can ensure that their Text API requests are served within Switzerland. To ensure that requests are handled in Switzerland, create the Translator resource in the `Resource region` `Switzerland North` or `Switzerland West`, then use the resource's custom endpoint in your API requests.
 
 For example: If you create a Translator resource in Azure portal with `Resource region` as `Switzerland North` and your resource name is `my-swiss-n`, then your custom endpoint is `https&#8203;://my-swiss-n.cognitiveservices.azure.com`. And a sample request to translate is:
 
@@ -49,7 +54,7 @@ curl -X POST "https://my-swiss-n.cognitiveservices.azure.com/translator/text/v3.
 -d "[{'Text':'Hello'}]" -v
 ```
 
-<sup>`2`</sup> Custom Translator isn't currently available in Switzerland.
+Custom Translator isn't currently available in Switzerland.
 
 ## Authentication
 

articles/ai-services/translator/text-translation-overview.md

@@ -7,7 +7,7 @@ author: laujan
 manager: nitinme
 ms.service: azure-ai-translator
 ms.topic: overview
-ms.date: 07/18/2023
+ms.date: 05/02/2024
 ms.author: lajanuar
 ---
 
@@ -62,21 +62,34 @@ Add Text Translation to your projects and applications using the following resou
 
 Text Translation data residency depends on the Azure region where your Translator resource was created:
 
-* Translator resources **created** in any region in Europe are **processed** at data center in West Europe and North Europe.
-* Translator resources **created** in any region in Asia or Australia are **processed** at data center in Southeast Asia and Australia East.
-* Translator resource **created** in all other regions including Global, North America and South America are **processed** at data center in East US and West US 2.
-
 ### Text Translation data residency
 
 ✔️ Feature: **Translator Text** </br>
-✔️ Region where resource created: **Any**
 
 | Service endpoint | Request processing data center |
 |------------------|--------------------------|
 |**Global (recommended):**</br>**`api.cognitive.microsofttranslator.com`**|Closest available data center.|
-|**Americas:**</br>**`api-nam.cognitive.microsofttranslator.com`**|East US &bull; South Central US &bull; West Central US &bull; West US 2|
-|**Europe:**</br>**`api-eur.cognitive.microsofttranslator.com`**|North Europe &bull; West Europe|
-| **Asia Pacific:**</br>**`api-apc.cognitive.microsofttranslator.com`**|Korea South &bull; Japan East &bull; Southeast Asia &bull; Australia East|
+|**Americas:**</br>**`api-nam.cognitive.microsofttranslator.com`**|East US 2 &bull; West US 2|
+|**Asia Pacific:**</br>**`api-apc.cognitive.microsofttranslator.com`**|Japan East &bull; Southeast Asia|
+|**Europe (except Switzerland):**</br>**`api-eur.cognitive.microsofttranslator.com`**|France Central &bull; West Europe|
+|**Switzerland:**</br> For more information, *see* [Switzerland service endpoints](#switzerland-service-endpoints).|Switzerland North &bull; Switzerland West|
+
+#### Switzerland service endpoints
+
+Customers with a resource located in Switzerland North or Switzerland West can ensure that their Text API requests are served within Switzerland. To ensure that requests are handled in Switzerland, create the Translator resource in the `Resource region` `Switzerland North` or `Switzerland West`, then use the resource's custom endpoint in your API requests.
+
+For example: If you create a Translator resource in Azure portal with `Resource region` as `Switzerland North` and your resource name is `my-swiss-n`, then your custom endpoint is `https&#8203;://my-swiss-n.cognitiveservices.azure.com`. And a sample request to translate is:
+
+```curl
+// Pass secret key and region using headers to a custom endpoint
+curl -X POST "https://my-swiss-n.cognitiveservices.azure.com/translator/text/v3.0/translate?to=fr" \
+-H "Ocp-Apim-Subscription-Key: xxx" \
+-H "Ocp-Apim-Subscription-Region: switzerlandnorth" \
+-H "Content-Type: application/json" \
+-d "[{'Text':'Hello'}]" -v
+```
+
+Custom Translator isn't currently available in Switzerland.
 
 ## Get started with Text Translation