AddTranslationArray Method
Adds an array of translations to add translation memory. This is an array version of AddTranslation().
| Method | Request URI |
|---|---|
| POST | http://api.microsofttranslator.com/V2/Http.svc/AddTranslationArray |
| Parameter | Description |
|---|---|
|
appId |
Required. If the Authorization header is used, leave the appid field empty else a string containing "Bearer" + " " + access token. |
|
translations[] |
Required. An array of translations to add to translation memory. Each translation must contain: originalText, translatedText, rating. The size of each originalText and translatedText is limited to 1000 chars. The total of all the originalText(s) and translatedText(s) must not exceed 10000 characters. The maximum number of array elements is 100. |
|
from |
Required. A string containing the language code of the source language. Must be one of the languages returned by the method GetLanguagesForTranslate. |
|
to |
Required. A string containing the language code of the target language. Must be one of the languages returned by the method GetLanguagesForTranslate. |
|
options |
A set of options. TranslateOptions contain: uri , category , contentType , user . User is required. Category , ContentType and Uri are optional. |
The following table describes required and optional request headers.
| Request Header | Description |
|---|---|
|
Authorization |
Required. Specify the the value of access_token in format "Bearer" + " " + Access Token Value |
The format of the request body is as follows
<AddtranslationsRequest>
<AppId></AppId>
<From>A string containing the language code of the source language</From>
<Options>
<Category xmlns="http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2">string-value</Category>
<ContentType xmlns="http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2">text/plain</ContentType>
<User xmlns="http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2">string-value</User>
<Uri xmlns="http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2">string-value</Uri>
</Options>
<To>A string containing the language code of the target language</To>
<Translations>
<Translation xmlns="http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2">
<OriginalText>string-value</OriginalText>
<Rating>int-value</Rating>
<TranslatedText>string-value</TranslatedText>
<Sequence>int-value</Sequence>
</Translation>
</Translations>
</AddtranslationsRequest>
Note
|
|---|
|
Bing App ID is deprecated and is no longer supported. Please obtain an access token to use the Microsoft Translator API. For details, go here. |
Example
C#PHP
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Net;
using System.IO;
using System.Runtime.Serialization.Json;
using System.Runtime.Serialization;
using System.Web;
using System.ServiceModel.Channels;
using System.ServiceModel;
namespace MicrosoftTranslatorSdk.HttpSamples
{
class Program
{
static void Main(string[] args)
{
AdmAccessToken admToken;
string headerValue;
//Get Client Id and Client Secret from https://datamarket.azure.com/developer/applications/
//Refer obtaining AccessToken (http://msdn.microsoft.com/en-us/library/hh454950.aspx)
AdmAuthentication admAuth = new AdmAuthentication("clientID", "client secret");
try
{
admToken = admAuth.GetAccessToken();
// Create a header with the access_token property of the returned token
headerValue = "Bearer " + admToken.access_token;
AddTranslationArrayMethod(headerValue);
}
catch (WebException e)
{
ProcessWebException(e);
Console.WriteLine("Press any key to continue...");
Console.ReadKey(true);
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
Console.WriteLine("Press any key to continue...");
Console.ReadKey(true);
}
}
private static void AddTranslationArrayMethod(string authToken)
{
string appId = "";
string uri = "http://api.microsofttranslator.com/v2/Http.svc/AddTranslationArray";
string originalText1 = "una importante contribución a la rentabilidad de la empresa";
string translatedText1 = "a significant contribution tothe company profitability";
string originalText2 = "a veces los errores son divertidos";
string translatedText2 = "in some cases errors are fun";
string body = GenerateAddtranslationRequestBody(appId, "es", "en", "general", "text/plain", "", "TestUserId");
string translationsCollection = string.Format("{0}{1}",
GenerateAddtranslationRequestElement(originalText1, 8, 0, translatedText1),
GenerateAddtranslationRequestElement(originalText2, 6, 0, translatedText2));
// update the body
string requestBody = string.Format(body, translationsCollection);
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(uri);
request.ContentType = "text/xml";
request.Method = "POST";
request.Headers.Add("Authorization", authToken);
using (System.IO.Stream stream = request.GetRequestStream())
{
byte[] arrBytes = System.Text.ASCIIEncoding.ASCII.GetBytes(requestBody);
stream.Write(arrBytes, 0, arrBytes.Length);
}
// get the response
WebResponse response = null;
try
{
response = request.GetResponse();
using (Stream respStream = response.GetResponseStream())
{
Console.WriteLine(string.Format("Your translations for '{0}' and '{1}' has been added successfully.", originalText1, originalText2));
}
}
catch
{
throw;
}
finally
{
if (response != null)
{
response.Close();
response = null;
}
}
Console.WriteLine("Press any key to continue...");
Console.ReadKey(true);
}
private static string GenerateAddtranslationRequestBody(string appId, string from, string to, string category, string contentType, string uri, string user)
{
string body = "<AddtranslationsRequest>" +
"<AppId>{0}</AppId>" +
"<From>{1}</From>" +
"<Options>" +
"<Category xmlns=\"http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2\">{2}</Category>" +
"<ContentType xmlns=\"http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2\">{3}</ContentType>" +
"<User xmlns=\"http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2\">{4}</User>" +
"<Uri xmlns=\"http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2\">{5}</Uri>" +
"</Options>" +
"<To>{6}</To>" +
"<Translations>{7}</Translations>" +
"</AddtranslationsRequest>";
return string.Format(body, appId, from, category, contentType, user, uri, to, "{0}");
}
private static string GenerateAddtranslationRequestElement(string originalText, int rating, int sequence, string translatedText)
{
string element = "<Translation xmlns=\"http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2\">" +
"<OriginalText>{0}</OriginalText>" +
"<Rating>{1}</Rating>" +
"<TranslatedText>{2}</TranslatedText>" +
"<Sequence>{3}</Sequence>" +
"</Translation>";
return string.Format(element, originalText, rating.ToString(), translatedText, sequence.ToString());
}
private static void ProcessWebException(WebException e)
{
Console.WriteLine("{0}", e.ToString());
// Obtain detailed error information
string strResponse = string.Empty;
using (HttpWebResponse response = (HttpWebResponse)e.Response)
{
using (Stream responseStream = response.GetResponseStream())
{
using (StreamReader sr = new StreamReader(responseStream, System.Text.Encoding.ASCII))
{
strResponse = sr.ReadToEnd();
}
}
}
Console.WriteLine("Http status code={0}, error message={1}", e.Status, strResponse);
}
}
}
Goto Top
<?php
class AccessTokenAuthentication {
/*
* Get the access token.
*
* @param string $grantType Grant type.
* @param string $scopeUrl Application Scope URL.
* @param string $clientID Application client ID.
* @param string $clientSecret Application client ID.
* @param string $authUrl Oauth Url.
*
* @return string.
*/
function getTokens($grantType, $scopeUrl, $clientID, $clientSecret, $authUrl){
try {
//Initialize the Curl Session.
$ch = curl_init();
//Create the request Array.
$paramArr = array (
'grant_type' => $grantType,
'scope' => $scopeUrl,
'client_id' => $clientID,
'client_secret' => $clientSecret
);
//Create an Http Query.//
$paramArr = http_build_query($paramArr);
//Set the Curl URL.
curl_setopt($ch, CURLOPT_URL, $authUrl);
//Set HTTP POST Request.
curl_setopt($ch, CURLOPT_POST, TRUE);
//Set data to POST in HTTP "POST" Operation.
curl_setopt($ch, CURLOPT_POSTFIELDS, $paramArr);
//CURLOPT_RETURNTRANSFER- TRUE to return the transfer as a string of the return value of curl_exec().
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
//CURLOPT_SSL_VERIFYPEER- Set FALSE to stop cURL from verifying the peer's certificate.
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//Execute the cURL session.
$strResponse = curl_exec($ch);
//Get the Error Code returned by Curl.
$curlErrno = curl_errno($ch);
if($curlErrno){
$curlError = curl_error($ch);
throw new Exception($curlError);
}
//Close the Curl Session.
curl_close($ch);
//Decode the returned JSON string.
$objResponse = json_decode($strResponse);
if ($objResponse->error){
throw new Exception($objResponse->error_description);
}
return $objResponse->access_token;
} catch (Exception $e) {
echo "Exception-".$e->getMessage();
}
}
}
/*
* Class:HTTPTranslator
*
* Processing the translator request.
*/
Class HTTPTranslator {
/*
* Create and execute the HTTP CURL request.
*
* @param string $url HTTP Url.
* @param string $authHeader Authorization Header string.
* @param string $postData Data to post.
*
* @return string.
*
*/
function curlRequest($url, $authHeader, $postData=''){
//Initialize the Curl Session.
$ch = curl_init();
//Set the Curl url.
curl_setopt ($ch, CURLOPT_URL, $url);
//Set the HTTP HEADER Fields.
curl_setopt ($ch, CURLOPT_HTTPHEADER, array($authHeader,"Content-Type: text/xml"));
//CURLOPT_RETURNTRANSFER- TRUE to return the transfer as a string of the return value of curl_exec().
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
//CURLOPT_SSL_VERIFYPEER- Set FALSE to stop cURL from verifying the peer's certificate.
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, False);
if($postData) {
//Set HTTP POST Request.
curl_setopt($ch, CURLOPT_POST, TRUE);
//Set data to POST in HTTP "POST" Operation.
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
}
//Execute the cURL session.
$curlResponse = curl_exec($ch);
//Get the Error Code returned by Curl.
$curlErrno = curl_errno($ch);
if ($curlErrno) {
$curlError = curl_error($ch);
throw new Exception($curlError);
}
//Close a cURL session.
curl_close($ch);
return $curlResponse;
}
/*
* Create Request XML Format.
*
* @param string $fromLanguage Source language Code.
* @param string $toLanguage Target language Code.
* @param string $category Category.
* @param string $contentType Content Type.
* @param string $user User Type.
* @param string $translationArr Translation Array.
*
* @return string.
*/
function createReqXML($fromLanguage,$toLanguage,$category,$contentType,$user,$translationArr) {
//Create the XML string for passing the values.
$requestXml = "<AddtranslationsRequest>";
$requestXml .= "<AppId></AppId>";
$requestXml .= "<From>$fromLanguage</From>";
$requestXml .= "<Options>";
$requestXml .= "<Category xmlns='http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2'>$category</Category>";
$requestXml .= "<ContentType xmlns='http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2'>$contentType</ContentType>";
$requestXml .= "<User xmlns='http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2'>$user</User>";
$requestXml .= "<Uri xmlns='http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2'></Uri>";
$requestXml .= "</Options>";
$requestXml .= "<To>$toLanguage</To>";
$requestXml .= "<Translations>";
foreach($translationArr as $value) {
$requestXml .= "<Translation xmlns='http://schemas.datacontract.org/2004/07/Microsoft.MT.Web.Service.V2'>";
$requestXml .= "<OriginalText>".$value['OriginalText']."</OriginalText>";
$requestXml .= "<Rating>".$value['rating']."</Rating>";
$requestXml .= "<TranslatedText>".$value['TranslatedText']."</TranslatedText>";
$requestXml .= "<Sequence>0</Sequence>";
$requestXml .="</Translation>";
}
$requestXml .= "</Translations>";
$requestXml .= "</AddtranslationsRequest>";
return $requestXml;
}
}
try {
//Client ID of the application.
$clientID = "ClientId";
//Client Secret key of the application.
$clientSecret = "ClientSecret";
//OAuth Url.
$authUrl = "https://datamarket.accesscontrol.windows.net/v2/OAuth2-13/";
//Application Scope Url
$scopeUrl = "http://api.microsofttranslator.com";
//Application grant type
$grantType = "client_credentials";
//Create the AccessTokenAuthentication object.
$authObj = new AccessTokenAuthentication();
//Get the Access token.
$accessToken = $authObj->getTokens($grantType, $scopeUrl, $clientID, $clientSecret, $authUrl);
//Create the authorization Header string.
$authHeader = "Authorization: Bearer ". $accessToken;
//Set the Params.
$fromLanguage = "es";
$toLanguage = "en";
$user = 'guest';
$category = "general";
$contentType = "text/plain";
//Create translation Array.
$translationArr = array();
$translationArr[] = array(
'OriginalText' => 'una importante contribución a la rentabilidad de la empresa',
'TranslatedText' => 'a significant contribution tothe company profitability',
'Rating' => 4
);
$translationArr[] = array (
'OriginalText' => 'a veces los errores son divertidos',
'TranslatedText' => 'in some cases errors are fun',
'Rating' => 4
);
//Create the Translator Object.
$translatorObj = new HTTPTranslator();
//Get the Request XML.
$requestXml = $translatorObj->createReqXML($fromLanguage,$toLanguage,$category,$contentType,$user,$translationArr);
//HTTP AddTranslationArray URL.
$url = "http://api.microsofttranslator.com/v2/Http.svc/AddTranslationArray";
//Get the curl response.
$curlResponse = $translatorObj->curlRequest($url, $authHeader, $requestXml);
foreach ($translationArr as $translation)
echo "Translation for <b>'".$translation["OriginalText"]."'</b> added successfully.<br/>";
} catch (Exception $e) {
echo "Exception: " . $e->getMessage() . PHP_EOL;
}
Note