Skip to content

Commit e522dc5

Browse files
committed
Remove internalId field from batch synthesis API response examples
1 parent d7116c7 commit e522dc5

File tree

2 files changed

+0
-5
lines changed

2 files changed

+0
-5
lines changed

articles/ai-services/speech-service/batch-synthesis-properties.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ Batch synthesis properties are described in the following table.
3030
|`description`|The description of the batch synthesis.<br/><br/>This property is optional.|
3131
|`id`|The batch synthesis job ID you passed in path.<br/><br/>This property is required in path.|
3232
|`inputs`|The plain text or SSML to be synthesized.<br/><br/>When the `inputKind` is set to `"PlainText"`, provide plain text as shown here: `"inputs": [{"text": "The rainbow has seven colors."}]`. When the `inputKind` is set to `"SSML"`, provide text in the [Speech Synthesis Markup Language (SSML)](speech-synthesis-markup.md) as shown here: `"inputs": [{"text": "<speak version='\''1.0'\'' xml:lang='\''en-US'\''><voice xml:lang='\''en-US'\'' xml:gender='\''Female'\'' name='\''en-US-AvaMultilingualNeural'\''>The rainbow has seven colors.</voice></speak>"}]`.<br/><br/>Include up to 1,000 text objects if you want multiple audio output files. Here's example input text that should be synthesized to two audio output files: `"inputs": [{"text": "synthesize this to a file"},{"text": "synthesize this to another file"}]`. However, if the `properties.concatenateResult` property is set to `true`, then each synthesized result is written to the same audio output file.<br/><br/>You don't need separate text inputs for new paragraphs. Within any of the (up to 1,000) text inputs, you can specify new paragraphs using the "\r\n" (newline) string. Here's example input text with two paragraphs that should be synthesized to the same audio output file: `"inputs": [{"text": "synthesize this to a file\r\nsynthesize this to another paragraph in the same file"}]`<br/><br/>There are no paragraph limits, but the maximum JSON payload size (including all text inputs and other properties) is 2 megabytes.<br/><br/>This property is required when you create a new batch synthesis job. This property isn't included in the response when you get the synthesis job.|
33-
|`internalId`|The internal batch synthesis job ID.<br/><br/>This property is read-only.|
3433
|`lastActionDateTime`|The most recent date and time when the `status` property value changed.<br/><br/>This property is read-only.|
3534
|`outputs.result`|The location of the batch synthesis result files with audio output and logs.<br/><br/>This property is read-only.|
3635
|`properties`|A defined set of optional batch synthesis configuration settings.|

articles/ai-services/speech-service/batch-synthesis.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ You should receive a response body in the following format:
7676
```json
7777
{
7878
"id": "YourSynthesisId",
79-
"internalId": "7ab84171-9070-4d3b-88d4-1b8cc1cb928a",
8079
"status": "Running",
8180
"createdDateTime": "2024-03-12T07:23:18.0097387Z",
8281
"lastActionDateTime": "2024-03-12T07:23:18.0097388Z",
@@ -108,7 +107,6 @@ You should receive a response body in the following format:
108107
```json
109108
{
110109
"id": "YourSynthesisId",
111-
"internalId": "7ab84171-9070-4d3b-88d4-1b8cc1cb928a",
112110
"status": "Succeeded",
113111
"createdDateTime": "2024-03-12T07:23:18.0097387Z",
114112
"lastActionDateTime": "2024-03-12T07:23:18.7979669",
@@ -152,7 +150,6 @@ You should receive a response body in the following format:
152150
"value": [
153151
{
154152
"id": "my-job-03",
155-
"internalId": "5f7e9ab6-2c92-4dcb-b5ee-ec0983ee4db0",
156153
"status": "Succeeded",
157154
"createdDateTime": "2024-03-12T07:28:32.5690441Z",
158155
"lastActionDateTime": "2024-03-12T07:28:33.0042293",
@@ -179,7 +176,6 @@ You should receive a response body in the following format:
179176
},
180177
{
181178
"id": "my-job-02",
182-
"internalId": "5577585f-4710-4d4f-aab6-162d14bd7ee0",
183179
"status": "Succeeded",
184180
"createdDateTime": "2024-03-12T07:28:29.6418211Z",
185181
"lastActionDateTime": "2024-03-12T07:28:30.0910306",

0 commit comments

Comments
 (0)