Translator 3.0: BreakSentence

Artikel
09/01/2024

Erkennt die Positionierung von Satzgrenzen in einem Textabschnitt.

Anfrage-URL

Sendet eine POST-Anforderung an:

https://api.cognitive.microsofttranslator.com/breaksentence?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:

Abfrageparameter	BESCHREIBUNG
api-version (API-Version)	Erforderlicher Abfrageparameter Die vom Client angeforderte Version der API. Der Wert muss `3.0` sein.
language	Optionaler Abfrageparameter Sprachtag, das die Sprache des Eingabetexts angibt. Wenn kein Code angegeben ist, wird die automatische Spracherkennung angewendet.
script	Optionaler Abfrageparameter Skripttag, das das Skript erkennt, das vom Eingabetext verwendet wird. Wenn kein Skript angegeben ist, wird vom Standardskript der Sprache ausgegangen.

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: `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. Satzgrenzen werden für den Wert der Text-Eigenschaft berechnet. Nachfolgend finden Sie ein Beispiel für einen Anforderungstext, der aus einem Abschnitt besteht:

[
    { "Text": "How are you? I am fine. What did you do today?" }
]

Es gelten die folgenden Einschränkungen:

Das Array kann höchstens über 100 Elemente verfügen.
Der Textwert eines Arrayelements darf 50.000 Zeichen (einschließlich Leerzeichen) nicht überschreiten.
Der gesamte Anforderungstext darf nicht mehr als 50.000 Zeichen enthalten (einschließlich Leerzeichen).
Wenn der Abfrageparameter language angegeben ist, müssen alle Arrayelemente in derselben Sprache sein. Wenn dies nicht der Fall ist, wird die automatische Spracherkennung auf jedes Arrayelement einzeln angewendet.

Antworttext

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

sentLen: Ein Integerarray stellt die Länge der Sätze im Textelement dar. Die Länge des Arrays stellt die Anzahl von Sätzen dar, und die Werte stehen jeweils für die Länge der einzelnen Sätze.
detectedLanguage: Ein Objekt, das die erkannte Sprache durch die folgenden Eigenschaften beschreibt:
- language: Code der erkannten Sprache.
- score: Ein float-Wert, der die Zuverlässigkeit des Ergebnisses angibt. Der Wert liegt zwischen 0 (null) und 1,0 (eins). Eine niedrige Bewertung (<= 0,4) weist auf eine geringe Konfidenz hin.

Die detectedLanguage-Eigenschaft ist nur im Ergebnisobjekt enthalten, wenn automatische Spracherkennung angefordert wird.

Eine JSON-Beispielantwort lautet wie folgt:

[
    {
        "detectedLanguage": {
            "language": "en",
            "score": 1.0
        },
        "sentLen": [
            13,
            11,
            22
        ]
    }
]

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 Antwortcode 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 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 Satzgrenzen für einen einzelnen Satz abrufen können. Der Dienst erkennt automatisch die Sprache des Satzes.

curl -X POST "https://api.cognitive.microsofttranslator.com/breaksentence?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'How are you? I am fine. What did you do today?'}]"

Freigeben über