Training Sets - Create

Service:

Azure AI Services

API Version:

2024-02-01-preview

Creates a new training set.

PUT {endpoint}/customvoice/trainingsets/{id}?api-version=2024-02-01-preview

URI Parameters

Name	In	Required	Type	Description
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: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version	query	True	string	The API version to use for this operation.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	Provide your Speech resource key here.

Request Body

Name	Required	Type	Description
locale	True	string	The locale of the training dataset. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	True	string	Resource id
description		string	Training set description
displayName		string	Training set name
id		string	Resource id
status		Status	Status of a resource.
voiceKind		VoiceKind	Voice kind

Responses

Name	Type	Description
201 Created	TrainingSet	Created
Other Status Codes	ErrorResponse	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 training set

Sample request

HTTP

PUT {endpoint}/customvoice/trainingsets/Jessica-300?api-version=2024-02-01-preview


{
  "description": "300 sentences Jessica data in general style.",
  "projectId": "Jessica",
  "locale": "en-US",
  "voiceKind": "Female"
}

Sample response

Status code:

201

{
  "id": "Jessica-300",
  "description": "300 sentences Jessica data in general style.",
  "projectId": "Jessica",
  "locale": "en-US",
  "voiceKind": "Female",
  "status": "Succeeded",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definitions

Name	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.
ErrorCode	Top-level error code
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.
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).
Status	Status of a resource.
TrainingSet	Training set
TrainingSetProperties	Training set properties
VoiceKind	Voice kind

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	ErrorCode	Top-level error code
details	Error[]	Additional supportive details regarding the error and/or expected policies.
innererror	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	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	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.

Status

Status of a resource.

Name	Type	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

TrainingSet

Training set

Name	Type	Description
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	Training set description
displayName	string	Training set name
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).
locale	string	The locale of the training dataset. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Resource id
properties	TrainingSetProperties	Training set properties
status	Status	Status of a resource.
voiceKind	VoiceKind	Voice kind

TrainingSetProperties

Training set properties

Name	Type	Description
utteranceCount	integer	Utterance count in this training set

VoiceKind

Voice kind

Name	Type	Description
Female	string
Male	string