Translator 3.0: BreakSentence

Artikel
09/01/2024

Hiermee wordt de positie van zinsgrenzen in een stuk tekst geïdentificeerd.

Aanvraag-URL

Een aanvraag POST versturen naar:

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

Zie Virtual Network Support for Translator service selected network and private endpoint configuration and support.

Aanvraagparameters

Aanvraagparameters die worden doorgegeven aan de queryreeks zijn:

Queryparameter	Beschrijving
api-version	Vereiste queryparameter. Versie van de API die door de client is aangevraagd. Waarde moet zijn `3.0`.
language	Optionele queryparameter. Taaltag waarmee de taal van de invoertekst wordt geïdentificeerd. Als er geen code is opgegeven, wordt automatische taaldetectie toegepast.
script	Optionele queryparameter. Scripttag die het script identificeert dat wordt gebruikt door de invoertekst. Als er geen script is opgegeven, wordt ervan uitgegaan dat het standaardscript van de taal wordt gebruikt.

Aanvraagheaders zijn onder andere:

Kopteksten	Beschrijving
Verificatieheaders	Vereiste aanvraagheader. Zie Beschikbare opties voor verificatie.
Inhoudstype	Vereiste aanvraagheader. Hiermee geeft u het inhoudstype van de payload op. Mogelijke waarden zijn: `application/json`.
Content-Length	Optioneel. De lengte van de aanvraagtekst.
X-ClientTraceId	Optioneel. Een door de client gegenereerde GUID om de aanvraag op unieke wijze te identificeren. U kunt deze header weglaten als u de tracerings-id in de queryreeks opneemt middels een queryparameter met de naam `ClientTraceId`.

Aanvraagtekst

De hoofdtekst van de aanvraag is een JSON-matrix. Elk matrixelement is een JSON-object met een tekenreekseigenschap met de naam Text. Zingrenzen worden berekend voor de waarde van de Text eigenschap. Een voorbeeldtekst van een aanvraag met één stuk tekst ziet er als volgt uit:

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

De volgende beperkingen zijn van toepassing:

De matrix kan maximaal 100 elementen bevatten.
De tekstwaarde van een matrixelement mag niet groter zijn dan 50.000 tekens, inclusief spaties.
De volledige tekst in de aanvraag mag niet langer zijn dan 50.000 tekens, inclusief spaties.
Als de language queryparameter is opgegeven, moeten alle matrixelementen zich in dezelfde taal bevinden. Anders wordt autodetection voor elke matrix afzonderlijk toegepast op elk matrixelement.

Hoofdtekst van de reactie

Een geslaagd antwoord is een JSON-matrix met één resultaat voor elke tekenreeks in de invoermatrix. Een resultaatobject bevat de volgende eigenschappen:

sentLen: Een matrix met gehele getallen die de lengte van de zinnen in het tekstelement vertegenwoordigen. De lengte van de matrix is het aantal zinnen en de waarden zijn de lengte van elke zin.
detectedLanguage: Een object dat de gedetecteerde taal beschrijft via de volgende eigenschappen:
- language: Code van de gedetecteerde taal.
- score: Een float-waarde die het vertrouwen in het resultaat aangeeft. De score ligt tussen nul (0) en één (1,0). Een lage score (<= 0,4) geeft een lage betrouwbaarheid aan.

De detectedLanguage eigenschap is alleen aanwezig in het resultaatobject wanneer automatisch bepalen van taal wordt aangevraagd.

Een voorbeeld van een JSON-antwoord is:

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

Responsheaders

Kopteksten	Beschrijving
X-RequestId	Waarde die door de service wordt gegenereerd om de aanvraag te identificeren en voor probleemoplossingsdoeleinden te gebruiken.

Antwoordstatuscodes

Hier volgen de mogelijke HTTP-statuscodes die een aanvraag retourneert.

Statuscode	Beschrijving
200	Geslaagd.
400	Een van de queryparameters ontbreekt of is ongeldig. Corrigeer aanvraagparameters voordat u het opnieuw probeert.
401	De aanvraag kan niet worden geverifieerd. Controleer of referenties zijn opgegeven en geldig zijn.
403	De aanvraag is niet geautoriseerd. Controleer het foutbericht met details. Deze antwoordcode geeft vaak aan dat alle gratis vertalingen die bij een proefabonnement worden geleverd, worden gebruikt.
429	De server heeft de aanvraag geweigerd omdat de client de aanvraaglimieten heeft overschreden.
500	Er is een onverwachte fout opgetreden. Als de fout zich blijft voordoen, meldt u deze met: datum en tijd van de fout, aanvraag-id van antwoordheader `X-RequestId`en client-id van aanvraagheader `X-ClientTraceId`.
503	Server is tijdelijk niet beschikbaar. Probeer de aanvraag opnieuw. Als de fout zich blijft voordoen, meldt u deze met: datum en tijd van de fout, aanvraag-id van antwoordheader `X-RequestId`en client-id van aanvraagheader `X-ClientTraceId`.

Als er een fout optreedt, retourneert de aanvraag een JSON-foutreactie. De foutcode is een getal van 6 cijfers dat de HTTP-statuscode van 3 cijfers combineert, gevolgd door een 3-cijferig getal om de fout verder te categoriseren. Algemene foutcodes vindt u op de naslagpagina van v3 Translator.

Voorbeelden

In het volgende voorbeeld ziet u hoe u zingrenzen voor één zin kunt verkrijgen. De service detecteert automatisch de zinstaal.

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

Delen via