Update Hook - Update Hook

Service:: Azure AI Services

Version d'API:: v3.0

Met à jour le hook web identifié par l’ID donné.
Si le secret de propriété dans la configuration est omis ou contient une chaîne vide, les rappels futurs ne contiennent pas d’en-têtes X-MicrosoftSpeechServices-Signature. Si la propriété contient une chaîne non vide, elle sera utilisée pour créer un hachage SHA256 de la charge utile avec le secret en tant que clé HMAC. Ce hachage est défini en tant qu’en-tête X-MicrosoftSpeechServices-Signature lors de l’appel à l’URL inscrite.

Si l’URL change, le hook web cesse de recevoir des événements jusqu’à ce qu’un défi/réponse soit terminé. Pour ce faire, une requête avec le défi de type d’événement est effectuée avec un paramètre de requête appelé validationToken. Répondez au défi avec une valeur 200 OK contenant la valeur du paramètre de requête validationToken en tant que corps de réponse. Une fois le défi/réponse terminé, le web hook commence à recevoir des événements.

PATCH {Endpoint}/speechtotext/v3.0/webhooks/{id}

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 hook web.

Corps de la demande

Media Types: "application/json", "application/merge-patch+json"

Nom	Type	Description
customProperties	object	Propriétés personnalisées de cette entité. La longueur maximale de la clé autorisée est de 64 caractères, la longueur maximale de la valeur autorisée est de 256 caractères et le nombre d’entrées autorisées est de 10.
description	string	Description de l’objet.
displayName	string	Nom de l’objet.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	URL inscrite à laquelle envoyer les demandes POST pour les événements inscrits.

Réponses

Nom	Type	Description
200 OK	WebHook	D’ACCORD En-têtes Retry-After: integer
Other Status Codes	Error	Une erreur s’est produite.

Nom

Type

Description

200 OK

WebHook

D’ACCORD

En-têtes

Retry-After: integer

Other Status Codes

Error

Une erreur s’est produite.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez ici votre clé de compte Cognitive Services.

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

Update a web hook

Exemple de requête

HTTP

PATCH https://westus.api.cognitive.microsoft.com//speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d

{
  "properties": {
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "events": {
    "evaluationCreation": true,
    "evaluationProcessing": true,
    "evaluationCompletion": true,
    "evaluationDeletion": true
  },
  "webUrl": "https://contoso.com/call/me/back",
  "displayName": "TranscriptionCompletionWebHook",
  "description": "I registered this URL to get a POST request for each completed transcription.",
  "customProperties": {
    "key": "value"
  }
}

Exemple de réponse

Code d’état:: 200

{
  "displayName": "TranscriptionCompletionWebHook",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d",
  "links": {
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/test",
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d/ping"
  },
  "properties": {
    "apiVersion": "v3.0",
    "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"
}

Définitions

Nom	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Erreur
ErrorCode	Code d'erreur
InnerError	InnerError
Status	Statut
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties
WebHookPropertiesUpdate	WebHookPropertiesUpdate
WebHookUpdate	WebHookUpdate

DetailedErrorCode

Énumération

DetailedErrorCode

Valeur	Description
InvalidParameterValue	Valeur de paramètre non valide.
InvalidRequestBodyFormat	Format du corps de la demande non valide.
EmptyRequest	Requête vide.
MissingInputRecords	Enregistrements d’entrée manquants.
InvalidDocument	Document non valide.
ModelVersionIncorrect	Version du modèle incorrecte.
InvalidDocumentBatch	Lot de documents non valide.
UnsupportedLanguageCode	Code de langue non pris en charge.
DataImportFailed	Échec de l’importation de données.
InUseViolation	En cas de violation d’utilisation.
InvalidLocale	Paramètres régionaux non valides.
InvalidBaseModel	Modèle de base non valide.
InvalidAdaptationMapping	Mappage d’adaptation non valide.
InvalidDataset	Jeu de données non valide.
InvalidTest	Test non valide.
FailedDataset	Jeu de données ayant échoué.
InvalidModel	Modèle non valide.
InvalidTranscription	Transcription non valide.
InvalidPayload	Charge utile non valide.
InvalidParameter	Paramètre non valide.
EndpointWithoutLogging	Point de terminaison sans journalisation.
InvalidPermissions	Autorisations non valides.
InvalidPrerequisite	Prérequis non valides.
InvalidProductId	ID de produit non valide.
InvalidSubscription	Abonnement non valide.
InvalidProject	Projet non valide.
InvalidProjectKind	Type de projet non valide.
InvalidRecordingsUri	Uri des enregistrements non valides.
OnlyOneOfUrlsOrContainerOrDataset	Une seule URL ou conteneur ou jeu de données.
ExceededNumberOfRecordingsUris	Nombre dépassé d’uris d’enregistrement.
ModelMismatch	Incompatibilité du modèle.
ProjectGenderMismatch	Incompatibilité entre les sexes du projet.
ModelDeprecated	Modèle déconseillé.
ModelExists	Le modèle existe.
ModelNotDeployable	Modèle non déployable.
EndpointNotUpdatable	Point de terminaison non modifiable.
SingleDefaultEndpoint	Point de terminaison par défaut unique.
EndpointCannotBeDefault	Le point de terminaison ne peut pas être par défaut.
InvalidModelUri	URI de modèle non valide.
SubscriptionNotFound	Abonnement introuvable.
QuotaViolation	Violation de quota.
UnsupportedDelta	Delta non pris en charge.
UnsupportedFilter	Filtre non pris en charge.
UnsupportedPagination	Pagination non prise en charge.
UnsupportedDynamicConfiguration	Configuration dynamique non prise en charge.
UnsupportedOrderBy	Commande non prise en charge par.
NoUtf8WithBom	Pas d’utf8 avec bom.
ModelDeploymentNotCompleteState	Le déploiement du modèle n’est pas terminé.
SkuLimitsExist	Les limites de référence SKU existent.
DeployingFailedModel	Déploiement d’un modèle ayant échoué.
UnsupportedTimeRange	Intervalle de temps non pris en charge.
InvalidLogDate	Date de journal non valide.
InvalidLogId	ID de journal non valide.
InvalidLogStartTime	Heure de début du journal non valide.
InvalidLogEndTime	Heure de fin du journal non valide.
InvalidTopForLogs	Top non valide pour les journaux d’activité.
InvalidSkipTokenForLogs	Jeton d’ignorer non valide pour les journaux d’activité.
DeleteNotAllowed	Supprimer non autorisé.
Forbidden	Interdit.
DeployNotAllowed	Déployer non autorisé.
UnexpectedError	Erreur inattendue.
InvalidCollection	Collection non valide.
InvalidCallbackUri	URI de rappel non valide.
InvalidSasValidityDuration	Durée de validité de sas non valide.
InaccessibleCustomerStorage	Stockage client inaccessible.
UnsupportedClassBasedAdaptation	Adaptation basée sur des classes non prise en charge.
InvalidWebHookEventKind	Type d’événement web hook non valide.
InvalidTimeToLive	Heure de vie non valide.

EntityError

Object

EntityError

Nom	Type	Description
code	string	Code de cette erreur.
message	string	Message de cette erreur.

Error

Object

Erreur

Nom	Type	Description
code	ErrorCode	Code d'erreur Codes d’erreur de haut niveau.
details	Error[]	Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError	InnerError	InnerError Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message	string	Message d’erreur de haut niveau.
target	string	Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

ErrorCode

Énumération

Code d'erreur

Valeur	Description
InvalidRequest	Représentant le code d’erreur de requête non valide.
InvalidArgument	Représentant le code d’erreur d’argument non valide.
InternalServerError	Représentant le code d’erreur du serveur interne.
ServiceUnavailable	Représentant le code d’erreur indisponible du service.
NotFound	Représentant le code d’erreur introuvable.
PipelineError	Représentant le code d’erreur du pipeline.
Conflict	Représentant le code d’erreur de conflit.
InternalCommunicationFailed	Représentant le code d’erreur de communication interne ayant échoué.
Forbidden	Représentant le code d’erreur interdit.
NotAllowed	Représentant le code d’erreur non autorisé.
Unauthorized	Représentant le code d’erreur non autorisé.
UnsupportedMediaType	Représentant le code d’erreur du type de média non pris en charge.
TooManyRequests	Représentant le code d’erreur trop grand nombre de requêtes.
UnprocessableEntity	Représentant le code d’erreur d’entité non traité.

InnerError

Object

InnerError

Nom	Type	Description
code	DetailedErrorCode	DetailedErrorCode Énumération détaillée du code d’erreur.
details	object	Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError	InnerError	InnerError Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message	string	Message d’erreur de haut niveau.
target	string	Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

Status

Énumération

Statut

Valeur	Description
NotStarted	L’opération de longue durée n’a pas encore démarré.
Running	L’opération de longue durée est en cours de traitement.
Succeeded	L’opération de longue durée s’est terminée.
Failed	L’opération de longue durée a échoué.

WebHook

Object

WebHook

Nom	Type	Description
createdDateTime	string (date-time)	Horodatage de la création de l’objet. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Propriétés personnalisées de cette entité. La longueur maximale de la clé autorisée est de 64 caractères, la longueur maximale de la valeur autorisée est de 256 caractères et le nombre d’entrées autorisées est de 10.
description	string	Description de l’objet.
displayName	string	Nom complet de l’objet.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string (date-time)	Horodatage lorsque l’état actuel a été entré. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string (uri)	Emplacement de cette entité.
status	Status	Statut Décrire l’état actuel de l’API
webUrl	string (uri)	URL inscrite à laquelle envoyer les demandes POST pour les événements inscrits.

WebHookEvents

Object

WebHookEvents

Nom	Type	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

Object

WebHookLinks

Nom	Type	Description
ping	string (uri)	URL qui peut être utilisée pour déclencher l’envoi d’un événement ping à l’URL inscrite d’une inscription de hook web.
test	string (uri)	URL qui peut être utilisée pour envoyer des événements de test à l’URL inscrite d’une inscription de hook web.

WebHookProperties

Object

WebHookProperties

Nom	Type	Description
apiVersion	string	La version de l’API dans laquelle le hook web a été créé. Cela définit la forme de la charge utile dans les rappels. Si le type de charge utile n’est plus pris en charge, car la forme a changé et que la version de l’API l’utilise est supprimée (après la dépréciation), le hook web est désactivé.
error	EntityError	EntityError
secret	string	Secret qui sera utilisé pour créer un hachage SHA256 de la charge utile avec le secret en tant que clé HMAC. Ce hachage est défini en tant qu’en-tête X-MicrosoftSpeechServices-Signature lors de l’appel à l’URL inscrite.

WebHookPropertiesUpdate

Object

WebHookPropertiesUpdate

Nom	Type	Description
secret	string	Secret qui sera utilisé pour créer un hachage SHA256 de la charge utile avec le secret en tant que clé HMAC. Ce hachage est défini en tant qu’en-tête X-MicrosoftSpeechServices-Signature lors de l’appel à l’URL inscrite.

WebHookUpdate

Object

WebHookUpdate

Nom	Type	Description
customProperties	object	Propriétés personnalisées de cette entité. La longueur maximale de la clé autorisée est de 64 caractères, la longueur maximale de la valeur autorisée est de 256 caractères et le nombre d’entrées autorisées est de 10.
description	string	Description de l’objet.
displayName	string	Nom de l’objet.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	URL inscrite à laquelle envoyer les demandes POST pour les événements inscrits.

Partager via

Update Hook - Update Hook

Paramètres URI

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Authorization

Exemples

Update a web hook

Exemple de requête

Exemple de réponse

Définitions

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate