Export (0) Print
Expand All

GetTranslations Method

Retrieves an array of translations for a given language pair from the store and the MT engine. GetTranslations differs from Translate as it returns all available translations.

Request
Request URI
http://api.microsofttranslator.com/V2/Ajax.svc/GetTranslations

URI parameters
Parameter Description

appId

Required. A string containing "Bearer" + " " + access token.

text

Required. A string representing the text to translate. The size of the text must not exceed 10000 characters.

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 are all optional and default to the most common settings.
  • Category: A string containing the category (domain) of the translation. Defaults to "general".
  • ContentType: A string containing the type of content. Either "text/html" or "text/plain". Defaults to "text/plain".
  • Uri: A string containing the content location of this translation.
  • User: A string used to track the originator of the submission.
  • State: User state to help correlate request and response. The same contents will be returned in the response.

Response
Name Description
GetTranslationsResponse A GetTranslationsResponse containing the following values:
  • 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.
TranslationMatch 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. Anonymously provided translations will generally have a rating of 1 to 4, whilst authoritatively provided translations will generally have a rating of 6 to 10.
  • Count: The number of times this translation with this rating has been selected. The value will be 0 for the automatically translated response.
  • TranslatedText: The translated text.

Ff512402.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

Obtain an Access Token on the server-side

                                               
[System.Web.Services.WebMethod]
public static AdmAccessToken GetAccessToken()
{
    AdmAccessToken admToken;
    string headerValue;
    //Get Client Id and Client Secret from https://datamarket.azure.com/developer/applications/
    AdmAuthentication admAuth = new AdmAuthentication("clientid", "clientsecret");

    admToken = admAuth.GetAccessToken();
    // Create a header with the access_token property of the returned token
    headerValue = "Bearer" + " " + HttpUtility.UrlEncode(admToken.access_token);

    return admToken;
} 
                                            
Invoke the AJAX method on the client-side

                                               
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
    <script type="text/javascript">
        var languageFrom = "es";
        var languageTo = "en";
        var text = "una importante contribución a la rentabilidad de la empresa";
        var options = "{\"User\":\"TestUserId\"}";
        function getTranslations() {
            PageMethods.GetAccessToken(OnSucceeded, OnFailed);

        }
        function OnSucceeded(result, usercontext, methodName) {

            window.mycallback = function (response) {
                var array = response.Translations;
                var translations = "Available translations for source text '" + text + "' are <br />";
                for (var i = 0; i < array.length; i++) {

                    translations = translations + "Translated text: " + array[i].TranslatedText + "<br />Rating: " + array[i].Rating + "<br />Count: " + array[i].Count + "<br /><br />";
                }
                document.getElementById('<%= lblResult.ClientID %>').innerHTML = translations;

            }

            var s = document.createElement("script");
            s.src = "http://api.microsofttranslator.com/V2/Ajax.svc/GetTranslations?oncomplete=mycallback&appId=Bearer " + encodeURIComponent(result.access_token) + "&text=" + encodeURIComponent(text) + "&from=" + languageFrom +
            "&to=" + languageTo + "&maxTranslations=5&options=" + options;
            document.getElementsByTagName("head")[0].appendChild(s);
        }
        function OnFailed(error, userContext, methodName) {
            alert("Error");
        }
    </script>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:ScriptManager ID="ScriptManager" runat="server" EnablePageMethods="true" />
        <asp:Button ID="buttonGetTrans" runat="server" Text="GetTranslations" OnClientClick="getTranslations();return false;" />
        <br />
        <asp:Label ID="lblResult" runat="server"></asp:Label>
    </div>
    </form>
</body>
</html>
                                            
Show:
© 2014 Microsoft