Update Hook - Update Hook

서비스:: Azure AI Services

API 버전:: v3.0

지정된 ID로 식별되는 웹 후크를 업데이트합니다.
구성의 속성 비밀을 생략하거나 빈 문자열을 포함하는 경우 이후 콜백에는 X-MicrosoftSpeechServices-Signature 헤더가 포함되지 않습니다. 속성에 비어 있지 않은 문자열이 포함된 경우 비밀을 HMAC 키로 사용하여 페이로드의 SHA256 해시를 만드는 데 사용됩니다. 이 해시는 등록된 URL로 다시 호출할 때 XMicrosoftSpeechServices-Signature 헤더로 설정됩니다.

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

PATCH {Endpoint}/speechtotext/v3.0/webhooks/{id}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
Endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	웹 후크의 식별자입니다.

요청 본문

Media Types: "application/json", "application/merge-patch+json"

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

응답

Name	형식	Description
200 OK	WebHook	그래 헤더 Retry-After: integer
Other Status Codes	Error	오류가 발생했습니다.

Name

형식

Description

200 OK

WebHook

그래

헤더

Retry-After: integer

Other Status Codes

Error

오류가 발생했습니다.

보안

Ocp-Apim-Subscription-Key

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

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

Authorization

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

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

예제

Update a web hook

샘플 요청

HTTP

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

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

샘플 응답

상태 코드:: 200

{
  "displayName": "TranscriptionCompletionWebHook",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d",
  "links": {
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test",
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping"
  },
  "properties": {
    "apiVersion": "v3.0",
    "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": "Succeeded"
}

정의

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

DetailedErrorCode

열거형

DetailedErrorCode

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

EntityError

Object

EntityError

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

Error

Object

오류

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, 메시지 및 선택적 속성 대상, details(키 값 쌍), 내부 오류(중첩될 수 있음)가 포함됩니다.
message	string	높은 수준의 오류 메시지입니다.
target	string	오류의 소스입니다. 예를 들어 잘못된 문서의 경우 "문서" 또는 "문서 ID"가 됩니다.

ErrorCode

열거형

오류 코드

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

InnerError

Object

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, 메시지 및 선택적 속성 대상, details(키 값 쌍), 내부 오류(중첩될 수 있음)가 포함됩니다.
message	string	높은 수준의 오류 메시지입니다.
target	string	오류의 소스입니다. 예를 들어 잘못된 문서의 경우 "문서" 또는 "문서 ID"가 됩니다.

Status

열거형

상태

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

WebHook

Object

WebHook

Name	형식	Description
createdDateTime	string (date-time)	개체를 만들 때의 타임스탬프를 지정합니다. 타임스탬프는 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 (date-time)	현재 상태가 입력된 타임스탬프를 지정합니다. 타임스탬프는 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 (uri)	이 엔터티의 위치입니다.
status	Status	상태 API의 현재 상태 설명
webUrl	string (uri)	등록된 이벤트에 대한 POST 요청을 보내는 데 사용할 등록된 URL입니다.

WebHookEvents

Object

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

Object

WebHookLinks

Name	형식	Description
ping	string (uri)	웹 후크 등록의 등록된 URL로 ping 이벤트 전송을 트리거하는 데 사용할 수 있는 URL입니다.
test	string (uri)	테스트 이벤트를 웹 후크 등록의 등록된 URL로 보내는 데 사용할 수 있는 URL입니다.

WebHookProperties

Object

WebHookProperties

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

WebHookPropertiesUpdate

Object

WebHookPropertiesUpdate

Name	형식	Description
secret	string	암호를 HMAC 키로 사용하여 페이로드의 SHA256 해시를 만드는 데 사용되는 비밀입니다. 이 해시는 등록된 URL로 다시 호출할 때 XMicrosoftSpeechServices-Signature 헤더로 설정됩니다.

WebHookUpdate

Object

WebHookUpdate

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

다음을 통해 공유

Update Hook - Update Hook

URI 매개 변수

요청 본문

응답

보안

Ocp-Apim-Subscription-Key

Authorization

예제

Update a web hook

샘플 요청

샘플 응답

정의

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate