Web Hooks - Update

Riferimento

Servizio:: Azure AI Services

Versione API:: v3.2-preview.2

Aggiornamenti 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 contengono 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 durante la chiamata all'URL registrato.

Se l'URL viene modificato, l'hook Web interromperà la ricezione di eventi fino al completamento di una richiesta/risposta. A tale scopo, verrà eseguita una richiesta con la richiesta di tipo di evento con un parametro di query denominato validationToken. Rispondere alla richiesta con un 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/v3.2-preview.2/webhooks/{id}

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.

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 è 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 che verrà usato per 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 qui la chiave dell'account dei servizi cognitivi.

Tipo: apiKey
In: header

Authorization

Fornire un token di accesso dal JWT restituito dal servizio 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

Update a web hook

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:: 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"
}

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
DataImportFailed	string	Importazione dati non riuscita.
DeleteNotAllowed	string	Eliminazione non consentita.
DeployNotAllowed	string	Distribuire non consentito.
DeployingFailedModel	string	Distribuzione di un modello non riuscito.
EmptyRequest	string	Richiesta vuota.
EndpointCannotBeDefault	string	L'endpoint non può essere predefinito.
EndpointNotUpdatable	string	Endpoint non aggiornabile.
EndpointWithoutLogging	string	Endpoint senza registrazione.
ExceededNumberOfRecordingsUris	string	Superato il numero di uri delle registrazioni.
FailedDataset	string	Set di dati non riuscito.
Forbidden	string	Non consentito.
InUseViolation	string	Violazione dell'uso.
InaccessibleCustomerStorage	string	Archiviazione clienti inaccessibile.
InvalidAdaptationMapping	string	Mapping di adattamento non valido.
InvalidBaseModel	string	Modello di base non valido.
InvalidCallbackUri	string	URI di callback non valido.
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 di 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 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 registrazioni non valide.
InvalidRequestBodyFormat	string	Formato del corpo della richiesta non valido.
InvalidSasValidityDuration	string	Durata della validità della firma di accesso condiviso non valida.
InvalidSkipTokenForLogs	string	Token ignora 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 non valido da vivere.
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.
ModelCopyOperationExists	string	Esiste un'operazione di copia modello.
ModelDeploymentNotCompleteState	string	Distribuzione del modello non completa stato.
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.
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	Endpoint predefinito singolo.
SkuLimitsExist	string	Esistono limiti di SKU.
SubscriptionNotFound	string	Sottoscrizione non trovata.
UnexpectedError	string	Errore imprevisto.
UnsupportedClassBasedAdaptation	string	Adattamento basato su classi non supportate.
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[]	Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innerError	InnerError	InnerError Nuovo formato di errore interno conforme alle linee guida per l'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, details(coppia chiave-valore), errore interno(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

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	Rappresenta il codice di errore dell'argomento non valido.
InvalidRequest	string	Rappresenta il codice di errore della richiesta non valido.
NotAllowed	string	Rappresenta il 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	Rappresenta il codice di errore del servizio non disponibile.
TooManyRequests	string	Rappresenta il codice di errore troppe richieste.
Unauthorized	string	Rappresenta il codice di errore non autorizzato.
UnprocessableEntity	string	Rappresenta il codice di errore dell'entità non elaborabile.
UnsupportedMediaType	string	Rappresenta il codice di errore del tipo di supporto non supportato.

InnerError

Nome	Tipo	Descrizione
code	DetailedErrorCode	DetailedErrorCode Enumerazione dettagliata del codice di errore.
details	object	Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innerError	InnerError	InnerError Nuovo formato di errore interno conforme alle linee guida per l'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, details(coppia chiave-valore), errore interno(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

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 è 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 è 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 è 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. In questo modo viene definita la forma del payload nei callback. Se il tipo di payload non è più supportato, perché la forma è stata modificata e la versione dell'API che lo 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 durante la chiamata all'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 durante la chiamata all'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 è 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

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Authorization

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