Board Review: Introducing Text Translation & SDK

[krishna-doss-mohan]

Thank you for starting the process for approval of the client library for your Azure service. Thorough review of your client library ensures that your APIs are consistent with the guidelines and the consumers of your client library have a consistently good experience when using Azure.

The Architecture Board reviews Track 2 libraries only. If your library does not meet this requirement, please reach out to Architecture Board before creating the issue.

Please reference our review process guidelines to understand what is being asked for in the issue template.

Before submitting, ensure you adjust the title of the issue appropriately.

Note that the required material must be included before a meeting can be scheduled.

Contacts and Timeline

• Service team responsible for the client library: Azure Cognitive Services Translator
• Main contacts:
  • Engineering: Christophe Poulain; Michal Materna;
  • PM: Krishna Doss Mohan
  • SDK team: Arun Chandrasekhar; Catalina Peralta
• Expected stable release date for this library: 03/27 (Public Preview), //build (GA)

About the Service

• Link to documentation introducing/describing the service: https://learn.microsoft.com/en-us/azure/cognitive-services/translator/text-translation-overview
• Link to the service REST APIs: https://learn.microsoft.com/en-us/azure/cognitive-services/translator/reference/rest-api-guide
• Is the goal to release a Public Preview, Private Preview, or GA? Service is already GA.

About the client library

• Name of client library:
• Link to library reference documentation: N/A
• Is there an existing SDK library? If yes, provide link:

Step 1: Champion Scenarios

Ultimately the library should be easy to use for common scenarios that developers want. Consider the following questions when thinking about champion scenarios:

1. What is the app the developer is building that uses your client library?
2. Who is the end-user of the application (the developer's customer)?
3. What features of the API need to be explained in the sample so that someone could use this API in real app?
4. How does the authentication workflow look?

See Champion Scenario section here.

Code is appreciated but optional. Pseudocode is fine.

John, a developer of Contoso a multinational company, is building a web app which allows their employees to translate text based on their various business needs. John would be using our SDK to build the web app.

• Champion scenario 1: Translate a text phrase

  • Mary, an employee of Contoso wants to translate text content from English to German. She goes to the web app, enters source text, selects source language and target language and request for translation. The app returns the translated text in German language and count of characters translated.

  • Link to library’s sample folder:

• Champion scenario 2: Translate a text phrase without specifying source language

  • Wang, an employee of Contoso wants to translate feedback in foreign languages from users into Chinese language. Wang may not always know which language the feedback is in. Wang goes to the web app, enters the source text, doesn't specify source language and selects target language and request for translation. The app auto detects the language of the source text and returns the translated text in Chinese language, the count of characters translated along with the detected source language and the confidence score of the language detected.

  • Link to library’s sample folder:

• Champion scenario 3: Translate arrays of text phrase

  • Ram is an employee of Contoso which is an eCommerce company. The customers do search in multiple languages. To perform analytics on this search data, Ram goes to the webapp, posts array of source text and selects the target language (English) in a request to translate. The app detects the language of each of these arrays separately and returns the translated content in English in an array along with the total character count of the request, respective detected language and their confidence scores.

  • Link to library’s sample folder:

• Champion scenario 4: Translate a text phrase using custom machine translation model

  • Mary is an employee of Contoso, which is a healthcare company. They have translation requirements but have some specifications on custom translations that fit their healthcare domain. Mary trains a custom model using Custom Translator and gets a custom model ID. Mary goes the web app, enters the source text, select target language, and enters the customer model ID (as category ID) and requests for translation. The service uses the custom model to translate and returns the translated text and the count of characters translated.
  • Link to library’s sample folder:

• Champion scenario 5: Transliterate a text phrase

  • Mary is an employee of Contoso, a tech company building a product to help users learn Arabic language. To help the English-speaking users learn the pronunciation of Arabic words, they have requirements to convert text from Arabic script to Latin script. To achieve this, she goes to the webapp, enters the source text, selects the source script, and the target script in the web app. The service converts the source content into native script, translate, and returns the translated content in the target script.

  • Link to library’s sample folder:

Step 2: Quickstart Samples (Optional)

Include samples demonstrating how to consume the client library if available:

• Create a new resource
• Read the resource
• Modify the resource
• Delete the resource
• Error handling
• Handling race conditions/concurrency issues

Thank you for your submission!

[ronniegeraghty]

Hi @krishna-doss-mohan, The Azure SDK Architecture Board has switched to using our Azure SDK Scheduling Experience tool. Please use the scheduling tool to schedule your review session and then close this issue. The scheduling tool will handle creating the GitHub Issue and sending out the meeting invites. Please let me know if you have any questions.