Models - Create

Служба:: Azure AI Services

Версия API:: 2024-02-01-preview

Создает новую голосовую модель.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://eastus.api.cognitive.microsoft.com).
id	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Укажите здесь ключ ресурса службы "Речь".
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор монитора состояния для операции. Если заголовок Operation-Id соответствует существующей операции, и запрос не идентичен предыдущему запросу, он завершится ошибкой с 400 недопустимым запросом.

Текст запроса

Имя	Обязательно	Тип	Описание
consentId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
projectId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
recipe	True	Recipe	Рецепт построения модели. Различные рецепты имеют разные возможности.
trainingSetId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
description		string	Описание модели
id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
locale		string	Языковой стандарт этой модели. Код языкового стандарта следует BCP-47. Здесь можно найти текст для языкового стандарта речи https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
properties		ModelProperties	Свойства модели
status		Status	Состояние ресурса.
voiceName		string minLength: 1	Имя голоса

Ответы

Имя	Тип	Описание
201 Created	Model	Созданный Заголовки Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Произошла ошибка. Заголовки x-ms-error-code: string

Имя

Тип

Описание

201 Created

Model

Созданный

Заголовки

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Произошла ошибка.

Заголовки

x-ms-error-code: string

Безопасность

Ocp-Apim-Subscription-Key

Укажите здесь ключ ресурса службы "Речь".

Тип: apiKey
В: header

Примеры

Create a model

Create a multi style model

Create a model

Образец запроса

HTTP

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



{
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300"
}

Пример ответа

Код состояния:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1f4352df-f247-40c0-a7b1-a54d017933e1?api-version=2024-02-01-preview
Operation-Id: 1f4352df-f247-40c0-a7b1-a54d017933e1

{
  "id": "Jessica",
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default",
    "version": "V7.2023.03"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Create a multi style model

Образец запроса

HTTP

PUT {endpoint}/customvoice/models/JessicaMultiStyle?api-version=2024-02-01-preview



{
  "voiceName": "JessicaMultiStyleNeural",
  "description": "Jessica multi style voice",
  "recipe": {
    "kind": "MultiStyle"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    }
  }
}

Пример ответа

Код состояния:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/a01a127a-c204-4e46-a8c1-fab01559b05b?api-version=2024-02-01-preview
Operation-Id: a01a127a-c204-4e46-a8c1-fab01559b05b

{
  "id": "JessicaMultiStyle",
  "voiceName": "JessicaMultiStyleNeural",
  "description": "Jessica multi style voice",
  "recipe": {
    "kind": "MultiStyle",
    "version": "V3.2023.06"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    },
    "voiceStyles": [
      "cheerful",
      "sad",
      "happy",
      "myStyle2"
    ]
  },
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Определения

Имя	Описание
Error	Ошибка верхнего уровня следует рекомендациям по REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более описательными сведениями.
ErrorCode	Код ошибки верхнего уровня
ErrorResponse	Ответ на ошибку следует рекомендациям по REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Внутренняя ошибка соответствует рекомендациям ПО REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит код ошибки обязательных свойств, сообщение и необязательные свойства, внутреннюю ошибку (это можно вложить).
Model	Объект Model
ModelFailureReason	Причина сбоя обучения модели
ModelProperties	Свойства модели
PresetStyleItem	Предустановленные стили, поддерживаемые рецептом. Модель голосовой связи может поддерживать эти стили без какого-либо набора стилей обучения.
Recipe	Рецепт построения модели. Различные рецепты имеют разные возможности.
Status	Состояние ресурса.

Error

Object

Ошибка верхнего уровня следует рекомендациям по REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более описательными сведениями.

Имя	Тип	Описание
code	ErrorCode	Код ошибки верхнего уровня
details	Error[]	Дополнительные сведения о поддержке ошибок и (или) ожидаемых политик.
innererror	InnerError	Внутренняя ошибка соответствует рекомендациям ПО REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит код ошибки обязательных свойств, сообщение и необязательные свойства, внутреннюю ошибку (это можно вложить).
message	string	Сообщение об ошибке верхнего уровня.
target	string	Источник ошибки. Например, это будет "модель" или "идентификатор модели" в случае недопустимой модели.

ErrorCode

Перечисление

Код ошибки верхнего уровня

Значение	Описание
BadRequest
BadArgument
Unauthorized
Forbidden
NotFound
UnsupportedMediaType
TooManyRequests
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Ответ на ошибку следует рекомендациям по REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Имя	Тип	Описание
error	Error	Ошибка верхнего уровня следует рекомендациям по REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более описательными сведениями.

InnerError

Object

Внутренняя ошибка соответствует рекомендациям ПО REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит код ошибки обязательных свойств, сообщение и необязательные свойства, внутреннюю ошибку (это можно вложить).

Имя	Тип	Описание
code	string	Подробный код ошибки для диагностики.
innererror	InnerError	Внутренняя ошибка соответствует рекомендациям ПО REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит код ошибки обязательных свойств, сообщение и необязательные свойства, внутреннюю ошибку (это можно вложить).
message	string	Подробное сообщение об ошибке.
target	string	Источник ошибки. Например, это будет "модель" или "идентификатор модели" в случае недопустимой модели.

Model

Object

Объект Model

Имя	Тип	Описание
consentId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
createdDateTime	string (date-time)	Метка времени создания объекта. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Описание модели
engineVersion	string	Версия подсистемы. Обновление этой версии может получить последнее исправление ошибок произношения.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
lastActionDateTime	string (date-time)	Метка времени ввода текущего состояния. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Языковой стандарт этой модели. Код языкового стандарта следует BCP-47. Здесь можно найти текст для языкового стандарта речи https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
properties	ModelProperties	Свойства модели
recipe	Recipe	Рецепт построения модели. Различные рецепты имеют разные возможности.
status	Status	Состояние ресурса.
trainingSetId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
voiceName	string minLength: 1	Имя голоса

ModelFailureReason

Перечисление

Причина сбоя обучения модели

Значение	Описание
InaccessibleCustomerStorage	Клиент использует собственное хранилище в учетной записи службы "Речь". Но сейчас хранилище недоступно. Проверьте документации.
SpeakerVerificationFailed	Согласие и обучающий звук не совпадают с тем же динамиком.
TerminateByUser	Обучение модели, отмененное клиентом.
Internal	Ошибка пользовательской голосовой службы.

ModelProperties

Object

Свойства модели

Имя	Тип	Описание
failureReason	ModelFailureReason	Причина сбоя обучения модели
presetStyles	string[]	Предустановленные стили этой модели.
styleTrainingSetIds	object	Настраиваемые стили и связанные наборы обучения.
voiceStyles	string[]	Все стили, поддерживаемые этой моделью.

PresetStyleItem

Object

Предустановленные стили, поддерживаемые рецептом. Модель голосовой связи может поддерживать эти стили без какого-либо набора стилей обучения.

Имя	Тип	Описание
female	string[]	Предустановленные стили, поддерживаемые в женской голосовой модели.
male	string[]	Предустановленные стили, поддерживаемые в мужской голосовой модели.

Recipe

Object

Рецепт построения модели. Различные рецепты имеют разные возможности.

Имя	Тип	Описание
datasetLocales	string[]	Языковой стандарт обучающего набора данных. Код языкового стандарта следует BCP-47. Здесь можно найти текст для языкового стандарта речи https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Описание рецепта
kind	string	Вид рецепта
maxCustomStyleNum	integer (int32)	Максимальный настраиваемый номер стиля, поддерживаемый в одной голосовой модели.
minStyleUtteranceCount	integer (int32)	Минимальное количество речевых фрагментов, необходимое для обучения каждого настраиваемого стиля.
minUtteranceCount	integer (int32)	Минимальное количество речевых фрагментов, необходимое для обучения модели голоса с помощью этого рецепта.
modelLocales	string[]	Языковой стандарт, который голосовая модель может говорить с этим рецептом. Код языкового стандарта следует BCP-47. Здесь можно найти текст для языкового стандарта речи https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Предустановленные стили, поддерживаемые этим рецептом на языковой стандарт. Эти стили можно получить без какого-либо набора стилей обучения.
version	string	Версия рецепта

Status

Перечисление

Состояние ресурса.

Значение	Описание
NotStarted
Running
Succeeded
Failed
Disabling
Disabled

Поделиться через

Models - Create

Параметры URI

Заголовок запроса

Текст запроса

Ответы

Безопасность

Ocp-Apim-Subscription-Key

Примеры

Create a model

Образец запроса

Пример ответа

Create a multi style model

Образец запроса

Пример ответа

Определения

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status