Translator 3.0: Transliterate

Konvertiert Text in einer Sprache aus einem Skript in ein anderes Skript.

Anfrage-URL

Sendet eine POST-Anforderung an:

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

Weitere Informationen finden Sie unter "Virtual Network Support for Translator service selected network and private endpoint configuration and support".

Anforderungsparameter

Die folgenden Anforderungsparameter werden in der Abfragezeichenfolge übergeben:

Query parameter (Abfrageparameter) BESCHREIBUNG
api-version Erforderlicher Parameter.
Die vom Client angeforderte Version der API. Der Wert muss 3.0 sein.
language Erforderlicher Parameter.
Gibt die Sprache des Texts an, der von einem Skript in ein anderes konvertiert werden soll. Mögliche Sprachen sind im transliteration-Bereich aufgeführt, der durch Abfrage des Diensts nach den unterstützten Sprachen abgerufen wird.
fromScript Erforderlicher Parameter.
Gibt das vom Eingabetext verwendete Skript an. Suchen Sie mithilfe des transliteration-Bereichs nach unterstützten Sprachen, um Eingabeskripts zu finden, die für die ausgewählte Sprache verfügbar sind.
toScript Erforderlicher Parameter.
Gibt das Ausgabeskript an. Suchen Sie mithilfe des transliteration-Bereichs nach unterstützten Sprachen, um Ausgabeskripts zu finden, die für die ausgewählte Kombination aus Sprache und Eingabeskript verfügbar sind.

Anforderungsheader enthalten Folgendes:

Header Beschreibung
Authentifizierungsheader Erforderlicher Anforderungsheader.
Weitere Informationen finden Sie in den verfügbaren Optionen für die Authentifizierung.
Content-Type Erforderlicher Anforderungsheader.
Gibt den Inhaltstyp der Nutzlast an. Mögliche Werte sind: application/json
Content-Length Optional.
Die Länge des Anforderungstexts.
X-ClientTraceId Optional:
Eine vom Client erstellte GUID zur eindeutigen Identifizierung der Anforderung. Sie können diesen Header nur weglassen, wenn Sie die Ablaufverfolgungs-ID in die Abfragezeichenfolge über einen Abfrageparameter namens ClientTraceId einschließen.

Anforderungstext

Der Anforderungstext ist ein JSON-Array. Jedes Arrayelement ist ein JSON-Objekt mit einer Zeichenfolgeneigenschaft namens Text, die die zu suchende Zeichenfolge repräsentiert.

[
    {"Text":"こんにちは"},
    {"Text":"さようなら"}
]

Es gelten die folgenden Einschränkungen:

  • Das Array darf höchstens 10 Elemente enthalten.
  • Der Textwert eines Arrayelements darf 1.000 Zeichen (einschließlich Leerzeichen) nicht überschreiten.
  • Der gesamte Anforderungstext darf nicht mehr als 5.000 Zeichen enthalten (einschließlich Leerzeichen).

Antworttext

Eine erfolgreiche Antwort ist ein JSON-Array mit einem Ergebnis für jedes Element im Eingabearray. Ein Ergebnisobjekt enthält die folgenden Eigenschaften:

  • text: Dies ist eine Zeichenfolge, die aus der Konvertierung der Eingabezeichenfolge in das Ausgabeskript resultiert.

  • script: Eine Zeichenfolge, die das in der Ausgabe verwendete Skript angibt.

Eine JSON-Beispielantwort lautet wie folgt:

[
    {"text":"konnnichiha","script":"Latn"},
    {"text":"sayounara","script":"Latn"}
]

Antwortheader

Header BESCHREIBUNG
X-RequestId Vom Dienst generierter Wert, um die Anforderung zu identifizieren und für Problembehandlungszwecke verwendet zu werden.

Antwortstatuscodes

Im Folgenden finden Sie die möglichen HTTP-Statuscodes, die eine Anforderung zurückgeben kann.

Statuscode BESCHREIBUNG
200 Erfolg.
400 Einer der Abfrageparameter fehlt oder ist ungültig. Korrigieren Sie die Anforderungsparameter, bevor Sie es erneut versuchen.
401 Die Anforderung konnte nicht authentifiziert werden. Überprüfen Sie, ob die Anmeldeinformationen angegeben und gültig sind.
403 Die Anforderung ist nicht autorisiert. Weitere Informationen finden Sie in der Fehlermeldung. Dieser Code gibt häufig an, dass alle kostenlosen Übersetzungen, die mit einem Testabonnement bereitgestellt werden, verwendet werden.
429 Der Server hat die Anforderung abgelehnt, da der Client die Anforderungsgrenzwerte überschritten hat.
500 Ein unerwarteter Fehler ist aufgetreten. Wenn der Fehler weiterhin besteht, melden Sie ihn, und gebe Sie Folgendes an: Datum und Zeitpunkt des Fehlers, Anforderungsbezeichner aus dem Anforderungsheader X-RequestId und Clientbezeichner aus dem Anforderungsheader X-ClientTraceId.
503 Der Server ist vorübergehend nicht verfügbar. Wiederholen Sie die Anforderung. Wenn der Fehler weiterhin besteht, melden Sie ihn, und gebe Sie Folgendes an: Datum und Zeitpunkt des Fehlers, Anforderungsbezeichner aus dem Anforderungsheader X-RequestId und Clientbezeichner aus dem Anforderungsheader X-ClientTraceId.

Sollte ein Fehler auftreten, gibt die Anforderung auch eine JSON-Fehlerantwort zurück. Der Fehlercode ist eine 6-stellige Zahl, die aus dem 3-stelligen HTTP-Statuscode gefolgt von einer 3-stelligen Zahl zur Kategorisierung des Fehlers besteht. Häufige Fehlercodes finden Sie in der Referenz zu Version 3 von Translator.

Beispiele

Das folgende Beispiel zeigt, wie Sie zwei japanische Zeichenfolgen in lateinische Buchstaben konvertieren.

Die JSON-Nutzlast für die Anforderung in diesem Beispiel:

[{"text":"こんにちは","script":"jpan"},{"text":"さようなら","script":"jpan"}]

Wenn Sie cURL in einem Befehlszeilenfenster verwenden, das keine Unicode-Zeichen unterstützt, verwenden Sie die folgende JSON-Nutzlast, und speichern Sie sie in eine Datei namens request.txt. Stellen Sie sicher, dass Sie diese Datei mit UTF-8-Codierung speichern.

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