Web Hooks - Create

참조

서비스:: Azure AI Services

API 버전:: v3.1

새 웹 후크를 만듭니다.
구성의 속성 비밀이 있고 비어 있지 않은 문자열을 포함하는 경우 암호를 HMAC 키로 사용하여 페이로드의 SHA256 해시를 만드는 데 사용됩니다. 이 해시는 등록된 URL로 다시 호출할 때 X-MicrosoftSpeechServices-Signature 헤더로 설정됩니다.

등록된 URL로 다시 호출할 때 요청에는 등록된 이벤트 유형 중 하나가 포함된 X-MicrosoftSpeechServices-Event 헤더가 포함됩니다. 등록된 이벤트 유형당 하나의 요청이 있습니다.

웹 후크를 성공적으로 등록한 후에는 챌린지/응답이 완료될 때까지 사용할 수 없습니다. 이렇게 하려면 validationToken이라는 쿼리 매개 변수를 사용하여 이벤트 유형 챌린지가 있는 요청이 수행됩니다. validationToken 쿼리 매개 변수의 값을 응답 본문으로 포함하는 200 OK로 챌린지에 응답합니다. 챌린지/응답이 성공적으로 완료되면 웹 후크가 이벤트 수신을 시작합니다.

POST {endpoint}/speechtotext/v3.1/webhooks

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus.api.cognitive.microsoft.com).

요청 본문

Name	필수	형식	Description
displayName	True	string	개체의 표시 이름입니다.
events	True	WebHookEvents	WebHookEvents
webUrl	True	string	등록된 이벤트에 대한 POST 요청을 보내는 데 사용할 등록된 URL입니다.
customProperties		object	이 엔터티의 사용자 지정 속성입니다. 허용되는 최대 키 길이는 64자, 허용되는 최대 값 길이는 256자, 허용되는 항목 수는 10자입니다.
description		string	개체에 대한 설명입니다.
links		WebHookLinks	WebHookLinks
properties		WebHookProperties	WebHookProperties

응답

Name	형식	Description
201 Created	WebHook	응답에는 엔터티에 대한 정보가 페이로드로 포함되고 해당 위치가 헤더로 포함됩니다. 헤더 Location: string
Other Status Codes	Error	오류가 발생했습니다.

Name

형식

Description

201 Created

WebHook

응답에는 엔터티에 대한 정보가 페이로드로 포함되고 해당 위치가 헤더로 포함됩니다.

헤더

Location: string

Other Status Codes

Error

오류가 발생했습니다.

보안

Ocp-Apim-Subscription-Key

여기에서 Cognitive Services 계정 키를 제공합니다.

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

Authorization

이 지역의 STS에서 반환된 JWT에서 액세스 토큰을 제공합니다. STS URL에 다음 쿼리 문자열을 추가하여 관리 scope 토큰에 추가해야 합니다. ?scope=speechservicesmanagement

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

예제

Create a web hook

샘플 요청

HTTP

POST {endpoint}/speechtotext/v3.1/webhooks

{
  "displayName": "TranscriptionCompletionWebHook",
  "properties": {
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "description": "I registered this URL to get a POST request for each completed transcription."
}

샘플 응답

상태 코드:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d

{
  "displayName": "TranscriptionCompletionWebHook",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d",
  "links": {
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test",
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping"
  },
  "properties": {
    "apiVersion": "v3.1",
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "description": "I registered this URL to get a POST request for each completed transcription.",
  "createdDateTime": "2018-11-11T00:00:00Z",
  "lastActionDateTime": "2018-11-28T00:00:00Z",
  "status": "NotStarted"
}

정의

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	오류
ErrorCode	오류 코드
InnerError	InnerError
Status	상태
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties

DetailedErrorCode

Name	형식	Description
DataImportFailed	string	데이터 가져오기에 실패했습니다.
DeleteNotAllowed	string	삭제할 수 없습니다.
DeployNotAllowed	string	배포가 허용되지 않습니다.
DeployingFailedModel	string	실패한 모델 배포.
EmptyRequest	string	빈 요청입니다.
EndpointCannotBeDefault	string	엔드포인트는 기본값일 수 없습니다.
EndpointNotUpdatable	string	엔드포인트를 사용할 수 없습니다.
EndpointWithoutLogging	string	로깅이 없는 엔드포인트입니다.
ExceededNumberOfRecordingsUris	string	기록 URI 수를 초과했습니다.
FailedDataset	string	실패한 데이터 세트입니다.
Forbidden	string	사용할 수 없습니다.
InUseViolation	string	사용 위반.
InaccessibleCustomerStorage	string	액세스할 수 없는 고객 스토리지.
InvalidAdaptationMapping	string	잘못된 적응 매핑입니다.
InvalidBaseModel	string	잘못된 기본 모델입니다.
InvalidCallbackUri	string	콜백 URI가 잘못되었습니다.
InvalidCollection	string	컬렉션이 잘못되었습니다.
InvalidDataset	string	데이터 세트가 잘못되었습니다.
InvalidDocument	string	잘못된 문서입니다.
InvalidDocumentBatch	string	문서 일괄 처리가 잘못되었습니다.
InvalidLocale	string	잘못된 로캘입니다.
InvalidLogDate	string	잘못된 로그 날짜입니다.
InvalidLogEndTime	string	로그 종료 시간이 잘못되었습니다.
InvalidLogId	string	잘못된 로그 ID입니다.
InvalidLogStartTime	string	로그 시작 시간이 잘못되었습니다.
InvalidModel	string	모델이 잘못되었습니다.
InvalidModelUri	string	모델 URI가 잘못되었습니다.
InvalidParameter	string	잘못된 매개 변수입니다.
InvalidParameterValue	string	매개 변수 값이 잘못되었습니다.
InvalidPayload	string	잘못된 페이로드입니다.
InvalidPermissions	string	권한이 잘못되었습니다.
InvalidPrerequisite	string	필수 구성 요소가 잘못되었습니다.
InvalidProductId	string	제품 ID가 잘못되었습니다.
InvalidProject	string	프로젝트가 잘못되었습니다.
InvalidProjectKind	string	프로젝트 종류가 잘못되었습니다.
InvalidRecordingsUri	string	잘못된 녹음/녹화 URI입니다.
InvalidRequestBodyFormat	string	요청 본문 형식이 잘못되었습니다.
InvalidSasValidityDuration	string	sas 유효 기간이 잘못되었습니다.
InvalidSkipTokenForLogs	string	로그에 대한 건너뛰기 토큰이 잘못되었습니다.
InvalidSubscription	string	구독이 잘못되었습니다.
InvalidTest	string	테스트가 잘못되었습니다.
InvalidTimeToLive	string	유효하지 않은 TL(Time to Live)
InvalidTopForLogs	string	로그의 위쪽이 잘못되었습니다.
InvalidTranscription	string	전사가 잘못되었습니다.
InvalidWebHookEventKind	string	웹 후크 이벤트 종류가 잘못되었습니다.
MissingInputRecords	string	입력 레코드가 없습니다.
ModelDeploymentNotCompleteState	string	모델 배포가 완료되지 않은 상태입니다.
ModelDeprecated	string	모델이 더 이상 사용되지 않습니다.
ModelExists	string	모델이 있습니다.
ModelMismatch	string	모델 불일치.
ModelNotDeployable	string	모델을 배포할 수 없습니다.
ModelVersionIncorrect	string	모델 버전이 잘못되었습니다.
NoUtf8WithBom	string	bom과 함께 utf8이 없습니다.
OnlyOneOfUrlsOrContainerOrDataset	string	URL 또는 컨테이너 또는 데이터 세트 중 하나만.
ProjectGenderMismatch	string	프로젝트 성별 불일치.
QuotaViolation	string	할당량 위반.
SingleDefaultEndpoint	string	단일 기본 엔드포인트입니다.
SkuLimitsExist	string	SKU 제한이 있습니다.
SubscriptionNotFound	string	구독을 찾을 수 없습니다.
UnexpectedError	string	예기치 않은 오류입니다.
UnsupportedClassBasedAdaptation	string	지원되지 않는 클래스 기반 적응입니다.
UnsupportedDelta	string	지원되지 않는 델타입니다.
UnsupportedDynamicConfiguration	string	지원되지 않는 동적 구성입니다.
UnsupportedFilter	string	지원되지 않는 필터입니다.
UnsupportedLanguageCode	string	지원되지 않는 언어 코드입니다.
UnsupportedOrderBy	string	지원되지 않는 순서 기준입니다.
UnsupportedPagination	string	지원되지 않는 페이지 매김.
UnsupportedTimeRange	string	지원되지 않는 시간 범위입니다.

EntityError

Name	형식	Description
code	string	이 오류의 코드입니다.
message	string	이 오류에 대한 메시지입니다.

Error

오류

Name	형식	Description
code	ErrorCode	오류 코드 높은 수준의 오류 코드입니다.
details	Error[]	오류 및/또는 예상 정책에 대한 추가 지원 세부 정보입니다.
innerError	InnerError	InnerError 에서 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow사용할 수 있는 Cognitive Services API 지침을 준수하는 새로운 내부 오류 형식입니다. 여기에는 필수 속성 ErrorCode, 메시지 및 선택적 속성 대상, 세부 정보(키 값 쌍), 내부 오류(중첩될 수 있음)가 포함됩니다.
message	string	높은 수준의 오류 메시지입니다.
target	string	오류의 출처입니다. 예를 들어 잘못된 문서의 경우 "documents" 또는 "document id"가 됩니다.

ErrorCode

오류 코드

Name	형식	Description
Conflict	string	충돌 오류 코드를 나타냅니다.
Forbidden	string	사용할 수 없는 오류 코드를 나타냅니다.
InternalCommunicationFailed	string	내부 통신 실패 오류 코드를 나타냅니다.
InternalServerError	string	내부 서버 오류 코드를 나타냅니다.
InvalidArgument	string	잘못된 인수 오류 코드를 나타냅니다.
InvalidRequest	string	잘못된 요청 오류 코드를 나타냅니다.
NotAllowed	string	허용되지 않는 오류 코드를 나타냅니다.
NotFound	string	찾을 수 없는 오류 코드를 나타냅니다.
PipelineError	string	파이프라인 오류 코드를 나타냅니다.
ServiceUnavailable	string	서비스를 사용할 수 없음 오류 코드를 나타냅니다.
TooManyRequests	string	너무 많은 요청 오류 코드를 나타냅니다.
Unauthorized	string	권한 없는 오류 코드를 나타냅니다.
UnprocessableEntity	string	처리할 수 없는 엔터티 오류 코드를 나타냅니다.
UnsupportedMediaType	string	지원되지 않는 미디어 형식 오류 코드를 나타냅니다.

InnerError

Name	형식	Description
code	DetailedErrorCode	DetailedErrorCode 자세한 오류 코드 열거형입니다.
details	object	오류 및/또는 예상 정책에 대한 추가 지원 세부 정보입니다.
innerError	InnerError	InnerError 에서 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow사용할 수 있는 Cognitive Services API 지침을 준수하는 새로운 내부 오류 형식입니다. 여기에는 필수 속성 ErrorCode, 메시지 및 선택적 속성 대상, 세부 정보(키 값 쌍), 내부 오류(중첩될 수 있음)가 포함됩니다.
message	string	높은 수준의 오류 메시지입니다.
target	string	오류의 출처입니다. 예를 들어 잘못된 문서의 경우 "documents" 또는 "document id"가 됩니다.

Status

상태

Name	형식	Description
Failed	string	장기 실행 작업이 실패했습니다.
NotStarted	string	장기 실행 작업이 아직 시작되지 않았습니다.
Running	string	장기 실행 작업은 현재 처리 중입니다.
Succeeded	string	장기 실행 작업이 성공적으로 완료되었습니다.

WebHook

Name	형식	Description
createdDateTime	string	개체를 만들 때의 타임스탬프를 지정합니다. 타임스탬프는 ISO 8601 날짜 및 시간 형식으로 인코딩됩니다("YYYY-MM-DDThh:mm:ssZ", 참조 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	이 엔터티의 사용자 지정 속성입니다. 허용되는 최대 키 길이는 64자, 허용되는 최대 값 길이는 256자, 허용되는 항목 수는 10자입니다.
description	string	개체에 대한 설명입니다.
displayName	string	개체의 표시 이름입니다.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string	현재 상태 입력한 타임스탬프를 지정합니다. 타임스탬프는 ISO 8601 날짜 및 시간 형식으로 인코딩됩니다("YYYY-MM-DDThh:mm:ssZ", 참조 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string	이 엔터티의 위치입니다.
status	Status	상태 API의 현재 상태 설명
webUrl	string	등록된 이벤트에 대한 POST 요청을 보내는 데 사용할 등록된 URL입니다.

WebHookEvents

Name	형식	Description
challenge	boolean
datasetCompletion	boolean
datasetCreation	boolean
datasetDeletion	boolean
datasetProcessing	boolean
endpointCompletion	boolean
endpointCreation	boolean
endpointDeletion	boolean
endpointProcessing	boolean
evaluationCompletion	boolean
evaluationCreation	boolean
evaluationDeletion	boolean
evaluationProcessing	boolean
modelCompletion	boolean
modelCreation	boolean
modelDeletion	boolean
modelProcessing	boolean
ping	boolean
transcriptionCompletion	boolean
transcriptionCreation	boolean
transcriptionDeletion	boolean
transcriptionProcessing	boolean

WebHookLinks

Name	형식	Description
ping	string	웹 후크 등록의 등록된 URL로 ping 이벤트 전송을 트리거하는 데 사용할 수 있는 URL입니다. 자세한 내용은 작업 "WebHooks_Ping"을 참조하세요.
test	string	테스트 이벤트를 웹 후크 등록의 등록된 URL로 보내는 데 사용할 수 있는 URL입니다. 자세한 내용은 "WebHooks_Test" 작업을 참조하세요.

WebHookProperties

Name	형식	Description
apiVersion	string	웹 후크가 만들어진 API 버전입니다. 콜백에서 페이로드의 모양을 정의합니다. 셰이프가 변경되고 사용 중인 API 버전이 제거되어 페이로드 형식이 더 이상 지원되지 않으면 웹 후크가 비활성화됩니다.
error	EntityError	EntityError
secret	string	암호를 HMAC 키로 사용하여 페이로드의 SHA256 해시를 만드는 데 사용되는 비밀입니다. 이 해시는 등록된 URL로 다시 호출할 때 X-MicrosoftSpeechServices-Signature 헤더로 설정됩니다.

다음을 통해 공유

Web Hooks - Create

URI 매개 변수

요청 본문

응답

보안

Ocp-Apim-Subscription-Key

Authorization

예제

Create a web hook

샘플 요청

샘플 응답

정의

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

추가 리소스