Consents - Create

참조

서비스:: Azure AI Services

API 버전:: 2024-02-01-preview

제공된 오디오 URL을 사용하여 새 성우 동의를 만듭니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	리소스의 ID입니다. regex 패턴: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

endpoint

path

True

string

지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://eastus.api.cognitive.microsoft.com).

path

True

string

리소스의 ID입니다.

regex 패턴: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

이 작업에 사용할 API 버전입니다.

요청 헤더

Name 필수 형식 Description

Ocp-Apim-Subscription-Key

True

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string	여기에서 Speech 리소스 키를 제공합니다.
Operation-Id		string	작업에 대한 상태 모니터의 ID입니다. Operation-Id 헤더가 기존 작업과 일치하고 요청이 이전 요청과 동일하지 않으면 400 잘못된 요청으로 실패합니다. regex 패턴: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

여기에서 Speech 리소스 키를 제공합니다.

Operation-Id

string

작업에 대한 상태 모니터의 ID입니다. Operation-Id 헤더가 기존 작업과 일치하고 요청이 이전 요청과 동일하지 않으면 400 잘못된 요청으로 실패합니다.

regex 패턴: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

요청 본문

Name	필수	형식	Description
companyName	True	string	회사 이름 동의 오디오 파일의 회사 이름과 일치해야 합니다.
locale	True	string	이 동의의 로캘입니다. 로캘 코드는 BCP-47을 따릅니다. 텍스트 음성 변환 로캘 목록은 여기에서 찾을 수 있습니다 https://zcusa.951200.xyz/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	리소스의 상태입니다.

응답

Name	형식	Description
201 Created	Consent	생성일 헤더 Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	오류가 발생했습니다. 헤더 x-ms-error-code: string

Name

형식

Description

201 Created

Consent

생성일

헤더

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

오류가 발생했습니다.

헤더

x-ms-error-code: string

보안

Ocp-Apim-Subscription-Key

여기에서 Speech 리소스 키를 제공합니다.

형식: apiKey
In(다음 안에): header

예제

샘플 요청

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"
}

정의

Name	Description
Consent	Consent 개체
ConsentFailureReason	동의 만들기 실패 이유
ConsentProperties	동의 속성
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 지침을 따릅니다. 여기에는 필수 속성 오류 코드, 메시지 및 선택적 속성 대상, 내부 오류(중첩될 수 있음)가 포함됩니다.
Status	리소스의 상태입니다.

Consent 개체

Name	형식	Description
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://zcusa.951200.xyz/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	리소스 ID
properties	ConsentProperties	동의 속성
status	Status	리소스의 상태입니다.
voiceTalentName	string	성우 이름입니다. 동의 오디오 파일의 음성 특성 이름과 일치해야 합니다.

ConsentFailureReason

동의 만들기 실패 이유

Name	형식	Description
AudioAndScriptNotMatch	string	동의 오디오가 구두 문과 일치하지 않습니다. 구두 진술을 확인하세요.
Internal	string	사용자 지정 음성 서비스 오류입니다.

ConsentProperties

동의 속성

Name	형식	Description
failureReason	ConsentFailureReason	동의 만들기 실패 이유

Error

최상위 오류는 에서 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors사용할 수 있는 Microsoft Azure REST API 지침을 따릅니다. 여기에는 오류 코드, 메시지, 세부 정보, 대상 및 자세한 세부 정보가 포함된 내부 오류가 포함된 최상위 오류가 포함됩니다.

Name	형식	Description
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	오류의 출처입니다. 예를 들어 모델이 잘못된 경우 "모델" 또는 "모델 ID"가 됩니다.

ErrorCode

최상위 오류 코드

Name	형식	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 지침을 따릅니다.

Name	형식	Description
error	Error	최상위 오류는 에서 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 지침을 따릅니다. 여기에는 필수 속성 오류 코드, 메시지 및 선택적 속성 대상, 내부 오류(중첩될 수 있음)가 포함됩니다.

Name	형식	Description
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	오류의 출처입니다. 예를 들어 모델이 잘못된 경우 "모델" 또는 "모델 ID"가 됩니다.

Status

리소스의 상태입니다.

Name	형식	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

다음을 통해 공유

Consents - Create

URI 매개 변수

요청 헤더

요청 본문

응답

보안

Ocp-Apim-Subscription-Key

예제

샘플 요청

샘플 응답

정의

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

추가 리소스

다음을 통해 공유

Consents - Create

URI 매개 변수

요청 헤더

요청 본문

응답

보안

Ocp-Apim-Subscription-Key

예제

Create a consent

샘플 요청

샘플 응답

정의

Consent

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

추가 리소스