From efd59b7b8ecbb816f1af467dcb5ebf2cf70aa2de Mon Sep 17 00:00:00 2001 From: Jun-wei Gan Date: Thu, 18 Jan 2024 18:52:09 +0800 Subject: [PATCH 1/3] Update description of Custom Voice API swagger. Add more description about Azure blob URL with SAS. --- .../2023-12-01-preview/texttospeech.json | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json index 18d87a688293..f58361c5e9c4 100644 --- a/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json +++ b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json @@ -101,7 +101,7 @@ "tags": [ "Project" ], - "description": "Deletes the project identified by the given ID.", + "description": "Deletes the project identified by the given ID. All data (like consent, training set) in this project will be deleted automatically.", "operationId": "Projects_Delete", "produces": [ "application/json" @@ -114,7 +114,7 @@ "in": "query", "name": "forceDelete", "type": "boolean", - "description": "Set this to true if you want to delete a project with model and endpoint", + "description": "Set this to true if you want to delete a project with model and endpoint. Otherwise, the delete operation will fail.", "default": false }, { @@ -1607,7 +1607,7 @@ }, "definitions": { "AzureBlobContentSource": { - "description": "Azure Blob Storage content.", + "description": "Azure Blob Storage content. With the examples below, it represents files https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav", "type": "object", "required": [ "containerUrl", @@ -1615,19 +1615,22 @@ ], "properties": { "containerUrl": { - "description": "Azure Blob Storage container URL.", + "description": "Azure Blob Storage container URL with [SAS](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview). Need both read and list permissions.", "type": "string", - "format": "url" + "format": "url", + "example": "https://contoso.blob.core.windows.net/voicecontainer?mySasToken" }, "prefix": { "description": "Blob name prefix.", - "type": "string" + "type": "string", + "example": "jessica" }, "extensions": { "description": "File name extensions.", "type": "array", "items": { - "type": "string" + "type": "string", + "example": ".wav" } } } @@ -1699,7 +1702,7 @@ "type": "string" }, "audioUrl": { - "description": "The public accessible URL of the consent audio file.", + "description": "The public accessible URL of the consent audio file. It's recommended to be an Azure blob URL with [SAS](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview). This property is only available in request.", "type": "string", "format": "uri" }, From f6616b5a01093d15e9c362fcde45a0e1ff95ff89 Mon Sep 17 00:00:00 2001 From: Jun-wei Gan Date: Fri, 19 Jan 2024 11:58:54 +0800 Subject: [PATCH 2/3] Update description of Custom Voice API swagger Change filter description from HTML to mark down. --- .../preview/2023-12-01-preview/texttospeech.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json index f58361c5e9c4..ab6626b54bab 100644 --- a/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json +++ b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json @@ -1405,7 +1405,7 @@ "tags": [ "PersonalVoice" ], - "description": "Creates a new personal voice.", + "description": "Creates a new personal voice with audio files in Azure Blob Storage.", "operationId": "PersonalVoices_Create", "consumes": [ "application/json" @@ -1469,7 +1469,7 @@ "tags": [ "PersonalVoice" ], - "description": "Creates a new personal voice.", + "description": "Creates a new personal voice with audio files in the client.", "operationId": "PersonalVoices_Post", "consumes": [ "multipart/form-data" @@ -2565,7 +2565,7 @@ "QueryFilter": { "name": "filter", "in": "query", - "description": "Filter condition.\r\n ", + "description": "Filter condition.\r\n - **Supported properties:** projectId, createdDateTime, locale, kind\r\n - **Operators:**\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - **Example:**\r\n - ```filter=projectId eq 'Jessica'``` (filter by project ID)\r\n - ```filter=kind eq 'ProfessionalVoice'``` (filter project by kind)\r\n - ```filter=locale eq 'en-US'``` (filter training set and model by locale)\r\n - ```filter=createdDateTime gt 2022-12-30T23:59:59.99Z``` (filter resource created time after 2023-11-01)", "required": false, "type": "string", "x-ms-parameter-location": "method" From 27e29ef4dcc005115bd01ac5ef6f80f7bc934706 Mon Sep 17 00:00:00 2001 From: Jun-wei Gan Date: Fri, 19 Jan 2024 13:22:42 +0800 Subject: [PATCH 3/3] remove en-US in Azure doc link. --- .../TextToSpeech/preview/2023-12-01-preview/texttospeech.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json index ab6626b54bab..17552284166d 100644 --- a/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json +++ b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json @@ -1615,7 +1615,7 @@ ], "properties": { "containerUrl": { - "description": "Azure Blob Storage container URL with [SAS](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview). Need both read and list permissions.", + "description": "Azure Blob Storage container URL with [SAS](https://learn.microsoft.com/azure/storage/common/storage-sas-overview). Need both read and list permissions.", "type": "string", "format": "url", "example": "https://contoso.blob.core.windows.net/voicecontainer?mySasToken" @@ -1702,7 +1702,7 @@ "type": "string" }, "audioUrl": { - "description": "The public accessible URL of the consent audio file. It's recommended to be an Azure blob URL with [SAS](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview). This property is only available in request.", + "description": "The public accessible URL of the consent audio file. It's recommended to be an Azure blob URL with [SAS](https://learn.microsoft.com/azure/storage/common/storage-sas-overview). This property is only available in request.", "type": "string", "format": "uri" },