You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/cognitive-services/Translator/reference/v3-0-break-sentence.md
+27-23Lines changed: 27 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ manager: nitinme
9
9
ms.service: cognitive-services
10
10
ms.subservice: translator-text
11
11
ms.topic: reference
12
-
ms.date: 08/06/2020
12
+
ms.date: 12/23/2022
13
13
ms.author: lajanuar
14
14
---
15
15
@@ -32,8 +32,8 @@ Request parameters passed on the query string are:
32
32
| Query Parameter | Description |
33
33
| -------| ----------- |
34
34
| api-version <imgwidth=200/> |**Required query parameter**.<br/>Version of the API requested by the client. Value must be `3.0`. |
35
-
| language |**Optional query parameter**.<br/>Language tag identifying the language of the input text. If a code is not specified, automatic language detection will be applied. |
36
-
| script |**Optional query parameter**.<br/>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. |
35
+
| language |**Optional query parameter**.<br/>Language tag identifying the language of the input text. If a code isn't specified, automatic language detection will be applied. |
36
+
| script |**Optional query parameter**.<br/>Script tag identifying the script used by the input text. If a script isn't specified, the default script of the language will be assumed. |
| Content-Type |**Required request header**.<br/>Specifies the content type of the payload. Possible values are: `application/json`. |
44
44
| Content-Length |**Required request header**.<br/>The length of the request body. |
45
-
| X-ClientTraceId |**Optional**.<br/>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`. |
45
+
| X-ClientTraceId |**Optional**.<br/>A client-generated GUID to uniquely identify the request. You can omit this header if you include the trace ID in the query string using a query parameter named `ClientTraceId`. |
46
46
47
47
## Request body
48
48
@@ -57,35 +57,39 @@ The body of the request is a JSON array. Each array element is a JSON object wit
57
57
The following limitations apply:
58
58
59
59
* The array can have at most 100 elements.
60
-
* The text value of an array element cannot exceed 50,000 characters including spaces.
61
-
* The entire text included in the request cannot exceed 50,000 characters including spaces.
60
+
* The text value of an array element can't exceed 50,000 characters including spaces.
61
+
* The entire text included in the request can't exceed 50,000 characters including spaces.
62
62
* 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.
63
63
64
64
## Response body
65
65
66
66
A successful response is a JSON array with one result for each string in the input array. A result object includes the following properties:
67
67
68
-
*`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.
68
+
*`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.
69
69
70
-
*`detectedLanguage`: An object describing the detected language through the following properties:
70
+
*`detectedLanguage`: An object describing the detected language through the following properties:
71
71
72
-
*`language`: Code of the detected language.
72
+
*`language`: Code of the detected language.
73
73
74
-
*`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.
75
-
76
-
Note that the`detectedLanguage` property is only present in the result object when language auto-detection is requested.
74
+
*`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.
75
+
76
+
The`detectedLanguage` property is only present in the result object when language auto-detection is requested.
77
77
78
78
An example JSON response is:
79
79
80
80
```json
81
81
[
82
-
{
83
-
"sentLen": [ 13, 11, 22 ]
84
-
"detectedLanguage": {
85
-
"language": "en",
86
-
"score": 401
87
-
},
88
-
}
82
+
{
83
+
"detectedLanguage": {
84
+
"language": "en",
85
+
"score": 1.0
86
+
},
87
+
"sentLen": [
88
+
13,
89
+
11,
90
+
22
91
+
]
92
+
}
89
93
]
90
94
```
91
95
@@ -96,7 +100,7 @@ An example JSON response is:
96
100
<th>Description</th>
97
101
<tr>
98
102
<td>X-RequestId</td>
99
-
<td>Value generated by the service to identify the request. It is used for troubleshooting purposes.</td>
103
+
<td>Value generated by the service to identify the request. It's used for troubleshooting purposes.</td>
100
104
</tr>
101
105
</table>
102
106
@@ -117,11 +121,11 @@ The following are the possible HTTP status codes that a request returns.
117
121
</tr>
118
122
<tr>
119
123
<td>401</td>
120
-
<td>The request could not be authenticated. Check that credentials are specified and valid.</td>
124
+
<td>The request couldn't be authenticated. Check that credentials are specified and valid.</td>
121
125
</tr>
122
126
<tr>
123
127
<td>403</td>
124
-
<td>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.</td>
128
+
<td>The request isn't authorized. Check the details error message. This response code often indicates that all free translations provided with a trial subscription have been used up.</td>
125
129
</tr>
126
130
<tr>
127
131
<td>429</td>
@@ -145,4 +149,4 @@ The following example shows how to obtain sentence boundaries for a single sente
145
149
146
150
```curl
147
151
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?'}]"
0 commit comments