Update Hook - Update Hook

Служба:: Azure AI Services

Версия API:: v3.0

Обновляет веб-перехватчик, определенный указанным идентификатором.
Если секрет свойства в конфигурации опущен или содержит пустую строку, будущие обратные вызовы не будут содержать заголовки X-MicrosoftSpeechServices-Signature. Если свойство содержит непустую строку, она будет использоваться для создания хэша SHA256 полезных данных с секретом в виде ключа HMAC. Этот хэш будет задан как заголовок X-MicrosoftSpeechServices-Signature при обратном вызове в зарегистрированный URL-адрес.

Если URL-адрес изменяется, веб-перехватчик перестанет получать события до завершения вызова или ответа. Для этого запрос с вызовом типа события будет выполнен с параметром запроса с именем validationToken. Ответьте на вызов с помощью 200 ОК, содержащего значение параметра запроса validationToken в качестве текста ответа. После успешного завершения вызова или ответа веб-перехватчик начнет получать события.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
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"

Имя	Тип	Описание
customProperties	object	Пользовательские свойства этой сущности. Максимальная допустимая длина ключа составляет 64 символов, максимальная допустимая длина — 256 символов, а число разрешенных записей — 10.
description	string	Описание объекта.
displayName	string	Имя объекта.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	Зарегистрированный URL-адрес, который будет использоваться для отправки запросов POST для зарегистрированных событий.

Ответы

Имя	Тип	Описание
200 OK	WebHook	ХОРОШО Заголовки Retry-After: integer
Other Status Codes	Error	Произошла ошибка.

Имя

Тип

Описание

200 OK

WebHook

ХОРОШО

Заголовки

Retry-After: integer

Other Status Codes

Error

Произошла ошибка.

Безопасность

Ocp-Apim-Subscription-Key

Укажите ключ учетной записи Cognitive Services здесь.

Тип: apiKey
В: header

Authorization

Предоставьте маркер доступа из JWT, возвращаемого stS этого региона. Обязательно добавьте область управления в маркер, добавив следующую строку запроса к URL-адресу STS: ?scope=speechservicesmanagement

Тип: apiKey
В: 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"
}

Определения

Имя	Описание
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Ошибка
ErrorCode	Код ошибки
InnerError	InnerError
Status	Состояние
WebHook	Веб-перехватчик
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties
WebHookPropertiesUpdate	WebHookPropertiesUpdate
WebHookUpdate	WebHookUpdate

DetailedErrorCode

Перечисление

DetailedErrorCode

Значение	Описание
InvalidParameterValue	Недопустимое значение параметра.
InvalidRequestBodyFormat	Недопустимый формат текста запроса.
EmptyRequest	Пустой запрос.
MissingInputRecords	Отсутствуют входные записи.
InvalidDocument	Недопустимый документ.
ModelVersionIncorrect	Неправильная версия модели.
InvalidDocumentBatch	Недопустимый пакет документов.
UnsupportedLanguageCode	Неподдерживаемый код языка.
DataImportFailed	Сбой импорта данных.
InUseViolation	Нарушение использования.
InvalidLocale	Недопустимый языковой стандарт.
InvalidBaseModel	Недопустимая базовая модель.
InvalidAdaptationMapping	Недопустимое сопоставление адаптации.
InvalidDataset	Недопустимый набор данных.
InvalidTest	Недопустимый тест.
FailedDataset	Не удалось выполнить набор данных.
InvalidModel	Недопустимая модель.
InvalidTranscription	Недопустимое транскрибирование.
InvalidPayload	Недопустимые полезные данные.
InvalidParameter	Недопустимый параметр.
EndpointWithoutLogging	Конечная точка без ведения журнала.
InvalidPermissions	Недопустимые разрешения.
InvalidPrerequisite	Недопустимое условие.
InvalidProductId	Недопустимый идентификатор продукта.
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	Нет utf8 с бомом.
ModelDeploymentNotCompleteState	Развертывание модели не завершено.
SkuLimitsExist	Существуют ограничения SKU.
DeployingFailedModel	Развертывание неудачной модели.
UnsupportedTimeRange	Неподдерживаемый диапазон времени.
InvalidLogDate	Недопустимая дата журнала.
InvalidLogId	Недопустимый идентификатор журнала.
InvalidLogStartTime	Недопустимое время запуска журнала.
InvalidLogEndTime	Недопустимое время окончания журнала.
InvalidTopForLogs	Недопустимое начало для журналов.
InvalidSkipTokenForLogs	Недопустимый маркер пропуска для журналов.
DeleteNotAllowed	Удалить не разрешено.
Forbidden	Запретный.
DeployNotAllowed	Развертывание не разрешено.
UnexpectedError	Непредвиденная ошибка.
InvalidCollection	Недопустимая коллекция.
InvalidCallbackUri	Недопустимый универсальный код ресурса (URI) обратного вызова.
InvalidSasValidityDuration	Недопустимая длительность действия sas.
InaccessibleCustomerStorage	Недоступное хранилище клиентов.
UnsupportedClassBasedAdaptation	Неподдерживаемая адаптация на основе класса.
InvalidWebHookEventKind	Недопустимый тип события веб-перехватчика.
InvalidTimeToLive	Недопустимое время жизни.

EntityError

Object

EntityError

Имя	Тип	Описание
code	string	Код этой ошибки.
message	string	Сообщение об этой ошибке.

Error

Object

Ошибка

Имя	Тип	Описание
code	ErrorCode	Код ошибки Коды ошибок высокого уровня.
details	Error[]	Дополнительные сведения о поддержке ошибок и (или) ожидаемых политик.
innerError	InnerError	InnerError Новый формат внутренней ошибки, соответствующий рекомендациям ПО API Cognitive Services, который доступен в https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Это содержит обязательные свойства ErrorCode, сообщение и необязательные свойства, сведения (пара значений ключа), внутренняя ошибка (это может быть вложено).
message	string	Сообщение об ошибке высокого уровня.
target	string	Источник ошибки. Например, это будет "документы" или "идентификатор документа" в случае недопустимого документа.

ErrorCode

Перечисление

Код ошибки

Значение	Описание
InvalidRequest	Представляет недопустимый код ошибки запроса.
InvalidArgument	Представляет недопустимый код ошибки аргумента.
InternalServerError	Представляет код ошибки внутреннего сервера.
ServiceUnavailable	Представляет недоступный код ошибки службы.
NotFound	Представление не найденного кода ошибки.
PipelineError	Представляет код ошибки конвейера.
Conflict	Представляет код ошибки конфликта.
InternalCommunicationFailed	Представляет код ошибки внутренней связи.
Forbidden	Представляет запрещенный код ошибки.
NotAllowed	Представляет недопустимый код ошибки.
Unauthorized	Представляет несанкционированный код ошибки.
UnsupportedMediaType	Представляет неподдерживаемый код ошибки типа носителя.
TooManyRequests	Представление слишком большого количества запросов кода ошибки.
UnprocessableEntity	Представляет код ошибки необработанной сущности.

InnerError

Object

InnerError

Имя	Тип	Описание
code	DetailedErrorCode	DetailedErrorCode Подробный код ошибки перечисления.
details	object	Дополнительные сведения о поддержке ошибок и (или) ожидаемых политик.
innerError	InnerError	InnerError Новый формат внутренней ошибки, соответствующий рекомендациям ПО API Cognitive Services, который доступен в https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Это содержит обязательные свойства ErrorCode, сообщение и необязательные свойства, сведения (пара значений ключа), внутренняя ошибка (это может быть вложено).
message	string	Сообщение об ошибке высокого уровня.
target	string	Источник ошибки. Например, это будет "документы" или "идентификатор документа" в случае недопустимого документа.

Status

Перечисление

Состояние

Значение	Описание
NotStarted	Долго выполняющаяся операция еще не запущена.
Running	В настоящее время выполняется длительная операция.
Succeeded	Долго выполняющаяся операция успешно завершена.
Failed	Сбой длительной операции.

WebHook

Object

Веб-перехватчик

Имя	Тип	Описание
createdDateTime	string (date-time)	Метка времени при создании объекта. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм: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 ("ГГГГ-ММ-DDThh:мм: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)	Зарегистрированный URL-адрес, который будет использоваться для отправки запросов POST для зарегистрированных событий.

WebHookEvents

Object

WebHookEvents

Имя	Тип	Описание
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

Имя	Тип	Описание
ping	string (uri)	URL-адрес, который можно использовать для активации отправки события ping на зарегистрированный URL-адрес регистрации веб-перехватчика.
test	string (uri)	URL-адрес, который можно использовать для отправки событий тестирования в зарегистрированный URL-адрес регистрации веб-перехватчика.

WebHookProperties

Object

WebHookProperties

Имя	Тип	Описание
apiVersion	string	Версия API, в которую был создан веб-перехватчик. Это определяет форму полезных данных в обратных вызовах. Если тип полезных данных больше не поддерживается, так как фигура изменилась, а версия API с его помощью удаляется (после отмены), веб-перехватчик будет отключен.
error	EntityError	EntityError
secret	string	Секрет, который будет использоваться для создания хэша SHA256 полезных данных с секретом в качестве ключа HMAC. Этот хэш будет задан как заголовок X-MicrosoftSpeechServices-Signature при обратном вызове в зарегистрированный URL-адрес.

WebHookPropertiesUpdate

Object

WebHookPropertiesUpdate

Имя	Тип	Описание
secret	string	Секрет, который будет использоваться для создания хэша SHA256 полезных данных с секретом в качестве ключа HMAC. Этот хэш будет задан как заголовок X-MicrosoftSpeechServices-Signature при обратном вызове в зарегистрированный URL-адрес.

WebHookUpdate

Object

WebHookUpdate

Имя	Тип	Описание
customProperties	object	Пользовательские свойства этой сущности. Максимальная допустимая длина ключа составляет 64 символов, максимальная допустимая длина — 256 символов, а число разрешенных записей — 10.
description	string	Описание объекта.
displayName	string	Имя объекта.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	Зарегистрированный URL-адрес, который будет использоваться для отправки запросов POST для зарегистрированных событий.

Поделиться через

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