Partager via

Web Hooks - Get

  • Référence
Service:
Azure AI Services
Version d'API:
v3.2-preview.2

Obtient le hook web identifié par l’ID donné.

GET {endpoint}/speechtotext/v3.2-preview.2/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.

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.

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

Get a web hook

Exemple de requête

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

Exemple de réponse

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

DetailedErrorCode

Énumération

DetailedErrorCode

Valeur Description
DataImportFailed

Échec de l’importation de données.
DeleteNotAllowed

Supprimer non autorisé.
DeployNotAllowed

Déployer non autorisé.
DeployingFailedModel

Déploiement d’un modèle ayant échoué.
EmptyRequest

Requête vide.
EndpointCannotBeDefault

Le point de terminaison ne peut pas être par défaut.
EndpointNotUpdatable

Point de terminaison non modifiable.
EndpointWithoutLogging

Point de terminaison sans journalisation.
ExceededNumberOfRecordingsUris

Nombre dépassé d’uris d’enregistrement.
FailedDataset

Jeu de données ayant échoué.
Forbidden

Interdit.
InUseViolation

En cas de violation d’utilisation.
InaccessibleCustomerStorage

Stockage client inaccessible.
InvalidAdaptationMapping

Mappage d’adaptation non valide.
InvalidBaseModel

Modèle de base non valide.
InvalidCallbackUri

URI de rappel non valide.
InvalidCollection

Collection non valide.
InvalidDataset

Jeu de données non valide.
InvalidDocument

Document non valide.
InvalidDocumentBatch

Lot de documents non valide.
InvalidLocale

Paramètres régionaux non valides.
InvalidLogDate

Date de journal non valide.
InvalidLogEndTime

Heure de fin du journal non valide.
InvalidLogId

ID de journal non valide.
InvalidLogStartTime

Heure de début du journal non valide.
InvalidModel

Modèle non valide.
InvalidModelUri

URI de modèle non valide.
InvalidParameter

Paramètre non valide.
InvalidParameterValue

Valeur de paramètre non valide.
InvalidPayload

Charge utile non valide.
InvalidPermissions

Autorisations non valides.
InvalidPrerequisite

Prérequis non valides.
InvalidProductId

ID de produit non valide.
InvalidProject

Projet non valide.
InvalidProjectKind

Type de projet non valide.
InvalidRecordingsUri

Uri des enregistrements non valides.
InvalidRequestBodyFormat

Format du corps de la demande non valide.
InvalidSasValidityDuration

Durée de validité de sas non valide.
InvalidSkipTokenForLogs

Jeton d’ignorer non valide pour les journaux d’activité.
InvalidSourceAzureResourceId

ID de ressource Azure source non valide.
InvalidSubscription

Abonnement non valide.
InvalidTest

Test non valide.
InvalidTimeToLive

Heure de vie non valide.
InvalidTopForLogs

Top non valide pour les journaux d’activité.
InvalidTranscription

Transcription non valide.
InvalidWebHookEventKind

Type d’événement web hook non valide.
MissingInputRecords

Enregistrements d’entrée manquants.
ModelCopyOperationExists

L’opération de copie de modèle existe.
ModelDeploymentNotCompleteState

Le déploiement du modèle n’est pas terminé.
ModelDeprecated

Modèle déconseillé.
ModelExists

Le modèle existe.
ModelMismatch

Incompatibilité du modèle.
ModelNotDeployable

Modèle non déployable.
ModelVersionIncorrect

Version du modèle incorrecte.
NoUtf8WithBom

Pas d’utf8 avec bom.
OnlyOneOfUrlsOrContainerOrDataset

Une seule URL ou conteneur ou jeu de données.
ProjectGenderMismatch

Incompatibilité entre les sexes du projet.
QuotaViolation

Violation de quota.
SingleDefaultEndpoint

Point de terminaison par défaut unique.
SkuLimitsExist

Les limites de référence SKU existent.
SubscriptionNotFound

Abonnement introuvable.
UnexpectedError

Erreur inattendue.
UnsupportedClassBasedAdaptation

Adaptation basée sur des classes non prise en charge.
UnsupportedDelta

Delta non pris en charge.
UnsupportedDynamicConfiguration

Configuration dynamique non prise en charge.
UnsupportedFilter

Filtre non pris en charge.
UnsupportedLanguageCode

Code de langue non pris en charge.
UnsupportedOrderBy

Commande non prise en charge par.
UnsupportedPagination

Pagination non prise en charge.
UnsupportedTimeRange

Intervalle de temps non pris en charge.

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
Conflict

Représentant le code d’erreur de conflit.
Forbidden

Représentant le code d’erreur interdit.
InternalCommunicationFailed

Représentant le code d’erreur de communication interne ayant échoué.
InternalServerError

Représentant le code d’erreur du serveur interne.
InvalidArgument

Représentant le code d’erreur d’argument non valide.
InvalidRequest

Représentant le code d’erreur de requête non valide.
NotAllowed

Représentant le code d’erreur non autorisé.
NotFound

Représentant le code d’erreur introuvable.
PipelineError

Représentant le code d’erreur du pipeline.
ServiceUnavailable

Représentant le code d’erreur indisponible du service.
TooManyRequests

Représentant le code d’erreur trop grand nombre de requêtes.
Unauthorized

Représentant le code d’erreur non autorisé.
UnprocessableEntity

Représentant le code d’erreur d’entité non traité.
UnsupportedMediaType

Représentant le code d’erreur du type de média non pris en charge.

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
Failed

L’opération de longue durée a échoué.
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.

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

minLength: 1

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

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. Pour plus d’informations, consultez l’opération « WebHooks_Ping ».
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. Pour plus d’informations, consultez l’opération « WebHooks_Test ».

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.