Translator 3.0: Talen

  • Artikel

Hiermee haalt u de set talen op die momenteel wordt ondersteund door andere bewerkingen van de Translator.

Aanvraag-URL

Een aanvraag GET versturen naar:

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

ZieVirtual Network Support for Translator Service selected network and private endpoint configuration and support (Ondersteuning voor geselecteerde netwerk- en privé-eindpunten).

Aanvraagparameters

Aanvraagparameters die worden doorgegeven aan de querytekenreeks zijn:

Queryparameters Description
api-versie Vereiste parameter

De versie van de API die door de client is aangevraagd. De waarde moet zijn 3.0.
scope Optionele parameter.

Een door komma's gescheiden lijst met namen die de groep talen definiëren die moeten worden geretourneerd. Toegestane groepsnamen zijn: translation, transliterationen dictionary. Als er geen bereik wordt opgegeven, worden alle groepen geretourneerd, wat gelijk is aan het doorgeven scope=translation,transliteration,dictionaryvan .

Zieantwoordtekst.

Aanvraagheaders zijn:

Kopteksten Beschrijving
Accept-Language Optionele aanvraagheader.

De taal die moet worden gebruikt voor gebruikersinterfacetekenreeksen. Sommige velden in het antwoord zijn namen van talen of regio's. Gebruik deze parameter om de taal te definiëren waarin deze namen worden geretourneerd. De taal wordt opgegeven door een goed opgemaaktE BCP 47-taaltag op te geven. Gebruik bijvoorbeeld de waarde fr om namen in het Frans aan te vragen of gebruik de waarde zh-Hant om namen in het Traditioneel Chinees aan te vragen.
Namen worden opgegeven in de Engelse taal wanneer er geen doeltaal is opgegeven of wanneer lokalisatie niet beschikbaar is.
X-ClientTraceId Optionele aanvraagheader.
Een door de client gegenereerde GUID om de aanvraag op unieke wijze te identificeren.

Verificatie is niet vereist om taalresources op te halen.

Hoofdtekst van de reactie

Een client gebruikt de scope queryparameter om te definiëren in welke groepen talen de client geïnteresseerd is.

  • scope=translation biedt talen die worden ondersteund om tekst van de ene naar de andere taal te vertalen;

  • scope=transliteration biedt mogelijkheden voor het converteren van tekst in één taal van het ene script naar het andere;

  • scope=dictionary biedt taalparen waarvoor Dictionary bewerkingen gegevens retourneren.

Een client kan meerdere groepen tegelijk ophalen door een door komma's gescheiden lijst met namen op te geven. retourneert scope=translation,transliteration,dictionary bijvoorbeeld ondersteunde talen voor alle groepen.

Een geslaagd antwoord is een JSON-object met één eigenschap voor elke aangevraagde groep:

{
    "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)
    }
}

De waarde voor elke eigenschap is als volgt.

  • translation Eigenschap

    De waarde van de translation eigenschap is een woordenlijst van (sleutel-, waarde)paren. Elke sleutel is een BCP 47-taaltag. Een sleutel geeft een taal aan waarin tekst kan worden vertaald of van waaruit kan worden vertaald. De waarde die aan de sleutel is gekoppeld, is een JSON-object met eigenschappen die de taal beschrijven:

    • name: Weergavenaam van de taal in de aangevraagde landinstelling via Accept-Language header.

    • nativeName: Weergavenaam van de taal in de landinstelling die native is voor deze taal.

    • dir: Directionality, voor talen die rtl van rechts naar links worden geschreven of ltr voor talen van links naar rechts.

    Een voorbeeld is:

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

  • transliteration Eigenschap

    De waarde van de transliteration eigenschap is een woordenlijst van (sleutel-, waarde)paren. Elke sleutel is een BCP 47-taaltag. Een sleutel geeft een taal aan waarvoor tekst van het ene script naar het andere kan worden geconverteerd. De waarde die aan de sleutel is gekoppeld, is een JSON-object met eigenschappen die de taal en de ondersteunde scripts beschrijven:

    • name: Weergavenaam van de taal in de aangevraagde landinstelling via Accept-Language header.

    • nativeName: Weergavenaam van de taal in de landinstelling die native is voor deze taal.

    • scripts: Lijst met scripts waaruit u wilt converteren. Elk element van de scripts lijst heeft eigenschappen:

      • code: Code waarmee het script wordt geïdentificeerd.

      • name: Weergavenaam van het script in de landinstelling die via Accept-Language de header is aangevraagd.

      • nativeName: Weergavenaam van de taal in de landinstelling die native is voor de taal.

      • dir: Directionality, voor talen die rtl van rechts naar links worden geschreven of ltr voor talen van links naar rechts.

      • toScripts: Lijst met scripts die beschikbaar zijn om tekst naar te converteren. Elk element van de toScripts lijst heeft eigenschappen code, name, nativeNameen dir , zoals eerder beschreven.

    Een voorbeeld is:

    {
  "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 Eigenschap

    De waarde van de dictionary eigenschap is een woordenlijst van (sleutel-, waarde)paren. Elke sleutel is een BCP 47-taaltag. De sleutel geeft een taal aan waarvoor alternatieve vertalingen en back-vertalingen beschikbaar zijn. De waarde is een JSON-object dat de brontaal en de doeltalen met beschikbare vertalingen beschrijft:

    • name: Weergavenaam van de brontaal in de aangevraagde landinstelling via Accept-Language header.

    • nativeName: Weergavenaam van de taal in de landinstelling die native is voor deze taal.

    • dir: Directionality, voor talen die rtl van rechts naar links worden geschreven of ltr voor talen van links naar rechts.

    • translations: Lijst met talen met afwisselende vertalingen en voorbeelden voor de query uitgedrukt in de brontaal. Elk element van de translations lijst heeft eigenschappen:

      • name: Weergavenaam van de doeltaal in de landinstelling die is aangevraagd via Accept-Language header.

      • nativeName: Weergavenaam van de doeltaal in de landinstelling die systeemeigen is voor de doeltaal.

      • dir: Directionality, voor talen die rtl van rechts naar links worden geschreven of ltr voor talen van links naar rechts.

      • code: taalcode die de doeltaal identificeert.

    Een voorbeeld is:

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

De structuur van het antwoordobject verandert niet zonder een wijziging in de versie van de API. Voor dezelfde versie van de API kan de lijst met beschikbare talen na verloop van tijd veranderen, omdat Microsoft Translator de lijst met talen die door de services worden ondersteund, voortdurend uitbreidt.

De lijst met ondersteunde talen wordt niet vaak gewijzigd. Om netwerkbandbreedte te besparen en de reactiesnelheid te verbeteren, moet een clienttoepassing overwegen taalresources en de bijbehorende entiteitstag (ETag) in de cache op te slaan. Vervolgens kan de clienttoepassing periodiek (bijvoorbeeld om de 24 uur) een query uitvoeren op de service om de meest recente set ondersteunde talen op te halen. Door de huidige ETag waarde door te geven in een If-None-Match koptekstveld, kan de service het antwoord optimaliseren. Als de resource niet is gewijzigd, retourneert de service statuscode 304 en een lege antwoordtekst.

Antwoordheaders

Kopteksten Beschrijving
ETag Huidige waarde van de entiteitstag voor de aangevraagde groepen ondersteunde talen. Om volgende aanvragen efficiënter te maken, kan de client de ETag waarde in een If-None-Match headerveld verzenden.
X-RequestId Waarde die door de service wordt gegenereerd om de aanvraag te identificeren. Het wordt gebruikt voor probleemoplossingsdoeleinden.

Antwoordstatuscodes

Hier volgen de mogelijke HTTP-statuscodes die een aanvraag retourneert.

Statuscode Description
200 Voltooid.
304 De resource is niet gewijzigd sinds de versie die is opgegeven door aanvraagheaders If-None-Match.
400 Een van de queryparameters ontbreekt of is ongeldig. Corrigeer aanvraagparameters voordat u het opnieuw probeert.
429 De server heeft de aanvraag afgewezen omdat de client de aanvraaglimieten heeft overschreden.
500 Er is een onverwachte fout opgetreden. Als de fout zich blijft voordoen, meldt u deze met: datum en tijd van de fout, aanvraag-id van antwoordheader X-RequestIden client-id van aanvraagheader X-ClientTraceId.
503 Server tijdelijk niet beschikbaar. Probeer de aanvraag opnieuw. Als de fout zich blijft voordoen, meldt u deze met: datum en tijd van de fout, aanvraag-id van antwoordheader X-RequestIden client-id van aanvraagheader X-ClientTraceId.

Als er een fout optreedt, retourneert de aanvraag ook een JSON-foutreactie. De foutcode is een 6-cijferig getal dat de 3-cijferige HTTP-statuscode combineert, gevolgd door een 3-cijferig getal om de fout verder te categoriseren. Algemene foutcodes vindt u op de naslagpagina van v3 Translator.

Voorbeelden

In het volgende voorbeeld ziet u hoe u talen ophaalt die worden ondersteund voor tekstvertaling.

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