Personal Voices - Post
Creates a new personal voice with audio files in the client.
POST {endpoint}/customvoice/personalvoices/{id}?api-version=2024-02-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
project
|
formData | True |
string |
The project ID. Regex pattern: |
audio
|
formData |
file |
Audio files. |
|
description
|
formData |
string |
Optional description of this model. |
|
display
|
formData |
string |
The display name of this model. |
|
properties
|
formData |
string |
properties. |
|
endpoint
|
path | True |
string |
Supported Cognitive Services endpoints (protocol and hostname, for example: https://eastus.api.cognitive.microsoft.com). |
id
|
path | True |
string |
The ID of the resource. Regex pattern: |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Header
Media Types: "multipart/form-data"
Name | Required | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Provide your Speech resource key here. |
Operation-Id |
string |
ID of the status monitor for the operation. If the Operation-Id header matches an existing operation and the request is not identical to the prior request, it will fail with a 400 Bad Request. Regex pattern: |
Responses
Name | Type | Description |
---|---|---|
201 Created |
Created Headers
|
|
Other Status Codes |
An error occurred. Headers x-ms-error-code: string |
Security
Ocp-Apim-Subscription-Key
Provide your Speech resource key here.
Type:
apiKey
In:
header
Examples
Create a personal voice
Sample request
POST {endpoint}/customvoice/personalvoices/Jessica-PersonalVoice?api-version=2024-02-01-preview
Sample response
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1321a2c0-9be4-471d-83bb-bc3be4f96a6f?api-version=2024-02-01-preview
Operation-Id: 1321a2c0-9be4-471d-83bb-bc3be4f96a6f
{
"id": "Jessica-PersonalVoice",
"speakerProfileId": "3059912f-a3dc-49e3-bdd0-02e449df1fe3",
"projectId": "PersonalVoice",
"consentId": "Jessica",
"status": "NotStarted",
"createdDateTime": "2023-04-01T05:30:00.000Z",
"lastActionDateTime": "2023-04-02T10:15:30.000Z"
}
Definitions
Name | Description |
---|---|
Azure |
Azure Blob Storage content. With the examples below, it represents files https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav |
Error |
Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details. |
Error |
Top-level error code |
Error |
Error response follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. |
Inner |
Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested). |
Model |
Model training failure reason |
Personal |
Personal voice object |
Personal |
Personal voice properties |
Status |
Status of a resource. |
AzureBlobContentSource
Azure Blob Storage content. With the examples below, it represents files https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav
Name | Type | Description |
---|---|---|
containerUrl |
string |
Azure Blob Storage container URL with SAS. Need both read and list permissions. |
extensions |
string[] |
File name extensions. |
prefix |
string |
Blob name prefix. |
Error
Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.
Name | Type | Description |
---|---|---|
code |
Top-level error code |
|
details |
Error[] |
Additional supportive details regarding the error and/or expected policies. |
innererror |
Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested). |
|
message |
string |
Top-level error message. |
target |
string |
The source of the error. For example it would be "model" or "model id" in case of invalid model. |
ErrorCode
Top-level error code
Name | Type | Description |
---|---|---|
BadArgument |
string |
|
BadRequest |
string |
|
Forbidden |
string |
|
InternalServerError |
string |
|
NotFound |
string |
|
ServiceUnavailable |
string |
|
TooManyRequests |
string |
|
Unauthorized |
string |
|
UnsupportedMediaType |
string |
ErrorResponse
Error response follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Name | Type | Description |
---|---|---|
error |
Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details. |
InnerError
Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
Name | Type | Description |
---|---|---|
code |
string |
Detailed error code to help diagnostic. |
innererror |
Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested). |
|
message |
string |
Detailed error message. |
target |
string |
The source of the error. For example it would be "model" or "model id" in case of invalid model. |
ModelFailureReason
Model training failure reason
Name | Type | Description |
---|---|---|
InaccessibleCustomerStorage |
string |
The customer uses Bring Your Own Storage in Speech Account. But the storage is not accessible now. Please check doc. |
Internal |
string |
Custom Voice Service error. |
SpeakerVerificationFailed |
string |
The consent and training audio are not from the same speaker. |
TerminateByUser |
string |
The customer canceled model training. |
PersonalVoice
Personal voice object
Name | Type | Description |
---|---|---|
audios |
Azure Blob Storage content. With the examples below, it represents files https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav |
|
consentId |
string |
Resource id |
createdDateTime |
string |
The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
description |
string |
Personal voice description |
displayName |
string |
Display name of personal voice |
id |
string |
Resource id |
lastActionDateTime |
string |
The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
projectId |
string |
Resource id |
properties |
Personal voice properties |
|
speakerProfileId |
string |
Personal voice speaker profile id. Fill this property in SSML. |
status |
Status of a resource. |
PersonalVoiceProperties
Personal voice properties
Name | Type | Description |
---|---|---|
failureReason |
Model training failure reason |
Status
Status of a resource.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Disabling |
string |
|
Failed |
string |
|
NotStarted |
string |
|
Running |
string |
|
Succeeded |
string |