Web Hooks - Update

Riferimento

Servizio:: Azure AI Services

Versione API:: 2024-11-15

Aggiorna l'hook Web identificato dall'ID specificato.
Se il segreto della proprietà nella configurazione viene omesso o contiene una stringa vuota, i callback futuri non conterranno intestazioni X-MicrosoftSpeechServices-Signature. Se la proprietà contiene una stringa non vuota, verrà usata 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.

Se l'URL cambia, l'hook Web smetterà di ricevere eventi 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.

PATCH {endpoint}/speechtotext/webhooks/{id}?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).
id	path	True	string uuid	Identificatore dell'hook Web.
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

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

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

Corpo della richiesta

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

Nome	Tipo	Descrizione
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	Nome dell'oggetto.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string	URL registrato a cui inviare le richieste POST per gli eventi registrati.

Risposte

Nome	Tipo	Descrizione
200 OK	WebHook	OK Intestazioni Retry-After: integer
Other Status Codes	Error	Si è verificato un errore.

Nome

Tipo

Descrizione

200 OK

WebHook

Intestazioni

Retry-After: integer

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

Update a web hook

Esempio di richiesta

HTTP

PATCH {endpoint}/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.",
  "webUrl": "https://contoso.com/call/me/back",
  "customProperties": {
    "key": "value"
  },
  "properties": {
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "events": {
    "evaluationCreation": true,
    "evaluationProcessing": true,
    "evaluationCompletion": true,
    "evaluationDeletion": true
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "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": "Succeeded",
  "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
WebHookPropertiesUpdate	WebHookPropertiesUpdate
WebHookUpdate	WebHookUpdate

DetailedErrorCode

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

EntityError

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

Error

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

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

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

Stato

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

WebHook

Nome	Tipo	Descrizione
createdDateTime	string	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	Nome visualizzato dell'oggetto.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string	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	Posizione dell'entità.
status	Status	Stato Descrivere lo stato corrente dell'API.
webUrl	string	URL registrato a cui inviare le richieste POST per gli eventi registrati.

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

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

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.

WebHookPropertiesUpdate

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

WebHookUpdate

Nome	Tipo	Descrizione
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	Nome dell'oggetto.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string	URL registrato a cui inviare le richieste POST per gli eventi registrati.

Condividi tramite

Web Hooks - Update

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Esempio

Update a web hook

Esempio di richiesta

Risposta di esempio

Definizioni

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate

Risorse aggiuntive