Compartir a través de

Web Hooks - Get

  • Referencia
Servicio:
Azure AI Services
Versión de la API:
v3.2-preview.2

Obtiene el webhook identificado por el identificador especificado.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string

Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus.api.cognitive.microsoft.com).
id
 path True

string (uuid)

Identificador del webhook.

Respuestas

Nombre Tipo Description
200 OK

WebHook

De acuerdo

Encabezados

Retry-After: integer
Other Status Codes

Error

Se ha producido un error.

Seguridad

Ocp-Apim-Subscription-Key

Proporcione aquí la clave de la cuenta de Cognitive Services.

Tipo: apiKey
En: header

Authorization

Proporcione un token de acceso del JWT devuelto por el STS de esta región. Asegúrese de agregar el ámbito de administración al token agregando la siguiente cadena de consulta a la dirección URL de STS: ?scope=speechservicesmanagement

Tipo: apiKey
En: header

Ejemplos

Get a web hook

Solicitud de ejemplo

GET {endpoint}/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d

Respuesta de muestra

status code:
200 
{
  "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": "Succeeded"
}

Definiciones

Nombre Description
DetailedErrorCode

DetailedErrorCode
EntityError

EntityError
Error

Error
ErrorCode

ErrorCode
InnerError

InnerError
Status

Estado
WebHook

WebHook
WebHookEvents

WebHookEvents
WebHookLinks

WebHookLinks
WebHookProperties

WebHookProperties

DetailedErrorCode

Enumeración

DetailedErrorCode

Valor Description
DataImportFailed

Error en la importación de datos.
DeleteNotAllowed

Eliminar no permitido.
DeployNotAllowed

No se permite la implementación.
DeployingFailedModel

Se ha producido un error en la implementación del modelo.
EmptyRequest

Solicitud vacía.
EndpointCannotBeDefault

El punto de conexión no puede ser predeterminado.
EndpointNotUpdatable

Punto de conexión no actualizable.
EndpointWithoutLogging

Punto de conexión sin registro.
ExceededNumberOfRecordingsUris

Se superó el número de uris de grabaciones.
FailedDataset

Conjunto de datos con errores.
Forbidden

Prohibido.
InUseViolation

En infracción de uso.
InaccessibleCustomerStorage

Almacenamiento de clientes inaccesible.
InvalidAdaptationMapping

Asignación de adaptación no válida.
InvalidBaseModel

Modelo base no válido.
InvalidCallbackUri

URI de devolución de llamada no válido.
InvalidCollection

Colección no válida.
InvalidDataset

Conjunto de datos no válido.
InvalidDocument

Documento no válido.
InvalidDocumentBatch

Lote de documentos no válido.
InvalidLocale

Configuración regional no válida.
InvalidLogDate

Fecha de registro no válida.
InvalidLogEndTime

Hora de finalización del registro no válida.
InvalidLogId

Identificador de registro no válido.
InvalidLogStartTime

Hora de inicio del registro no válida.
InvalidModel

Modelo no válido.
InvalidModelUri

URI de modelo no válido.
InvalidParameter

Parámetro no válido.
InvalidParameterValue

Valor de parámetro no válido.
InvalidPayload

Carga no válida.
InvalidPermissions

Permisos no válidos.
InvalidPrerequisite

Requisito previo no válido.
InvalidProductId

Identificador de producto no válido.
InvalidProject

Proyecto no válido.
InvalidProjectKind

Tipo de proyecto no válido.
InvalidRecordingsUri

URI de grabaciones no válidos.
InvalidRequestBodyFormat

Formato de cuerpo de la solicitud no válido.
InvalidSasValidityDuration

Duración de validez de sas no válida.
InvalidSkipTokenForLogs

Token de omisión no válido para los registros.
InvalidSourceAzureResourceId

Identificador de recurso de Azure de origen no válido.
InvalidSubscription

Suscripción no válida.
InvalidTest

Prueba no válida.
InvalidTimeToLive

Tiempo de vida no válido.
InvalidTopForLogs

Top no válido para los registros.
InvalidTranscription

Transcripción no válida.
InvalidWebHookEventKind

Tipo de evento web hook no válido.
MissingInputRecords

Faltan registros de entrada.
ModelCopyOperationExists

Existe una operación de copia del modelo.
ModelDeploymentNotCompleteState

La implementación del modelo no está completa.
ModelDeprecated

Modelo en desuso.
ModelExists

El modelo existe.
ModelMismatch

Error de coincidencia del modelo.
ModelNotDeployable

El modelo no se puede implementar.
ModelVersionIncorrect

Versión del modelo incorrecta.
NoUtf8WithBom

No hay utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset

Solo una de direcciones URL o contenedor o conjunto de datos.
ProjectGenderMismatch

No coinciden los géneros del proyecto.
QuotaViolation

Infracción de cuota.
SingleDefaultEndpoint

Punto de conexión predeterminado único.
SkuLimitsExist

Existen límites de SKU.
SubscriptionNotFound

No se encontró la suscripción.
UnexpectedError

Error inesperado.
UnsupportedClassBasedAdaptation

Adaptación basada en clases no admitidas.
UnsupportedDelta

Delta no admitido.
UnsupportedDynamicConfiguration

Configuración dinámica no admitida.
UnsupportedFilter

Filtro no admitido.
UnsupportedLanguageCode

Código de lenguaje no admitido.
UnsupportedOrderBy

Orden no admitido por.
UnsupportedPagination

Paginación no admitida.
UnsupportedTimeRange

Intervalo de tiempo no admitido.

EntityError

Object

EntityError

Nombre Tipo Description
code

string

Código de este error.
message

string

Mensaje para este error.

Error

Object

Error

Nombre Tipo Description
code

ErrorCode

ErrorCode
Códigos de error de alto nivel.
details

Error[]

Detalles de apoyo adicionales relacionados con el error o las directivas esperadas.
innerError

InnerError

InnerError
Nuevo formato de error interno que se ajusta a las directrices de Cognitive Services API que están disponibles en https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene las propiedades necesarias ErrorCode, message y propiedades opcionales de destino, details(key value pair), inner error(this can be nested).
message

string

Mensaje de error de alto nivel.
target

string

Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en caso de documento no válido.

ErrorCode

Enumeración

ErrorCode

Valor Description
Conflict

Representa el código de error en conflicto.
Forbidden

Representa el código de error prohibido.
InternalCommunicationFailed

Representa el código de error de comunicación interna con error.
InternalServerError

Representa el código de error interno del servidor.
InvalidArgument

Representa el código de error de argumento no válido.
InvalidRequest

Representa el código de error de solicitud no válido.
NotAllowed

Representa el código de error no permitido.
NotFound

Representa el código de error no encontrado.
PipelineError

Representa el código de error de canalización.
ServiceUnavailable

Representa el código de error del servicio no disponible.
TooManyRequests

Representa el código de error de demasiadas solicitudes.
Unauthorized

Representa el código de error no autorizado.
UnprocessableEntity

Representa el código de error de entidad no procesado.
UnsupportedMediaType

Representa el código de error de tipo de medio no admitido.

InnerError

Object

InnerError

Nombre Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enumeración detallada del código de error.
details

object

Detalles de apoyo adicionales relacionados con el error o las directivas esperadas.
innerError

InnerError

InnerError
Nuevo formato de error interno que se ajusta a las directrices de Cognitive Services API que están disponibles en https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene las propiedades necesarias ErrorCode, message y propiedades opcionales de destino, details(key value pair), inner error(this can be nested).
message

string

Mensaje de error de alto nivel.
target

string

Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en caso de documento no válido.

Status

Enumeración

Estado

Valor Description
Failed

Error en la operación de larga duración.
NotStarted

La operación de larga duración aún no se ha iniciado.
Running

La operación de larga duración se está procesando actualmente.
Succeeded

La operación de larga duración se ha completado correctamente.

WebHook

Object

WebHook

Nombre Tipo Description
createdDateTime

string (date-time)

Marca de tiempo cuando se creó el objeto. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", vea https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

Propiedades personalizadas de esta entidad. La longitud máxima de clave permitida es de 64 caracteres, la longitud máxima permitida del valor es de 256 caracteres y el recuento de entradas permitidas es de 10.
description

string

Descripción del objeto.
displayName

string

minLength: 1

Nombre para mostrar del objeto.
events

WebHookEvents

WebHookEvents
lastActionDateTime

string (date-time)

Marca de tiempo cuando se especificó el estado actual. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", vea https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links

WebHookLinks

WebHookLinks
properties

WebHookProperties

WebHookProperties
self

string (uri)

Ubicación de esta entidad.
status

Status

Estado
Describir el estado actual de la API
webUrl

string (uri)

Dirección URL registrada que se usará para enviar las solicitudes POST a los eventos registrados.

WebHookEvents

Object

WebHookEvents

Nombre 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

Object

WebHookLinks

Nombre Tipo Description
ping

string (uri)

Dirección URL que se puede usar para desencadenar el envío de un evento ping a la dirección URL registrada de un registro de web hook. Consulte la operación "WebHooks_Ping" para obtener más información.
test

string (uri)

Dirección URL que se puede usar para enviar eventos de prueba a la dirección URL registrada de un registro de webhook. Consulte la operación "WebHooks_Test" para obtener más información.

WebHookProperties

Object

WebHookProperties

Nombre Tipo Description
apiVersion

string

La versión de API en la que se creó el webhook. Esto define la forma de la carga útil en las devoluciones de llamada. Si ya no se admite el tipo de carga, ya que la forma ha cambiado y la versión de la API que lo usa se quita (después del desuso), el webhook se deshabilitará.
error

EntityError

EntityError
secret

string

Secreto que se usará para crear un hash SHA256 de la carga con el secreto como clave HMAC. Este hash se establecerá como encabezado X-MicrosoftSpeechServices-Signature al volver a llamar a la dirección URL registrada.