Web Hooks - Ping

Servicio:

Azure AI Services

Versión de la API:

v3.2-preview.2

Envía un evento ping a la dirección URL registrada.
El cuerpo de la solicitud POST enviada a la dirección URL del webook registrado tiene la misma forma que en la solicitud GET para un enlace específico. El identificador de esquema de Swagger del modelo es WebHookV3.

La solicitud contendrá un encabezado X-MicrosoftSpeechServices-Event con el valor ping. Si el web hook se registró con un secreto, contendrá un encabezado X-MicrosoftSpeechServices-Signature con un hash SHA256 de la carga con el secreto como clave HMAC. El hash está codificado en base64.

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

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 al que se va a hacer ping.

Respuestas

Nombre	Tipo	Description
202 Accepted		Comenzó a intentar enviar una solicitud de ping al web hook. Encabezados Retry-After: integer
Other Status Codes	Error	Se produjo 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

Ping a web hook

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

202

Definiciones

Nombre	Description
DetailedErrorCode	DetailedErrorCode
Error	Error
ErrorCode	ErrorCode
InnerError	InnerError

DetailedErrorCode

DetailedErrorCode

Nombre	Tipo	Description
DataImportFailed	string	Error en la importación de datos.
DeleteNotAllowed	string	No se permite eliminar.
DeployNotAllowed	string	No se permite la implementación.
DeployingFailedModel	string	Error al implementar el modelo.
EmptyRequest	string	Solicitud vacía.
EndpointCannotBeDefault	string	El punto de conexión no puede ser predeterminado.
EndpointNotUpdatable	string	Punto de conexión no actualizable.
EndpointWithoutLogging	string	Punto de conexión sin registro.
ExceededNumberOfRecordingsUris	string	Se superó el número de URI de grabaciones.
FailedDataset	string	Conjunto de datos con error.
Forbidden	string	Prohibido.
InUseViolation	string	En infracción de uso.
InaccessibleCustomerStorage	string	Almacenamiento de cliente inaccesible.
InvalidAdaptationMapping	string	Asignación de adaptación no válida.
InvalidBaseModel	string	Modelo base no válido.
InvalidCallbackUri	string	URI de devolución de llamada no válido.
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	Id. 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.
ModelCopyOperationExists	string	Existe la operación de copia del modelo.
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.
NoUtf8WithBom	string	No hay utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Solo una de las direcciones URL o el contenedor o el conjunto de datos.
ProjectGenderMismatch	string	Error de coincidencia de género 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 admitida.
UnsupportedDelta	string	Delta no admitido.
UnsupportedDynamicConfiguration	string	Configuración dinámica no admitida.
UnsupportedFilter	string	Filtro no admitido.
UnsupportedLanguageCode	string	Código de idioma no admitido.
UnsupportedOrderBy	string	Orden no admitido por.
UnsupportedPagination	string	Paginación no admitida.
UnsupportedTimeRange	string	Intervalo de tiempo no admitido.

Error

Error

Nombre	Tipo	Description
code	ErrorCode	ErrorCode Códigos de error de alto nivel.
details	Error[]	Detalles adicionales de apoyo 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 las propiedades opcionales, target, details (par clave-valor), innerError (se puede anidar).
message	string	Mensaje de error de alto nivel.
target	string	Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en el caso de un documento no válido.

ErrorCode

ErrorCode

Nombre	Tipo	Description
Conflict	string	Representa el código de error de conflicto.
Forbidden	string	Representa el código de error prohibido.
InternalCommunicationFailed	string	Representando el código de error de comunicación interna con errores.
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

InnerError

Nombre	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enumeración detallada del código de error.
details	object	Detalles adicionales de apoyo 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 las propiedades opcionales, target, details (par clave-valor), innerError (se puede anidar).
message	string	Mensaje de error de alto nivel.
target	string	Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en el caso de un documento no válido.