Dela via


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

Se Stöd för virtuellt nätverk för Translator-tjänsten valt nätverk och privat slutpunktskonfiguration och support.

Parametrar för begäran

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.
språk Obligatorisk parameter.
Anger språket för texten som ska konverteras från ett skript till ett annat. Möjliga språk visas i det transliteration omfång 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 hjälp av omfånget transliteration för att hitta utdataskript som är tillgängliga för den valda kombinationen av indataspråk och indataskript.

Bland begäranderubrikerna finns:

Sidhuvuden beskrivning
Autentiseringshuvuden Obligatoriskt begärandehuvud.
Se tillgängliga alternativ för autentisering.
Innehållstyp Obligatoriskt begärandehuvud.
Anger nyttolastens innehållstyp. Möjliga värden är: application/json
Innehållslängd Valfritt.
Längden på begärandetexten.
X-ClientTraceId Valfritt.
Ett klientgenererat GUID för att unikt identifiera begäran. Du kan utelämna den här rubriken 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 är resultatet av att konvertera 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"}
]

Svarsrubriker

Sidhuvuden beskrivning
X-RequestId Värde som genereras av tjänsten för att identifiera begäran och som används för felsökning.

Svarsstatuskoder

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

Statuskod beskrivning
200 Lyckades.
400 En av frågeparametrarna saknas eller är ogiltig. Korrigera parametrar för begäran innan du försöker igen.
401 Det gick inte att autentisera begäran. Kontrollera att autentiseringsuppgifterna är angivna och giltiga.
403 Begäran är inte auktoriserad. Kontrollera informationsfelmeddelandet. Den här koden anger ofta att alla kostnadsfria översättningar som tillhandahålls med en utvärderingsprenumeration används.
429 Servern avvisade begäran eftersom klienten överskred 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 uppstår returnerar begäran också ett JSON-felsvar. Felkoden är ett 6-siffrigt tal som kombinerar den tresiffriga HTTP-statuskoden följt av ett tresiffrigt tal 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