Translator 3.0: Nyelvek

  • Cikk

Lekéri a Translator más műveletei által jelenleg támogatott nyelvek készletét.

URL-cím kérése

GET kérés küldése ide:

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

LásdVirtual Network A Translator szolgáltatás által kiválasztott hálózati és privát végpontok konfigurációja és támogatása című témakört.

Kérelemparaméterek

A lekérdezési sztringen átadott kérelemparaméterek a következők:

Lekérdezési paraméterek Description
api-verzió Kötelező paraméter

Az ügyfél által kért API-verzió. Az értéknek meg kell lennie 3.0.
scope Nem kötelező paraméter.

A visszaadni kívánt nyelvek csoportját meghatározó nevek vesszővel tagolt listája. Az engedélyezett csoportnevek a következők: translation, transliteration, és dictionary. Ha nincs megadva hatókör, a rendszer az összes csoportot visszaadja, ami egyenértékű az átadással scope=translation,transliteration,dictionary.

Lásd:választörzs.

A kérésfejlécek a következők:

Fejlécek Description
Accept-Language Nem kötelező kérésfejléc.

A felhasználói felület sztringjeihez használni kívánt nyelv. A válasz egyes mezői a nyelvek nevei vagy a régiók nevei. Ez a paraméter határozza meg azt a nyelvet, amelyben a rendszer visszaadja ezeket a neveket. A nyelv egy jól formázott BCP 47 nyelvi címke megadásával van megadva. Az érték fr használatával például francia nyelven kérheti le a neveket, vagy az érték zh-Hant használatával kérheti le a neveket a hagyományos kínai nyelven.
A nevek angol nyelven vannak megadva, ha nincs megadva célnyelv, vagy ha a honosítás nem érhető el.
X-ClientTraceId Nem kötelező kérésfejléc.
Ügyfél által létrehozott GUID a kérés egyedi azonosításához.

A nyelvi erőforrások lekéréséhez nincs szükség hitelesítésre.

Választörzs

Az ügyfél a scope lekérdezési paraméterrel határozza meg, hogy mely nyelvcsoportok érdeklik.

  • scope=translation olyan nyelveket biztosít, amely támogatja a szöveg fordítását egyik nyelvről a másikra;

  • scope=transliteration lehetővé teszi, hogy az egyik nyelven lévő szöveget egy szkriptből egy másik szkriptbe konvertálja;

  • scope=dictionary nyelvi párokat biztosít, amelyekhez Dictionary a műveletek adatokat adnak vissza.

Az ügyfél egyszerre több csoportot is lekérhet a nevek vesszővel tagolt listájának megadásával. Például az scope=translation,transliteration,dictionary összes csoport támogatott nyelvét adja vissza.

A sikeres válasz egy JSON-objektum, amely minden kért csoporthoz egy tulajdonsággal rendelkezik:

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

Az egyes tulajdonságok értéke a következő.

  • translation Tulajdonság

    A tulajdonság értéke translation a (kulcs, érték) párok szótára. Minden kulcs egy BCP 47 nyelvi címke. A kulcsok azt a nyelvet azonosítják, amelyből a szöveg lefordítható vagy fordítható. A kulcshoz társított érték egy JSON-objektum, amely a nyelvet leíró tulajdonságokkal rendelkezik:

    • name: A nyelv megjelenítendő neve a fejlécen keresztül Accept-Language kért területi beállításban.

    • nativeName: Az ehhez a nyelvhez tartozó natív területi beállításban megjelenítheti a nyelv nevét.

    • dir: Irány, amely rtl jobbról balra vagy ltr balról jobbra író nyelvekhez használható.

    Ilyen például a következő:

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

  • transliteration Tulajdonság

    A tulajdonság értéke transliteration a (kulcs, érték) párok szótára. Minden kulcs egy BCP 47 nyelvi címke. A kulcs azonosítja azt a nyelvet, amelynek szövegét egy szkriptből egy másik szkriptbe lehet konvertálni. A kulcshoz társított érték egy JSON-objektum, amely a nyelvet és a támogatott szkripteket leíró tulajdonságokkal rendelkezik:

    • name: A nyelv megjelenítendő neve a fejlécen keresztül Accept-Language kért területi beállításban.

    • nativeName: Az ehhez a nyelvhez tartozó natív területi beállításban megjelenítheti a nyelv nevét.

    • scripts: A konvertálni kívánt szkriptek listája. A lista minden eleme scripts rendelkezik tulajdonságokkal:

      • code: A szkriptet azonosító kód.

      • name: A szkript nevének megjelenítése a fejlécen keresztül Accept-Language kért területi beállításban.

      • nativeName: A nyelv nyelvének megjelenítése a nyelv natív területi beállításában.

      • dir: Irány, amely rtl jobbról balra vagy ltr balról jobbra író nyelvekhez használható.

      • toScripts: A szöveg konvertálásához elérhető szkriptek listája. A lista minden eleme toScripts rendelkezik a , , nativeNamenameés dir a korábban ismertetett tulajdonságokkalcode.

    Ilyen például a következő:

    {
  "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 Tulajdonság

    A tulajdonság értéke dictionary a (kulcs, érték) párok szótára. Minden kulcs egy BCP 47 nyelvi címke. A kulcs azonosítja azt a nyelvet, amelyhez alternatív fordítások és háttérfordítások érhetők el. Az érték egy JSON-objektum, amely leírja a forrásnyelvet és a célnyelveket az elérhető fordításokkal:

    • name: A forrásnyelv nevének megjelenítése a fejlécen keresztül Accept-Language kért területi beállításban.

    • nativeName: Az ehhez a nyelvhez tartozó natív területi beállításban megjelenítheti a nyelv nevét.

    • dir: Irány, amely rtl jobbról balra vagy ltr balról jobbra író nyelvekhez használható.

    • translations: A váltakozó fordítású nyelvek listája, valamint a forrásnyelven kifejezett lekérdezésre vonatkozó példák. A lista minden eleme translations rendelkezik tulajdonságokkal:

      • name: A célnyelv megjelenítendő neve a fejlécen keresztül Accept-Language kért területi beállításban.

      • nativeName: A célnyelv nevének megjelenítése a célnyelv natív területi beállításában.

      • dir: Irány, amely rtl jobbról balra vagy ltr balról jobbra író nyelvekhez használható.

      • code: A célnyelvet azonosító nyelvkód.

    Ilyen például a következő:

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

A válaszobjektum struktúrája nem változik az API verziójának módosítása nélkül. Az API ugyanazon verziójában az elérhető nyelvek listája idővel változhat, mivel a Microsoft Translator folyamatosan bővíti a szolgáltatásai által támogatott nyelvek listáját.

A támogatott nyelvek listája nem változik gyakran. A hálózati sávszélesség megtakarítása és a válaszképesség javítása érdekében az ügyfélalkalmazásnak fontolóra kell vennie a nyelvi erőforrások és a megfelelő entitáscímke (ETag) gyorsítótárazását. Ezután az ügyfélalkalmazás rendszeres időközönként (például 24 óránként) lekérdezheti a szolgáltatást a legújabb támogatott nyelvek lekéréséhez. A fejlécmező aktuális ETag értékének If-None-Match átadása lehetővé teszi a szolgáltatás számára a válasz optimalizálását. Ha az erőforrás nem lett módosítva, a szolgáltatás a 304-ben megadott állapotkódot és egy üres választörzset ad vissza.

Válaszfejlécek

Fejlécek Description
Etag Az entitáscímke aktuális értéke a támogatott nyelvek kért csoportjaihoz. A későbbi kérések hatékonyabbá tétele érdekében az ügyfél elküldheti az ETag értéket egy If-None-Match fejlécmezőben.
X-RequestId A szolgáltatás által a kérés azonosítására létrehozott érték. Hibaelhárítási célokra használják.

Válaszállapot-kódok

A következő lehetséges HTTP-állapotkódok jelennek meg, amelyeket a kérés visszaad.

Állapotkód Description
200 Sikeres művelet.
304 Az erőforrás nem lett módosítva a kérelemfejlécek If-None-Matcháltal megadott verzió óta.
400 A lekérdezési paraméterek egyike hiányzik vagy érvénytelen. Az újrapróbálkozás előtt javítsa ki a kérésparamétereket.
429 A kiszolgáló elutasította a kérést, mert az ügyfél túllépte a kérelemkorlátokat.
500 Váratlan hiba történt. Ha a hiba továbbra is fennáll, jelentse a következővel: a hiba dátuma és időpontja, kérésazonosító a válaszfejlécből X-RequestId, és ügyfélazonosító a kérelemfejlécből X-ClientTraceId.
503 A kiszolgáló átmenetileg nem érhető el. Ismételje meg a kérést. Ha a hiba továbbra is fennáll, jelentse a következővel: a hiba dátuma és időpontja, kérésazonosító a válaszfejlécből X-RequestId, és ügyfélazonosító a kérelemfejlécből X-ClientTraceId.

Hiba esetén a kérés JSON-hibaválaszt is ad vissza. A hibakód egy 6 jegyű szám, amely a 3 jegyű HTTP-állapotkódot kombinálja, majd egy háromjegyű számmal a hiba további kategorizálásához. A gyakori hibakódokért tekintse meg a 3-as verziójú Translator referenciaoldalát.

Példák

Az alábbi példa bemutatja, hogyan kérhetők le a szövegfordításhoz támogatott nyelvek.

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