Skip to content

Commit 85bb422

Browse files
authored
Merge pull request #167723 from laujan/1857822-what-is-text-translator
[cognitive svcs][translator] add overview articles
2 parents 53383fe + cd7d6ba commit 85bb422

12 files changed

+229
-101
lines changed

.openpublishing.redirection.json

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40344,7 +40344,7 @@
4034440344
"redirect_url": "/azure/active-directory/b2b/claims-mapping",
4034540345
"redirect_document_id": true
4034640346
},
40347-
{
40347+
{
4034840348
"source_path_from_root": "/articles/active-directory/hybrid/reference-connect-device-disappearance.md",
4034940349
"redirect_url": "/troubleshoot/azure/active-directory/reference-connect-device-disappearance",
4035040350
"redirect_document_id": false
@@ -56253,6 +56253,11 @@
5625356253
"source_path_from_root": "/articles/communication-services/concepts/telephony-sms/sip-interface-infrastructure.md",
5625456254
"redirect_url": "/azure/communication-services/concepts/telephony-sms/direct-routing-infrastructure",
5625556255
"redirect_document_id": false
56256-
}
56256+
},
56257+
{
56258+
"source_path_from_root": "/articles/cognitive-services/translator/translator-info-overview.md",
56259+
"redirect_url": "/azure/cognitive-services/translator/translator-overview",
56260+
"redirect_document_id": false
56261+
}
5625756262
]
56258-
}
56263+
}

articles/cognitive-services/Translator/containers/translator-how-to-install-container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Translator container enables you to build a translator application architecture
3131

3232
To get started, you'll need 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-
You'll also need the following to use Translator containers:
34+
You'll also need the following:
3535

3636
| Required | Purpose |
3737
|--|--|

articles/cognitive-services/Translator/document-translation/client-sdks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ ms.date: 07/06/2021
1212
ms.author: lajanuar
1313
---
1414

15-
# Document Translation client libraries and SDKs
15+
# 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-info-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](get-started-with-document-translation.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'll learn how to use the Document Translation service C#/.NET and Python client libraries. For the REST API, see our [Quickstart](get-started-with-document-translation.md) guide.
1919

2020
## Prerequisites
2121

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.date: 08/09/2021
1010

1111
# Get started with Document Translation
1212

13-
In this article, you'll learn to use Document Translation with HTTP REST API methods. Document Translation is a cloud-based feature of the [Azure Translator](../translator-info-overview.md) service. The Document Translation API enables the translation of whole documents while preserving source document structure and text formatting.
13+
In this article, you'll learn to use Document Translation with HTTP REST API methods. Document Translation is a cloud-based feature of the [Azure Translator](../translator-overview.md) service. The Document Translation API enables the translation of whole documents while preserving source document structure and text formatting.
1414

1515
## Prerequisites
1616

articles/cognitive-services/Translator/document-translation/overview.md

Lines changed: 38 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
title: What is Document Translation?
2+
title: What is Microsoft Azure Cognitive Services Document Translation?
33
description: An overview of the cloud-based batch document translation service and process.
44
ms.topic: overview
55
manager: nitinme
66
ms.author: lajanuar
77
author: laujan
8-
ms.date: 06/20/2021
8+
ms.date: 08/09/2021
99
---
1010
# What is Document Translation?
1111

12-
Document Translation is a cloud-based feature of the [Azure Translator](../translator-info-overview.md) service and is part of the Azure Cognitive Service family of REST APIs. The Document Translation API translates documents across all [supported languages and dialects](../../language-support.md) while preserving document structure and data format.
12+
Document Translation is a cloud-based feature of the [Azure Translator](../translator-overview.md) service and is part of the Azure Cognitive Service family of REST APIs. In this overview, you'll learn how the Document Translation API can be used to translate multiple and complex documents across all [supported languages and dialects](../../language-support.md) while preserving original document structure and data format.
1313

14-
This documentation contains the following article types:
14+
This documentation contains the following article types:
1515

1616
* [**Quickstarts**](get-started-with-document-translation.md) are getting-started instructions to guide you through making requests to the service.
17-
* [**How-to guides**](create-sas-tokens.md) contain instructions for using the feature in more specific or customized ways.
18-
* [**Reference**](reference/rest-api-guide.md) provide REST API settings, values, keywords and configuration.
17+
* [**How-to guides**](create-sas-tokens.md) contain instructions for using the feature in more specific or customized ways.
18+
* [**Reference**](reference/rest-api-guide.md) provide REST API settings, values, keywords, and configuration.
1919

2020
## Document Translation key features
2121

@@ -27,50 +27,59 @@ This documentation contains the following article types:
2727
|**Apply custom translation**| Translate documents using general and [custom translation](../customization.md#custom-translator) models.|
2828
|**Apply custom glossaries**|Translate documents using custom glossaries.|
2929
|**Automatically detect document language**|Let the Document Translation service determine the language of the document.|
30-
|**Translate documents with content in multiple languages**|Use the auto-detect feature to translate documents with content in multiple languages into your target language.|
30+
|**Translate documents with content in multiple languages**|Use the autodetect feature to translate documents with content in multiple languages into your target language.|
3131

3232
> [!NOTE]
3333
> When translating documents with content in multiple languages, the feature is intended for complete sentences in a single language. If sentences are composed of more than one language, the content may not all translate into the target language.
34-
>
35-
## How to get started?
34+
>
35+
36+
## Document Translation development options
37+
38+
You can add Document Translation to your applications using the REST API or a client-library SDK:
39+
40+
* The [**REST API**](reference/rest-api-guide.md). is a language agnostic interface that enables you to create HTTP requests and authorization headers to translate documents.
41+
42+
* The [**client-library SDKs**](client-sdks.md) are language-specific classes, objects, methods, and code that you can quickly use by adding a reference in your project. Currently Document Translation has programming language support for [**C#/.NET**](/dotnet/api/azure.ai.translation.document) and [**Python**](/python/azure-ai-translation-document/latest/azure.ai.translation.document.html)
43+
44+
## Get started
3645

3746
In our how-to guide, you'll learn how to quickly get started using Document Translator. To begin, you'll need 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).
3847

3948
> [!div class="nextstepaction"]
40-
> [Get Started](get-started-with-document-translation.md)
49+
> [Start here](get-started-with-document-translation.md "Learn how to use Document Translation with HTTP REST")
4150
4251
## Supported document formats
4352

4453
The following document file types are supported by Document Translation:
4554

4655
| File type| File extension|Description|
4756
|---|---|--|
48-
|Adobe PDF|.pdf|Adobe Acrobat portable document format|
49-
|Comma-Separated Values |.csv| A comma-delimited raw-data file used by spreadsheet programs.|
50-
|HTML|.html, .htm|Hyper Text Markup Language.|
51-
|Localization Interchange File Format|.xlf. , xliff| A parallel document format, export of Translation Memory systems. The languages used are defined inside the file.|
52-
|Markdown| .markdown, .mdown, .mkdn, .md, .mkd, .mdwn, .mdtxt, .mdtext, .rmd| A lightweight markup language for creating formatted text.|
53-
|MHTML|.mthml, .mht| A web page archive format used to combine HTML code and its companion resources.|
54-
|Microsoft Excel|.xls, .xlsx|A spreadsheet file for data analysis and documentation.|
55-
|Microsoft Outlook|.msg|An email message created or saved within Microsoft Outlook.|
56-
|Microsoft PowerPoint|.ppt, .pptx| A presentation file used to display content in a slideshow format.|
57-
|Microsoft Word|.doc, .docx| A text document file.|
58-
|OpenDocument Text|.odt|An open-source text document file.|
59-
|OpenDocument Presentation|.odp|An open-source presentation file.|
60-
|OpenDocument Spreadsheet|.ods|An open-source spreadsheet file.|
61-
|Rich Text Format|.rtf|A text document containing formatting.|
62-
|Tab Separated Values/TAB|.tsv/.tab| A tab-delimited raw-data file used by spreadsheet programs.|
63-
|Text|.txt| An unformatted text document.|
57+
|Adobe PDF|pdf|Adobe Acrobat portable document format|
58+
|Comma-Separated Values |csv| A comma-delimited raw-data file used by spreadsheet programs.|
59+
|HTML|html, htm|Hyper Text Markup Language.|
60+
|Localization Interchange File Format|xlf. , xliff| A parallel document format, export of Translation Memory systems. The languages used are defined inside the file.|
61+
|Markdown| markdown, mdown, mkdn, md, mkd, mdwn, mdtxt, mdtext, rmd| A lightweight markup language for creating formatted text.|
62+
|MHTML|mthml, mht| A web page archive format used to combine HTML code and its companion resources.|
63+
|Microsoft Excel|xls, xlsx|A spreadsheet file for data analysis and documentation.|
64+
|Microsoft Outlook|msg|An email message created or saved within Microsoft Outlook.|
65+
|Microsoft PowerPoint|ppt, pptx| A presentation file used to display content in a slideshow format.|
66+
|Microsoft Word|doc, docx| A text document file.|
67+
|OpenDocument Text|odt|An open-source text document file.|
68+
|OpenDocument Presentation|odp|An open-source presentation file.|
69+
|OpenDocument Spreadsheet|ods|An open-source spreadsheet file.|
70+
|Rich Text Format|rtf|A text document containing formatting.|
71+
|Tab Separated Values/TAB|tsv/tab| A tab-delimited raw-data file used by spreadsheet programs.|
72+
|Text|txt| An unformatted text document.|
6473

6574
## Supported glossary formats
6675

6776
The following glossary file types are supported by Document Translation:
6877

6978
| File type| File extension|Description|
7079
|---|---|--|
71-
|Comma-Separated Values| .csv |A comma-delimited raw-data file used by spreadsheet programs.|
72-
|Localization Interchange File Format|.xlf. , xliff| A parallel document format, export of Translation Memory systems. The languages used are defined inside the file.|
73-
|Tab-Separated Values/TAB|.tsv, .tab| A tab-delimited raw-data file used by spreadsheet programs.|
80+
|Comma-Separated Values| csv |A comma-delimited raw-data file used by spreadsheet programs.|
81+
|Localization Interchange File Format| xlf , xliff| A parallel document format, export of Translation Memory systems The languages used are defined inside the file.|
82+
|Tab-Separated Values/TAB|tsv, tab| A tab-delimited raw-data file used by spreadsheet programs.|
7483

7584
## Next steps
7685

articles/cognitive-services/Translator/index.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ landingContent:
2525
- linkListType: overview
2626
links:
2727
- text: What is Translator?
28-
url: translator-info-overview.md
28+
url: translator-overview.md
2929
- text: Language support
3030
url: language-support.md
3131
- text: Document Translation
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: "Text Translation REST API reference guide"
3+
titleSuffix: Azure Cognitive Services
4+
description: View a list of with links to the Text Translation REST APIs.
5+
services: cognitive-services
6+
author: laujan
7+
manager: nitinme
8+
ms.service: cognitive-services
9+
ms.subservice: translator-text
10+
ms.topic: reference
11+
ms.date: 08/10/2021
12+
ms.author: lajanuar
13+
---
14+
15+
# Text Translation REST API
16+
17+
Text Translation is a cloud-based feature of the Azure Translator service and is part of the Azure Cognitive Service family of REST APIs. The Text Translation API translates text between language pairs across all [supported languages and dialects](../../language-support.md). The available methods are listed in the table below:
18+
19+
| Request| Method| Description|
20+
|---------|--------------|---------|
21+
| [**languages**](v3-0-languages.md) | **GET** | Returns the set of languages currently supported by the **translation**, **transliteration**, and **dictionary** methods. This request does not require authentication headers and you do not need a Translator resource to view the supported language set.|
22+
|[**translate**](v3-0-translate.md) | **POST**| Translate specified source language text into the target language text.|
23+
|[**transliterate**](v3-0-transliterate.md) | **POST** | Map source language script or alphabet to a target language script or alphabet.
24+
|[**detect**](v3-0-detect.md) | **POST** | Identify the source language. |
25+
|[**breakSentence**](v3-0-break-sentence.md) | **POST** | Returns an array of integers representing the length of sentences in a source text. |
26+
| [**dictionary/lookup**](v3-0-dictionary-lookup.md) | **POST** | Returns alternatives for single word translations. |
27+
| [**dictionary/examples**](v3-0-dictionary-lookup.md) | **POST** | Returns how a term is used in context. |
28+
29+
> [!div class="nextstepaction"]
30+
> [Create a Translator resource in the Azure portal.](/translator-how-to-signup.md)
31+
32+
> [!div class="nextstepaction"]
33+
> [Quickstart: REST API and your programming language](../quickstart-translator.md)
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: What is Microsoft Azure Cognitive Services Text Translation?
3+
titlesuffix: Azure Cognitive Services
4+
description: Integrate the Text Translation API into your applications, websites, tools, and other solutions to provide multi-language user experiences.
5+
services: cognitive-services
6+
author: laujan
7+
manager: nitinme
8+
ms.service: cognitive-services
9+
ms.topic: overview
10+
ms.subservice: translator-text
11+
ms.date: 08/09/2021
12+
ms.author: lajanuar
13+
ms.custom: cog-serv-seo-aug-2020
14+
keywords: translator, text translation, machine translation, translation service, custom translator
15+
---
16+
17+
# What is Text Translation?
18+
19+
Text translation is a cloud-based REST API feature of the Translator service that uses neural machine translation technology to enable quick and accurate source-to-target text translation in real time across all [supported languages](language-support.md). In this overview, you'll learn how the Text Translation REST APIs enable you to build intelligent solutions for your applications and workflows.
20+
21+
Text translation documentation contains the following article types:
22+
23+
* [**Quickstarts**](quickstart-translator.md). Getting-started instructions to guide you through making requests to the service.
24+
* [**How-to guides**](translator-how-to-signup.md). Instructions for accessing and using the service in more specific or customized ways.
25+
* [**Reference articles**](reference/v3-0-reference.md). REST API documentation and programming language-based content.
26+
27+
## Text translation features
28+
29+
The following methods are supported by the Text Translation feature:
30+
31+
* [**Languages**](reference/v3-0-languages.md). Returns a list of languages supported by **Translate**, **Transliterate**, and **Dictionary Lookup** operations. This request does not require authentication; just copy and paste the following GET request into Postman or your favorite API tool or browser:
32+
33+
```http
34+
https://api.cognitive.microsofttranslator.com/languages?api-version=3.0
35+
```
36+
37+
* [**Translate**](reference/v3-0-translate.md#translate-to-multiple-languages). Renders single source-language text to multiple target-language texts with a single request.
38+
39+
* [**Transliterate**](reference/v3-0-transliterate.md). Converts characters or letters of a source language to the corresponding characters or letters of a target language.
40+
41+
* [**Detect**](reference/v3-0-detect.md). Returns the source code language code and a boolean variable denoting whether the detected language is supported for text translation and transliteration.
42+
43+
> [!NOTE]
44+
> You can **Translate, Transliterate, and Detect** text with [a single REST API call](reference/v3-0-translate.md#translate-a-single-input-with-language-autodetection) .
45+
46+
* [**Dictionary lookup**](reference/v3-0-dictionary-lookup.md). Returns equivalent words for the source term in the target language.
47+
* [**Dictionary example**](reference/v3-0-dictionary-examples.md) Returns grammatical structure and context examples for the source term and target term pair.
48+
49+
## Text translation deployment options
50+
51+
Add Text Translation to your projects and applications using the following resources:
52+
53+
* Access the cloud-based Translator service via the [**REST API**](reference/rest-api-guide.md), available in Azure.
54+
55+
* Use the REST API [translate request](containers/translator-container-supported-parameters.md) with the [**Text translation Docker container**](containers/translator-how-to-install-container.md).
56+
57+
> [!IMPORTANT]
58+
>
59+
> * The Translator container is in gated preview. To use it, you must complete and submit the [**Azure Cognitive Services Application for Gated Services**](https://aka.ms/csgate-translator) online request form and have it approved to acquire access to the container.
60+
>
61+
> * The [**Translator container image**](https://hub.docker.com/_/microsoft-azure-cognitive-services-translator-text-translation) supports limited features compared to cloud offerings.
62+
>
63+
64+
## Get started with Text Translation
65+
66+
Ready to begin?
67+
68+
* [**Create a Translator resource**](translator-how-to-signup.md "Go to the Azure portal.").
69+
70+
* [**Get your access keys and API endpoint**](translator-how-to-signup.md#authentication-keys-and-endpoint-url "An endpoint URL and read-only key are required for authentication.")
71+
72+
* Explore our [**Quickstart**](quickstart-translator.md "Learn to use Translator via REST and a preferred programming language.") and view use cases and code samples for the following programming languages:
73+
* [**C#/.NET**](quickstart-translator.md?tabs=csharp)
74+
* [**Go**](quickstart-translator.md?tabs=go)
75+
* [**Java**](quickstart-translator.md?tabs=java)
76+
* [**JavaScript/Node.js**](quickstart-translator.md?tabs=nodejs)
77+
* [**Python**](quickstart-translator.md?tabs=python).
78+
79+
## Next steps
80+
81+
Dive deeper into the Text Translation REST API:
82+
83+
> [!div class="nextstepaction"]
84+
> [See the REST API reference](./reference/v3-0-reference.md)

0 commit comments

Comments
 (0)