Merge pull request #4914 from Ling-Cao/caoling/0515batch-doc

[Batch Synthesis API] Clarified OpenAI voices support and updated job status example

Author: v-lmcdonald

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

@@ -30,7 +30,6 @@ Batch synthesis properties are described in the following table.
 |`description`|The description of the batch synthesis.<br/><br/>This property is optional.|
 |`id`|The batch synthesis job ID you passed in path.<br/><br/>This property is required in path.|
 |`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.|
-|`internalId`|The internal batch synthesis job ID.<br/><br/>This property is read-only.|
 |`lastActionDateTime`|The most recent date and time when the `status` property value changed.<br/><br/>This property is read-only.|
 |`outputs.result`|The location of the batch synthesis result files with audio output and logs.<br/><br/>This property is read-only.|
 |`properties`|A defined set of optional batch synthesis configuration settings.|
@@ -47,7 +46,7 @@ Batch synthesis properties are described in the following table.
 |`properties.succeededAudioCount`|The count of batch synthesis inputs to audio output succeeded.<br/><br/>This property is read-only.|
 |`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.|
 |`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.|
-|`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.|
+|`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.|
 |`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"`.|
 |`synthesisConfig.backgroundAudio`|The background audio for each audio output.<br/><br/>This optional property is only applicable when `inputKind` is set to `"PlainText"`.|
 |`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

@@ -76,8 +76,7 @@ You should receive a response body in the following format:
 ```json
 {
   "id": "YourSynthesisId",
-  "internalId": "7ab84171-9070-4d3b-88d4-1b8cc1cb928a",
-  "status": "NotStarted",
+  "status": "Running",
   "createdDateTime": "2024-03-12T07:23:18.0097387Z",
   "lastActionDateTime": "2024-03-12T07:23:18.0097388Z",
   "inputKind": "SSML",
@@ -93,7 +92,7 @@ You should receive a response body in the following format:
 }
 ```
 
-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`.
+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`.
 
 ## Get batch synthesis
 
@@ -108,7 +107,6 @@ You should receive a response body in the following format:
 ```json
 {
   "id": "YourSynthesisId",
-  "internalId": "7ab84171-9070-4d3b-88d4-1b8cc1cb928a",
   "status": "Succeeded",
   "createdDateTime": "2024-03-12T07:23:18.0097387Z",
   "lastActionDateTime": "2024-03-12T07:23:18.7979669",
@@ -152,7 +150,6 @@ You should receive a response body in the following format:
   "value": [
     {
       "id": "my-job-03",
-      "internalId": "5f7e9ab6-2c92-4dcb-b5ee-ec0983ee4db0",
       "status": "Succeeded",
       "createdDateTime": "2024-03-12T07:28:32.5690441Z",
       "lastActionDateTime": "2024-03-12T07:28:33.0042293",
@@ -179,7 +176,6 @@ You should receive a response body in the following format:
     },
     {
       "id": "my-job-02",
-      "internalId": "5577585f-4710-4d4f-aab6-162d14bd7ee0",
       "status": "Succeeded",
       "createdDateTime": "2024-03-12T07:28:29.6418211Z",
       "lastActionDateTime": "2024-03-12T07:28:30.0910306",

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

@@ -49,7 +49,7 @@ Here's a comparison of features between OpenAI text to speech voices in Azure Op
 | **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. |
 | **Development options** | REST API | Speech SDK, Speech CLI, REST API | Speech SDK, Speech CLI, REST API |
 | **Deployment option** | Cloud only | Cloud only | Cloud, embedded, hybrid, and containers. |
-| **Real-time or batch synthesis** |  Real-time | Real-time and batch synthesis | Real-time and batch synthesis |
+| **Real-time or batch synthesis** |  Real-time | Real-time | Real-time and batch synthesis |
 | **Latency** | greater than 500 ms | greater than 500 ms | less than 300 ms |
 | **Sample rate of synthesized audio** | 24 kHz | 8, 16, 24, and 48 kHz | 8, 16, 24, and 48 kHz |
 | **Speech output audio format** | opus, mp3, aac, flac | opus, mp3, pcm, truesilk | opus, mp3, pcm, truesilk |