Web Hooks - Create

Referência

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

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

Depois de registrar com sucesso o gancho da web, 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 sucesso, o gancho da Web começará a receber eventos.

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

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

Corpo do Pedido

Name	Necessário	Tipo	Description
displayName	True	string minLength: 1	O nome para exibição do objeto.
events	True	WebHookEvents	WebHookEventos
webUrl	True	string (uri)	O URL registado que será utilizado para enviar os pedidos POST para os eventos registados.
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.
properties		WebHookProperties	WebHookPropriedades

Respostas

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

Name

Tipo

Description

201 Created

WebHook

A resposta contém informações sobre a entidade como carga útil 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 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

Create a web hook

Pedido de amostra

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

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

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

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
DataImportFailed	Falha na importação de dados.
DeleteNotAllowed	Excluir não permitido.
DeployNotAllowed	Implantação não permitida.
DeployingFailedModel	Implantação de modelo com falha.
EmptyRequest	Pedido vazio.
EndpointCannotBeDefault	O ponto de extremidade não pode ser padrão.
EndpointNotUpdatable	Ponto final não atualizável.
EndpointWithoutLogging	Ponto de extremidade sem registro.
ExceededNumberOfRecordingsUris	Excedeu o número de gravações uris.
FailedDataset	Conjunto de dados com falha.
Forbidden	Proibido.
InUseViolation	Violação em uso.
InaccessibleCustomerStorage	Armazenamento inacessível do cliente.
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 registo inválida.
InvalidLogEndTime	Hora de fim de log inválida.
InvalidLogId	ID de log inválido.
InvalidLogStartTime	Hora de início de 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	Carga útil inválida.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	Gravações inválidas uri.
InvalidRequestBodyFormat	Formato de corpo de solicitação inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InvalidSkipTokenForLogs	Token de pulo inválido para logs.
InvalidSourceAzureResourceId	ID de recurso do Azure de origem inválida.
InvalidSubscription	Subscrição 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.
ModelCopyOperationExists	A operação de cópia do modelo existe.
ModelDeploymentNotCompleteState	Implantação do modelo não concluída estado.
ModelDeprecated	Modelo preterido.
ModelExists	Modelo existe.
ModelMismatch	Incompatibilidade de modelos.
ModelNotDeployable	Modelo não implantável.
ModelVersionIncorrect	Versão do modelo incorreta.
NoUtf8WithBom	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	Apenas um dos urls ou contêiner ou conjunto de dados.
ProjectGenderMismatch	Desfasamento entre homens e mulheres no projeto.
QuotaViolation	Violação de quotas.
SingleDefaultEndpoint	Ponto de extremidade padrão único.
SkuLimitsExist	Existem limites de Sku.
SubscriptionNotFound	Subscrição não encontrada.
UnexpectedError	Erro inesperado.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
UnsupportedDelta	Delta não suportado.
UnsupportedDynamicConfiguration	Configuração dinâmica não suportada.
UnsupportedFilter	Filtro não suportado.
UnsupportedLanguageCode	Código de idioma não suportado.
UnsupportedOrderBy	Ordem não suportada por.
UnsupportedPagination	Paginação não suportada.
UnsupportedTimeRange	Intervalo de tempo não suportado.

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
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álida.
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 não suportado.

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

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 minLength: 1	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. 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 gancho da Web. Consulte a operação "WebHooks_Test" para obter mais detalhes.

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.

Partilhar via

Web Hooks - Create

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Create a web hook

Pedido de amostra

Resposta da amostra

Definições

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties