Web Hooks - Ping
Envoie un événement ping à l’URL inscrite.
Le corps de la requête POST envoyée à l’URL de web hook inscrite est de la même forme que dans la demande GET pour un hook spécifique.
L’ID de schéma Swagger du modèle est WebHookV3.
La requête contiendra un en-tête X-MicrosoftSpeechServices-Event avec la valeur ping. Si le web hook a été inscrit avec un secret, il contient un en-tête X-MicrosoftSpeechServices-Signature avec un hachage SHA256 de la charge utile avec le secret comme clé HMAC. Le hachage est encodé en base64.
POST {endpoint}/speechtotext/v3.2-preview.2/webhooks/{id}:ping
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com). |
id
|
path | True |
string uuid |
Identificateur du web hook à effectuer un test ping. |
Réponses
Nom | Type | Description |
---|---|---|
202 Accepted |
Vous avez commencé à essayer d’envoyer une demande ping au web hook. En-têtes Retry-After: integer |
|
Other Status Codes |
Une erreur est survenue. |
Sécurité
Ocp-Apim-Subscription-Key
Fournissez la clé de votre compte Cognitive Services ici.
Type:
apiKey
Dans:
header
Authorization
Fournissez un jeton d’accès à partir du JWT retourné par le STS de cette région. Veillez à ajouter l’étendue de gestion au jeton en ajoutant la chaîne de requête suivante à l’URL STS : ?scope=speechservicesmanagement
Type:
apiKey
Dans:
header
Exemples
Ping a web hook
Exemple de requête
POST {endpoint}/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping
Exemple de réponse
Définitions
Nom | Description |
---|---|
Detailed |
DetailedErrorCode |
Error |
Erreur |
Error |
ErrorCode |
Inner |
InnerError |
DetailedErrorCode
DetailedErrorCode
Nom | Type | Description |
---|---|---|
DataImportFailed |
string |
Échec de l’importation des données. |
DeleteNotAllowed |
string |
Supprimer non autorisé. |
DeployNotAllowed |
string |
Déploiement non autorisé. |
DeployingFailedModel |
string |
Déploiement d’un modèle ayant échoué. |
EmptyRequest |
string |
Requête vide. |
EndpointCannotBeDefault |
string |
Le point de terminaison ne peut pas être par défaut. |
EndpointNotUpdatable |
string |
Point de terminaison non modifiable. |
EndpointWithoutLogging |
string |
Point de terminaison sans journalisation. |
ExceededNumberOfRecordingsUris |
string |
Dépassement du nombre d’URI d’enregistrements. |
FailedDataset |
string |
Échec du jeu de données. |
Forbidden |
string |
Interdit. |
InUseViolation |
string |
Violation en cours d’utilisation. |
InaccessibleCustomerStorage |
string |
Stockage client inaccessible. |
InvalidAdaptationMapping |
string |
Mappage d’adaptation non valide. |
InvalidBaseModel |
string |
Modèle de base non valide. |
InvalidCallbackUri |
string |
URI de rappel non valide. |
InvalidCollection |
string |
Collection non valide. |
InvalidDataset |
string |
Jeu de données non valide. |
InvalidDocument |
string |
Document non valide. |
InvalidDocumentBatch |
string |
Lot de documents non valide. |
InvalidLocale |
string |
Paramètres régionaux non valides. |
InvalidLogDate |
string |
Date de journal non valide. |
InvalidLogEndTime |
string |
Heure de fin du journal non valide. |
InvalidLogId |
string |
ID de journal non valide. |
InvalidLogStartTime |
string |
Heure de début du journal non valide. |
InvalidModel |
string |
Modèle non valide. |
InvalidModelUri |
string |
URI de modèle non valide. |
InvalidParameter |
string |
Paramètre non valide. |
InvalidParameterValue |
string |
Valeur de paramètre non valide. |
InvalidPayload |
string |
Charge utile non valide. |
InvalidPermissions |
string |
Autorisations non valides. |
InvalidPrerequisite |
string |
Prérequis non valides. |
InvalidProductId |
string |
ID de produit non valide. |
InvalidProject |
string |
Projet non valide. |
InvalidProjectKind |
string |
Type de projet non valide. |
InvalidRecordingsUri |
string |
Uri des enregistrements non valides. |
InvalidRequestBodyFormat |
string |
Format du corps de la demande non valide. |
InvalidSasValidityDuration |
string |
Durée de validité de sas non valide. |
InvalidSkipTokenForLogs |
string |
Jeton d’ignorer non valide pour les journaux. |
InvalidSourceAzureResourceId |
string |
ID de ressource Azure source non valide. |
InvalidSubscription |
string |
Abonnement non valide. |
InvalidTest |
string |
Test non valide. |
InvalidTimeToLive |
string |
Durée de vie non valide. |
InvalidTopForLogs |
string |
Top non valide pour les journaux. |
InvalidTranscription |
string |
Transcription non valide. |
InvalidWebHookEventKind |
string |
Type d’événement web hook non valide. |
MissingInputRecords |
string |
Enregistrements d’entrée manquants. |
ModelCopyOperationExists |
string |
L’opération de copie de modèle existe. |
ModelDeploymentNotCompleteState |
string |
État non terminé du déploiement du modèle. |
ModelDeprecated |
string |
Modèle déconseillé. |
ModelExists |
string |
Le modèle existe. |
ModelMismatch |
string |
Incompatibilité de modèle. |
ModelNotDeployable |
string |
Modèle non déployable. |
ModelVersionIncorrect |
string |
Version du modèle incorrecte. |
NoUtf8WithBom |
string |
Pas de utf8 avec bom. |
OnlyOneOfUrlsOrContainerOrDataset |
string |
Une seule url ou conteneur ou jeu de données. |
ProjectGenderMismatch |
string |
Projet d’incompatibilité entre les sexes. |
QuotaViolation |
string |
Violation de quota. |
SingleDefaultEndpoint |
string |
Point de terminaison par défaut unique. |
SkuLimitsExist |
string |
Des limites de référence SKU existent. |
SubscriptionNotFound |
string |
Abonnement introuvable. |
UnexpectedError |
string |
Erreur inattendue. |
UnsupportedClassBasedAdaptation |
string |
Adaptation basée sur les classes non prise en charge. |
UnsupportedDelta |
string |
Delta non pris en charge. |
UnsupportedDynamicConfiguration |
string |
Configuration dynamique non prise en charge. |
UnsupportedFilter |
string |
Filtre non pris en charge. |
UnsupportedLanguageCode |
string |
Code de langue non pris en charge. |
UnsupportedOrderBy |
string |
Commande non prise en charge par. |
UnsupportedPagination |
string |
Pagination non prise en charge. |
UnsupportedTimeRange |
string |
Intervalle de temps non pris en charge. |
Error
Erreur
Nom | Type | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Détails supplémentaires concernant l’erreur et/ou les stratégies attendues. |
innerError |
InnerError |
|
message |
string |
Message d’erreur de haut niveau. |
target |
string |
Source de l’erreur. Par exemple, « documents » ou « document id » en présence d’un document non valide. |
ErrorCode
ErrorCode
Nom | Type | Description |
---|---|---|
Conflict |
string |
Représentant le code d’erreur de conflit. |
Forbidden |
string |
Représentant le code d’erreur interdit. |
InternalCommunicationFailed |
string |
Représentant le code d’erreur d’échec de la communication interne. |
InternalServerError |
string |
Représentant le code d’erreur interne du serveur. |
InvalidArgument |
string |
Représentant le code d’erreur de l’argument non valide. |
InvalidRequest |
string |
Représentant le code d’erreur de requête non valide. |
NotAllowed |
string |
Représentant le code d’erreur non autorisé. |
NotFound |
string |
Représentant le code d’erreur introuvable. |
PipelineError |
string |
Représentant le code d’erreur du pipeline. |
ServiceUnavailable |
string |
Représentant le code d’erreur indisponible du service. |
TooManyRequests |
string |
Représentant le code d’erreur de trop de requêtes. |
Unauthorized |
string |
Représentant le code d’erreur non autorisé. |
UnprocessableEntity |
string |
Représentant le code d’erreur d’entité non traité. |
UnsupportedMediaType |
string |
Représentant le code d’erreur de type multimédia non pris en charge. |
InnerError
InnerError
Nom | Type | Description |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
Détails supplémentaires concernant l’erreur et/ou les stratégies attendues. |
innerError |
InnerError |
|
message |
string |
Message d’erreur de haut niveau. |
target |
string |
Source de l’erreur. Par exemple, « documents » ou « document id » en présence d’un document non valide. |