Share via

Translator 3.0: Språk

  • Artikel

Hämtar den uppsättning språk som för närvarande stöds av andra åtgärder i Translator.

Begärans-URL

Skicka en GET-begäran till:

https://api.cognitive.microsofttranslator.com/languages?api-version=3.0

SeVirtual Network Support för Translator-tjänstens valda konfiguration och support för nätverk och privat slutpunkt.

Parametrar för begäran

Begäransparametrar som skickas på frågesträngen är:

Frågeparametrar Description
api-version Obligatorisk parameter

Den version av API:et som begärs av klienten. Värdet måste vara 3.0.
omfång Valfri parameter.

En kommaavgränsad lista med namn som definierar vilken grupp av språk som ska returneras. Tillåtna gruppnamn är: translation, transliterationoch dictionary. Om inget omfång anges returneras alla grupper, vilket motsvarar att skicka scope=translation,transliteration,dictionary.

Sesvarstext.

Begärandehuvuden är:

Sidhuvuden Description
Accept-Language Valfritt begärandehuvud.

Språket som ska användas för användargränssnittssträngar. Några av fälten i svaret är namn på språk eller namn på regioner. Använd den här parametern för att definiera språket där dessa namn returneras. Språket anges genom att tillhandahålla en välformulerad BCP 47-språktagg. Använd till exempel värdet fr för att begära namn på franska eller använda värdet zh-Hant för att begära namn i traditionell kinesiska.
Namn anges på engelska när ett målspråk inte anges eller när lokalisering inte är tillgängligt.
X-ClientTraceId Valfritt begärandehuvud.
Ett klientgenererat GUID för att unikt identifiera begäran.

Autentisering krävs inte för att hämta språkresurser.

Själva svaret

En klient använder scope frågeparametern för att definiera vilka grupper av språk den är intresserad av.

  • scope=translation innehåller språk som stöds för att översätta text från ett språk till ett annat språk;

  • scope=transliteration innehåller funktioner för att konvertera text på ett språk från ett skript till ett annat skript.

  • scope=dictionary innehåller språkpar för vilka Dictionary åtgärder returnerar data.

En klient kan hämta flera grupper samtidigt genom att ange en kommaavgränsad lista med namn. Skulle till exempel scope=translation,transliteration,dictionary returnera språk som stöds för alla grupper.

Ett lyckat svar är ett JSON-objekt med en egenskap för varje begärd grupp:

{
    "translation": {
        //... set of languages supported to translate text (scope=translation)
    },
    "transliteration": {
        //... set of languages supported to convert between scripts (scope=transliteration)
    },
    "dictionary": {
        //... set of languages supported for alternative translations and examples (scope=dictionary)
    }
}

Värdet för varje egenskap är följande.

  • translation Egenskapen

    Värdet för translation egenskapen är en ordlista med (nyckel, värde) par. Varje nyckel är en BCP 47-språktagg. En nyckel identifierar ett språk som texten kan översättas till eller översättas från. Värdet som är associerat med nyckeln är ett JSON-objekt med egenskaper som beskriver språket:

    • name: Visningsnamn för språket på det språk som begärs via Accept-Language sidhuvudet.

    • nativeName: Visningsnamn för språket på nationella inställningar för det här språket.

    • dir: Riktning, som är rtl för höger-till-vänster-språk eller ltr för vänster-till-höger-språk.

    Ett exempel är:

    {
  "translation": {
    ...
    "fr": {
      "name": "French",
      "nativeName": "Français",
      "dir": "ltr"
    },
    ...
  }
}

  • transliteration Egenskapen

    Värdet för transliteration egenskapen är en ordlista med (nyckel, värde) par. Varje nyckel är en BCP 47-språktagg. En nyckel identifierar ett språk där text kan konverteras från ett skript till ett annat skript. Värdet som är associerat med nyckeln är ett JSON-objekt med egenskaper som beskriver språket och dess skript som stöds:

    • name: Visningsnamn för språket på det språk som begärs via Accept-Language sidhuvudet.

    • nativeName: Visningsnamn för språket på nationella inställningar för det här språket.

    • scripts: Lista över skript att konvertera från. Varje element i listan scripts har egenskaper:

      • code: Kod som identifierar skriptet.

      • name: Visningsnamn för skriptet på det språk som begärs via Accept-Language -huvudet.

      • nativeName: Visningsnamn för språket på språkets nationella inställningar.

      • dir: Riktning, som är rtl för höger-till-vänster-språk eller ltr för vänster-till-höger-språk.

      • toScripts: Lista över skript som är tillgängliga att konvertera text till. Varje element i toScripts listan har egenskaperna code, name, nativeNameoch dir enligt beskrivningen ovan.

    Ett exempel är:

    {
  "transliteration": {
    ...
    "ja": {
      "name": "Japanese",
      "nativeName": "日本語",
      "scripts": [
        {
          "code": "Jpan",
          "name": "Japanese",
          "nativeName": "日本語",
          "dir": "ltr",
          "toScripts": [
            {
              "code": "Latn",
              "name": "Latin",
              "nativeName": "ラテン語",
              "dir": "ltr"
            }
          ]
        },
        {
          "code": "Latn",
          "name": "Latin",
          "nativeName": "ラテン語",
          "dir": "ltr",
          "toScripts": [
            {
              "code": "Jpan",
              "name": "Japanese",
              "nativeName": "日本語",
              "dir": "ltr"
            }
          ]
        }
      ]
    },
    ...
  }
}

  • dictionary Egenskapen

    Värdet för dictionary egenskapen är en ordlista med (nyckel, värde) par. Varje nyckel är en BCP 47-språktagg. Nyckeln identifierar ett språk som alternativa översättningar och serveröversättningar är tillgängliga för. Värdet är ett JSON-objekt som beskriver källspråket och målspråken med tillgängliga översättningar:

    • name: Visningsnamn för källspråket på det språk som begärs via Accept-Language sidhuvud.

    • nativeName: Visningsnamn för språket på nationella inställningar för det här språket.

    • dir: Riktning, som är rtl för höger-till-vänster-språk eller ltr för vänster-till-höger-språk.

    • translations: Lista över språk med alterativa översättningar och exempel för frågan som uttrycks i källspråket. Varje element i listan translations har egenskaper:

      • name: Visningsnamn för målspråket på de nationella inställningar som begärs via Accept-Language sidhuvudet.

      • nativeName: Målspråkets visningsnamn på det nationella språket som är inbyggt för målspråket.

      • dir: Riktning, som är rtl för höger-till-vänster-språk eller ltr för vänster-till-höger-språk.

      • code: Språkkod som identifierar målspråket.

    Ett exempel är:

    "es": {
  "name": "Spanish",
  "nativeName": "Español",
  "dir": "ltr",
  "translations": [
    {
      "name": "English",
      "nativeName": "English",
      "dir": "ltr",
      "code": "en"
    }
  ]
},

Strukturen för svarsobjektet ändras inte utan en ändring i API-versionen. För samma version av API:et kan listan över tillgängliga språk ändras med tiden eftersom Microsoft Translator kontinuerligt utökar listan över språk som stöds av dess tjänster.

Listan över språk som stöds ändras inte ofta. För att spara nätverksbandbredd och förbättra svarstiden bör ett klientprogram överväga att cachelagra språkresurser och motsvarande entitetstagg (ETag). Sedan kan klientprogrammet regelbundet (till exempel en gång var 24:e timme) fråga tjänsten för att hämta den senaste uppsättningen språk som stöds. Genom att skicka det aktuella ETag värdet i ett If-None-Match rubrikfält kan tjänsten optimera svaret. Om resursen inte har ändrats returnerar tjänsten statuskod 304 och en tom svarstext.

Svarshuvuden

Sidhuvuden Description
Etag Aktuellt värde för entitetstaggen för de begärda grupperna av språk som stöds. Om du vill göra efterföljande begäranden mer effektiva kan klienten skicka ETag värdet i ett If-None-Match rubrikfält.
X-RequestId Värde som genereras av tjänsten för att identifiera begäran. Den används för felsökning.

Svarsstatuskoder

Följande är de möjliga HTTP-statuskoder som en begäran returnerar.

Statuskod Description
200 Åtgärden lyckades.
304 Resursen har inte ändrats sedan den version som anges av begärandehuvuden If-None-Match.
400 En av frågeparametrarna saknas eller är ogiltig. Korrigera begärandeparametrarna innan du försöker igen.
429 Servern avvisade begäran eftersom klienten har överskridit begärandegränserna.
500 Det uppstod ett oväntat fel. Om felet kvarstår rapporterar du det med: datum och tid för felet, begärandeidentifierare från svarshuvudet X-RequestIdoch klientidentifierare från begärandehuvudet X-ClientTraceId.
503 Servern är inte tillgänglig för tillfället. Försök igen med begäran. Om felet kvarstår rapporterar du det med: datum och tid för felet, begärandeidentifierare från svarshuvudet X-RequestIdoch klientidentifierare från begärandehuvudet X-ClientTraceId.

Om ett fel inträffar returnerar begäran också ett JSON-felsvar. Felkoden är ett 6-siffrigt tal som kombinerar den tresiffriga HTTP-statuskoden följt av ett tresiffrigt nummer för att ytterligare kategorisera felet. Vanliga felkoder finns på referenssidan för Translator v3.

Exempel

I följande exempel visas hur du hämtar språk som stöds för textöversättning.

curl "https://api.cognitive.microsofttranslator.com/languages?api-version=3.0&scope=translation"