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]$	リソースの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string	ここで Speech リソース キーを指定します。

要求本文

名前	必須	型	説明
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]$	リソース ID

応答

名前	型	説明
201 Created	Project	作成
Other Status Codes	ErrorResponse	エラーが発生しました。 ヘッダー x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

ここで Speech リソース キーを指定します。

型: 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	最上位レベルのエラーは、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	内部エラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、必須プロパティのエラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。
Project	Project オブジェクト。 同意、トレーニング セット、モデル、エンドポイントは、プロジェクトで編成されます。
ProjectKind	プロジェクトの種類

Error

Object

最上位レベルのエラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、エラー コード、メッセージ、詳細、ターゲットを含む最上位レベルのエラーと、よりわかりやすい詳細を含む内部エラーが含まれます。

名前	型	説明
code	ErrorCode	最上位のエラー コード
details	Error[]	エラーや予想されるポリシーに関するその他のサポートの詳細。
innererror	InnerError	内部エラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、必須プロパティのエラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。
message	string	最上位レベルのエラー メッセージ。
target	string	エラーの原因。 たとえば、無効なモデルの場合は "model" または "model id" になります。

ErrorCode

列挙

最上位のエラー コード

値	説明
BadRequest
BadArgument
Unauthorized
Forbidden
NotFound
UnsupportedMediaType
TooManyRequests
InternalServerError
ServiceUnavailable

ErrorResponse

Object

エラー応答は、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。

名前	型	説明
error	Error	最上位レベルのエラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、エラー コード、メッセージ、詳細、ターゲットを含む最上位レベルのエラーと、よりわかりやすい詳細を含む内部エラーが含まれます。

InnerError

Object

内部エラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、必須プロパティのエラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。

名前	型	説明
code	string	診断に役立つ詳細なエラー コード。
innererror	InnerError	内部エラーは、https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsで利用可能な Microsoft Azure REST API ガイドラインに従います。 これには、必須プロパティのエラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。
message	string	詳細なエラー メッセージ。
target	string	エラーの原因。 たとえば、無効なモデルの場合は "model" または "model id" になります。

Project

Object

Project オブジェクト。 同意、トレーニング セット、モデル、エンドポイントは、プロジェクトで編成されます。

名前	型	説明
createdDateTime	string (date-time)	オブジェクトが作成されたときのタイムスタンプ。 タイムスタンプは ISO 8601 日時形式でエンコードされます (「YYYY-MM-DDThh:mm: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]$	リソース ID
kind	ProjectKind	プロジェクトの種類

ProjectKind

列挙

プロジェクトの種類

値	説明
ProfessionalVoice
PersonalVoice