Update Hook - Update Hook

Služba:: Azure AI Services

Verze rozhraní API:: v3.0

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/v3.0/webhooks/{id}

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.

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

Authorization

Zadejte přístupový token z JWT vráceného službou STS této oblasti. Nezapomeňte do tokenu přidat obor správy přidáním následujícího řetězce dotazu do adresy URL služby STS: ?scope=speechservicesmanagement

Typ: apiKey
V: header

Příklady

Update a web hook

Ukázkový požadavek

HTTP

PATCH https://westus.api.cognitive.microsoft.com//speechtotext/v3.0/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d

{
  "properties": {
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "events": {
    "evaluationCreation": true,
    "evaluationProcessing": true,
    "evaluationCompletion": true,
    "evaluationDeletion": true
  },
  "webUrl": "https://contoso.com/call/me/back",
  "displayName": "TranscriptionCompletionWebHook",
  "description": "I registered this URL to get a POST request for each completed transcription.",
  "customProperties": {
    "key": "value"
  }
}

Ukázková odpověď

Stavový kód:: 200

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

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
InvalidParameterValue	Neplatná hodnota parametru
InvalidRequestBodyFormat	Neplatný formát textu požadavku
EmptyRequest	Prázdný požadavek.
MissingInputRecords	Chybí vstupní záznamy.
InvalidDocument	Neplatný dokument
ModelVersionIncorrect	Verze modelu není správná.
InvalidDocumentBatch	Neplatná dávka dokumentu
UnsupportedLanguageCode	Nepodporovaný kód jazyka
DataImportFailed	Import dat se nezdařil.
InUseViolation	V narušení používání.
InvalidLocale	Neplatné národní prostředí
InvalidBaseModel	Neplatný základní model
InvalidAdaptationMapping	Neplatné mapování adaptací
InvalidDataset	Neplatná datová sada
InvalidTest	Neplatný test.
FailedDataset	Datová sada se nezdařila.
InvalidModel	Neplatný model.
InvalidTranscription	Neplatný přepis
InvalidPayload	Neplatná datová část
InvalidParameter	Neplatný parametr.
EndpointWithoutLogging	Koncový bod bez protokolování
InvalidPermissions	Neplatná oprávnění
InvalidPrerequisite	Neplatný požadavek.
InvalidProductId	Neplatné ID produktu
InvalidSubscription	Neplatné předplatné
InvalidProject	Neplatný projekt.
InvalidProjectKind	Neplatný druh projektu.
InvalidRecordingsUri	Identifikátor URI pro neplatné nahrávky
OnlyOneOfUrlsOrContainerOrDataset	Pouze jedna z adres URL nebo kontejneru nebo datové sady.
ExceededNumberOfRecordingsUris	Byl překročen počet nahrávek.
ModelMismatch	Neshoda modelů
ProjectGenderMismatch	Neshoda pohlaví projektu
ModelDeprecated	Model je zastaralý.
ModelExists	Model existuje.
ModelNotDeployable	Model nejde nasadit.
EndpointNotUpdatable	Koncový bod nejde aktualizovat.
SingleDefaultEndpoint	Jeden výchozí koncový bod
EndpointCannotBeDefault	Koncový bod nemůže být výchozí.
InvalidModelUri	Neplatný identifikátor URI modelu
SubscriptionNotFound	Předplatné se nenašlo.
QuotaViolation	Porušení kvóty
UnsupportedDelta	Nepodporovaný rozdíl.
UnsupportedFilter	Nepodporovaný filtr
UnsupportedPagination	Nepodporované stránkování
UnsupportedDynamicConfiguration	Nepodporovaná dynamická konfigurace
UnsupportedOrderBy	Nepodporované pořadí podle.
NoUtf8WithBom	Žádné utf8 s bom.
ModelDeploymentNotCompleteState	Nasazení modelu není dokončeno.
SkuLimitsExist	Existují omezení skladové položky.
DeployingFailedModel	Nasazení neúspěšného modelu
UnsupportedTimeRange	Nepodporovaný časový rozsah
InvalidLogDate	Neplatné datum protokolu
InvalidLogId	Neplatné ID protokolu
InvalidLogStartTime	Neplatný čas spuštění protokolu
InvalidLogEndTime	Neplatný čas ukončení protokolu
InvalidTopForLogs	Neplatný horní okraj pro protokoly.
InvalidSkipTokenForLogs	Neplatný token pro přeskočení protokolů
DeleteNotAllowed	Odstranění není povoleno.
Forbidden	Zakázaný.
DeployNotAllowed	Nasazení není povoleno.
UnexpectedError	Neočekávaná chyba
InvalidCollection	Neplatná kolekce.
InvalidCallbackUri	Neplatný identifikátor URI zpětného volání.
InvalidSasValidityDuration	Neplatná doba platnosti SAS.
InaccessibleCustomerStorage	Nepřístupné úložiště zákazníka
UnsupportedClassBasedAdaptation	Nepodporovaná úprava založená na třídách.
InvalidWebHookEventKind	Neplatný druh události webhooku
InvalidTimeToLive	Neplatný čas naživo.

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

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
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.
Failed	Dlouhotrvající operace se nezdařila.

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	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 Popis aktuálního stavu 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.
test	string (uri)	Adresa URL, která se dá použít k odesílání testovacích událostí na registrovanou adresu URL registrace webhooku.

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

Update Hook - Update Hook

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Authorization

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