你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	支持的认知服务终结点 (协议和主机名，例如： 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	在此处提供语音资源密钥。
Operation-Id		string	操作的状态监视器的 ID。 如果 Operation-Id 标头与现有操作匹配，并且请求与以前的请求不同，则失败并显示 400 错误请求。 正则表达式模式: ^[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

在此处提供语音资源密钥。

类型: apiKey
在: header

示例

Create a consent

示例请求

HTTP

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	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	资源的状态。

Consent

Consent 对象

名称	类型	说明
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	自定义语音服务错误。

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