Projects - Create

Service:

Cognitive Services - Custom Voice

API Version:

2023-12-01-preview

建立新專案。

PUT {endpoint}/customvoice/projects/{id}?api-version=2023-12-01-preview

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://eastus.api.cognitive.microsoft.com) 。
id	path	True	string	資源的標識碼。 Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version	query	True	string	用於此作業的 API 版本。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	在這裡提供您的語音資源金鑰。

要求本文

名稱	必要	類型	Description
kind	True	ProjectKind	專案種類
description		string	專案描述
displayName		string	專案名稱
id		string	資源識別碼

回應

名稱	類型	Description
201 Created	Project	建立時間
Other Status Codes	ErrorResponse	發生錯誤。

安全性

Ocp-Apim-Subscription-Key

在這裡提供您的語音資源金鑰。

Type: apiKey
In: header

範例

Create a project

Sample Request

HTTP

PUT {endpoint}/customvoice/projects/Jessica?api-version=2023-12-01-preview


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

Sample Response

Status code:

201

{
  "id": "Jessica",
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice",
  "createdDateTime": "2023-04-01T05:30:00.000Z"
}

定義

名稱	Description
Error	最上層錯誤遵循可在 取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors的 Microsoft Azure REST API 指導方針。 這包含具有錯誤碼、訊息、詳細數據、目標和內部錯誤的最上層錯誤，其中包含更具描述性的詳細數據。
ErrorCode	最上層錯誤碼
ErrorResponse	錯誤回應遵循可在 取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors的 Microsoft Azure REST API 指導方針。
InnerError	內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。
Project	Project 物件。 同意、定型集、模型和端點會組織在專案中。
ProjectKind	專案種類

Error

最上層錯誤遵循可在 取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors的 Microsoft Azure REST API 指導方針。 這包含具有錯誤碼、訊息、詳細數據、目標和內部錯誤的最上層錯誤，其中包含更具描述性的詳細數據。

名稱	類型	Description
code	ErrorCode	最上層錯誤碼
details	Error[]	關於錯誤和/或預期原則的其他支持詳細數據。
innererror	InnerError	內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。
message	string	最上層錯誤訊息。
target	string	錯誤的來源。 例如，如果是無效的模型，它會是「模型」或「模型標識碼」。

ErrorCode

最上層錯誤碼

名稱	類型	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

錯誤回應遵循可在 取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors的 Microsoft Azure REST API 指導方針。

名稱	類型	Description
error	Error	最上層錯誤遵循可在 取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors的 Microsoft Azure REST API 指導方針。 這包含具有錯誤碼、訊息、詳細數據、目標和內部錯誤的最上層錯誤，其中包含更具描述性的詳細數據。

InnerError

內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。

名稱	類型	Description
code	string	詳細的錯誤碼可協助診斷。
innererror	InnerError	內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。
message	string	詳細的錯誤訊息。
target	string	錯誤的來源。 例如，如果是無效的模型，它會是「模型」或「模型標識碼」。

Project

Project 物件。 同意、定型集、模型和端點會組織在專案中。

名稱	類型	Description
createdDateTime	string	建立物件的時間戳。 時間戳會編碼為 ISO 8601 日期和時間格式， (“YYYY-MM-DDThh：mm：ssZ”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。
description	string	專案描述
displayName	string	專案名稱
id	string	資源識別碼
kind	ProjectKind	專案種類

ProjectKind

專案種類

名稱	類型	Description
PersonalVoice	string
ProfessionalVoice	string