Endpoints - Create

Service:

Cognitive Services - Custom Voice

API Version:

2023-12-01-preview

新しいエンドポイントを作成します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://eastus.api.cognitive.microsoft.com
id	path	True	string uuid	リソース ID。UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string	Speech リソース キーをここに入力します。
Operation-Id		string	操作の状態モニターの ID。 Operation-Id ヘッダーが既存の操作と一致し、要求が以前の要求と同じでない場合、400 Bad Request で失敗します。 Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

要求本文

名前	必須	型	説明
modelId	True	string	リソースの ID
projectId	True	string	リソースの ID
description		string	エンドポイントの説明
displayName		string	エンドポイント名
id		string	エンドポイント ID
properties		EndpointProperties	エンドポイントのプロパティ
status		Status	リソースの状態。

応答

名前	型	説明
201 Created	Endpoint	作成済み Headers Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

Speech リソース キーをここに入力します。

Type: apiKey
In: header

例

Create an endpoint

Sample Request

HTTP

PUT {
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica"
}/customvoice/endpoints/9f50c644-2121-40e9-9ea7-544e48bfe3cb?api-version=2023-12-01-preview



{
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica"
}

Sample Response

Status code:

201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/2595b58d-40d6-4032-a618-482dcce1c130?api-version=2023-12-01-preview
Operation-Id: 2595b58d-40d6-4032-a618-482dcce1c130

Response Body

{
  "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica",
  "properties": {
    "kind": "HighPerformance"
  },
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

定義

名前	説明
Endpoint	Endpoint オブジェクト
EndpointKind	エンドポイントの種類
EndpointProperties	エンドポイントのプロパティ
Error	最上位レベルのエラーは、 で利用可能な Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、エラー コード、メッセージ、詳細、ターゲット、およびよりわかりやすい詳細を含む内部エラーを含む最上位レベルのエラーが含まれます。
ErrorCode	最上位のエラー コード
ErrorResponse	エラー応答は、 で入手できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。
InnerError	内部エラーは、 で入手できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、必須プロパティのエラー コード、メッセージ、およびオプションのプロパティ ターゲット、内部エラー (入れ子にできます) が含まれます。
Status	リソースの状態。

Endpoint

Endpoint オブジェクト

名前	型	説明
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	エンドポイント ID
lastActionDateTime	string	現在の状態が入力されたときのタイムスタンプ。 タイムスタンプは ISO 8601 日時形式 ("YYYY-MM-DDThh:mm:ssZ"、 を参照) https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representationsとしてエンコードされます。
modelId	string	リソースの ID
projectId	string	リソースの ID
properties	EndpointProperties	エンドポイントのプロパティ
status	Status	リソースの状態。

EndpointKind

エンドポイントの種類

名前	型	説明
FastResume	string
HighPerformance	string

EndpointProperties

エンドポイントのプロパティ

名前	型	説明
kind	EndpointKind	エンドポイントの種類

Error

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

名前	型	説明
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	エラーのソースです。 たとえば、無効なモデルの場合は、"model" または "model id" になります。

ErrorCode

最上位のエラー コード

名前	型	説明
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

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

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

InnerError

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

名前	型	説明
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	エラーのソースです。 たとえば、無効なモデルの場合は、"model" または "model id" になります。

Status

リソースの状態。

名前	型	説明
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string