Skip to content

Commit d7116c7

Browse files
committed
Clarify OpenAI voices are not suportted in Batch Synthesis API and update job status sample
1 parent 60beb4e commit d7116c7

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
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
@@ -47,7 +47,7 @@ Batch synthesis properties are described in the following table.
4747
|`properties.succeededAudioCount`|The count of batch synthesis inputs to audio output succeeded.<br/><br/>This property is read-only.|
4848
|`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.|
50-
|`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.|
50+
|`status`|The batch synthesis processing status.<br/><br/>The status should progress from "Running" 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"`.|
5252
|`synthesisConfig.backgroundAudio`|The background audio for each audio output.<br/><br/>This optional property is only applicable when `inputKind` is set to `"PlainText"`.|
5353
|`synthesisConfig.backgroundAudio.fadein`|The duration of the background audio fade-in as milliseconds. The default value is `0`, which is the equivalent to no fade in. Accepted values: `0` to `10000` inclusive.<br/><br/>For information, see the attributes table under [add background audio](speech-synthesis-markup-voice.md#add-background-audio) in the Speech Synthesis Markup Language (SSML) documentation. Invalid values are ignored.<br/><br/>This optional property is only applicable when `inputKind` is set to `"PlainText"`.|

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ You should receive a response body in the following format:
7777
{
7878
"id": "YourSynthesisId",
7979
"internalId": "7ab84171-9070-4d3b-88d4-1b8cc1cb928a",
80-
"status": "NotStarted",
80+
"status": "Running",
8181
"createdDateTime": "2024-03-12T07:23:18.0097387Z",
8282
"lastActionDateTime": "2024-03-12T07:23:18.0097388Z",
8383
"inputKind": "SSML",
@@ -93,7 +93,7 @@ You should receive a response body in the following format:
9393
}
9494
```
9595

96-
The `status` property should progress from `NotStarted` status, to `Running`, and finally to `Succeeded` or `Failed`. You can call the [GET batch synthesis API](#get-batch-synthesis) periodically until the returned status is `Succeeded` or `Failed`.
96+
The `status` property should progress from `Running` status to `Succeeded` or `Failed`. You can call the [GET batch synthesis API](#get-batch-synthesis) periodically until the returned status is `Succeeded` or `Failed`.
9797

9898
## Get batch synthesis
9999

articles/ai-services/speech-service/openai-voices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Here's a comparison of features between OpenAI text to speech voices in Azure Op
4949
| **Speech Synthesis Markup Language (SSML) support** | Not supported | Support for [a subset of SSML elements](#ssml-elements-supported-by-openai-text-to-speech-voices-in-azure-ai-speech). | Support for the [full set of SSML](speech-synthesis-markup-structure.md) in Azure AI Speech. |
5050
| **Development options** | REST API | Speech SDK, Speech CLI, REST API | Speech SDK, Speech CLI, REST API |
5151
| **Deployment option** | Cloud only | Cloud only | Cloud, embedded, hybrid, and containers. |
52-
| **Real-time or batch synthesis** | Real-time | Real-time and batch synthesis | Real-time and batch synthesis |
52+
| **Real-time or batch synthesis** | Real-time | Real-time | Real-time and batch synthesis |
5353
| **Latency** | greater than 500 ms | greater than 500 ms | less than 300 ms |
5454
| **Sample rate of synthesized audio** | 24 kHz | 8, 16, 24, and 48 kHz | 8, 16, 24, and 48 kHz |
5555
| **Speech output audio format** | opus, mp3, aac, flac | opus, mp3, pcm, truesilk | opus, mp3, pcm, truesilk |

0 commit comments

Comments
 (0)