Web Hooks - Create

Servizio:: Azure AI Services

Versione API:: v3.2-preview.2

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/v3.2-preview.2/webhooks

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

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

Authorization

Fornire un token di accesso dal token JWT restituito dal servizio token di sicurezza di questa area. Assicurarsi di aggiungere l'ambito di gestione al token aggiungendo la stringa di query seguente all'URL sts: ?scope=speechservicesmanagement

Tipo: apiKey
In: header

Esempio

Create a web hook

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 201

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

{
  "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": "NotStarted"
}

Definizioni

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

DetailedErrorCode

Enumerazione

DetailedErrorCode

Valore	Descrizione
InvalidParameterValue	Valore del parametro non valido.
InvalidRequestBodyFormat	Formato del corpo della richiesta non valido.
EmptyRequest	Richiesta vuota.
MissingInputRecords	Record di input mancanti.
InvalidDocument	Documento non valido.
ModelVersionIncorrect	Versione del modello non corretta.
InvalidDocumentBatch	Batch di documenti non valido.
UnsupportedLanguageCode	Codice del linguaggio non supportato.
DataImportFailed	Importazione dei dati non riuscita.
InUseViolation	In violazione dell'uso.
InvalidLocale	Impostazioni locali non valide.
InvalidBaseModel	Modello di base non valido.
InvalidAdaptationMapping	Mapping di adattamento non valido.
InvalidDataset	Set di dati non valido.
InvalidTest	Test non valido.
FailedDataset	Set di dati non riuscito.
InvalidModel	Modello non valido.
InvalidTranscription	Trascrizione non valida.
InvalidPayload	Payload non valido.
InvalidParameter	Parametro non valido.
EndpointWithoutLogging	Endpoint senza registrazione.
InvalidPermissions	Autorizzazioni non valide.
InvalidPrerequisite	Prerequisito non valido.
InvalidProductId	ID prodotto non valido.
InvalidSubscription	Sottoscrizione non valida.
InvalidProject	Progetto non valido.
InvalidProjectKind	Tipo di progetto non valido.
InvalidRecordingsUri	URI delle registrazioni non valido.
OnlyOneOfUrlsOrContainerOrDataset	Solo uno degli URL o del contenitore o del set di dati.
ExceededNumberOfRecordingsUris	È stato superato il numero di URI delle registrazioni.
ModelMismatch	Mancata corrispondenza del modello.
ProjectGenderMismatch	Mancata corrispondenza di genere del progetto.
ModelDeprecated	Modello deprecato.
ModelExists	Il modello esiste.
ModelNotDeployable	Modello non distribuibile.
EndpointNotUpdatable	Endpoint non aggiornabile.
SingleDefaultEndpoint	Singolo endpoint predefinito.
EndpointCannotBeDefault	L'endpoint non può essere predefinito.
InvalidModelUri	URI del modello non valido.
SubscriptionNotFound	Sottoscrizione non trovata.
QuotaViolation	Violazione della quota.
UnsupportedDelta	Delta non supportato.
UnsupportedFilter	Filtro non supportato.
UnsupportedPagination	Impaginazione non supportata.
UnsupportedDynamicConfiguration	Configurazione dinamica non supportata.
UnsupportedOrderBy	Ordine non supportato per.
NoUtf8WithBom	Nessun utf8 con bom.
ModelDeploymentNotCompleteState	Lo stato della distribuzione del modello non è completo.
SkuLimitsExist	Esistono limiti di SKU.
DeployingFailedModel	Distribuzione del modello non riuscito.
UnsupportedTimeRange	Intervallo di tempo non supportato.
InvalidLogDate	Data del log non valida.
InvalidLogId	ID log non valido.
InvalidLogStartTime	Ora di inizio del log non valida.
InvalidLogEndTime	Ora di fine del log non valida.
InvalidTopForLogs	Top non valido per i log.
InvalidSkipTokenForLogs	Token skip non valido per i log.
DeleteNotAllowed	Eliminazione non consentita.
Forbidden	Vietato.
DeployNotAllowed	Distribuzione non consentita.
UnexpectedError	Errore imprevisto.
InvalidCollection	Raccolta non valida.
InvalidCallbackUri	URI di callback non valido.
InvalidSasValidityDuration	Durata della validità della firma di accesso condiviso non valida.
InaccessibleCustomerStorage	Archiviazione dei clienti inaccessibile.
UnsupportedClassBasedAdaptation	Adattamento basato su classe non supportato.
InvalidWebHookEventKind	Tipo di evento web hook non valido.
InvalidTimeToLive	Tempo di vita non valido.
InvalidSourceAzureResourceId	ID risorsa di Azure di origine non valido.
ModelCopyOperationExists	Esiste un'operazione di copia del modello.

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	Codice Errore 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	Indica l'origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

ErrorCode

Enumerazione

Codice Errore

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

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	Indica l'origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

Status

Enumerazione

Stato

Valore	Descrizione
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.
Failed	L'operazione a esecuzione prolungata non è riuscita.

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.