Freigeben über


Transliterat (2025-05-01-Preview)

Die Texttransliterations-API ordnet Ihr Quellsprachenskript oder -alphabet einem Zielsprachenskript oder -alphabet zu. Im Gegensatz zur Übersetzung gibt transliteration nicht die Bedeutung zurück, nur die Art und Weise, wie der Text geschrieben wird.

Anfrage-URL

Globale Endpunktkonfiguration

Senden Sie eine POST Anforderung an:

curl -X POST https://api.cognitive.microsofttranslator.com/transliterate?api-version=2025-05-01-preview
 -H "Ocp-Apim-Subscription-Key:<your-key>" ^
 -H "Ocp-Apim-Subscription-Region:<your-resource-region>" ^
 -H "Content-Type: application/json" ^
 -d "<your-request-body>"

Linux oder macOS

curl -X POST "https://api.cognitive.microsofttranslator.com/transliterate?api-version=2025-05-01-preview" \
-H "Ocp-Apim-Subscription-Key:<your-key>" \
-H "Ocp-Apim-Subscription-Region:<your-resource-region>" \
-H "Content-Type: application/json" \
-d "<your-request-body>"

Benutzerdefinierte Endpunktkonfiguration

Ihr benutzerdefinierter Domänenendpunkt ist eine URL, die mit Ihrem Ressourcennamen und Hostnamen formatiert ist und im Azure-Portal verfügbar ist. Wenn Sie Ihre Translator-Ressource erstellt haben, ist der Wert, den Sie im Name Feld eingegeben haben, der parameter für den benutzerdefinierten Domänennamen für den Endpunkt.

Senden einer POST Anforderung:

Fenster

curl -X POST "https://<your-resource-name>.cognitiveservices.azure.com//transliterate?api-version=2025-05-01-preview"^
    -H "Ocp-Apim-Subscription-Key:<your-key>"^
    -H "Ocp-Apim-Subscription-Region:<your-resource-region>"^
    -H "Content-Type: application/json"^
    -d "<your-request-body>"

Linux oder macOS

curl -X POST "https://<your-resource-name>.cognitiveservices.azure.com//transliterate?api-version=2025-05-01-preview" \
    -H "Ocp-Apim-Subscription-Key:<your-key>" \
    -H "Ocp-Apim-Subscription-Region:<your-resource-region>" \
    -H "Content-Type: application/json" \
    -d "<your-request-body>"

Privater Endpunkt

Weitere Informationen zum ausgewählten Übersetzerdienst und zur Konfiguration und Unterstützung privater Endpunkte finden Sie unterVirtual Network Support.For more information on Translator service selected network configuration and private endpoint configuration and support, see Virtual Network Support.

Anforderungsheader

Headers Erforderlich Description
Authentifizierungsheader Wahr Weitere Informationen finden Sieunter den verfügbaren Optionen für die Authentifizierung.
Inhaltstyp Wahr Gibt den Inhaltstyp der Nutzlast an. Akzeptierte Werte sind: application/json; charset=UTF-8
Inhaltslänge Falsch Die Länge des Anforderungstexts.
X-ClientTraceId Falsch Eine vom Client generierte GUID, um die Anforderung eindeutig zu identifizieren. Sie können diesen optionalen Header weglassen, wenn Sie die Ablaufverfolgungs-ID in die Abfragezeichenfolge mithilfe eines Abfrageparameters mit dem Namen ClientTraceIdeinschließen.

Anforderungsparameter

Anforderungsparameter, die an die Abfragezeichenfolgenbereiche übergeben werden, sind wie folgt:

Parameter Typ Erforderlich Description
API-Version Schnur Wahr Version der API, die vom Client angefordert wird. Der akzeptierte Wert ist 2025-05-01-preview.
fromScript Schnur Wahr Gibt das skript an, das vom Eingabetext verwendet wird. Suchen Sie nach unterstützten Sprachen mithilfe des transliteration Bereichs, um Eingabeskripts zu finden, die für die ausgewählte Sprache verfügbar sind.
toScript Schnur Wahr Gibt das Ausgabeskript an. Suchen Sie mithilfe des Bereichs transliteration, um Ausgabeskripts für die ausgewählte Kombination aus Eingabesprache und Eingabeskript zu finden.
Sprache Schnur Falsch Gibt den Sprachcode für den source Text an. Wenn nicht angegeben, schneidet das System automatisch die Sprache des Quelltexts ab. Akzeptierte Werte sind eine Liste von Sprachcode, der vom angegebenen Modell unterstützt wird.

Anfragekörper

Der Textkörper der Anforderung ist ein JSON-Array. Jedes Arrayelement ist ein JSON-Objekt mit einer Zeichenfolgeneigenschaft namens Text, die die zu konvertierende Zeichenfolge darstellt.

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

Es gelten die folgenden Einschränkungen:

  • Das Array kann höchstens 10 Elemente aufweisen.
  • Der Textwert eines Arrayelements darf 1.000 Zeichen einschließlich Leerzeichen nicht überschreiten.
  • Der gesamte text, der in der Anforderung enthalten ist, darf 5.000 Zeichen einschließlich Leerzeichen nicht überschreiten.

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: Eine Zeichenfolge, die aus der Konvertierung der Eingabezeichenfolge in das Ausgabeskript resultiert.

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

Beispiel für eine JSON-Antwort:

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

Antwortkopfzeilen

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

Example

Das folgende Beispiel zeigt, wie zwei japanische Zeichenfolgen in romanisiertes Japanisch konvertiert werden.

  curl -X POST "https://api.cognitive.microsofttranslator.com/transliterate?api-version=2025-05-01-preview&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

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

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

Statuscodes für Antworten

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

Statuscode Description
200 Erfolg.
400 Einer der Abfrageparameter fehlt oder ist ungültig. Korrigieren Sie die Anforderungsparameter, bevor Sie den Vorgang wiederholen.
401 Die Anforderung konnte nicht authentifiziert werden. Überprüfen Sie, ob Anmeldeinformationen angegeben und gültig sind.
403 Die Anforderung ist nicht autorisiert. Überprüfen Sie die Fehlermeldung "Details". 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 mit: Datum und Uhrzeit des Fehlers, Anforderungsbezeichner vom Antwortheader und Client-ID aus Anforderungsheader X-RequestIdX-ClientTraceId.
503 Der Server ist vorübergehend nicht verfügbar. Wiederholen Sie die Anforderung. Wenn der Fehler weiterhin besteht, melden Sie ihn mit: Datum und Uhrzeit des Fehlers, Anforderungsbezeichner vom Antwortheader und Client-ID aus Anforderungsheader X-RequestIdX-ClientTraceId.

Wenn ein Fehler auftritt, gibt die Anforderung auch eine JSON-Fehlerantwort zurück. Der Fehlercode ist eine 6-stellige Zahl, die den 3-stelligen HTTP-Statuscode kombiniert, gefolgt von einer 3-stelligen Zahl, um den Fehler weiter zu kategorisieren. Allgemeine Fehlercodes finden Sie auf der Statuscodereferenzseite.

Nächste Schritte