Projects - Create

Служба:

Azure AI Services

Версия API:

2024-02-01-preview

Создает новый проект.

PUT {endpoint}/customvoice/projects/{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	Укажите здесь ключ ресурса службы "Речь".

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

Имя	Обязательно	Тип	Описание
kind	True	ProjectKind	Тип проекта
description		string	Описание проекта
displayName		string minLength: 1	Имя проекта
id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса

Ответы

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Примеры

Create a project

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

HTTP

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


{
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice"
}

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

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

201

{
  "id": "Jessica",
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice",
  "createdDateTime": "2023-04-01T05:30:00.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. Это содержит код ошибки обязательных свойств, сообщение и необязательные свойства, внутреннюю ошибку (это можно вложить).
Project	Объект Project. Разрешения, обучающие наборы, модели и конечные точки организованы в проекте.
ProjectKind	Тип проекта

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

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

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

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

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	Источник ошибки. Например, это будет "модель" или "идентификатор модели" в случае недопустимой модели.

Project

Object

Объект Project. Разрешения, обучающие наборы, модели и конечные точки организованы в проекте.

Имя	Тип	Описание
createdDateTime	string (date-time)	Метка времени создания объекта. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Описание проекта
displayName	string minLength: 1	Имя проекта
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
kind	ProjectKind	Тип проекта

ProjectKind

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

Тип проекта

Значение	Описание
PersonalVoice
ProfessionalVoice