Web Hooks - Create

Riferimento

Servizio:: Azure AI Services

Versione API:: 2024-11-15

Crea un nuovo web hook.
Se il segreto della proprietà nella configurazione è presente e contiene una stringa non vuota, verrà usato per creare un hash SHA256 del payload con il segreto come chiave HMAC. Questo hash verrà impostato come intestazione X-MicrosoftSpeechServices-Signature quando si richiama di nuovo nell'URL registrato.

Quando si richiama di nuovo nell'URL registrato, la richiesta conterrà un'intestazione X-MicrosoftSpeechServices-Event contenente uno dei tipi di evento registrati. Sarà presente una richiesta per ogni tipo di evento registrato.

Dopo aver registrato correttamente l'hook Web, non sarà utilizzabile fino al completamento di una richiesta/risposta. A tale scopo, verrà eseguita una richiesta con la richiesta di verifica del tipo di evento con un parametro di query denominato validationToken. Rispondere alla richiesta con 200 OK contenente il valore del parametro di query validationToken come corpo della risposta. Al termine della richiesta/risposta, l'hook Web inizierà a ricevere eventi.

POST {endpoint}/speechtotext/webhooks?api-version=2024-11-15

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus.api.cognitive.microsoft.com).
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string	Specificare la chiave dell'account di Servizi cognitivi qui.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
displayName	True	string minLength: 1	Nome visualizzato dell'oggetto.
events	True	WebHookEvents	WebHookEvents
webUrl	True	string (uri)	URL registrato a cui inviare le richieste POST per gli eventi registrati.
customProperties		object	Proprietà personalizzate di questa entità. La lunghezza massima consentita della chiave è di 64 caratteri, la lunghezza massima consentita del valore è di 256 caratteri e il numero di voci consentite è 10.
description		string	Descrizione dell'oggetto.
properties		WebHookProperties	WebHookProperties

Risposte

Nome	Tipo	Descrizione
201 Created	WebHook	La risposta contiene informazioni sull'entità come payload e sulla relativa posizione come intestazione. Intestazioni Location: string
Other Status Codes	Error	Si è verificato un errore.

Nome

Tipo

Descrizione

201 Created

WebHook

La risposta contiene informazioni sull'entità come payload e sulla relativa posizione come intestazione.

Intestazioni

Location: string

Other Status Codes

Error

Si è verificato un errore.

Sicurezza

Ocp-Apim-Subscription-Key

Specificare la chiave dell'account di Servizi cognitivi qui.

Tipo: apiKey
In: header

Esempio

Create a web hook

Esempio di richiesta

HTTP

POST {endpoint}/speechtotext/webhooks?api-version=2024-11-15


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

Risposta di esempio

Codice di stato:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-11-15

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-11-15",
  "displayName": "TranscriptionCompletionWebHook",
  "description": "I registered this URL to get a POST request for each completed transcription.",
  "properties": {
    "apiVersion": "2024-11-15",
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "createdDateTime": "2018-11-11T00:00:00Z",
  "lastActionDateTime": "2018-11-28T00:00:00Z",
  "status": "NotStarted",
  "links": {
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-11-15",
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-11-15"
  }
}

Definizioni

Nome	Descrizione
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Errore
ErrorCode	ErrorCode
InnerError	InnerError
Status	Stato
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties

DetailedErrorCode

Enumerazione

DetailedErrorCode

Valore	Descrizione
AudioLengthLimitExceeded	Il file audio è più lungo della durata massima consentita.
BadChannelConfiguration	Esiste una mancata corrispondenza tra canali audio nei dati, nella configurazione o nei requisiti dell'applicazione.
DataImportFailed	Importazione dei dati non riuscita.
DeleteNotAllowed	Eliminazione non consentita.
DeployNotAllowed	Distribuzione non consentita.
DeployingFailedModel	Distribuzione del modello non riuscito.
EmptyAudioFile	Il file audio è vuoto.
EmptyRequest	Richiesta vuota.
EndpointCannotBeDefault	L'endpoint non può essere predefinito.
EndpointLoggingNotSupported	Registrazione degli endpoint non supportata.
EndpointNotUpdatable	Endpoint non aggiornabile.
EndpointWithoutLogging	Endpoint senza registrazione.
ExceededNumberOfRecordingsUris	È stato superato il numero di URI delle registrazioni.
FailedDataset	Set di dati non riuscito.
Forbidden	Vietato.
InUseViolation	In violazione dell'uso.
InaccessibleCustomerStorage	Archiviazione dei clienti inaccessibile.
InvalidAdaptationMapping	Mapping di adattamento non valido.
InvalidAudioFormat	Il formato dell'audio di input non è supportato.
InvalidBaseModel	Modello di base non valido.
InvalidCallbackUri	URI di callback non valido.
InvalidChannelSpecification	La selezione dei canali nella richiesta di trascrizione non è supportata (ad esempio, non sono stati selezionati né 0 né 1).
InvalidChannels	Canali non validi.
InvalidCollection	Raccolta non valida.
InvalidDataset	Set di dati non valido.
InvalidDocument	Documento non valido.
InvalidDocumentBatch	Batch di documenti non valido.
InvalidLocale	Impostazioni locali non valide.
InvalidLogDate	Data del log non valida.
InvalidLogEndTime	Ora di fine del log non valida.
InvalidLogId	ID log non valido.
InvalidLogStartTime	Ora di inizio del log non valida.
InvalidModel	Modello non valido.
InvalidModelUri	URI del modello non valido.
InvalidParameter	Parametro non valido.
InvalidParameterValue	Valore del parametro non valido.
InvalidPayload	Payload non valido.
InvalidPermissions	Autorizzazioni non valide.
InvalidPrerequisite	Prerequisito non valido.
InvalidProductId	ID prodotto non valido.
InvalidProject	Progetto non valido.
InvalidProjectKind	Tipo di progetto non valido.
InvalidRecordingsUri	URI delle registrazioni non valido.
InvalidRequestBodyFormat	Formato del corpo della richiesta non valido.
InvalidSasValidityDuration	Durata della validità della firma di accesso condiviso non valida.
InvalidSkipTokenForLogs	Token skip non valido per i log.
InvalidSourceAzureResourceId	ID risorsa di Azure di origine non valido.
InvalidSubscription	Sottoscrizione non valida.
InvalidTest	Test non valido.
InvalidTimeToLive	Tempo di vita non valido.
InvalidTopForLogs	Top non valido per i log.
InvalidTranscription	Trascrizione non valida.
InvalidWebHookEventKind	Tipo di evento web hook non valido.
MissingInputRecords	Record di input mancanti.
ModelCopyAuthorizationExpired	ModelCopyAuthorization scaduto.
ModelDeploymentNotCompleteState	Lo stato della distribuzione del modello non è completo.
ModelDeprecated	Modello deprecato.
ModelExists	Il modello esiste.
ModelMismatch	Mancata corrispondenza del modello.
ModelNotDeployable	Modello non distribuibile.
ModelVersionIncorrect	Versione del modello non corretta.
MultipleLanguagesIdentified	Identificazione della lingua ha riconosciuto più lingue. Non è stato possibile determinare nessun linguaggio dominante.
NoLanguageIdentified	L'identificazione della lingua non riconosce alcuna lingua.
NoUtf8WithBom	Nessun utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset	Solo uno degli URL o del contenitore o del set di dati.
ProjectGenderMismatch	Mancata corrispondenza di genere del progetto.
QuotaViolation	Violazione della quota.
SingleDefaultEndpoint	Singolo endpoint predefinito.
SkuLimitsExist	Esistono limiti di SKU.
SubscriptionNotFound	Sottoscrizione non trovata.
UnexpectedError	Errore imprevisto.
UnsupportedClassBasedAdaptation	Adattamento basato su classe non supportato.
UnsupportedDelta	Delta non supportato.
UnsupportedDynamicConfiguration	Configurazione dinamica non supportata.
UnsupportedFilter	Filtro non supportato.
UnsupportedLanguageCode	Codice del linguaggio non supportato.
UnsupportedOrderBy	Ordine non supportato per.
UnsupportedPagination	Impaginazione non supportata.
UnsupportedTimeRange	Intervallo di tempo non supportato.

EntityError

Object

EntityError

Nome	Tipo	Descrizione
code	string	Codice di questo errore.
message	string	Messaggio per questo errore.

Error

Object

Errore

Nome	Tipo	Descrizione
code	ErrorCode	ErrorCode Codici di errore di alto livello.
details	Error[]	Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innerError	InnerError	InnerError Nuovo formato di errore interno conforme alle linee guida dell'API Servizi cognitivi, disponibile in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene le proprietà obbligatorie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia chiave-valore), errore interno (che può essere annidato).
message	string	Messaggio di errore di alto livello.
target	string	Origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

ErrorCode

Enumerazione

ErrorCode

Valore	Descrizione
Conflict	Rappresentazione del codice di errore del conflitto.
Forbidden	Rappresentazione del codice di errore non consentito.
InternalCommunicationFailed	Rappresentazione del codice di errore della comunicazione interna non riuscita.
InternalServerError	Rappresentazione del codice di errore interno del server.
InvalidArgument	Rappresentazione del codice di errore dell'argomento non valido.
InvalidRequest	Rappresentazione del codice di errore della richiesta non valido.
NotAllowed	Rappresentazione del codice di errore non consentito.
NotFound	Rappresentazione del codice di errore non trovato.
PipelineError	Rappresentazione del codice di errore della pipeline.
ServiceUnavailable	Rappresentazione del codice di errore del servizio non disponibile.
TooManyRequests	Rappresentazione del codice di errore troppe richieste.
Unauthorized	Rappresentazione del codice di errore non autorizzato.
UnprocessableEntity	Rappresentazione del codice di errore dell'entità non elaborabile.
UnsupportedMediaType	Rappresentazione del codice di errore del tipo di supporto non supportato.

InnerError

Object

InnerError

Nome	Tipo	Descrizione
code	DetailedErrorCode	DetailedErrorCode Enumerazione dettagliata del codice di errore.
details	object	Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innerError	InnerError	InnerError Nuovo formato di errore interno conforme alle linee guida dell'API Servizi cognitivi, disponibile in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene le proprietà obbligatorie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia chiave-valore), errore interno (che può essere annidato).
message	string	Messaggio di errore di alto livello.
target	string	Origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

Status

Enumerazione

Stato

Valore	Descrizione
Failed	L'operazione a esecuzione prolungata non è riuscita.
NotStarted	L'operazione a esecuzione prolungata non è ancora stata avviata.
Running	L'operazione a esecuzione prolungata è attualmente in elaborazione.
Succeeded	L'operazione a esecuzione prolungata è stata completata correttamente.

WebHook

Object

WebHook

Nome	Tipo	Descrizione
createdDateTime	string (date-time)	Timestamp al momento della creazione dell'oggetto. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAA-MM-GGThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Proprietà personalizzate di questa entità. La lunghezza massima consentita della chiave è di 64 caratteri, la lunghezza massima consentita del valore è di 256 caratteri e il numero di voci consentite è 10.
description	string	Descrizione dell'oggetto.
displayName	string minLength: 1	Nome visualizzato dell'oggetto.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string (date-time)	Timestamp quando è stato immesso lo stato corrente. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAA-MM-GGThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string (uri)	Posizione dell'entità.
status	Status	Stato Descrivere lo stato corrente dell'API.
webUrl	string (uri)	URL registrato a cui inviare le richieste POST per gli eventi registrati.

WebHookEvents

Object

WebHookEvents

Nome	Tipo	Descrizione
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

Nome	Tipo	Descrizione
ping	string (uri)	URL che può essere usato per attivare l'invio di un evento ping all'URL registrato di una registrazione web hook. Per altri dettagli, vedere l'operazione "WebHooks_Ping".
test	string (uri)	URL che può essere usato inviando eventi di test all'URL registrato di una registrazione web hook. Per altri dettagli, vedere l'operazione "WebHooks_Test".

WebHookProperties

Object

WebHookProperties

Nome	Tipo	Descrizione
apiVersion	string	La versione dell'API in cui è stato creato l'hook Web. Definisce la forma del payload nei callback. Se il tipo di payload non è più supportato, perché la forma è cambiata e la versione dell'API che la usa viene rimossa (dopo la deprecazione), l'hook Web verrà disabilitato.
error	EntityError	EntityError
secret	string	Segreto che verrà usato per creare un hash SHA256 del payload con il segreto come chiave HMAC. Questo hash verrà impostato come intestazione X-MicrosoftSpeechServices-Signature quando si richiama di nuovo nell'URL registrato.

Condividi tramite

Web Hooks - Create

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Esempio

Create a web hook

Esempio di richiesta

Risposta di esempio

Definizioni

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

Risorse aggiuntive