次の方法で共有

Consents - Create

  • リファレンス
サービス:
Azure AI Services
API バージョン:
2024-02-01-preview

指定されたオーディオ URL を使用して、新しい音声タレントの同意を作成します。

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

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://eastus.api.cognitive.microsoft.com
id
 path True

string

リソースの ID。

正規表現パターン: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version
 query True

string

この操作に使用する API バージョン。

要求ヘッダー

名前 必須 型 説明
Ocp-Apim-Subscription-Key True

string

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

string

操作の状態モニターの ID。 Operation-Id ヘッダーが既存の操作と一致し、要求が以前の要求と同じでない場合、400 Bad Request で失敗します。

正規表現パターン: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

要求本文

名前 必須 型 説明
companyName True

string

会社名 同意オーディオ ファイル内の会社名と一致する必要があります。
locale True

string

この同意のロケール。 ロケール コードは BCP-47 に従います。 テキスト読み上げロケールの一覧については、こちらを参照してください https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts。
projectId True

string

リソースの ID
voiceTalentName True

string

音声タレント名。 同意オーディオ ファイルの音声タレント名と一致する必要があります。
audioUrl

string

同意オーディオ ファイルのパブリックアクセス可能な URL。 SAS を使用する Azure BLOB URL にすることをお勧めします。 このプロパティは、要求でのみ使用できます。
description

string

同意の説明。
displayName

string

同意の名前。
id

string

リソースの ID
properties

ConsentProperties

同意プロパティ
status

Status

リソースの状態。

応答

名前 型 説明
201 Created

Consent

作成済み

ヘッダー

  • Operation-Id: string
  • Operation-Location: string
Other Status Codes

ErrorResponse

エラーが発生しました。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

例

要求のサンプル

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



{
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "audioUrl": "https://contoso.blob.core.windows.net/public/jessica-consent.wav?mySasToken",
  "locale": "en-US"
}

応答のサンプル

状態コード:
201 
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2024-02-01-preview
Operation-Id: 070f7986-ef17-41d0-ba2b-907f0f28e314
{
  "id": "Jessica",
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "locale": "en-US",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

定義

名前 説明
Consent

同意オブジェクト
ConsentFailureReason

同意の作成エラーの理由
ConsentProperties

同意プロパティ
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

リソースの状態。

同意オブジェクト

名前 型 説明
audioUrl

string

同意オーディオ ファイルのパブリックアクセス可能な URL。 SAS を使用する Azure BLOB URL にすることをお勧めします。 このプロパティは、要求でのみ使用できます。
companyName

string

会社名 同意オーディオ ファイル内の会社名と一致する必要があります。
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としてエンコードされます。
locale

string

この同意のロケール。 ロケール コードは BCP-47 に従います。 テキスト読み上げロケールの一覧については、こちらを参照してください https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts。
projectId

string

リソースの ID
properties

ConsentProperties

同意プロパティ
status

Status

リソースの状態。
voiceTalentName

string

音声タレント名。 同意オーディオ ファイルの音声タレント名と一致する必要があります。

ConsentFailureReason

同意の作成エラーの理由

名前 型 説明
AudioAndScriptNotMatch

string

同意音声と口頭での声明の不一致。 口頭での文章をご確認ください。
Internal

string

Custom Voice Service エラー。

ConsentProperties

同意プロパティ

名前 型 説明
failureReason

ConsentFailureReason

同意の作成エラーの理由

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