Azure Text Translation SDK (preview)

Article
07/18/2023

Important

The Translator text SDKs are currently available in public preview. Features, approaches and processes may change, prior to General Availability (GA), based on user feedback.

Azure Text Translation is a cloud-based REST API feature of the Azure AI Translator service. The Text Translation API enables quick and accurate source-to-target text translations in real time. The Text Translation software development kit (SDK) is a set of libraries and tools that enable you to easily integrate Text Translation REST API capabilities into your applications. Text Translation SDK is available across programming platforms in C#/.NET, Java, JavaScript, and Python.

Supported languages

Text Translation SDK supports the programming languages and platforms:

Language → SDK version	Package	Client library	Supported API version
.NET/C# → 1.0.0-beta.1	NuGet	Azure SDK for .NET	Translator v3.0
Java✱ → 1.0.0-beta.1	MVN repository	Azure SDK for Java	Translator v3.0
JavaScript → 1.0.0-beta.1	npm	Azure SDK for JavaScript	Translator v3.0
Python → 1.0.0b1	PyPi	Azure SDK for Python	Translator v3.0

✱ The Azure Text Translation SDK for Java is tested and supported on Windows, Linux, and macOS platforms. It isn't tested on other platforms and doesn't support Android deployments.

Changelog and release history

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

Translator Text SDK April 2023 preview release

This release includes the following updates:

Use Text Translation SDK in your applications

The Text Translation SDK enables the use and management of the Text Translation service in your application. The SDK builds on the underlying Text Translation REST API allowing you to easily use those APIs within your programming language paradigm. Here's how you use the Text Translation SDK for your preferred programming language:

1. Install the SDK client library

dotnet add package Azure.AI.Translation.Text --version 1.0.0-beta.1

Install-Package Azure.AI.Translation.Text -Version 1.0.0-beta.1

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-ai-translation-text</artifactId>
    <version>1.0.0-beta.1</version>
</dependency>

implementation("com.azure:azure-ai-translation-text:1.0.0-beta.1")

npm i @azure-rest/ai-translation-text@1.0.0-beta.1

pip install azure-ai-translation-text==1.0.0b1

2. Import the SDK client library into your application

using Azure;
using Azure.AI.Translation.Text;

import java.util.List;
import java.util.ArrayList;
import com.azure.ai.translation.text.models.*;
import com.azure.ai.translation.text.TextTranslationClientBuilder;
import com.azure.ai.translation.text.TextTranslationClient;

import com.azure.core.credential.AzureKeyCredential;

const {TextTranslationClient } = require("@azure-rest/ai-translation-text").default;

from azure.core.credentials import TextTranslationClient
from azure-ai-translation-text import TextTranslationClient

3. Authenticate the client

Interaction with the Translator service using the client library begins with creating an instance of the TextTranslationClientclass. You need your API key and region to instantiate a client object. The Text Translation API key is found in the Azure portal:

Screenshot of the keys and endpoint location in the Azure portal.

Using the global endpoint (default)

string key = "<your-key>";

AzureKeyCredential credential = new(key);
TextTranslationClient client = new(credential);

Using a regional endpoint


Uri endpoint = new("<your-endpoint>");
string key = "<your-key>";
string region = "<region>";

AzureKeyCredential credential = new(key);
TextTranslationClient client = new(credential, region);

Using the global endpoint (default)


String apiKey = "<your-key>";
AzureKeyCredential credential = new AzureKeyCredential(apiKey);

TextTranslationClient client = new TextTranslationClientBuilder()
            .credential(credential)
            .buildClient();

Using a regional endpoint

String apiKey = "<your-key>";
String endpoint = "<your-endpoint>";
String region = "<region>";

AzureKeyCredential credential = new AzureKeyCredential(apiKey);

TextTranslationClient client = new TextTranslationClientBuilder()
.credential(credential)
.region(region)
.endpoint(endpoint)
.buildClient();


const TextTranslationClient = require("@azure-rest/ai-translation-text").default,

const apiKey = "<your-key>";
const endpoint = "<your-endpoint>";
const region = "<region>";


from azure.ai.translation.text import TextTranslationClient, TranslatorCredential
from azure.ai.translation.text.models import InputTextItem
from azure.core.exceptions import HttpResponseError

key = "<your-key>"
endpoint = "<your-endpoint>"
region = "<region>"


credential = TranslatorCredential(key, region)
text_translator = TextTranslationClient(endpoint=endpoint, credential=credential)

4. Build your application

Create a client object to interact with the Text Translation SDK, and then call methods on that client object to interact with the service. The SDKs provide both synchronous and asynchronous methods. For more insight, see the Text Translation sample repository for .NET/C#.

Help options

The Microsoft Q&A and Stack Overflow forums are available for the developer community to ask and answer questions about Azure Text Translation and other services. Microsoft monitors the forums and replies to questions that the community has yet to answer. To make sure that we see your question, tag it with azure-text-translation.

Next steps

Text Translation quickstart

Text Translation v3.0 reference guide