Web Hooks - Create

Szolgáltatás:
Azure AI Services
API-verzió:
v3.2-preview.2

Új webes horogot hoz létre.
Ha a konfigurációban található tulajdonságkulcs egy nem üres sztringet tartalmaz, a rendszer a hasznos adatok SHA256-kivonatának létrehozásához használja hMAC-kulccsal. Ez a kivonat X-MicrosoftSpeechServices-Signature fejlécként lesz beállítva a regisztrált URL-címre való visszahíváskor.

A regisztrált URL-címre való visszahíváskor a kérés egy X-MicrosoftSpeechServices-Event fejlécet tartalmaz, amely a regisztrált eseménytípusok egyikét tartalmazza. Regisztrált eseménytípusonként egy kérés lesz.

A webes horog sikeres regisztrálása után nem használható, amíg egy feladat/válasz be nem fejeződik. Ehhez az eseménytípus-kihívással kapcsolatos kérést a rendszer egy validationToken nevű lekérdezési paraméterrel küldi el. Válaszoljon a kihívásra egy 200 OK-val, amely a validationToken lekérdezési paraméter értékét tartalmazza válasz törzsként. Ha a feladat/válasz sikeresen befejeződött, a webes horog elkezd eseményeket fogadni.

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

URI-paraméterek

Name In Kötelező Típus Description
endpoint
 path True

string

Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus.api.cognitive.microsoft.com).

Kérelem törzse

Name Kötelező Típus Description
displayName True

string

minLength: 1

Az objektum megjelenítendő neve.
events True

WebHookEvents

WebHookEvents
webUrl True

string (uri)

A regisztrált események POST-kéréseinek küldéséhez használt regisztrált URL-cím.
customProperties

object

Az entitás egyéni tulajdonságai. A maximálisan megengedett kulcshossz 64 karakter, az engedélyezett érték maximális hossza 256 karakter, az engedélyezett bejegyzések száma pedig 10.
description

string

Az objektum leírása.
properties

WebHookProperties

WebHookProperties

Válaszok

Name Típus Description
201 Created

WebHook

A válasz hasznos adatként tartalmazza az entitás adatait és fejlécként való helyét.

Fejlécek

Location: string
Other Status Codes

Error

Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Itt adja meg a Cognitive Services-fiókkulcsot.

Típus: apiKey
In: header

Authorization

Adjon meg egy hozzáférési jogkivonatot a régió STS által visszaadott JWT-ből. Győződjön meg arról, hogy hozzáadja a felügyeleti hatókört a jogkivonathoz, ha hozzáadja a következő lekérdezési sztringet az STS URL-címéhez: ?scope=speechservicesmanagement

Típus: apiKey
In: header

Példák

Create a web hook

Mintakérelem

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

Mintaválasz

Állapotkó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"
}

Definíciók

Name Description
DetailedErrorCode

DetailedErrorCode
EntityError

EntityError
Error

Hiba
ErrorCode

Hibakód
InnerError

InnerError
Status

Állapot
WebHook

WebHook
WebHookEvents

WebHookEvents
WebHookLinks

WebHookLinks
WebHookProperties

WebHookProperties

DetailedErrorCode

Enumerálás

DetailedErrorCode

Érték Description
InvalidParameterValue

Érvénytelen paraméterérték.
InvalidRequestBodyFormat

Érvénytelen kérelem törzsformátuma.
EmptyRequest

Üres kérelem.
MissingInputRecords

Hiányzó bemeneti rekordok.
InvalidDocument

Érvénytelen dokumentum.
ModelVersionIncorrect

A modell verziója helytelen.
InvalidDocumentBatch

Érvénytelen dokumentumköteg.
UnsupportedLanguageCode

Nem támogatott nyelvi kód.
DataImportFailed

Az adatimportálás nem sikerült.
InUseViolation

Használaton belüli szabálysértés.
InvalidLocale

Érvénytelen területi beállítás.
InvalidBaseModel

Érvénytelen alapmodell.
InvalidAdaptationMapping

Érvénytelen adaptációs leképezés.
InvalidDataset

Érvénytelen adatkészlet.
InvalidTest

Érvénytelen teszt.
FailedDataset

Sikertelen adathalmaz.
InvalidModel

Érvénytelen modell.
InvalidTranscription

Érvénytelen átírás.
InvalidPayload

Érvénytelen hasznos adat.
InvalidParameter

Érvénytelen paraméter.
EndpointWithoutLogging

Végpont naplózás nélkül.
InvalidPermissions

Érvénytelen engedélyek.
InvalidPrerequisite

Érvénytelen előfeltétel.
InvalidProductId

Érvénytelen termékazonosító.
InvalidSubscription

Érvénytelen előfizetés.
InvalidProject

Érvénytelen projekt.
InvalidProjectKind

Érvénytelen projekttípus.
InvalidRecordingsUri

Érvénytelen felvételek uri.
OnlyOneOfUrlsOrContainerOrDataset

Csak egy URL-cím, tároló vagy adatkészlet.
ExceededNumberOfRecordingsUris

Túllépte a felvételek URI-jainak számát.
ModelMismatch

Modelleltérés.
ProjectGenderMismatch

A projekt neme nem egyezik.
ModelDeprecated

A modell elavult.
ModelExists

A modell létezik.
ModelNotDeployable

A modell nem telepíthető.
EndpointNotUpdatable

A végpont nem frissíthető.
SingleDefaultEndpoint

Egyetlen alapértelmezett végpont.
EndpointCannotBeDefault

A végpont nem lehet alapértelmezett.
InvalidModelUri

Érvénytelen modell uri.
SubscriptionNotFound

Az előfizetés nem található.
QuotaViolation

Kvóta megsértése.
UnsupportedDelta

Nem támogatott változás.
UnsupportedFilter

Nem támogatott szűrő.
UnsupportedPagination

Nem támogatott lapozás.
UnsupportedDynamicConfiguration

Nem támogatott dinamikus konfiguráció.
UnsupportedOrderBy

Nem támogatott sorrend szerint.
NoUtf8WithBom

Nincs utf8 a bom.
ModelDeploymentNotCompleteState

A modell üzembe helyezése nem fejeződött be.
SkuLimitsExist

A termékváltozat korlátai léteznek.
DeployingFailedModel

Sikertelen modell üzembe helyezése.
UnsupportedTimeRange

Nem támogatott időtartomány.
InvalidLogDate

Érvénytelen naplódátum.
InvalidLogId

Érvénytelen naplóazonosító.
InvalidLogStartTime

Érvénytelen naplóindítási időpont.
InvalidLogEndTime

Érvénytelen naplóvégzési idő.
InvalidTopForLogs

A naplók felső része érvénytelen.
InvalidSkipTokenForLogs

Érvénytelen kihagyó jogkivonat a naplókhoz.
DeleteNotAllowed

A törlés nem engedélyezett.
Forbidden

Tiltott.
DeployNotAllowed

Az üzembe helyezés nem engedélyezett.
UnexpectedError

Váratlan hiba.
InvalidCollection

Érvénytelen gyűjtemény.
InvalidCallbackUri

Érvénytelen visszahívási uri.
InvalidSasValidityDuration

Érvénytelen sas-érvényességi időtartam.
InaccessibleCustomerStorage

Elérhetetlen ügyféltároló.
UnsupportedClassBasedAdaptation

Nem támogatott osztályalapú adaptáció.
InvalidWebHookEventKind

Érvénytelen webhookesemény-típus.
InvalidTimeToLive

Érvénytelen élettartam.
InvalidSourceAzureResourceId

Érvénytelen forrás Azure-erőforrás-azonosító.
ModelCopyOperationExists

Létezik modellmásolási művelet.

EntityError

Objektum

EntityError

Name Típus Description
code

string

A hiba kódja.
message

string

A hiba üzenete.

Error

Objektum

Hiba

Name Típus Description
code

ErrorCode

Hibakód
Magas szintű hibakódok.
details

Error[]

További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban.
innerError

InnerError

InnerError
Új belső hibaformátum, amely megfelel az https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owcímen elérhető Cognitive Services API-irányelveknek. Ez tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és választható tulajdonságok célértéke, részletek (kulcsértékpár), belső hiba (ez beágyazható).
message

string

Magas szintű hibaüzenet.
target

string

A hiba forrása. Érvénytelen dokumentum esetén például "dokumentumok" vagy "dokumentumazonosító".

ErrorCode

Enumerálás

Hibakód

Érték Description
InvalidRequest

Az érvénytelen kérés hibakódját jelöli.
InvalidArgument

Az érvénytelen argumentum hibakódját jelöli.
InternalServerError

A belső kiszolgáló hibakódját jelöli.
ServiceUnavailable

A szolgáltatás nem érhető el hibakódjának ábrázolása.
NotFound

A nem található hibakódot jelöli.
PipelineError

A folyamat hibakódjának ábrázolása.
Conflict

Az ütközési hibakódot jelöli.
InternalCommunicationFailed

A belső kommunikáció nem sikerült hibakódját jelöli.
Forbidden

A tiltott hibakódot jelöli.
NotAllowed

A nem engedélyezett hibakódot jelöli.
Unauthorized

A jogosulatlan hibakódot jelöli.
UnsupportedMediaType

A nem támogatott médiatípus hibakódját jelöli.
TooManyRequests

A túl sok kérés hibakódját jelöli.
UnprocessableEntity

A feldolgozhatatlan entitás hibakódját jelöli.

InnerError

Objektum

InnerError

Name Típus Description
code

DetailedErrorCode

DetailedErrorCode
Részletes hibakód enumerálás.
details

object

További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban.
innerError

InnerError

InnerError
Új belső hibaformátum, amely megfelel az https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owcímen elérhető Cognitive Services API-irányelveknek. Ez tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és választható tulajdonságok célértéke, részletek (kulcsértékpár), belső hiba (ez beágyazható).
message

string

Magas szintű hibaüzenet.
target

string

A hiba forrása. Érvénytelen dokumentum esetén például "dokumentumok" vagy "dokumentumazonosító".

Status

Enumerálás

Állapot

Érték Description
NotStarted

A hosszú ideig futó művelet még nem indult el.
Running

A hosszú ideig futó művelet jelenleg feldolgozásra kerül.
Succeeded

A hosszú ideig futó művelet sikeresen befejeződött.
Failed

A hosszú ideig futó művelet nem sikerült.

WebHook

Objektum

WebHook

Name Típus Description
createdDateTime

string (date-time)

Az objektum létrehozásának időbélyege. Az időbélyeg ISO 8601 dátum- és időformátumként van kódolva ("YYYY-MM-DDThh:mm:ssZ", lásd https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

Az entitás egyéni tulajdonságai. A maximálisan megengedett kulcshossz 64 karakter, az engedélyezett érték maximális hossza 256 karakter, az engedélyezett bejegyzések száma pedig 10.
description

string

Az objektum leírása.
displayName

string

minLength: 1

Az objektum megjelenítendő neve.
events

WebHookEvents

WebHookEvents
lastActionDateTime

string (date-time)

Az aktuális állapot megadásának időbélyege. Az időbélyeg ISO 8601 dátum- és időformátumként van kódolva ("YYYY-MM-DDThh:mm:ssZ", lásd https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links

WebHookLinks

WebHookLinks
properties

WebHookProperties

WebHookProperties
self

string (uri)

Az entitás helye.
status

Status

Állapot
Az API aktuális állapotának ismertetése
webUrl

string (uri)

A regisztrált események POST-kéréseinek küldéséhez használt regisztrált URL-cím.

WebHookEvents

Objektum

WebHookEvents

Name Típus 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

Objektum

WebHookLinks

Name Típus Description
ping

string (uri)

A pingesemények webes horogregisztráció regisztrált URL-címére való küldésének aktiválására használható URL-cím. További részletekért tekintse meg a "WebHooks_Ping" műveletet.
test

string (uri)

A tesztesemények webes horogregisztráció regisztrált URL-címére küldhető URL-cím. További részletekért tekintse meg a "WebHooks_Test" műveletet.

WebHookProperties

Objektum

WebHookProperties

Name Típus Description
apiVersion

string

Az API-verzió, amelyben a webes horog létre lett hozva. Ez határozza meg a visszahívások hasznos adatainak alakját. Ha a hasznos adattípus már nem támogatott, mert az alakzat megváltozott, és az azt használó API-verzió el lesz távolítva (az elavulás után), a webes horog le lesz tiltva.
error

EntityError

EntityError
secret

string

Egy titkos kód, amely a hasznos adatok SHA256-kivonatának létrehozásához használható HMAC-kulccsal. Ez a kivonat X-MicrosoftSpeechServices-Signature fejlécként lesz beállítva a regisztrált URL-címre való visszahíváskor.