GetTranslationsArray Method

Use the GetTranslationsArray method to retrieve multiple translation candidates for multiple source texts.

Syntax
C#
GetTranslationsResponse[] Microsoft.Translator.GetTranslationsArray(appId, texts[], from, to, maxTranslations, options);

Parameters
Parameter Description

appId

Required. If the Authorization header is used, leave the appid field empty else specify a string containing "Bearer" + " " + access token.

texts

Required. An array containing the texts for translation. All strings must be of the same language. The total of all texts to be translated must not exceed 10000 characters. The maximum number of array elements is 10.

from

Required. A string representing the language code of the translation text.

to

Required. A string representing the language code to translate the text into.

maxTranslations

Required. An int representing the maximum number of translations to return.

options

Optional. A TranslateOptions object which contains the values listed below. They all default to the most common settings. You do not need to set any of the values.

  • Category : A string containing the category (domain) of the translation. Defaults to "general".
  • ContentType : The only supported, and the default, option is "text/plain".
  • Uri : Filter results by this URI. If no value is set, the default is all.
  • User : Filter results by this user. If no value is set, the default is all.
  • State : User state to help correlate request and response. The same contents will be returned in the response.

Request Headers

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


Return value
Returns a GetTranslationsResponse array. Each GetTranslationsResponse has the following elements:
  • Translations : An array of matches found, stored in TranslationMatch (see below) objects. The translations may include slight variants of the original text (fuzzy matching). The translations will be sorted: 100% matches first, fuzzy matches below.
  • From : If the method did not specify a From language, this will be the result of auto language detection. Otherwise it will be the given From language.
  • State : User state to help correlate request and response. Contains the same value as given in the TranslateOptions parameter.
A TranslationMatch object consists of the following:
  • Error : If an error has occurred for a specific input string, the error code is stored. Otherwise the field is empty.
  • MatchDegree : The system matches input sentences against the store, including inexact matches. MatchDegree indicates how closely the input text matches the original text found in the store. The value returned ranges from 0 to 100, where 0 is no similarity and 100 is an exact case sensitive match.
  • MatchedOriginalText : Original text that was matched for this result. Only returned if the matched original text was different than the input text. Used to return the source text of a fuzzy match. Not returned for Microsoft Translator results.
  • Rating : Indicates the authority of the person making the quality decision. Machine Translation results will have a rating of 5. End user submitted translations will generally have a rating of 1 to 4, whilst approved custom translations will generally have a rating of 6 to 10.
  • Count : The number of times this translation with this rating has been selected by the users. The value will be 0 for the automatically translated response.
  • TranslatedText : The translated text.

Ff512434.alert_note(en-us,MSDN.10).gif 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.SoapSamples
{
    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();
                DateTime tokenReceived = DateTime.Now;
                // Create a header with the access_token property of the returned token
                headerValue = "Bearer " + admToken.access_token;
                GetTranslationArrayMethod(headerValue);
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
                Console.WriteLine("Press any key to continue...");
                Console.ReadKey(true);
            }
        }
        private static void GetTranslationArrayMethod(string authToken)
        {
            // Add TranslatorService as a service reference, Address:http://api.microsofttranslator.com/V2/Soap.svc
            TranslatorService.LanguageServiceClient client = new TranslatorService.LanguageServiceClient();
            //Set Authorization header before sending the request
            HttpRequestMessageProperty httpRequestProperty = new HttpRequestMessageProperty();
            httpRequestProperty.Method = "POST";
            httpRequestProperty.Headers.Add("Authorization", authToken);

            // Creates a block within which an OperationContext object is in scope.
            using (OperationContextScope scope = new OperationContextScope(client.InnerChannel))
            {
                OperationContext.Current.OutgoingMessageProperties[HttpRequestMessageProperty.Name] = httpRequestProperty;
                string[] textTranslations = { "a veces los errores son divertidos", " una importante contribución a la rentabilidad de la empresa" };
                MicrosoftTranslatorSdk.SoapSamples.TranslatorService.TranslateOptions translateOptions = new MicrosoftTranslatorSdk.SoapSamples.TranslatorService.TranslateOptions(); // Use the default options
                ////Set options if required
                //Keep appId parameter blank as we are sending access token in authorization header.
                MicrosoftTranslatorSdk.SoapSamples.TranslatorService.GetTranslationsResponse[] getTranslationResponses = client.GetTranslationsArray("", textTranslations, "es", "en", 5, translateOptions);

                foreach (MicrosoftTranslatorSdk.SoapSamples.TranslatorService.GetTranslationsResponse translationResponse in getTranslationResponses)
                {
                    foreach (MicrosoftTranslatorSdk.SoapSamples.TranslatorService.TranslationMatch match in translationResponse.Translations)
                    {

                        if (string.IsNullOrEmpty(match.Error))
                        {
                            Console.WriteLine("Matched original text: {0}", match.MatchedOriginalText);
                            Console.WriteLine("Translated text: {0}", match.TranslatedText);
                            Console.WriteLine("Match degree: {0}", match.MatchDegree.ToString());
                            Console.WriteLine("Rating: {0}", match.Rating.ToString());
                            Console.WriteLine("Count: {0}" + Environment.NewLine, match.Count.ToString());
                        }
                        else
                        {
                            Console.WriteLine("Error: {0}" + Environment.NewLine, match.Error.ToString());
                        }
                    }
                }

                Console.WriteLine("Press any key to continue...");
                Console.ReadKey(true);
            }
        }
           }
}

                                            

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:AccessTokenAuthentication
 *
 * Create SOAP Object.
 */
class SOAPMicrosoftTranslator {
    /*
     * Soap Object.
     *
     * @var ObjectArray.
     */
    public $objSoap;
    /*
     * Create the SAOP object.
     *
     * @param string $accessToken Access Token string.
     * @param string $wsdlUrl     WSDL string.
     *
     * @return string.
     */
    public function __construct($accessToken, $wsdlUrl){
        try {
            //Authorization header string.
            $authHeader = "Authorization: Bearer ". $accessToken;
            $contextArr = array(
                'http'   => array(
                    'header' => $authHeader
            )
            );
            //Create a streams context.
            $objContext = stream_context_create($contextArr);
            $optionsArr = array (
                'soap_version'   => 'SOAP_1_2',
                'encoding'          => 'UTF-8',
                'exceptions'      => true,
                'trace'          => true,
                'cache_wsdl'     => 'WSDL_CACHE_NONE',
                'stream_context' => $objContext,
                'user_agent'     => 'PHP-SOAP/'.PHP_VERSION."\r\n".$authHeader    
            );
            //Call Soap Client.
            $this->objSoap = new SoapClient($wsdlUrl, $optionsArr);
        } catch(Exception $e){
            echo "<h2>Exception Error!</h2>";
            echo $e->getMessage();
        }
    }
}

try {
    //Soap WSDL Url
    $wsdlUrl       = "http://api.microsofttranslator.com/V2/Soap.svc";
    //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 Authentication object
    $authObj      = new AccessTokenAuthentication();
    //Get the Access token
    $accessToken  = $authObj->getTokens($grantType, $scopeUrl, $clientID, $clientSecret, $authUrl);
    //Create soap translator Object
    $soapTranslator = new SOAPMicrosoftTranslator($accessToken, $wsdlUrl);
        
    // Create Option Array.
    $optionArg = array (
        'Category'    => "general", 
        'ContentType' => "text/plain",
        'Uri'         => null, 
        'User'        => 'TestUser' 
    );

    // Input text Array.
    $inputStrArr = array("Wir versuchen, offensiven Wortschatz bzw.", "Techniker arbeiten, um das Problem zu beheben");

    //Request argument list.
    $requestArg = array (
         'appId'            => '', // no longer used, but pass it anyway
         'texts'            => $inputStrArr,
         'from'            => 'de',
         'to'                => 'en',
         'maxTranslations' => 5,
         'options'            => $optionArg
    );
    // Call GetTranslationArray.//
    $responseObj          = $soapTranslator->objSoap->GetTranslationsArray($requestArg);
    $responseTranslation = $responseObj->GetTranslationsArrayResult->GetTranslationsResponse;
    $i=0;
    foreach($responseTranslation as $translationArr) {
        $translationMatchArr = $translationArr->Translations->TranslationMatch;
        echo "Get Translation For <b>$inputStrArr[$i]</b>";
        echo "<table border ='2px'>";
        echo "<tr><td><b>Count</b></td><td><b>MatchDegree</b></td>
        <td><b>Rating</b></td><td><b>TranslatedText</b></td></tr>";
        foreach($translationMatchArr as $translationMatch) {
            echo "<tr><td>$translationMatch->Count</td><td>$translationMatch->MatchDegree</td><td>$translationMatch->Rating</td>
            <td>$translationMatch->TranslatedText</td></tr>";
        }
        echo "</table></br>";
        $i++;
    }
} catch (Exception $e) {
    echo "Exception: " . $e->getMessage() . "<br/>";
}
                                            
Goto Top
Show: