Web Hooks - Create

Reference

Služba:: Azure AI Services

Verze rozhraní API:: v3.2-preview.2

Vytvoří nový web hook.
Pokud tajný klíč vlastnosti v konfiguraci existuje a 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 nastaví jako hlavička X-MicrosoftSpeechServices-Signature při volání zpět na registrovanou adresu URL.

Při zpětném volání na registrovanou adresu URL bude požadavek obsahovat hlavičku X-MicrosoftSpeechServices-Event obsahující jeden z registrovaných typů událostí. Pro každý zaregistrovaný typ události bude existovat jeden požadavek.

Po úspěšné registraci webového háku nebude možné ho použít, dokud se nedokončí výzva nebo odpověď. Za tímto účelem se vytvoří požadavek s výzvou typu události s parametrem dotazu s názvem validationToken. Odpovězte na výzvu pomocí 200 OK obsahující hodnotu parametru dotazu validationToken jako tělo odpovědi. Po úspěšném dokončení výzvy nebo odpovědi začne web hook přijímat události.

POST {endpoint}/speechtotext/v3.2-preview.2/webhooks

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

Text požadavku

Name	Vyžadováno	Typ	Description
displayName	True	string	Zobrazovaný název objektu.
events	True	WebHookEvents	WebHookEvents
webUrl	True	string	Registrovaná adresa URL, která se použije k odesílání požadavků POST na registrované události.
customProperties		object	Vlastní vlastnosti této entity. Maximální povolená délka klíče je 64 znaků, maximální délka povolené hodnoty je 256 znaků a počet povolených položek je 10.
description		string	Popis objektu.
properties		WebHookProperties	WebHookProperties

Odpovědi

Name	Typ	Description
201 Created	WebHook	Odpověď obsahuje informace o entitě jako datové části a jejím umístění jako hlavičce. Hlavičky Location: string
Other Status Codes	Error	Došlo k chybě.

Name

Typ

Description

201 Created

WebHook

Odpověď obsahuje informace o entitě jako datové části a jejím umístění jako hlavičce.

Hlavičky

Location: string

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ý 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

Create a web hook

Ukázkový požadavek

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/webhooks

{
  "displayName": "TranscriptionCompletionWebHook",
  "properties": {
    "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."
}

Ukázková odpověď

Stavový kód:: 201

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

{
  "displayName": "TranscriptionCompletionWebHook",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d",
  "links": {
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test",
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping"
  },
  "properties": {
    "apiVersion": "v3.2-preview.2",
    "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": "NotStarted"
}

Definice

Name	Description
DetailedErrorCode	Podrobný kód chyby
EntityError	Chyba entity
Error	Chyba
ErrorCode	ErrorCode
InnerError	Vnitřní chyba
Status	Stav
WebHook	Webhook
WebHookEvents	WebHookEvents
WebHookLinks	Odkazy na webhook
WebHookProperties	Vlastnosti webhooku

DetailedErrorCode

Podrobný kód chyby

Name	Typ	Description
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
EmptyRequest	string	Prázdný požadavek.
EndpointCannotBeDefault	string	Koncový bod nemůže být výchozí.
EndpointNotUpdatable	string	Koncový bod není možné aktualizovat.
EndpointWithoutLogging	string	Koncový bod bez protokolování
ExceededNumberOfRecordingsUris	string	Překročili jsme počet nahrávek uris.
FailedDataset	string	Datová sada selhala.
Forbidden	string	Zakázáno.
InUseViolation	string	Porušení používání.
InaccessibleCustomerStorage	string	Nepřístupné úložiště zákazníka.
InvalidAdaptationMapping	string	Neplatné mapování adaptace
InvalidBaseModel	string	Neplatný základní model
InvalidCallbackUri	string	Neplatný identifikátor URI zpětného volání
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ý koncový čas 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á podmínka.
InvalidProductId	string	Neplatné ID produktu
InvalidProject	string	Neplatný projekt.
InvalidProjectKind	string	Neplatný druh projektu.
InvalidRecordingsUri	string	Neplatný identifikátor URI nahrávek
InvalidRequestBodyFormat	string	Neplatný formát textu požadavku.
InvalidSasValidityDuration	string	Neplatná doba platnosti sas.
InvalidSkipTokenForLogs	string	Neplatný token skip pro protokoly.
InvalidSourceAzureResourceId	string	Neplatné ID zdrojového prostředku Azure.
InvalidSubscription	string	Neplatné předplatné
InvalidTest	string	Neplatný test
InvalidTimeToLive	string	Neplatný čas do života.
InvalidTopForLogs	string	Neplatná horní část pro protokoly.
InvalidTranscription	string	Neplatný přepis.
InvalidWebHookEventKind	string	Neplatný druh události web hooku
MissingInputRecords	string	Chybí vstupní záznamy.
ModelCopyOperationExists	string	Existuje operace kopírování modelu.
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	Nesprávná verze modelu.
NoUtf8WithBom	string	Ne utf8 s bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Pouze jednu z adres URL nebo kontejneru nebo datové sady.
ProjectGenderMismatch	string	Neshoda mezi pohlavími projektu.
QuotaViolation	string	Porušení kvóty.
SingleDefaultEndpoint	string	Jeden výchozí koncový bod.
SkuLimitsExist	string	Existují omezení skladových položek.
SubscriptionNotFound	string	Předplatné se nenašlo.
UnexpectedError	string	Neočekávaná chyba.
UnsupportedClassBasedAdaptation	string	Nepodporovaná adaptace na základě tříd.
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

Chyba entity

Name	Typ	Description
code	string	Kód této chyby.
message	string	Zpráva o této chybě.

Error

Chyba

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

ErrorCode

Name	Typ	Description
Conflict	string	Představuje kód chyby konfliktu.
Forbidden	string	Představuje kód chyby Zakázáno.
InternalCommunicationFailed	string	Představuje kód chyby vnitřní komunikace, která selhala.
InternalServerError	string	Představuje kód 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 nepovolený kód chyby.
NotFound	string	Představuje kód chyby nenalezena.
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š mnoho požadavků.
Unauthorized	string	Představuje neoprávněný kód chyby.
UnprocessableEntity	string	Představuje kód chyby nezpracované entity.
UnsupportedMediaType	string	Představuje kód chyby nepodporovaného typu média.

InnerError

Vnitřní chyba

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

Status

Stav

Name	Typ	Description
Failed	string	Dlouhotrvající operace selhala.
NotStarted	string	Dlouhotrvající operace se ještě nespustila.
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, kdy byl objekt vytvořen. Časové razítko je kódované 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 hodnoty 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ódované 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	Odkazy na webhook
properties	WebHookProperties	Vlastnosti webhooku
self	string	Umístění této entity
status	Status	Stav Popis aktuálního stavu rozhraní API
webUrl	string	Registrovaná adresa URL, která se použije k odesílání požadavků POST na registrované události.

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

Odkazy na webhook

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

WebHookProperties

Vlastnosti webhooku

Name	Typ	Description
apiVersion	string	Verze rozhraní API, ve které byl webhook vytvořen. To definuje tvar datové části ve zpětných voláních. Pokud se typ datové části už nepodporuje, protože se změnil tvar a verze rozhraní API, která ho používá, se odebere (po vyřazení), webhook se zakáže.
error	EntityError	Chyba entity
secret	string	Tajný kód, 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 zpětném volání do registrované adresy URL nastaví jako hlavička X-MicrosoftSpeechServices-Signature.

Sdílet prostřednictvím

Web Hooks - Create

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Authorization

Příklady

Create a web hook

Ukázkový požadavek

Ukázková odpověď

Definice

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

Další materiály