Web Hooks - Create

Serviço:: Azure AI Services

Versão da API:: v3.2-preview.2

Cria um novo gancho da Web.
Se o segredo da propriedade na configuração estiver presente e contiver uma cadeia de caracteres não vazia, ele 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.

Ao chamar de volta para a URL registrada, a solicitação conterá um cabeçalho X-MicrosoftSpeechServices-Event que contém um dos tipos de evento registrados. Haverá uma solicitação por tipo de evento registrado.

Depois de registrar com êxito o web hook, ele não será utilizável 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.

POST {endpoint}/speechtotext/v3.2-preview.2/webhooks

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).

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
displayName	True	string minLength: 1	O nome de exibição do objeto.
events	True	WebHookEvents	WebHookEvents
webUrl	True	string (uri)	A URL registrada que será usada para enviar as solicitações POST para os eventos registrados.
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.
properties		WebHookProperties	WebHookProperties

Respostas

Nome	Tipo	Description
201 Created	WebHook	A resposta contém informações sobre a entidade como conteúdo e sua localização como cabeçalho. Cabeçalhos Location: string
Other Status Codes	Error	Ocorreu um erro.

Nome

Tipo

Description

201 Created

WebHook

A resposta contém informações sobre a entidade como conteúdo e sua localização como cabeçalho.

Cabeçalhos

Location: string

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

Create a web hook

Solicitação de exemplo

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/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."
}

Resposta de exemplo

Código de status:: 201

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

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

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

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
InvalidParameterValue	Valor de parâmetro inválido.
InvalidRequestBodyFormat	Formato do corpo da solicitação inválido.
EmptyRequest	Solicitação vazia.
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 sem suporte.
DataImportFailed	Falha na importação de dados.
InUseViolation	Em violação de 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	Conteúdo inválido.
InvalidParameter	Parâmetro inválido.
EndpointWithoutLogging	Ponto de extremidade sem registro em log.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválido.
InvalidSubscription	Assinatura inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	URI de gravações inválido.
OnlyOneOfUrlsOrContainerOrDataset	Apenas uma das URLs, contêiner ou conjunto de dados.
ExceededNumberOfRecordingsUris	Número excedido de uris de gravações.
ModelMismatch	Incompatibilidade de modelo.
ProjectGenderMismatch	Incompatibilidade de gênero do projeto.
ModelDeprecated	Modelo preterido.
ModelExists	O modelo existe.
ModelNotDeployable	Modelo não implantável.
EndpointNotUpdatable	Ponto de extremidade 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	Assinatura não encontrada.
QuotaViolation	Violação de cota.
UnsupportedDelta	Delta sem suporte.
UnsupportedFilter	Filtro sem suporte.
UnsupportedPagination	Paginação sem suporte.
UnsupportedDynamicConfiguration	Configuração dinâmica sem suporte.
UnsupportedOrderBy	Ordem sem suporte por.
NoUtf8WithBom	Não utf8 com bom.
ModelDeploymentNotCompleteState	Implantação de modelo não completa o estado.
SkuLimitsExist	Existem limites de SKU.
DeployingFailedModel	Implantação de modelo com falha.
UnsupportedTimeRange	Intervalo de tempo sem suporte.
InvalidLogDate	Data de log inválida.
InvalidLogId	ID de log inválida.
InvalidLogStartTime	Hora de início do log inválida.
InvalidLogEndTime	Hora de término do log inválida.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidSkipTokenForLogs	Token de ignorar inválido para logs.
DeleteNotAllowed	Exclusão não permitida.
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 de clientes inacessível.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
InvalidWebHookEventKind	Tipo de evento de gancho da Web inválido.
InvalidTimeToLive	Tempo de vida inválido.
InvalidSourceAzureResourceId	ID de recurso do Azure de origem inválida.
ModelCopyOperationExists	A operação de cópia de modelo existe.

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
InvalidRequest	Representando o código de erro de solicitação inválido.
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 sem suporte.
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

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
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.
Failed	A operação de execução prolongada falhou.

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 minLength: 1	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. Consulte a operação "WebHooks_Ping" para obter mais detalhes.
test	string (uri)	A URL que pode ser usada enviando eventos de teste para a URL registrada de um registro de web hook. Consulte a operação "WebHooks_Test" para obter mais detalhes.

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.