Web Hooks - Ping

Servizio:

Azure AI Services

Versione API:

2024-11-15

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/webhooks/{id}:ping?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 da eseguire per il ping.
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.

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	Error	Si è verificato un errore.

Sicurezza

Ocp-Apim-Subscription-Key

Specificare la chiave dell'account di Servizi cognitivi qui.

Tipo: apiKey
In: header

Esempio

Ping a web hook

Esempio di richiesta

HTTP

POST {endpoint}/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-11-15

Risposta di esempio

Codice di stato:

202

Definizioni

Nome	Descrizione
DetailedErrorCode	DetailedErrorCode
Error	Errore
ErrorCode	ErrorCode
InnerError	InnerError

DetailedErrorCode

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.

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

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

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.