Web Hooks - Get

Služba:

Azure AI Services

Verze rozhraní API:

2024-11-15

Získá webhook identifikovaný daným ID.

GET {endpoint}/speechtotext/webhooks/{id}?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.
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
200 OK	WebHook	OK Hlavičky Retry-After: integer
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

Get a web hook

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-11-15",
  "displayName": "TranscriptionCompletionWebHook",
  "description": "I registered this URL to get a POST request for each completed transcription.",
  "properties": {
    "apiVersion": "2024-11-15",
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "createdDateTime": "2018-11-11T00:00:00Z",
  "lastActionDateTime": "2018-11-28T00:00:00Z",
  "status": "Succeeded",
  "links": {
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-11-15",
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-11-15"
  }
}

Definice

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Chyba
ErrorCode	Kód chyby
InnerError	Vnitřní chyba
Status	Stav
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties

DetailedErrorCode

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

EntityError

EntityError

Name	Typ	Description
code	string	Kód této chyby.
message	string	Zpráva pro tuto chybu.

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

Status

Stav

Name	Typ	Description
Failed	string	Dlouhotrvající operace se nezdařila.
NotStarted	string	Dlouhotrvající operace ještě nebyla spuštěna.
Running	string	Dlouhotrvající operace se právě zpracovává.
Succeeded	string	Dlouhotrvající operace byla úspěšně dokončena.

WebHook

WebHook

Name	Typ	Description
createdDateTime	string	Časové razítko při vytvoření objektu. Časové razítko je kódováno jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Vlastní vlastnosti této entity. Maximální povolená délka klíče je 64 znaků, maximální povolená délka je 256 znaků a počet povolených položek je 10.
description	string	Popis objektu.
displayName	string	Zobrazovaný název objektu.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string	Časové razítko, kdy byl zadán aktuální stav. Časové razítko je kódováno jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string	Umístění této entity.
status	Status	Stav Popište aktuální stav rozhraní API.
webUrl	string	Registrovaná adresa URL, která se použije k odesílání požadavků POST na registrované události.

WebHookEvents

WebHookEvents

Name	Typ	Description
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

WebHookLinks

Name	Typ	Description
ping	string	Adresa URL, která se dá použít k aktivaci odesílání události ping na registrovanou adresu URL registrace webhooku. Další podrobnosti najdete v operaci "WebHooks_Ping".
test	string	Adresa URL, která se dá použít k odesílání testovacích událostí na registrovanou adresu URL registrace webhooku. Další podrobnosti najdete v operaci "WebHooks_Test".

WebHookProperties

WebHookProperties

Name	Typ	Description
apiVersion	string	Verze rozhraní API, ve které byl webhook vytvořen. Tím se definuje tvar datové části v zpětných voláních. Pokud už typ datové části není podporovaný, protože se změnil obrazec a verze rozhraní API, která ho používá, se odebere (po vyřazení), webový háček se zakáže.
error	EntityError	EntityError
secret	string	Tajný klíč, který se použije k vytvoření hodnoty hash SHA256 datové části s tajným kódem jako klíčem HMAC. Tato hodnota hash se při volání zpět do registrované adresy URL nastaví jako hlavička X-MicrosoftSpeechServices-Signature.