Merge pull request #262965 from eric-urban/eur/cnv-personal-voice

personal voice from local files

Author: JamesJBarnett

articles/ai-services/speech-service/includes/previews/preview-personal-voice.md

@@ -5,7 +5,7 @@
  ms.author: eric-urban
  ms.service: azure-ai-services
  ms.topic: include
- ms.date: 12/1/2023
+ms.date: 1/10/2024
  ms.custom: include
 ---
 

articles/ai-services/speech-service/personal-voice-create-consent.md

@@ -6,7 +6,7 @@ author: eric-urban
 manager: nitinme
 ms.service: azure-ai-speech
 ms.topic: how-to
-ms.date: 12/1/2023
+ms.date: 1/10/2024
 ms.author: eur
 ---
 
@@ -16,7 +16,7 @@ ms.author: eur
 
 With the personal voice feature, it's required that every voice be created with explicit consent from the user. A recorded statement from the user is required acknowledging that the customer (Azure AI Speech resource owner) will create and use their voice.
 
-To add user consent to the personal voice project, you get the prerecorded consent audio file from a publicly accessible URL (`Consents_Create`) or upload the audio file (`Consents_Post`). In this article, you add consent from a URL. 
+To add user consent to the personal voice project, you provide the prerecorded consent audio file [from a publicly accessible URL](#add-consent-from-a-url) (`Consents_Create`) or [upload the audio file](#add-consent-from-a-file) (`Consents_Post`).  
 
 ## Consent statement
 
@@ -28,8 +28,54 @@ You can get the consent statement text for each locale from the text to speech G
 "I  [state your first and last name] am aware that recordings of my voice will be used by [state the name of the company] to create and use a synthetic version of my voice."
 ```
 
+## Add consent from a file
+
+In this scenario, the audio files must be available locally. 
+
+To add consent to a personal voice project from a local audio file, use the `Consents_Post` operation of the custom voice API. Construct the request body according to the following instructions:
+
+- Set the required `projectId` property. See [create a project](./personal-voice-create-project.md).
+- Set the required `voiceTalentName` property. The voice talent name can't be changed later.
+- Set the required `companyName` property. The company name can't be changed later.
+- Set the required `audiodata` property with the consent audio file. 
+- Set the required `locale` property. This should be the locale of the consent. The locale can't be changed later. You can find the text to speech locale list [here](/azure/ai-services/speech-service/language-support?tabs=tts).
+
+Make an HTTP POST request using the URI as shown in the following `Consents_Post` example. 
+- Replace `YourResourceKey` with your Speech resource key.
+- Replace `YourResourceRegion` with your Speech resource region.
+- Replace `JessicaConsentId` with a consent ID of your choice. The case sensitive ID will be used in the consent's URI and can't be changed later. 
+
+```azurecli-interactive
+curl -v -X POST -H "Ocp-Apim-Subscription-Key: YourResourceKey" -F 'description="Consent for Jessica voice"' -F 'projectId="ProjectId"' -F 'voiceTalentName="Jessica Smith"' -F 'companyName="Contoso"' -F 'audiodata=@"D:\PersonalVoiceTest\jessica-consent.wav"' -F 'locale="en-US"' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/consents/JessicaConsentId?api-version=2023-12-01-preview"
+```
+
+You should receive a response body in the following format:
+
+```json
+{
+  "id": "JessicaConsentId",
+  "description": "Consent for Jessica voice",
+  "projectId": "ProjectId",
+  "voiceTalentName": "Jessica Smith",
+  "companyName": "Contoso",
+  "locale": "en-US",
+  "status": "NotStarted",
+  "createdDateTime": "2023-04-01T05:30:00.000Z",
+  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
+}
+```
+
+The response header contains the `Operation-Location` property. Use this URI to get details about the `Consents_Post` operation. Here's an example of the response header:
+
+```HTTP 201
+Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2023-12-01-preview
+Operation-Id: 070f7986-ef17-41d0-ba2b-907f0f28e314
+```
+
 ## Add consent from a URL
 
+In this scenario, the audio files must already be stored in an Azure Blob Storage container. 
+
 To add consent to a personal voice project from the URL of an audio file, use the `Consents_Create` operation of the custom voice API. Construct the request body according to the following instructions:
 
 - Set the required `projectId` property. See [create a project](./personal-voice-create-project.md).

articles/ai-services/speech-service/personal-voice-create-project.md

@@ -6,7 +6,7 @@ author: eric-urban
 manager: nitinme
 ms.service: azure-ai-speech
 ms.topic: how-to
-ms.date: 12/1/2023
+ms.date: 1/10/2024
 ms.author: eur
 ---
 

articles/ai-services/speech-service/personal-voice-create-voice.md

@@ -6,7 +6,7 @@ author: eric-urban
 manager: nitinme
 ms.service: azure-ai-speech
 ms.topic: how-to
-ms.date: 12/1/2023
+ms.date: 1/10/2024
 ms.author: eur
 ---
 
@@ -18,13 +18,59 @@ To use personal voice in your application, you need to get a speaker profile ID.
 
 You create a speaker profile ID based on the speaker's verbal consent statement and an audio prompt (a clean human voice sample between 50 - 90 seconds). The user's voice characteristics are encoded in the `speakerProfileId` property that's used for text to speech. For more information, see [use personal voice in your application](./personal-voice-how-to-use.md).
 
-## Create personal voice
+> [!NOTE]
+> The personal voice ID and speaker profile ID aren't same. You can choose the personal voice ID, but the speaker profile ID is generated by the service. The personal voice ID is used to manage the personal voice. The speaker profile ID is used for text to speech.
+
+You provide the audio files [from a publicly accessible URL](#create-personal-voice-from-a-url) (`PersonalVoices_Create`) or [upload the audio files](#create-personal-voice-from-a-file) (`PersonalVoices_Post`).  
 
-To create a personal voice and get the speaker profile ID, use the `PersonalVoices_Create` operation of the custom voice API. 
+## Create personal voice from a file
 
-Before calling this API, please store audio files in Azure Blob. In the example below, audio files are https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav. 
+In this scenario, the audio files must be available locally. 
 
-Construct the request body according to the following instructions:
+To create a personal voice and get the speaker profile ID, use the `PersonalVoices_Post` operation of the custom voice API. Construct the request body according to the following instructions:
+
+- Set the required `projectId` property. See [create a project](./personal-voice-create-project.md).
+- Set the required `consentId` property. See [add user consent](./personal-voice-create-consent.md).
+- Set the required `audiodata` property. You can specify one or more audio files in the same request. 
+
+Make an HTTP POST request using the URI as shown in the following `PersonalVoices_Post` example. 
+- Replace `YourResourceKey` with your Speech resource key.
+- Replace `YourResourceRegion` with your Speech resource region. 
+- Replace `JessicaPersonalVoiceId` with a personal voice ID of your choice. The case sensitive ID will be used in the personal voice's URI and can't be changed later. 
+
+```azurecli-interactive
+curl -v -X POST -H "Ocp-Apim-Subscription-Key: YourResourceKey" -F 'projectId="ProjectId"' -F 'consentId="JessicaConsentId"' -F 'audiodata=@"D:\PersonalVoiceTest\CNVSample001.wav"' -F 'audiodata=@"D:\PersonalVoiceTest\CNVSample002.wav"' "
+https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/personalvoices/JessicaPersonalVoiceId?api-version=2023-12-01-preview"
+```
+
+You should receive a response body in the following format:
+
+```json
+{
+  "id": "JessicaPersonalVoiceId",
+  "speakerProfileId": "3059912f-a3dc-49e3-bdd0-02e449df1fe3",
+  "projectId": "ProjectId",
+  "consentId": "JessicaConsentId",
+  "status": "NotStarted",
+  "createdDateTime": "2023-04-01T05:30:00.000Z",
+  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
+}
+```
+
+Use the `speakerProfileId` property to integrate personal voice in your text to speech application. For more information, see [use personal voice in your application](./personal-voice-how-to-use.md).
+
+The response header contains the `Operation-Location` property. Use this URI to get details about the `PersonalVoices_Post` operation. Here's an example of the response header:
+
+```HTTP 201
+Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1321a2c0-9be4-471d-83bb-bc3be4f96a6f?api-version=2023-12-01-preview
+Operation-Id: 1321a2c0-9be4-471d-83bb-bc3be4f96a6f
+```
+
+## Create personal voice from a URL
+
+In this scenario, the audio files must already be stored in an Azure Blob Storage container. 
+
+To create a personal voice and get the speaker profile ID, use the `PersonalVoices_Create` operation of the custom voice API. Construct the request body according to the following instructions:
 
 - Set the required `projectId` property. See [create a project](./personal-voice-create-project.md).
 - Set the required `consentId` property. See [add user consent](./personal-voice-create-consent.md).
@@ -33,9 +79,6 @@ Construct the request body according to the following instructions:
   - Set the required `extensions` property to the extensions of the audio files. 
   - Optionally, set the `prefix` property to set a prefix for the blob name.
 
-> [!NOTE]
-> The personal voice ID and speaker profile ID aren't same. You can choose the personal voice ID, but the speaker profile ID is generated by the service. The personal voice ID is used to manage the personal voice. The speaker profile ID is used for text to speech.
-
 Make an HTTP PUT request using the URI as shown in the following `PersonalVoices_Create` example. 
 - Replace `YourResourceKey` with your Speech resource key.
 - Replace `YourResourceRegion` with your Speech resource region. 

articles/ai-services/speech-service/personal-voice-how-to-use.md

@@ -6,7 +6,7 @@ author: eric-urban
 manager: nitinme
 ms.service: azure-ai-speech
 ms.topic: overview
-ms.date: 11/15/2023
+ms.date: 1/10/2024
 ms.author: eur
 ms.custom: references_regions
 ---

articles/ai-services/speech-service/personal-voice-overview.md

@@ -6,7 +6,7 @@ author: eric-urban
 manager: nitinme
 ms.service: azure-ai-speech
 ms.topic: overview
-ms.date: 12/1/2023
+ms.date: 1/10/2024
 ms.author: eur
 ms.custom: references_regions
 ---