Skip to content

Commit 3141d75

Browse files
Merge pull request #3088 from Ling-Cao/speech/caoling/0221BatchProperttyUpdate
[Batch Synthesis] Reduced default retention period from 31 days to 7 days
2 parents 5ca33aa + c1796c7 commit 3141d75

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Batch synthesis properties are described in the following table.
4545
|`properties.outputFormat`|The audio output format.<br/><br/>For information about the accepted values, see [audio output formats](rest-text-to-speech.md#audio-outputs). The default output format is `riff-24khz-16bit-mono-pcm`.|
4646
|`properties.sentenceBoundaryEnabled`|Determines whether to generate sentence boundary data. This optional `bool` value ("true" or "false") is "false" by default.<br/><br/>If sentence boundary data is requested, then a corresponding `[nnnn].sentence.json` file is included in the results data ZIP file.|
4747
|`properties.succeededAudioCount`|The count of batch synthesis inputs to audio output succeeded.<br/><br/>This property is read-only.|
48-
|`properties.timeToLiveInHours`|A duration in hours after the synthesis job is created, when the synthesis results will be automatically deleted. This optional setting is `744` (31 days) by default. The maximum time to live is 31 days. The date and time of automatic deletion (for synthesis jobs with a status of "Succeeded" or "Failed") is equal to the `lastActionDateTime` + `timeToLiveInHours` properties.<br/><br/>Otherwise, you can call the [delete](./batch-synthesis.md#delete-batch-synthesis) synthesis method to remove the job sooner.|
48+
|`properties.timeToLiveInHours`|A duration in hours after the synthesis job is completed, when the synthesis results will be automatically deleted. This optional setting is `168` (7 days) by default. The maximum time to live is `744` (31 days). The date and time of automatic deletion (for synthesis jobs with a status of "Succeeded" or "Failed") is equal to the `lastActionDateTime` + `timeToLiveInHours` properties.<br/><br/>Otherwise, you can call the [delete](./batch-synthesis.md#delete-batch-synthesis) synthesis method to remove the job sooner.|
4949
|`properties.wordBoundaryEnabled`|Determines whether to generate word boundary data. This optional `bool` value ("true" or "false") is "false" by default.<br/><br/>If word boundary data is requested, then a corresponding `[nnnn].word.json` file is included in the results data ZIP file.|
5050
|`status`|The batch synthesis processing status.<br/><br/>The status should progress from "NotStarted" to "Running", and finally to either "Succeeded" or "Failed".<br/><br/>This property is read-only.|
5151
|`synthesisConfig`|The configuration settings to use for batch synthesis of plain text.<br/><br/>This property is only applicable when `inputKind` is set to `"PlainText"`.|

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ You should receive a response body in the following format:
8383
"inputKind": "SSML",
8484
"customVoices": {},
8585
"properties": {
86-
"timeToLiveInHours": 744,
86+
"timeToLiveInHours": 168,
8787
"outputFormat": "riff-24khz-16bit-mono-pcm",
8888
"concatenateResult": false,
8989
"decompressOutputFiles": false,
@@ -115,7 +115,7 @@ You should receive a response body in the following format:
115115
"inputKind": "SSML",
116116
"customVoices": {},
117117
"properties": {
118-
"timeToLiveInHours": 744,
118+
"timeToLiveInHours": 168,
119119
"outputFormat": "riff-24khz-16bit-mono-pcm",
120120
"concatenateResult": false,
121121
"decompressOutputFiles": false,
@@ -159,7 +159,7 @@ You should receive a response body in the following format:
159159
"inputKind": "SSML",
160160
"customVoices": {},
161161
"properties": {
162-
"timeToLiveInHours": 744,
162+
"timeToLiveInHours": 168,
163163
"outputFormat": "riff-24khz-16bit-mono-pcm",
164164
"concatenateResult": false,
165165
"decompressOutputFiles": false,
@@ -186,7 +186,7 @@ You should receive a response body in the following format:
186186
"inputKind": "SSML",
187187
"customVoices": {},
188188
"properties": {
189-
"timeToLiveInHours": 744,
189+
"timeToLiveInHours": 168,
190190
"outputFormat": "riff-24khz-16bit-mono-pcm",
191191
"concatenateResult": false,
192192
"decompressOutputFiles": false,
@@ -215,7 +215,7 @@ The `value` property in the json response lists your synthesis requests. The lis
215215

216216
## Delete batch synthesis
217217

218-
Delete the batch synthesis job history after you retrieved the audio output results. The Speech service keeps batch synthesis history for up to 31 days, or the duration of the request `timeToLiveInHours` property, whichever comes sooner. The date and time of automatic deletion (for synthesis jobs with a status of "Succeeded" or "Failed") is equal to the `lastActionDateTime` + `timeToLiveInHours` properties.
218+
Delete the batch synthesis job history after you retrieved the audio output results. The Speech service keeps batch synthesis history for 168 hours (7 days) by default. Alternatively, you can specify this retention period using the `timeToLiveInHours` property, up to 744 hours (31 days). The date and time of automatic deletion (for synthesis jobs with a status of "Succeeded" or "Failed") is equal to the `lastActionDateTime` + `timeToLiveInHours` properties.
219219

220220
To delete a batch synthesis job, make an HTTP DELETE request using the URI as shown in the following example. Replace `YourSynthesisId` with your batch synthesis ID, replace `YourSpeechKey` with your Speech resource key, and replace `YourSpeechRegion` with your Speech resource region.
221221

@@ -248,9 +248,7 @@ The summary file contains the synthesis results for each text input. Here's an e
248248
"status": "Succeeded",
249249
"results": [
250250
{
251-
"contents": [
252-
"<speak version=\"1.0\" xml:lang=\"en-US\"><voice name=\"en-US-JennyNeural\">The rainbow has seven colors.</voice></speak>"
253-
],
251+
"contents": ["<speak version=\"1.0\" xml:lang=\"en-US\"><voice name=\"en-US-JennyNeural\">The rainbow has seven colors.</voice></speak>"],
254252
"status": "Succeeded",
255253
"audioFileName": "0001.wav",
256254
"properties": {

0 commit comments

Comments
 (0)