Update Hook - Update Hook

Serviço:: Azure AI Services

Versão da API:: v3.0

Atualiza o gancho da Web identificado pelo ID fornecido.
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 X-MicrosoftSpeechServices-Signature. Se a propriedade contiver uma cadeia de caracteres não vazia, ela será usada para criar um hash SHA256 da carga útil com o segredo como chave HMAC. Esse hash será definido como cabeçalho X-MicrosoftSpeechServices-Signature ao chamar de volta para a URL registrada.

Se o URL mudar, o gancho da Web 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 sucesso, o gancho da Web começará a receber eventos.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	O identificador do gancho da web.

Corpo do Pedido

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

Name	Tipo	Description
customProperties	object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres e a contagem de entradas permitidas é de 10.
description	string	A descrição do objeto.
displayName	string	O nome do objeto.
events	WebHookEvents	WebHookEventos
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	O URL registado que será utilizado para enviar os pedidos POST para os eventos registados.

Respostas

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

Name

Tipo

Description

200 OK

WebHook

Cabeçalhos

Retry-After: integer

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da sua 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. Certifique-se de adicionar o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Update a web hook

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Erro
ErrorCode	Código de erro
InnerError	InnerError
Status	Situação
WebHook	Gancho WebHook
WebHookEvents	WebHookEventos
WebHookLinks	WebHookLinks
WebHookProperties	WebHookPropriedades
WebHookPropertiesUpdate	WebHookPropertiesUpdate
WebHookUpdate	WebHookUpdate

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
InvalidParameterValue	Valor de parâmetro inválido.
InvalidRequestBodyFormat	Formato de corpo de solicitação inválido.
EmptyRequest	Pedido vazio.
MissingInputRecords	Registros de entrada ausentes.
InvalidDocument	Documento inválido.
ModelVersionIncorrect	Versão do modelo incorreta.
InvalidDocumentBatch	Lote de documentos inválido.
UnsupportedLanguageCode	Código de idioma não suportado.
DataImportFailed	Falha na importação de dados.
InUseViolation	Violação em uso.
InvalidLocale	Localidade inválida.
InvalidBaseModel	Modelo base inválido.
InvalidAdaptationMapping	Mapeamento de adaptação inválido.
InvalidDataset	Conjunto de dados inválido.
InvalidTest	Teste inválido.
FailedDataset	Conjunto de dados com falha.
InvalidModel	Modelo inválido.
InvalidTranscription	Transcrição inválida.
InvalidPayload	Carga útil inválida.
InvalidParameter	Parâmetro inválido.
EndpointWithoutLogging	Ponto de extremidade sem registro.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválida.
InvalidSubscription	Subscrição inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	Gravações inválidas uri.
OnlyOneOfUrlsOrContainerOrDataset	Apenas um dos urls ou contêiner ou conjunto de dados.
ExceededNumberOfRecordingsUris	Excedeu o número de gravações uris.
ModelMismatch	Incompatibilidade de modelos.
ProjectGenderMismatch	Desfasamento entre homens e mulheres no projeto.
ModelDeprecated	Modelo preterido.
ModelExists	Modelo existe.
ModelNotDeployable	Modelo não implantável.
EndpointNotUpdatable	Ponto final não atualizável.
SingleDefaultEndpoint	Ponto de extremidade padrão único.
EndpointCannotBeDefault	O ponto de extremidade não pode ser padrão.
InvalidModelUri	Uri de modelo inválido.
SubscriptionNotFound	Subscrição não encontrada.
QuotaViolation	Violação de quotas.
UnsupportedDelta	Delta não suportado.
UnsupportedFilter	Filtro não suportado.
UnsupportedPagination	Paginação não suportada.
UnsupportedDynamicConfiguration	Configuração dinâmica não suportada.
UnsupportedOrderBy	Ordem não suportada por.
NoUtf8WithBom	Não utf8 com bom.
ModelDeploymentNotCompleteState	Implantação do modelo não concluída estado.
SkuLimitsExist	Existem limites de Sku.
DeployingFailedModel	Implantação de modelo com falha.
UnsupportedTimeRange	Intervalo de tempo não suportado.
InvalidLogDate	Data de registo inválida.
InvalidLogId	ID de log inválido.
InvalidLogStartTime	Hora de início de log inválida.
InvalidLogEndTime	Hora de fim de log inválida.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidSkipTokenForLogs	Token de pulo inválido para logs.
DeleteNotAllowed	Excluir não permitido.
Forbidden	Proibido.
DeployNotAllowed	Implantação não permitida.
UnexpectedError	Erro inesperado.
InvalidCollection	Coleção inválida.
InvalidCallbackUri	Uri de retorno de chamada inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InaccessibleCustomerStorage	Armazenamento inacessível do cliente.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
InvalidWebHookEventKind	Tipo de evento de gancho da Web inválido.
InvalidTimeToLive	Tempo de vida inválido.

EntityError

Object

EntityError

Name	Tipo	Description
code	string	O código deste erro.
message	string	A mensagem para este erro.

Error

Object

Erro

Name	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 políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de 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, mensagem e destino de propriedades opcionais, detalhes (par de valores 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, seria "documentos" ou "id do documento" no caso de documento inválido.

ErrorCode

Enumeração

Código de erro

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

InnerError

Object

InnerError

Name	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Código de erro detalhado enum.
details	object	Detalhes adicionais de suporte sobre o erro e/ou políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de 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, mensagem e destino de propriedades opcionais, detalhes (par de valores 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, seria "documentos" ou "id do documento" no caso de documento inválido.

Status

Enumeração

Situação

Valor	Description
NotStarted	A operação de longa duração ainda não começou.
Running	A operação de longa duração está atualmente em processamento.
Succeeded	A operação de longa duração foi concluída com êxito.
Failed	A operação de longa duração falhou.

WebHook

Object

Gancho WebHook

Name	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 ("AAAA-MM-DDThh:mm:ssZ", ver https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres e a contagem de entradas permitidas é de 10.
description	string	A descrição do objeto.
displayName	string	O nome para exibição do objeto.
events	WebHookEvents	WebHookEventos
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 ("AAAA-MM-DDThh:mm:ssZ", ver https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookPropriedades
self	string (uri)	A localização desta entidade.
status	Status	Situação Descrever o estado atual da API
webUrl	string (uri)	O URL registado que será utilizado para enviar os pedidos POST para os eventos registados.

WebHookEvents

Object

WebHookEventos

Name	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

Object

WebHookLinks

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

WebHookProperties

Object

WebHookPropriedades

Name	Tipo	Description
apiVersion	string	A versão da API na qual o gancho da Web foi criado. Isso define a forma da carga útil nos retornos de chamada. Se o tipo de carga não for mais suportado, porque a forma foi alterada e a versão da API que a utiliza foi removida (após a descontinuação), o gancho da Web será desativado.
error	EntityError	EntityError
secret	string	Um segredo que será usado para criar um hash SHA256 da carga útil com o segredo como chave HMAC. Esse hash será definido como cabeçalho X-MicrosoftSpeechServices-Signature ao chamar de volta para a URL registrada.

WebHookPropertiesUpdate

Object

WebHookPropertiesUpdate

Name	Tipo	Description
secret	string	Um segredo que será usado para criar um hash SHA256 da carga útil com o segredo como chave HMAC. Esse hash será definido como cabeçalho X-MicrosoftSpeechServices-Signature ao chamar de volta para a URL registrada.

WebHookUpdate

Object

WebHookUpdate

Name	Tipo	Description
customProperties	object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres e a contagem de entradas permitidas é de 10.
description	string	A descrição do objeto.
displayName	string	O nome do objeto.
events	WebHookEvents	WebHookEventos
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	O URL registado que será utilizado para enviar os pedidos POST para os eventos registados.

Partilhar via

Update Hook - Update Hook

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Update a web hook

Pedido de amostra

Resposta da amostra

Definições

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate