Web Hooks - Ping
Invia un evento ping all'URL registrato.
Il corpo della richiesta POST inviato all'URL dell'hook Web registrato è della stessa forma della richiesta GET per un hook specifico.
L'ID dello schema Swagger del modello è WebHookV3.
La richiesta conterrà un'intestazione X-MicrosoftSpeechServices-Event con il valore ping. Se l'hook Web è stato registrato con un segreto, conterrà un'intestazione X-MicrosoftSpeechServices-Signature con un hash SHA256 del payload con il segreto come chiave HMAC. L'hash è codificato in base64.
POST {endpoint}/speechtotext/v3.1/webhooks/{id}:pingParametri 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 da eseguire per il ping. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 202 Accepted |
È stato avviato il tentativo di inviare una richiesta ping all'hook Web. Intestazioni Retry-After: integer |
|
| Other Status Codes |
Si è verificato un errore. |
Sicurezza
Ocp-Apim-Subscription-Key
Specificare qui la chiave dell'account di Servizi cognitivi.
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
Ping a web hook
Esempio di richiesta
POST {endpoint}/speechtotext/v3.1/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping
Risposta di esempio
Definizioni
| Nome | Descrizione |
|---|---|
|
Detailed |
DettagliErrorCode |
| Error |
Errore |
|
Error |
ErrorCode |
|
Inner |
InnerError |
DetailedErrorCode
DettagliErrorCode
| Valore | Descrizione |
|---|---|
| DataImportFailed |
Importazione dei dati non riuscita. |
| DeleteNotAllowed |
Eliminazione non consentita. |
| DeployNotAllowed |
Distribuire non consentito. |
| DeployingFailedModel |
Distribuzione di un modello non riuscito. |
| EmptyRequest |
Richiesta vuota. |
| EndpointCannotBeDefault |
L'endpoint non può essere predefinito. |
| EndpointNotUpdatable |
Endpoint non aggiornabile. |
| EndpointWithoutLogging |
Endpoint senza registrazione. |
| ExceededNumberOfRecordingsUris |
Superato il numero di uri delle registrazioni. |
| FailedDataset |
Set di dati non riuscito. |
| Forbidden |
Non consentito. |
| InUseViolation |
In violazione dell'uso. |
| InaccessibleCustomerStorage |
Archiviazione dei clienti inaccessibile. |
| InvalidAdaptationMapping |
Mapping di adattamento non valido. |
| InvalidBaseModel |
Modello di base non valido. |
| InvalidCallbackUri |
URI di callback non valido. |
| 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 di 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 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 registrazioni non valide. |
| InvalidRequestBodyFormat |
Formato del corpo della richiesta non valido. |
| InvalidSasValidityDuration |
Durata di validità della firma di accesso condiviso non valida. |
| InvalidSkipTokenForLogs |
Token ignora non valido per i log. |
| InvalidSubscription |
Sottoscrizione non valida. |
| InvalidTest |
Test non valido. |
| InvalidTimeToLive |
Tempo non valido per la durata. |
| InvalidTopForLogs |
Top non valido per i log. |
| InvalidTranscription |
Trascrizione non valida. |
| InvalidWebHookEventKind |
Tipo di evento web hook non valido. |
| MissingInputRecords |
Record di input mancanti. |
| ModelDeploymentNotCompleteState |
Distribuzione del modello non completa stato. |
| ModelDeprecated |
Modello deprecato. |
| ModelExists |
Il modello esiste. |
| ModelMismatch |
Mancata corrispondenza del modello. |
| ModelNotDeployable |
Modello non distribuibile. |
| ModelVersionIncorrect |
Versione del modello non corretta. |
| 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 |
Endpoint predefinito singolo. |
| SkuLimitsExist |
Esistono limiti di SKU. |
| SubscriptionNotFound |
Sottoscrizione non trovata. |
| UnexpectedError |
Errore imprevisto. |
| UnsupportedClassBasedAdaptation |
Adattamento basato sulla 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. |
Error
Errore
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
ErrorCode |
|
| details |
Error[] |
Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti. |
| innerError |
InnerError |
|
| message |
string |
Messaggio di errore di alto livello. |
| target |
string |
Indica l'origine dell'errore. Ad esempio, sarebbe "documenti" o "ID documento" nel caso di documento non valido. |
ErrorCode
ErrorCode
| Valore | Descrizione |
|---|---|
| Conflict |
Rappresenta il codice di errore del conflitto. |
| Forbidden |
Rappresenta il codice di errore non consentito. |
| InternalCommunicationFailed |
Rappresentazione del codice di errore interno della comunicazione non riuscita. |
| InternalServerError |
Rappresenta il codice di errore del server interno. |
| InvalidArgument |
Rappresenta il codice di errore dell'argomento non valido. |
| InvalidRequest |
Rappresenta il codice di errore della richiesta non valido. |
| NotAllowed |
Rappresenta il codice di errore non consentito. |
| NotFound |
Rappresenta il codice di errore non trovato. |
| PipelineError |
Rappresenta il codice di errore della pipeline. |
| ServiceUnavailable |
Rappresenta il codice di errore non disponibile del servizio. |
| TooManyRequests |
Rappresenta il codice di errore di troppe richieste. |
| Unauthorized |
Rappresenta il codice di errore non autorizzato. |
| UnprocessableEntity |
Rappresenta il codice di errore dell'entità non elaborabile. |
| UnsupportedMediaType |
Rappresenta il codice di errore del tipo di supporto non supportato. |
InnerError
InnerError
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
DettagliErrorCode |
|
| details |
object |
Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti. |
| innerError |
InnerError |
|
| message |
string |
Messaggio di errore di alto livello. |
| target |
string |
Indica l'origine dell'errore. Ad esempio, sarebbe "documenti" o "ID documento" nel caso di documento non valido. |