Translator 3.0: Transliterát
Převede text v jednom jazyce z jednoho skriptu na jiný.
Adresa URL požadavku
Odešlete požadavek POST do:
https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0
VizVirtual Network Podpora pro konfiguraci a podporu vybrané sítě a privátního koncového bodu služby Translator.
Parametry požadavku
Parametry požadavku předávané řetězci dotazu jsou:
| Parametr dotazu | Popis |
|---|---|
| verze-api | Povinný parametr. Verze rozhraní API vyžádaná klientem Hodnota musí být 3.0. |
| language | Povinný parametr. Určuje jazyk textu, který se má převést z jednoho skriptu na jiný. Možné jazyky jsou uvedené v transliteration oboru získaném dotazováním služby na podporované jazyky. |
| fromScript | Povinný parametr. Určuje skript použitý vstupním textem. Vyhledejte podporované jazyky pomocí transliteration oboru a vyhledejte vstupní skripty dostupné pro vybraný jazyk. |
| toScript | Povinný parametr. Určuje výstupní skript. Vyhledejte podporované jazyky pomocí transliteration oboru a vyhledejte výstupní skripty dostupné pro vybranou kombinaci vstupního jazyka a vstupního skriptu. |
Mezi hlavičky požadavků patří:
| Hlavičky | Description |
|---|---|
| Hlavičky ověřování | Požadovaná hlavička požadavku. Projděte si dostupné možnosti ověřování. |
| Typ obsahu | Požadovaná hlavička požadavku. Určuje typ obsahu datové části. Možné hodnoty jsou: application/json |
| Délka obsahu | Požadovaná hlavička požadavku. Délka textu požadavku. |
| X-ClientTraceId | Volitelné. Identifikátor GUID vygenerovaný klientem pro jedinečnou identifikaci požadavku. Tuto hlavičku můžete vynechat, pokud do řetězce dotazu zahrnete ID trasování pomocí parametru dotazu s názvem ClientTraceId. |
Text požadavku
Text požadavku je pole JSON. Každý prvek pole je objekt JSON s vlastností řetězce s názvem Text, která představuje řetězec, který se má převést.
[
{"Text":"こんにちは"},
{"Text":"さようなら"}
]
Platí následující omezení:
- Pole může mít maximálně 10 prvků.
- Textová hodnota prvku pole nesmí překročit 1 000 znaků včetně mezer.
- Celý text zahrnutý v požadavku nesmí být delší než 5 000 znaků včetně mezer.
Text odpovědi
Úspěšná odpověď je pole JSON s jedním výsledkem pro každý prvek vstupního pole. Objekt výsledku obsahuje následující vlastnosti:
text: Řetězec, který je výsledkem převodu vstupního řetězce na výstupní skript.script: Řetězec určující skript použitý ve výstupu.
Příklad odpovědi JSON:
[
{"text":"konnnichiha","script":"Latn"},
{"text":"sayounara","script":"Latn"}
]
Hlavičky odpovědi
| Hlavičky | Description |
|---|---|
| X-RequestId | Hodnota vygenerovaná službou k identifikaci požadavku. Používá se pro účely řešení potíží. |
Stavové kódy odpovědí
Níže jsou uvedené možné stavové kódy HTTP, které požadavek vrátí.
| Stavový kód | Description |
|---|---|
| 200 | Úspěch. |
| 400 | Jeden z parametrů dotazu chybí nebo je neplatný. Před opakováním opravte parametry požadavku. |
| 401 | Požadavek nelze ověřit. Zkontrolujte, jestli jsou zadané a platné přihlašovací údaje. |
| 403 | Žádost není autorizovaná. Zkontrolujte chybovou zprávu s podrobnostmi. Tento kód často označuje, že všechny bezplatné překlady poskytované se zkušebním předplatným byly využity. |
| 429 | Server odmítl požadavek, protože klient překročil limity požadavků. |
| 500 | Došlo k neočekávané chybě. Pokud chyba přetrvává, nahlaste ji s datem a časem selhání, identifikátorem požadavku z hlavičky X-RequestIdodpovědi a identifikátorem klienta z hlavičky X-ClientTraceIdpožadavku . |
| 503 | Server je dočasně nedostupný. Zkuste požadavek zopakovat. Pokud chyba přetrvává, nahlaste ji s datem a časem selhání, identifikátorem požadavku z hlavičky X-RequestIdodpovědi a identifikátorem klienta z hlavičky X-ClientTraceIdpožadavku . |
Pokud dojde k chybě, požadavek také vrátí chybovou odpověď JSON. Kód chyby je 6místné číslo, které kombinuje 3místný stavový kód HTTP následovaný 3místným číslem pro další kategorizaci chyby. Běžné kódy chyb najdete na referenční stránce služby Translator v3.
Příklady
Následující příklad ukazuje, jak převést dva japonské řetězce na romanizovanou japonštinu.
Datová část JSON pro požadavek v tomto příkladu:
[{"text":"こんにちは","script":"jpan"},{"text":"さようなら","script":"jpan"}]
Pokud používáte cURL v okně příkazového řádku, které nepodporuje znaky Unicode, použijte následující datovou část JSON a uložte ji do souboru s názvem request.txt. Nezapomeňte soubor uložit s kódováním UTF-8 .
curl -X POST "https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0&language=ja&fromScript=Jpan&toScript=Latn" -H "X-ClientTraceId: 875030C7-5380-40B8-8A03-63DACCF69C11" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d @request.txt