Skip to content

Commit 798ceb5

Browse files
committed
update json example
1 parent 7a1ae67 commit 798ceb5

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

articles/cognitive-services/Translator/reference/v3-0-break-sentence.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ manager: nitinme
99
ms.service: cognitive-services
1010
ms.subservice: translator-text
1111
ms.topic: reference
12-
ms.date: 08/06/2020
12+
ms.date: 12/23/2022
1313
ms.author: lajanuar
1414
---
1515

@@ -32,8 +32,8 @@ Request parameters passed on the query string are:
3232
| Query Parameter | Description |
3333
| -------| ----------- |
3434
| api-version <img width=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. |
3737

3838
Request headers include:
3939

@@ -42,7 +42,7 @@ Request headers include:
4242
| Authentication header(s) <img width=200/> | **Required request header**.<br/>See <a href="/azure/cognitive-services/translator/reference/v3-0-reference#authentication">available options for authentication</a>. |
4343
| Content-Type | **Required request header**.<br/>Specifies the content type of the payload. Possible values are: `application/json`. |
4444
| 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`. |
4646

4747
## Request body
4848

@@ -57,23 +57,23 @@ The body of the request is a JSON array. Each array element is a JSON object wit
5757
The following limitations apply:
5858

5959
* 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.
6262
* 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.
6363

6464
## Response body
6565

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

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.
6969

70-
* `detectedLanguage`: An object describing the detected language through the following properties:
70+
* `detectedLanguage`: An object describing the detected language through the following properties:
7171

72-
* `language`: Code of the detected language.
72+
* `language`: Code of the detected language.
7373

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.
7777

7878
An example JSON response is:
7979

@@ -100,7 +100,7 @@ An example JSON response is:
100100
<th>Description</th>
101101
<tr>
102102
<td>X-RequestId</td>
103-
<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>
104104
</tr>
105105
</table>
106106

@@ -121,11 +121,11 @@ The following are the possible HTTP status codes that a request returns.
121121
</tr>
122122
<tr>
123123
<td>401</td>
124-
<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>
125125
</tr>
126126
<tr>
127127
<td>403</td>
128-
<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>
129129
</tr>
130130
<tr>
131131
<td>429</td>

0 commit comments

Comments
 (0)