Web Hooks - Get

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2024-11-15

Obtiene el webhook identificado por el identificador especificado.

GET {endpoint}/speechtotext/webhooks/{id}?api-version=2024-11-15

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.
api-version	query	True	string	Versión de api solicitada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Proporcione aquí la clave de la cuenta de Cognitive Services.

Respuestas

Nombre	Tipo	Description
200 OK	WebHook	De acuerdo Encabezados Retry-After: integer
Other Status Codes	Error	Error.

Nombre

Tipo

Description

200 OK

WebHook

De acuerdo

Encabezados

Retry-After: integer

Other Status Codes

Error

Error.

Seguridad

Ocp-Apim-Subscription-Key

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

Tipo: apiKey
En: header

Ejemplos

Get a web hook

Solicitud de ejemplo

HTTP

GET {endpoint}/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-11-15

Respuesta de muestra

status code:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-11-15",
  "displayName": "TranscriptionCompletionWebHook",
  "description": "I registered this URL to get a POST request for each completed transcription.",
  "properties": {
    "apiVersion": "2024-11-15",
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "createdDateTime": "2018-11-11T00:00:00Z",
  "lastActionDateTime": "2018-11-28T00:00:00Z",
  "status": "Succeeded",
  "links": {
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-11-15",
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-11-15"
  }
}

Definiciones

Nombre	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Error
ErrorCode	ErrorCode
InnerError	InnerError
Status	Estado
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties

DetailedErrorCode

Nombre	Tipo	Description
AudioLengthLimitExceeded	string	El archivo de audio es mayor que la duración máxima permitida.
BadChannelConfiguration	string	Hay una discrepancia entre los canales de audio de los datos, en la configuración o los requisitos de la aplicación.
DataImportFailed	string	Error en la importación de datos.
DeleteNotAllowed	string	Eliminar no permitido.
DeployNotAllowed	string	No se permite la implementación.
DeployingFailedModel	string	Se ha producido un error en la implementación del modelo.
EmptyAudioFile	string	El archivo de audio está vacío.
EmptyRequest	string	Solicitud vacía.
EndpointCannotBeDefault	string	El punto de conexión no puede ser predeterminado.
EndpointLoggingNotSupported	string	No se admite el registro de puntos de conexión.
EndpointNotUpdatable	string	Punto de conexión no actualizable.
EndpointWithoutLogging	string	Punto de conexión sin registro.
ExceededNumberOfRecordingsUris	string	Se superó el número de uris de grabaciones.
FailedDataset	string	Conjunto de datos con errores.
Forbidden	string	Prohibido.
InUseViolation	string	En infracción de uso.
InaccessibleCustomerStorage	string	Almacenamiento de clientes inaccesible.
InvalidAdaptationMapping	string	Asignación de adaptación no válida.
InvalidAudioFormat	string	No se admite el formato de audio de entrada.
InvalidBaseModel	string	Modelo base no válido.
InvalidCallbackUri	string	URI de devolución de llamada no válido.
InvalidChannelSpecification	string	No se admite la selección de canales en la solicitud de transcripción (por ejemplo, no se han seleccionado 0 ni 1).
InvalidChannels	string	Canales no válidos.
InvalidCollection	string	Colección no válida.
InvalidDataset	string	Conjunto de datos no válido.
InvalidDocument	string	Documento no válido.
InvalidDocumentBatch	string	Lote de documentos no válido.
InvalidLocale	string	Configuración regional no válida.
InvalidLogDate	string	Fecha de registro no válida.
InvalidLogEndTime	string	Hora de finalización del registro no válida.
InvalidLogId	string	Identificador de registro no válido.
InvalidLogStartTime	string	Hora de inicio del registro no válida.
InvalidModel	string	Modelo no válido.
InvalidModelUri	string	URI de modelo no válido.
InvalidParameter	string	Parámetro no válido.
InvalidParameterValue	string	Valor de parámetro no válido.
InvalidPayload	string	Carga no válida.
InvalidPermissions	string	Permisos no válidos.
InvalidPrerequisite	string	Requisito previo no válido.
InvalidProductId	string	Identificador de producto no válido.
InvalidProject	string	Proyecto no válido.
InvalidProjectKind	string	Tipo de proyecto no válido.
InvalidRecordingsUri	string	URI de grabaciones no válidos.
InvalidRequestBodyFormat	string	Formato de cuerpo de la solicitud no válido.
InvalidSasValidityDuration	string	Duración de validez de sas no válida.
InvalidSkipTokenForLogs	string	Token de omisión no válido para los registros.
InvalidSourceAzureResourceId	string	Identificador de recurso de Azure de origen no válido.
InvalidSubscription	string	Suscripción no válida.
InvalidTest	string	Prueba no válida.
InvalidTimeToLive	string	Tiempo de vida no válido.
InvalidTopForLogs	string	Top no válido para los registros.
InvalidTranscription	string	Transcripción no válida.
InvalidWebHookEventKind	string	Tipo de evento web hook no válido.
MissingInputRecords	string	Faltan registros de entrada.
ModelCopyAuthorizationExpired	string	ModelCopyAuthorization expirado.
ModelDeploymentNotCompleteState	string	La implementación del modelo no está completa.
ModelDeprecated	string	Modelo en desuso.
ModelExists	string	El modelo existe.
ModelMismatch	string	Error de coincidencia del modelo.
ModelNotDeployable	string	El modelo no se puede implementar.
ModelVersionIncorrect	string	Versión del modelo incorrecta.
MultipleLanguagesIdentified	string	Identificación del idioma reconocido varios idiomas. No se puede determinar ningún idioma dominante.
NoLanguageIdentified	string	La identificación del idioma no reconoció ningún idioma.
NoUtf8WithBom	string	No hay utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Solo una de direcciones URL o contenedor o conjunto de datos.
ProjectGenderMismatch	string	No coinciden los géneros del proyecto.
QuotaViolation	string	Infracción de cuota.
SingleDefaultEndpoint	string	Punto de conexión predeterminado único.
SkuLimitsExist	string	Existen límites de SKU.
SubscriptionNotFound	string	No se encontró la suscripción.
UnexpectedError	string	Error inesperado.
UnsupportedClassBasedAdaptation	string	Adaptación basada en clases no admitidas.
UnsupportedDelta	string	Delta no admitido.
UnsupportedDynamicConfiguration	string	Configuración dinámica no admitida.
UnsupportedFilter	string	Filtro no admitido.
UnsupportedLanguageCode	string	Código de lenguaje no admitido.
UnsupportedOrderBy	string	Orden no admitido por.
UnsupportedPagination	string	Paginación no admitida.
UnsupportedTimeRange	string	Intervalo de tiempo no admitido.

EntityError

Nombre	Tipo	Description
code	string	Código de este error.
message	string	Mensaje para este error.

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

Nombre	Tipo	Description
Conflict	string	Representa el código de error en conflicto.
Forbidden	string	Representa el código de error prohibido.
InternalCommunicationFailed	string	Representa el código de error de comunicación interna con error.
InternalServerError	string	Representa el código de error interno del servidor.
InvalidArgument	string	Representa el código de error de argumento no válido.
InvalidRequest	string	Representa el código de error de solicitud no válido.
NotAllowed	string	Representa el código de error no permitido.
NotFound	string	Representa el código de error no encontrado.
PipelineError	string	Representa el código de error de canalización.
ServiceUnavailable	string	Representa el código de error del servicio no disponible.
TooManyRequests	string	Representa el código de error de demasiadas solicitudes.
Unauthorized	string	Representa el código de error no autorizado.
UnprocessableEntity	string	Representa el código de error de entidad no procesado.
UnsupportedMediaType	string	Representa el código de error de tipo de medio no admitido.

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

Estado

Nombre	Tipo	Description
Failed	string	Error en la operación de larga duración.
NotStarted	string	La operación de larga duración aún no se ha iniciado.
Running	string	La operación de larga duración se está procesando actualmente.
Succeeded	string	La operación de larga duración se ha completado correctamente.

WebHook

Nombre	Tipo	Description
createdDateTime	string	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	Nombre para mostrar del objeto.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string	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	Ubicación de esta entidad.
status	Status	Estado Describir el estado actual de la API.
webUrl	string	Dirección URL registrada que se usará para enviar las solicitudes POST a los eventos registrados.

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

WebHookLinks

Nombre	Tipo	Description
ping	string	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	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

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.

Compartir a través de

Web Hooks - Get

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Ejemplos

Get a web hook

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

Recursos adicionales