Translator 3.0: BreakSentence

Artikel
09/01/2024

Identifierar placeringen av meningsgränser i en textdel.

Begärans-URL

Skicka en POST-begäran till:

https://api.cognitive.microsofttranslator.com/breaksentence?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 frågeparameter. Version av API:et som begärs av klienten. Värdet måste vara `3.0`.
språk	Valfri frågeparameter. Språktagg som identifierar språket i indatatexten. Om ingen kod anges tillämpas automatisk språkidentifiering.
-skriptet	Valfri frågeparameter. Skripttagg som identifierar skriptet som används av indatatexten. Om ett skript inte anges antas språkets standardskript.

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. Meningsgränser beräknas för värdet för Text egenskapen. Ett exempel på begärandetext med en text ser ut så här:

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

Följande begränsningar gäller:

Matrisen kan ha högst 100 element.
Textvärdet för ett matriselement får inte överstiga 50 000 tecken, inklusive blanksteg.
Hela texten som ingår i begäran får inte överstiga 50 000 tecken, inklusive blanksteg.
language Om frågeparametern anges måste alla matriselement vara på samma språk. Annars tillämpas automatisk språkdetection på varje matriselement oberoende av varandra.

Själva svaret

Ett lyckat svar är en JSON-matris med ett resultat för varje sträng i indatamatrisen. Ett resultatobjekt innehåller följande egenskaper:

sentLen: En matris med heltal som representerar längden på meningarna i textelementet. Matrisens längd är antalet meningar och värdena är längden på varje mening.
detectedLanguage: Ett objekt som beskriver det identifierade språket via följande egenskaper:
- language: Kod för det identifierade språket.
- score: Ett flyttalsvärde som anger konfidensen i resultatet. Poängen är mellan noll (0) och en (1,0). En låg poäng (<= 0,4) indikerar ett lågt förtroende.

Egenskapen detectedLanguage finns bara i resultatobjektet när autodetection för språk begärs.

Ett exempel på JSON-svar är:

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

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	Klart!
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 svarskoden 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	Ett oväntat fel har uppstått. Om felet kvarstår rapporterar du det med: datum och tid för felet, begärandeidentifierare från svarshuvudet `X-RequestId`och 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-RequestId`och klientidentifierare från begärandehuvudet `X-ClientTraceId`.

Om ett fel inträffar returnerar begäran 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 hämtar meningsgränser för en enda mening. Tjänsten identifierar automatiskt meningsspråket.

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?'}]"

Dela via