Translator 3.0: Translitterera
Konverterar text på ett språk från ett skript till ett annat skript.
Begärans-URL
Skicka en POST-begäran till:
https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0
SeVirtual Network Support för Translator-tjänstens valda nätverks- och privata slutpunktskonfiguration och support.
Begärandeparametrar
Begärandeparametrar som skickas på frågesträngen är:
| Frågeparameter | Beskrivning |
|---|---|
| api-version | Obligatorisk parameter. Version av API:et som begärs av klienten. Värdet måste vara 3.0. |
| language | Obligatorisk parameter. Anger språket i texten som ska konverteras från ett skript till ett annat. Möjliga språk visas i omfånget transliteration som erhålls genom att fråga tjänsten om dess språk som stöds. |
| fromScript | Obligatorisk parameter. Anger skriptet som används av indatatexten. Leta upp språk som stöds med hjälp av omfånget transliteration för att hitta indataskript som är tillgängliga för det valda språket. |
| toScript | Obligatorisk parameter. Anger utdataskriptet. Leta upp språk som stöds med omfånget transliteration för att hitta utdataskript som är tillgängliga för den valda kombinationen av indataspråk och indataskript. |
Bland begärandehuvudena finns:
| Sidhuvuden | Description |
|---|---|
| Autentiseringshuvuden | Obligatoriskt begärandehuvud. Se tillgängliga alternativ för autentisering. |
| Content-Type | Obligatoriskt begärandehuvud. Anger nyttolastens innehållstyp. Möjliga värden är: application/json |
| Innehållslängd | Obligatoriskt begärandehuvud. Längden på begärandetexten. |
| X-ClientTraceId | Valfritt. Ett klientgenererat GUID för att unikt identifiera begäran. Du kan utelämna det här huvudet om du inkluderar spårnings-ID:t i frågesträngen med hjälp av en frågeparameter med namnet ClientTraceId. |
Begärandetext
Brödtexten i begäran är en JSON-matris. Varje matriselement är ett JSON-objekt med en strängegenskap med namnet Text, som representerar strängen som ska konverteras.
[
{"Text":"こんにちは"},
{"Text":"さようなら"}
]
Följande begränsningar gäller:
- Matrisen kan ha högst 10 element.
- Textvärdet för ett matriselement får inte överstiga 1 000 tecken, inklusive blanksteg.
- Hela texten som ingår i begäran får inte överstiga 5 000 tecken, inklusive blanksteg.
Själva svaret
Ett lyckat svar är en JSON-matris med ett resultat för varje element i indatamatrisen. Ett resultatobjekt innehåller följande egenskaper:
text: En sträng som resulterar i att du konverterar indatasträngen till utdataskriptet.script: En sträng som anger skriptet som används i utdata.
Ett exempel på JSON-svar är:
[
{"text":"konnnichiha","script":"Latn"},
{"text":"sayounara","script":"Latn"}
]
Svarshuvuden
| Sidhuvuden | Description |
|---|---|
| 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. |
| 400 | En av frågeparametrarna saknas eller är ogiltig. Korrigera begärandeparametrarna innan du försöker igen. |
| 401 | Det gick inte att autentisera begäran. Kontrollera att autentiseringsuppgifterna är angivna och giltiga. |
| 403 | Begäran har inte behörighet. Kontrollera informationsfelmeddelandet. Den här koden anger ofta att alla kostnadsfria översättningar som tillhandahålls med en utvärderingsprenumeration har förbrukats. |
| 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 konverterar två japanska strängar till romaniserade japanska.
JSON-nyttolasten för begäran i det här exemplet:
[{"text":"こんにちは","script":"jpan"},{"text":"さようなら","script":"jpan"}]
Om du använder cURL i ett kommandoradsfönster som inte stöder Unicode-tecken, tar du följande JSON-nyttolast och sparar den i en fil med namnet request.txt. Se till att spara filen med UTF-8 kodning.
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