Update Hook - Update Hook

Referência

Serviço:: Azure AI Services

Versão da API:: v3.0

Atualiza o gancho da Web identificado pela ID fornecida.
Se o segredo da propriedade na configuração for omitido ou contiver uma cadeia de caracteres vazia, os retornos de chamada futuros não conterão cabeçalhos deMicrosoftSpeechServices-Signature X. Se a propriedade contiver uma cadeia de caracteres não vazia, ela será usada para criar um hash SHA256 do conteúdo com o segredo como chave HMAC. Esse hash será definido como cabeçalho X-MicrosoftSpeechServices-Signature ao chamar novamente para a URL registrada.

Se a URL for alterada, o web hook deixará de receber eventos até que um desafio/resposta seja concluído. Para fazer isso, uma solicitação com o desafio de tipo de evento será feita com um parâmetro de consulta chamado validationToken. Responda ao desafio com um OK 200 contendo o valor do parâmetro de consulta validationToken como o corpo da resposta. Quando o desafio/resposta for concluído com êxito, o gancho da Web começará a receber eventos.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	O identificador do web hook.

Corpo da solicitação

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

Nome	Tipo	Description
customProperties	object	As propriedades personalizadas dessa entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo de valor permitido é de 256 caracteres e a contagem de entradas permitidas é 10.
description	string	A descrição do objeto.
displayName	string	O nome do objeto.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	A URL registrada que será usada para enviar as solicitações POST para os eventos registrados.

Respostas

Nome	Tipo	Description
200 OK	WebHook	OKEY Cabeçalhos Retry-After: integer
Other Status Codes	Error	Ocorreu um erro.

Nome

Tipo

Description

200 OK

WebHook

OKEY

Cabeçalhos

Retry-After: integer

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da conta de serviços cognitivos aqui.

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT retornado pelo STS desta região. Adicione o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL do STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Update a web hook

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Erro
ErrorCode	Código de Erro
InnerError	InnerError
Status	Situação
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties
WebHookPropertiesUpdate	WebHookPropertiesUpdate
WebHookUpdate	WebHookUpdate

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
DataImportFailed	Falha na importação de dados.
DeleteNotAllowed	Exclusão não permitida.
DeployNotAllowed	Implantação não permitida.
DeployingFailedModel	Implantação de modelo com falha.
EmptyRequest	Solicitação vazia.
EndpointCannotBeDefault	O ponto de extremidade não pode ser padrão.
EndpointNotUpdatable	Ponto de extremidade não atualizável.
EndpointWithoutLogging	Ponto de extremidade sem registro em log.
ExceededNumberOfRecordingsUris	Número excedido de uris de gravações.
FailedDataset	Conjunto de dados com falha.
Forbidden	Proibido.
InUseViolation	Em violação de uso.
InaccessibleCustomerStorage	Armazenamento de clientes inacessível.
InvalidAdaptationMapping	Mapeamento de adaptação inválido.
InvalidBaseModel	Modelo base inválido.
InvalidCallbackUri	URI de retorno de chamada inválido.
InvalidCollection	Coleção inválida.
InvalidDataset	Conjunto de dados inválido.
InvalidDocument	Documento inválido.
InvalidDocumentBatch	Lote de Documentos Inválido.
InvalidLocale	Localidade inválida.
InvalidLogDate	Data de log inválida.
InvalidLogEndTime	Hora de término do log inválida.
InvalidLogId	ID de log inválida.
InvalidLogStartTime	Hora de início do log inválida.
InvalidModel	Modelo inválido.
InvalidModelUri	URI de modelo inválido.
InvalidParameter	Parâmetro inválido.
InvalidParameterValue	Valor de parâmetro inválido.
InvalidPayload	Conteúdo inválido.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválido.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	URI de gravações inválido.
InvalidRequestBodyFormat	Formato do corpo da solicitação inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InvalidSkipTokenForLogs	Token de ignorar inválido para logs.
InvalidSubscription	Assinatura inválida.
InvalidTest	Teste inválido.
InvalidTimeToLive	Tempo de vida inválido.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidTranscription	Transcrição inválida.
InvalidWebHookEventKind	Tipo de evento de gancho da Web inválido.
MissingInputRecords	Registros de entrada ausentes.
ModelDeploymentNotCompleteState	Implantação de modelo não completa o estado.
ModelDeprecated	Modelo preterido.
ModelExists	O modelo existe.
ModelMismatch	Incompatibilidade de modelo.
ModelNotDeployable	Modelo não implantável.
ModelVersionIncorrect	Versão do modelo incorreta.
NoUtf8WithBom	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	Apenas uma das URLs, contêiner ou conjunto de dados.
ProjectGenderMismatch	Incompatibilidade de gênero do projeto.
QuotaViolation	Violação de cota.
SingleDefaultEndpoint	Ponto de extremidade padrão único.
SkuLimitsExist	Existem limites de SKU.
SubscriptionNotFound	Assinatura não encontrada.
UnexpectedError	Erro inesperado.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
UnsupportedDelta	Delta sem suporte.
UnsupportedDynamicConfiguration	Configuração dinâmica sem suporte.
UnsupportedFilter	Filtro sem suporte.
UnsupportedLanguageCode	Código de idioma sem suporte.
UnsupportedOrderBy	Ordem sem suporte por.
UnsupportedPagination	Paginação sem suporte.
UnsupportedTimeRange	Intervalo de tempo sem suporte.

EntityError

Objeto

EntityError

Nome	Tipo	Description
code	string	O código desse erro.
message	string	A mensagem para este erro.

Error

Objeto

Erro

Nome	Tipo	Description
code	ErrorCode	Código de Erro Códigos de erro de alto nível.
details	Error[]	Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valor de chave), erro interno(isso pode ser aninhado).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seriam "documentos" ou "id de documento" em caso de documento inválido.

ErrorCode

Enumeração

Código de Erro

Valor	Description
Conflict	Representando o código de erro de conflito.
Forbidden	Representando o código de erro proibido.
InternalCommunicationFailed	Representando o código de erro de falha de comunicação interna.
InternalServerError	Representando o código de erro interno do servidor.
InvalidArgument	Representando o código de erro de argumento inválido.
InvalidRequest	Representando o código de erro de solicitação inválido.
NotAllowed	Representando o código de erro não permitido.
NotFound	Representando o código de erro não encontrado.
PipelineError	Representando o código de erro do pipeline.
ServiceUnavailable	Representando o código de erro indisponível do serviço.
TooManyRequests	Representando o código de erro de muitas solicitações.
Unauthorized	Representando o código de erro não autorizado.
UnprocessableEntity	Representando o código de erro de entidade não processável.
UnsupportedMediaType	Representando o código de erro de tipo de mídia sem suporte.

InnerError

Objeto

InnerError

Nome	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enumeração detalhada do código de erro.
details	object	Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valor de chave), erro interno(isso pode ser aninhado).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seriam "documentos" ou "id de documento" em caso de documento inválido.

Status

Enumeração

Situação

Valor	Description
Failed	A operação de execução prolongada falhou.
NotStarted	A operação de execução prolongada ainda não foi iniciada.
Running	A operação de execução longa está sendo processada no momento.
Succeeded	A operação de execução longa foi concluída com êxito.

WebHook

Objeto

WebHook

Nome	Tipo	Description
createdDateTime	string (date-time)	O carimbo de data/hora quando o objeto foi criado. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	As propriedades personalizadas dessa entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo de valor permitido é de 256 caracteres e a contagem de entradas permitidas é 10.
description	string	A descrição do objeto.
displayName	string	O nome de exibição do objeto.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string (date-time)	O carimbo de data/hora quando o status atual foi inserido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string (uri)	O local dessa entidade.
status	Status	Situação Descrever o estado atual da API
webUrl	string (uri)	A URL registrada que será usada para enviar as solicitações POST para os eventos registrados.

WebHookEvents

Objeto

WebHookEvents

Nome	Tipo	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

Objeto

WebHookLinks

Nome	Tipo	Description
ping	string (uri)	A URL que pode ser usada para disparar o envio de um evento de ping para a URL registrada de um registro de web hook.
test	string (uri)	A URL que pode ser usada enviando eventos de teste para a URL registrada de um registro de web hook.

WebHookProperties

Objeto

WebHookProperties

Nome	Tipo	Description
apiVersion	string	A versão da API na qual o web hook foi criado. Isso define a forma da carga nos retornos de chamada. Se o tipo de conteúdo não tiver mais suporte, porque a forma foi alterada e a versão da API que o usa é removida (após a substituição), o gancho da Web será desabilitado.
error	EntityError	EntityError
secret	string	Um segredo que será usado para criar um hash SHA256 do conteúdo com o segredo como chave HMAC. Esse hash será definido como cabeçalho X-MicrosoftSpeechServices-Signature ao chamar novamente para a URL registrada.

WebHookPropertiesUpdate

Objeto

WebHookPropertiesUpdate

Nome	Tipo	Description
secret	string	Um segredo que será usado para criar um hash SHA256 do conteúdo com o segredo como chave HMAC. Esse hash será definido como cabeçalho X-MicrosoftSpeechServices-Signature ao chamar novamente para a URL registrada.

WebHookUpdate

Objeto

WebHookUpdate

Nome	Tipo	Description
customProperties	object	As propriedades personalizadas dessa entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo de valor permitido é de 256 caracteres e a contagem de entradas permitidas é 10.
description	string	A descrição do objeto.
displayName	string	O nome do objeto.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	A URL registrada que será usada para enviar as solicitações POST para os eventos registrados.

Compartilhar via

Update Hook - Update Hook

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Update a web hook

Solicitação de exemplo

Resposta de exemplo

Definições

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate