Partager via


Web Hooks - Create

Crée un web hook.
Si le secret de propriété dans la configuration est présent et contient une chaîne non vide, il est utilisé pour créer un hachage SHA256 de la charge utile avec le secret comme clé HMAC. Ce hachage sera défini en tant qu’en-tête X-MicrosoftSpeechServices-Signature lors du rappel de l’URL inscrite.

Lors du rappel dans l’URL inscrite, la requête contient un en-tête X-MicrosoftSpeechServices-Event contenant l’un des types d’événements inscrits. Il y aura une demande par type d’événement inscrit.

Une fois le web hook inscrit, il ne sera pas utilisable tant qu’une demande/réponse n’est pas terminée. Pour ce faire, une requête avec la demande de type d’événement est effectuée avec un paramètre de requête appelé validationToken. Répondez au défi avec un 200 OK contenant la valeur du paramètre de requête validationToken comme corps de la réponse. Une fois la demande/réponse terminée, le web hook commence à recevoir des événements.

POST {endpoint}/speechtotext/v3.1/webhooks

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).

Corps de la demande

Nom Obligatoire Type Description
displayName True

string

Nom complet de l’objet.

events True

WebHookEvents

WebHookEvents

webUrl True

string

URL inscrite qui sera utilisée pour envoyer les demandes POST pour les événements inscrits.

customProperties

object

Propriétés personnalisées de cette entité. La longueur de clé maximale 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 .

links

WebHookLinks

WebHookLinks

properties

WebHookProperties

WebHookProperties

Réponses

Nom Type Description
201 Created

WebHook

La réponse contient des informations sur l’entité en tant que charge utile et son emplacement en tant qu’en-tête.

En-têtes

Location: string

Other Status Codes

Error

Une erreur est survenue.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez votre clé de 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

Create a web hook

Exemple de requête

POST {endpoint}/speechtotext/v3.1/webhooks

{
  "displayName": "TranscriptionCompletionWebHook",
  "properties": {
    "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."
}

Exemple de réponse

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

Définitions

Nom Description
DetailedErrorCode

DetailedErrorCode

EntityError

EntityError

Error

Erreur

ErrorCode

ErrorCode

InnerError

InnerError

Status

Statut

WebHook

WebHook

WebHookEvents

WebHookEvents

WebHookLinks

WebHookLinks

WebHookProperties

WebHookProperties

DetailedErrorCode

DetailedErrorCode

Nom Type Description
DataImportFailed

string

Échec de l’importation des données.

DeleteNotAllowed

string

Suppression non autorisée.

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

Nombre d’URI d’enregistrements dépassé.

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é sas non valide.

InvalidSkipTokenForLogs

string

Jeton d’évitement non valide pour les journaux.

InvalidSubscription

string

Abonnement non valide.

InvalidTest

string

Test non valide.

InvalidTimeToLive

string

Durée de vie non valide.

InvalidTopForLogs

string

Haut 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.

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é du modèle.

ModelNotDeployable

string

Modèle non déployable.

ModelVersionIncorrect

string

Version du modèle incorrecte.

NoUtf8WithBom

string

Pas d’utf8 avec bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Une seule des URL, 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

Il existe des limites de référence SKU.

SubscriptionNotFound

string

Abonnement introuvable.

UnexpectedError

string

Erreur inattendue.

UnsupportedClassBasedAdaptation

string

Adaptation basée sur la classe 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.

EntityError

EntityError

Nom Type Description
code

string

Code de cette erreur.

message

string

Message correspondant à cette erreur.

Error

Erreur

Nom Type Description
code

ErrorCode

ErrorCode
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, disponible à l’adresse https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ce format contient les propriétés obligatoires ErrorCode, message et les propriétés facultatives target, details (paire clé-valeur), et l’erreur interne (qui peut être imbriquée).

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

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, disponible à l’adresse https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ce format contient les propriétés obligatoires ErrorCode, message et les propriétés facultatives target, details (paire clé-valeur), et l’erreur interne (qui peut être imbriquée).

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.

Status

Statut

Nom Type Description
Failed

string

L’opération de longue durée a échoué.

NotStarted

string

L’opération de longue durée n’a pas encore démarré.

Running

string

L’opération de longue durée est en cours de traitement.

Succeeded

string

L’opération de longue durée s’est terminée avec succès.

WebHook

WebHook

Nom Type Description
createdDateTime

string

Horodatage de la création de l’objet. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :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 autorisée de la clé 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

Horodatage lorsque le status actuel a été entré. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

WebHookLinks

WebHookLinks

properties

WebHookProperties

WebHookProperties

self

string

Emplacement de cette entité.

status

Status

Statut
Décrire l’état actuel de l’API

webUrl

string

URL inscrite qui sera utilisée pour envoyer les demandes POST pour les événements inscrits.

WebHookEvents

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

Nom Type Description
ping

string

URL qui peut être utilisée pour déclencher l’envoi d’un événement ping à l’URL inscrite d’une inscription web hook. Pour plus d’informations, consultez l’opération « WebHooks_Ping ».

test

string

URL qui peut être utilisée en envoyant des événements de test à l’URL inscrite d’une inscription de web hook. Pour plus d’informations, consultez l’opération « WebHooks_Test ».

WebHookProperties

WebHookProperties

Nom Type Description
apiVersion

string

Version de l’API dans laquelle le web hook 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 la version de l’API qui l’utilise est supprimée (après la dépréciation), le web hook 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 comme clé HMAC. Ce hachage sera défini en tant qu’en-tête X-MicrosoftSpeechServices-Signature lors du rappel de l’URL inscrite.