Translator Text API 3.0: BreakSentence

Identifies the positioning of sentence boundaries in a piece of text.

Request URL

Send a POST request to:

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

Request parameters

Request parameters passed on the query string are:

Query parameter Description
api-version *Required query parameter*.
Version of the API requested by the client. Value must be `3.0`.
language *Optional query parameter*.
Language tag identifying the language of the input text. If a code is not specified, automatic language detection will be applied.
script *Optional query parameter*.
Script tag identifying the script used by the input text. If a script is not specified, the default script of the language will be assumed.

Request headers include:

Headers Description
Authentication header(s) Required request header.
See available options for authentication.
Content-Type *Required request header*.
Specifies the content type of the payload. Possible values are: `application/json`.
Content-Length *Required request header*.
The length of the request body.
X-ClientTraceId *Optional*.
A client-generated GUID to uniquely identify the request. Note that you can omit this header if you include the trace ID in the query string using a query parameter named `ClientTraceId`.

Request body

The body of the request is a JSON array. Each array element is a JSON object with a string property named Text. Sentence boundaries are computed for the value of the Text property. A sample request body with one piece of text looks like that:

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

The following limitations apply:

  • The array can have at most 100 elements.
  • The text value of an array element cannot exceed 10,000 characters including spaces.
  • The entire text included in the request cannot exceed 50,000 characters including spaces.
  • If the language query parameter is specified, then all array elements must be in the same language. Otherwise, language auto-detection is applied to each array element independently.

Response body

A successful response is a JSON array with one result for each string in the input array. A result object includes the following properties:

  • sentLen: An array of integers representing the lengths of the sentences in the text element. The length of the array is the number of sentences, and the values are the length of each sentence.

  • detectedLanguage: An object describing the detected language through the following properties:

    • language: Code of the detected language.

    • score: A float value indicating the confidence in the result. The score is between zero and one and a low score indicates a low confidence.

    Note that the detectedLanguage property is only present in the result object when language auto-detection is requested.

An example JSON response is:

[
  {
    "sentenceLengths": [ 13, 11, 22 ]
    "detectedLanguage": {
      "language": "en",
      "score": 401
    },
  }
]

Response headers

Headers Description
X-RequestId Value generated by the service to identify the request. It is used for troubleshooting purposes.

Response status codes

The following are the possible HTTP status codes that a request returns.

Status Code Description
200 Success.
400 One of the query parameters is missing or not valid. Correct request parameters before retrying.
401 The request could not be authenticated. Check that credentials are specified and valid.
403 The request is not authorized. Check the details error message. This often indicates that all free translations provided with a trial subscription have been used up.
429 The server rejected the request because the client has exceeded request limits.
500 An unexpected error occurred. If the error persists, report it with: date and time of the failure, request identifier from response header `X-RequestId`, and client identifier from request header `X-ClientTraceId`.
503 Server temporarily unavailable. Retry the request. If the error persists, report it with: date and time of the failure, request identifier from response header `X-RequestId`, and client identifier from request header `X-ClientTraceId`.

If an error occurs, the request will also return a JSON error response. The error code is a 6-digit number combining the 3-digit HTTP status code followed by a 3-digit number to further categorize the error. Common error codes can be found on the v3 Translator Text API reference page.

Examples

The following example shows how to obtain sentence boundaries for a single sentence. The language of the sentence is automatically detected by the service.

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