Web Hooks - Test

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2024-11-15

Odešle požadavek na každý zaregistrovaný typ události na registrovanou adresu URL.
Datová část se vygeneruje z poslední entity, která by vyvolala webhooku. Pokud žádná entita není k dispozici pro žádný z registrovaných typů událostí, post odpoví 204. Pokud je možné provést testovací požadavek, odpoví 200. Požadavek bude obsahovat hlavičku X-MicrosoftSpeechServices-Event s příslušným registrovaným typem události. Pokud byl webhook zaregistrován tajným kódem, bude obsahovat hlavičku X-MicrosoftSpeechServices-Signature s hodnotou hash SHA256 datové části s tajným kódem jako klíčem HMAC. Hodnota hash je zakódovaná v base64.

POST {endpoint}/speechtotext/webhooks/{id}:test?api-version=2024-11-15

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	Identifikátor webhooku pro příkaz ping.
api-version	query	True	string	Požadovaná verze rozhraní API.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Tady zadejte svůj klíč účtu služeb Cognitive Services.

Odpovědi

Name	Typ	Description
202 Accepted		Do registrovaného webového háku se odešle testovací požadavek s poslední entitou. Hlavičky Retry-After: integer
204 No Content		Pro žádný typ události nebyla nalezena žádná entita, takže se do registrovaného webového hoku neposílají žádné testovací požadavky.
Other Status Codes	Error	Došlo k chybě.

Name

Typ

Description

202 Accepted

Do registrovaného webového háku se odešle testovací požadavek s poslední entitou.

Hlavičky

Retry-After: integer

204 No Content

Pro žádný typ události nebyla nalezena žádná entita, takže se do registrovaného webového hoku neposílají žádné testovací požadavky.

Other Status Codes

Error

Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Tady zadejte svůj klíč účtu služeb Cognitive Services.

Typ: apiKey
V: header

Příklady

Test a web hook

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 202

Stavový kód:: 204

Definice

Name	Description
DetailedErrorCode	DetailedErrorCode
Error	Chyba
ErrorCode	Kód chyby
InnerError	Vnitřní chyba

DetailedErrorCode

Name	Typ	Description
AudioLengthLimitExceeded	string	Zvukový soubor je delší než maximální povolená doba trvání.
BadChannelConfiguration	string	Mezi zvukovými kanály v datech, konfigurací nebo požadavky aplikace se neshoduje.
DataImportFailed	string	Import dat se nezdařil.
DeleteNotAllowed	string	Odstranění není povoleno.
DeployNotAllowed	string	Nasazení není povoleno.
DeployingFailedModel	string	Nasazení neúspěšného modelu
EmptyAudioFile	string	Zvukový soubor je prázdný.
EmptyRequest	string	Prázdný požadavek.
EndpointCannotBeDefault	string	Koncový bod nemůže být výchozí.
EndpointLoggingNotSupported	string	Protokolování koncového bodu se nepodporuje.
EndpointNotUpdatable	string	Koncový bod nejde aktualizovat.
EndpointWithoutLogging	string	Koncový bod bez protokolování
ExceededNumberOfRecordingsUris	string	Byl překročen počet nahrávek.
FailedDataset	string	Datová sada se nezdařila.
Forbidden	string	Zakázaný.
InUseViolation	string	V narušení používání.
InaccessibleCustomerStorage	string	Nepřístupné úložiště zákazníka
InvalidAdaptationMapping	string	Neplatné mapování adaptací
InvalidAudioFormat	string	Formát vstupního zvuku není podporován.
InvalidBaseModel	string	Neplatný základní model
InvalidCallbackUri	string	Neplatný identifikátor URI zpětného volání.
InvalidChannelSpecification	string	Výběr kanálů v žádosti o přepis se nepodporuje (například 0 ani 1 nebylo vybráno.)
InvalidChannels	string	Neplatné kanály.
InvalidCollection	string	Neplatná kolekce.
InvalidDataset	string	Neplatná datová sada
InvalidDocument	string	Neplatný dokument
InvalidDocumentBatch	string	Neplatná dávka dokumentu
InvalidLocale	string	Neplatné národní prostředí
InvalidLogDate	string	Neplatné datum protokolu
InvalidLogEndTime	string	Neplatný čas ukončení protokolu
InvalidLogId	string	Neplatné ID protokolu
InvalidLogStartTime	string	Neplatný čas spuštění protokolu
InvalidModel	string	Neplatný model.
InvalidModelUri	string	Neplatný identifikátor URI modelu
InvalidParameter	string	Neplatný parametr.
InvalidParameterValue	string	Neplatná hodnota parametru
InvalidPayload	string	Neplatná datová část
InvalidPermissions	string	Neplatná oprávnění
InvalidPrerequisite	string	Neplatný požadavek.
InvalidProductId	string	Neplatné ID produktu
InvalidProject	string	Neplatný projekt.
InvalidProjectKind	string	Neplatný druh projektu.
InvalidRecordingsUri	string	Identifikátor URI pro neplatné nahrávky
InvalidRequestBodyFormat	string	Neplatný formát textu požadavku
InvalidSasValidityDuration	string	Neplatná doba platnosti SAS.
InvalidSkipTokenForLogs	string	Neplatný token pro přeskočení protokolů
InvalidSourceAzureResourceId	string	Neplatné ID zdroje prostředku Azure
InvalidSubscription	string	Neplatné předplatné
InvalidTest	string	Neplatný test.
InvalidTimeToLive	string	Neplatný čas naživo.
InvalidTopForLogs	string	Neplatný horní okraj pro protokoly.
InvalidTranscription	string	Neplatný přepis
InvalidWebHookEventKind	string	Neplatný druh události webhooku
MissingInputRecords	string	Chybí vstupní záznamy.
ModelCopyAuthorizationExpired	string	Platnost modeluCopyAuthorization vypršela.
ModelDeploymentNotCompleteState	string	Nasazení modelu není dokončeno.
ModelDeprecated	string	Model je zastaralý.
ModelExists	string	Model existuje.
ModelMismatch	string	Neshoda modelů
ModelNotDeployable	string	Model nejde nasadit.
ModelVersionIncorrect	string	Verze modelu není správná.
MultipleLanguagesIdentified	string	Identifikace jazyka rozpoznala více jazyků. Nelze určit žádný dominantní jazyk.
NoLanguageIdentified	string	Identifikace jazyka nerozpoznala žádný jazyk.
NoUtf8WithBom	string	No utf8 with bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Pouze jedna z adres URL nebo kontejneru nebo datové sady.
ProjectGenderMismatch	string	Neshoda pohlaví projektu
QuotaViolation	string	Porušení kvóty
SingleDefaultEndpoint	string	Jeden výchozí koncový bod
SkuLimitsExist	string	Existují omezení skladové položky.
SubscriptionNotFound	string	Předplatné se nenašlo.
UnexpectedError	string	Neočekávaná chyba
UnsupportedClassBasedAdaptation	string	Nepodporovaná úprava založená na třídách.
UnsupportedDelta	string	Nepodporovaný rozdíl.
UnsupportedDynamicConfiguration	string	Nepodporovaná dynamická konfigurace
UnsupportedFilter	string	Nepodporovaný filtr
UnsupportedLanguageCode	string	Nepodporovaný kód jazyka
UnsupportedOrderBy	string	Nepodporované pořadí podle.
UnsupportedPagination	string	Nepodporované stránkování
UnsupportedTimeRange	string	Nepodporovaný časový rozsah

Error

Chyba

Name	Typ	Description
code	ErrorCode	Kód chyby Kódy chyb vysoké úrovně.
details	Error[]	Další podrobnosti podpory týkající se chyb a/nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřní chyby, který odpovídá pokynům rozhraní API služeb Cognitive Services, které jsou k dispozici v https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message and optional properties target, details(key value pair), inner error(this can be vnořováno).
message	string	Chybová zpráva vysoké úrovně
target	string	Zdroj chyby. Například v případě neplatného dokumentu by to bylo "dokumenty" nebo "ID dokumentu".

ErrorCode

Kód chyby

Name	Typ	Description
Conflict	string	Představuje kód chyby konfliktu.
Forbidden	string	Představuje zakázaný kód chyby.
InternalCommunicationFailed	string	Představuje kód chyby selhání interní komunikace.
InternalServerError	string	Představuje kód chyby vnitřní chyby serveru.
InvalidArgument	string	Představuje neplatný kód chyby argumentu.
InvalidRequest	string	Představuje neplatný kód chyby požadavku.
NotAllowed	string	Představuje kód chyby, který není povolený.
NotFound	string	Představuje kód chyby, který nebyl nalezen.
PipelineError	string	Představuje kód chyby kanálu.
ServiceUnavailable	string	Představuje kód chyby nedostupné služby.
TooManyRequests	string	Představuje kód chyby příliš velkého počtu požadavků.
Unauthorized	string	Představuje neautorizovaný kód chyby.
UnprocessableEntity	string	Představuje nezpracovaný kód chyby entity.
UnsupportedMediaType	string	Představuje nepodporovaný kód chyby typu média.

InnerError

Vnitřní chyba

Name	Typ	Description
code	DetailedErrorCode	DetailedErrorCode Podrobný výčet kódu chyby
details	object	Další podrobnosti podpory týkající se chyb a/nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřní chyby, který odpovídá pokynům rozhraní API služeb Cognitive Services, které jsou k dispozici v https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message and optional properties target, details(key value pair), inner error(this can be vnořováno).
message	string	Chybová zpráva vysoké úrovně
target	string	Zdroj chyby. Například v případě neplatného dokumentu by to bylo "dokumenty" nebo "ID dokumentu".

Sdílet prostřednictvím

Web Hooks - Test

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Příklady

Test a web hook

Ukázkový požadavek

Ukázková odpověď

Definice

DetailedErrorCode

Error

ErrorCode

InnerError

Další materiály