Web Hooks - Update

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2024-11-15

Aktualizuje webhook identifikovaný daným ID.
Pokud je tajný klíč vlastnosti v konfiguraci vynechán nebo obsahuje prázdný řetězec, budoucí zpětná volání nebudou obsahovat hlavičky XMicrosoftSpeechServices-Signature. Pokud vlastnost obsahuje neprázdný řetězec, použije se 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.

Pokud se adresa URL změní, webhook přestane přijímat události, dokud se nedokončí výzva nebo odpověď. K tomu se vytvoří požadavek s výzvou typu události s parametrem dotazu s názvem validationToken. Odpovězte na výzvu s ok 200 obsahující hodnotou parametru dotazu validationToken jako text odpovědi. Po úspěšném dokončení výzvy nebo odpovědi začne webhook přijímat události.

PATCH {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

Media Types: "application/json", "application/merge-patch+json"

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

Text požadavku

Media Types: "application/json", "application/merge-patch+json"

Name	Typ	Description
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	Název objektu.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	Registrovaná adresa URL, která se použije k odesílání požadavků POST na registrované události.

Odpovědi

Name	Typ	Description
200 OK	WebHook	OK Hlavičky Retry-After: integer
Other Status Codes	Error	Došlo k chybě.

Name

Typ

Description

200 OK

WebHook

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

Update a web hook

Ukázkový požadavek

HTTP

PATCH {endpoint}/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.",
  "webUrl": "https://contoso.com/call/me/back",
  "customProperties": {
    "key": "value"
  },
  "properties": {
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "events": {
    "evaluationCreation": true,
    "evaluationProcessing": true,
    "evaluationCompletion": true,
    "evaluationDeletion": true
  }
}

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
WebHookPropertiesUpdate	WebHookPropertiesUpdate
WebHookUpdate	WebHookUpdate

DetailedErrorCode

Výčet

DetailedErrorCode

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

EntityError

Objekt

EntityError

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

Error

Objekt

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

Výčet

Kód chyby

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

InnerError

Objekt

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

Výčet

Stav

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

WebHook

Objekt

WebHook

Name	Typ	Description
createdDateTime	string (date-time)	Č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 minLength: 1	Zobrazovaný název objektu.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string (date-time)	Č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 (uri)	Umístění této entity.
status	Status	Stav Popište aktuální stav rozhraní API.
webUrl	string (uri)	Registrovaná adresa URL, která se použije k odesílání požadavků POST na registrované události.

WebHookEvents

Objekt

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

Objekt

WebHookLinks

Name	Typ	Description
ping	string (uri)	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 (uri)	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

Objekt

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.

WebHookPropertiesUpdate

Objekt

WebHookPropertiesUpdate

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

WebHookUpdate

Objekt

WebHookUpdate

Name	Typ	Description
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	Název objektu.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	Registrovaná adresa URL, která se použije k odesílání požadavků POST na registrované události.

Sdílet prostřednictvím

Web Hooks - Update

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Příklady

Update a web hook

Ukázkový požadavek

Ukázková odpověď

Definice

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate

Další materiály