Web Hooks - List

Referência

Serviço:: Azure AI Services

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

Obtém a lista de ganchos da Web para a assinatura autenticada.

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

Com parâmetros opcionais:

GET {endpoint}/speechtotext/v3.2-preview.2/webhooks?skip={skip}&top={top}&filter={filter}

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).
filter	query		string	Uma expressão de filtragem para selecionar um subconjunto dos ganchos disponíveis. `Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and webUrl. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=displayName eq 'test'`
skip	query		integer int32	Número de conjuntos de dados que serão ignorados.
top	query		integer int32	Número de conjuntos de dados que serão incluídos após ignorar.

Respostas

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

Nome

Tipo

Description

200 OK

PaginatedWebHooks

Cabeçalhos

Retry-After: integer

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

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

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT retornado pelo STS dessa 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

Get all web hooks

Get all web hooks created in 03/2020 ordered by their name

Get all web hooks

Solicitação de exemplo

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/webhooks?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Resposta de exemplo

Código de status:: 200

{
  "values": [
    {
      "displayName": "TranscriptionCompletionWebHook",
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/aff13a6e-17c4-4247-862f-70e99469c553",
      "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": "2019-02-11T00:00:00Z",
      "lastActionDateTime": "2019-02-28T00:00:00Z",
      "status": "Succeeded"
    },
    {
      "displayName": "TranscriptionCompletionWebHook",
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37",
      "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": "Succeeded"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Get all web hooks created in 03/2020 ordered by their name

Solicitação de exemplo

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/webhooks?skip=0&top=2&filter=createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z

Resposta de exemplo

Código de status:: 200

{
  "values": [
    {
      "displayName": "A test web hook",
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/aff13a6e-17c4-4247-862f-70e99469c553",
      "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": "2020-03-11T14:13:12Z",
      "lastActionDateTime": "2020-03-11T14:13:12Z",
      "status": "Succeeded"
    },
    {
      "displayName": "Beta version web hook",
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37",
      "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": "2020-03-21T09:07:43Z",
      "lastActionDateTime": "2020-03-21T09:07:43Z",
      "status": "Succeeded"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z"
}

Definições

Nome	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Erro
ErrorCode	ErrorCode
InnerError	InnerError
PaginatedWebHooks	PaginatedWebHooks
Status	Status
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties

DetailedErrorCode

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

EntityError

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

Error

Erro

Nome	Tipo	Description
code	ErrorCode	ErrorCode 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. Ele contém as propriedades obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e inner error (pode ser aninhada).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido.

ErrorCode

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

InnerError

Nome	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enumeração de código de erro detalhada.
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. Ele contém as propriedades obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e inner error (pode ser aninhada).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido.

PaginatedWebHooks

Nome	Tipo	Description
@nextLink	string	Um link para o próximo conjunto de resultados paginados se houver mais entidades disponíveis; caso contrário, nulo.
values	WebHook[]	Uma lista de entidades limitada pelos parâmetros de consulta passados 'skip' e 'top' ou seus valores padrão. Ao iterar por meio de uma lista usando paginação e excluir entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendável criar uma lista no cliente e excluir após a busca da lista completa.

Nome

Tipo

Description

@nextLink

string

Um link para o próximo conjunto de resultados paginados se houver mais entidades disponíveis; caso contrário, nulo.

values

WebHook[]

Uma lista de entidades limitada pelos parâmetros de consulta passados 'skip' e 'top' ou seus valores padrão.

Ao iterar por meio de uma lista usando paginação e excluir entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendável criar uma lista no cliente e excluir após a busca da lista completa.

Status

Nome	Tipo	Description
Failed	string	Falha na operação de execução prolongada.
NotStarted	string	A operação de execução prolongada ainda não foi iniciada.
Running	string	A operação de execução prolongada está sendo processada no momento.
Succeeded	string	A operação de execução prolongada foi concluída com êxito.

WebHook

Nome	Tipo	Description
createdDateTime	string	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 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	WebHookEvents
lastActionDateTime	string	O carimbo de data/hora em que a status atual foi inserida. 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	O local dessa entidade.
status	Status	Status Descrever o estado atual da API
webUrl	string	A URL registrada que será usada para enviar as solicitações POST para os eventos registrados.

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

Nome	Tipo	Description
ping	string	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. Confira a operação "WebHooks_Ping" para obter mais detalhes.
test	string	A URL que pode ser usada enviando eventos de teste para a URL registrada de um registro de web hook. Confira a operação "WebHooks_Test" para obter mais detalhes.

WebHookProperties

Nome	Tipo	Description
apiVersion	string	A versão da API na qual o gancho da Web 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 de volta para a URL registrada.

Compartilhar via

Web Hooks - List

Parâmetros de URI

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Get all web hooks

Solicitação de exemplo

Resposta de exemplo

Get all web hooks created in 03/2020 ordered by their name

Solicitação de exemplo

Resposta de exemplo

Definições

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

PaginatedWebHooks

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

Recursos adicionais