Web Hooks - Create

Referensi

Service:: Azure AI Services

API Version:: v3.2-preview.2

Membuat webhook baru.
Jika rahasia properti dalam konfigurasi ada dan berisi string yang tidak kosong, itu akan digunakan untuk membuat hash SHA256 dari payload dengan rahasia sebagai kunci HMAC. Hash ini akan ditetapkan sebagai header X-MicrosoftSpeechServices-Signature saat memanggil kembali ke URL terdaftar.

Saat memanggil kembali ke URL terdaftar, permintaan akan berisi header X-MicrosoftSpeechServices-Event yang berisi salah satu jenis peristiwa terdaftar. Akan ada satu permintaan per jenis peristiwa terdaftar.

Setelah berhasil mendaftarkan webhook, webhook tidak akan dapat digunakan sampai tantangan/respons selesai. Untuk melakukan ini, permintaan dengan tantangan jenis peristiwa akan dibuat dengan parameter kueri yang disebut validationToken. Tanggapi tantangan dengan 200 OK yang berisi nilai parameter kueri validationToken sebagai isi respons. Ketika tantangan/respons berhasil diselesaikan, webhook akan mulai menerima peristiwa.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus.api.cognitive.microsoft.com).

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
displayName	True	string	Nama tampilan objek.
events	True	WebHookEvents	WebHookEvents
webUrl	True	string	URL terdaftar yang akan digunakan untuk mengirim permintaan POST untuk peristiwa terdaftar.
customProperties		object	Properti kustom entitas ini. Panjang kunci maksimum yang diizinkan adalah 64 karakter, panjang nilai maksimum yang diizinkan adalah 256 karakter dan jumlah entri yang diizinkan adalah 10.
description		string	Deskripsi objek .
properties		WebHookProperties	WebHookProperties

Respons

Nama	Jenis	Deskripsi
201 Created	WebHook	Respons berisi informasi tentang entitas sebagai payload dan lokasinya sebagai header. Headers Location: string
Other Status Codes	Error	Terjadi kesalahan.

Nama

Jenis

Deskripsi

201 Created

WebHook

Respons berisi informasi tentang entitas sebagai payload dan lokasinya sebagai header.

Headers

Location: string

Other Status Codes

Error

Terjadi kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Berikan kunci akun layanan kognitif Anda di sini.

Type: apiKey
In: header

Authorization

Berikan token akses dari JWT yang dikembalikan oleh STS wilayah ini. Pastikan untuk menambahkan cakupan manajemen ke token dengan menambahkan string kueri berikut ke URL STS: ?scope=speechservicesmanagement

Type: apiKey
In: header

Contoh

Create a web hook

Sample Request

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

Sample Response

Status code:: 201

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

Response Body

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

Definisi

Nama	Deskripsi
DetailedErrorCode	DetailErrorCode
EntityError	EntityError
Error	Kesalahan
ErrorCode	ErrorCode
InnerError	InnerError
Status	Status
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties

DetailedErrorCode

DetailErrorCode

Nama	Jenis	Deskripsi
DataImportFailed	string	Impor data gagal.
DeleteNotAllowed	string	Hapus tidak diperbolehkan.
DeployNotAllowed	string	Penyebaran tidak diperbolehkan.
DeployingFailedModel	string	Menyebarkan model yang gagal.
EmptyRequest	string	Permintaan Kosong.
EndpointCannotBeDefault	string	Titik akhir tidak boleh default.
EndpointNotUpdatable	string	Titik akhir tidak dapat diperbarui.
EndpointWithoutLogging	string	Titik akhir tanpa pengelogan.
ExceededNumberOfRecordingsUris	string	Melebihi jumlah uri rekaman.
FailedDataset	string	Himpunan data yang gagal.
Forbidden	string	Terlarang.
InUseViolation	string	Dalam pelanggaran penggunaan.
InaccessibleCustomerStorage	string	Penyimpanan pelanggan yang tidak dapat diakses.
InvalidAdaptationMapping	string	Pemetaan adaptasi tidak valid.
InvalidBaseModel	string	Model dasar tidak valid.
InvalidCallbackUri	string	Uri panggilan balik tidak valid.
InvalidCollection	string	Koleksi tidak valid.
InvalidDataset	string	Himpunan data tidak valid.
InvalidDocument	string	Dokumen Tidak Valid.
InvalidDocumentBatch	string	Batch Dokumen Tidak Valid.
InvalidLocale	string	Lokal tidak valid.
InvalidLogDate	string	Tanggal log tidak valid.
InvalidLogEndTime	string	Waktu akhir log tidak valid.
InvalidLogId	string	Id log tidak valid.
InvalidLogStartTime	string	Waktu mulai log tidak valid.
InvalidModel	string	Model tidak valid.
InvalidModelUri	string	Uri model tidak valid.
InvalidParameter	string	Parameter tidak valid.
InvalidParameterValue	string	Nilai parameter tidak valid.
InvalidPayload	string	Payload tidak valid.
InvalidPermissions	string	Izin tidak valid.
InvalidPrerequisite	string	Prasyarat tidak valid.
InvalidProductId	string	Id produk tidak valid.
InvalidProject	string	Proyek tidak valid.
InvalidProjectKind	string	Jenis proyek tidak valid.
InvalidRecordingsUri	string	Rekaman uri tidak valid.
InvalidRequestBodyFormat	string	Format isi permintaan tidak valid.
InvalidSasValidityDuration	string	Durasi validitas sas tidak valid.
InvalidSkipTokenForLogs	string	Lewati token untuk log tidak valid.
InvalidSourceAzureResourceId	string	ID sumber daya Azure sumber tidak valid.
InvalidSubscription	string	Langganan tidak valid.
InvalidTest	string	Tes tidak valid.
InvalidTimeToLive	string	Waktu hidup tidak valid.
InvalidTopForLogs	string	Atas tidak valid untuk log.
InvalidTranscription	string	Transkripsi tidak valid.
InvalidWebHookEventKind	string	Jenis peristiwa webhook tidak valid.
MissingInputRecords	string	Rekaman Input Hilang.
ModelCopyOperationExists	string	Operasi penyalinan model ada.
ModelDeploymentNotCompleteState	string	Status penyebaran model tidak selesai.
ModelDeprecated	string	Model tidak digunakan lagi.
ModelExists	string	Model ada.
ModelMismatch	string	Model tidak cocok.
ModelNotDeployable	string	Model tidak dapat disebarkan.
ModelVersionIncorrect	string	Versi Model Salah.
NoUtf8WithBom	string	Tidak ada utf8 dengan bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Hanya salah satu url atau kontainer atau himpunan data.
ProjectGenderMismatch	string	Ketidakcocokan jenis kelamin proyek.
QuotaViolation	string	Pelanggaran kuota.
SingleDefaultEndpoint	string	Titik akhir default tunggal.
SkuLimitsExist	string	Batas Sku ada.
SubscriptionNotFound	string	Langganan tidak ditemukan.
UnexpectedError	string	Kesalahan tak terduga.
UnsupportedClassBasedAdaptation	string	Adaptasi berbasis kelas yang tidak didukung.
UnsupportedDelta	string	Delta yang tidak didukung.
UnsupportedDynamicConfiguration	string	Konfigurasi dinamis yang tidak didukung.
UnsupportedFilter	string	Filter yang tidak didukung.
UnsupportedLanguageCode	string	Kode bahasa yang tidak didukung.
UnsupportedOrderBy	string	Urutan tidak didukung oleh.
UnsupportedPagination	string	Penomoran halaman yang tidak didukung.
UnsupportedTimeRange	string	Rentang waktu yang tidak didukung.

EntityError

Nama	Jenis	Deskripsi
code	string	Kode kesalahan ini.
message	string	Pesan untuk kesalahan ini.

Error

Kesalahan

Nama	Jenis	Deskripsi
code	ErrorCode	ErrorCode Kode kesalahan tingkat tinggi.
details	Error[]	Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan.
innerError	InnerError	InnerError Format Kesalahan Dalam Baru yang sesuai dengan Pedoman API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Hal ini berisi properti yang diperlukan ErrorCode, pesan dan target properti opsional, detail (pasangan nilai kunci), inner error (ini dapat berlapis).
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan. Misalnya "dokumen" atau "id dokumen" jika dokumen tidak valid.

ErrorCode

Nama	Jenis	Deskripsi
Conflict	string	Mewakili kode kesalahan konflik.
Forbidden	string	Mewakili kode kesalahan terlarang.
InternalCommunicationFailed	string	Mewakili kode kesalahan komunikasi internal yang gagal.
InternalServerError	string	Mewakili kode kesalahan server internal.
InvalidArgument	string	Mewakili kode kesalahan argumen yang tidak valid.
InvalidRequest	string	Mewakili kode kesalahan permintaan yang tidak valid.
NotAllowed	string	Mewakili kode kesalahan yang tidak diizinkan.
NotFound	string	Mewakili kode kesalahan yang tidak ditemukan.
PipelineError	string	Mewakili kode kesalahan kesalahan alur.
ServiceUnavailable	string	Mewakili kode kesalahan layanan yang tidak tersedia.
TooManyRequests	string	Mewakili terlalu banyak kode kesalahan permintaan.
Unauthorized	string	Mewakili kode kesalahan yang tidak sah.
UnprocessableEntity	string	Mewakili kode kesalahan entitas yang tidak dapat diolah.
UnsupportedMediaType	string	Mewakili kode kesalahan jenis media yang tidak didukung.

InnerError

Nama	Jenis	Deskripsi
code	DetailedErrorCode	DetailErrorCode Enum kode kesalahan terperinci.
details	object	Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan.
innerError	InnerError	InnerError Format Kesalahan Dalam Baru yang sesuai dengan Pedoman API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Hal ini berisi properti yang diperlukan ErrorCode, pesan dan target properti opsional, detail (pasangan nilai kunci), inner error (ini dapat berlapis).
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan. Misalnya "dokumen" atau "id dokumen" jika dokumen tidak valid.

Status

Nama	Jenis	Deskripsi
Failed	string	Operasi jangka panjang telah gagal.
NotStarted	string	Operasi jangka panjang belum dimulai.
Running	string	Operasi yang berjalan lama saat ini sedang diproses.
Succeeded	string	Operasi jangka panjang berhasil diselesaikan.

WebHook

Nama	Jenis	Deskripsi
createdDateTime	string	Stempel waktu saat objek dibuat. Stempel waktu dikodekan sebagai format tanggal dan waktu ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", lihat https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Properti kustom entitas ini. Panjang kunci maksimum yang diizinkan adalah 64 karakter, panjang nilai maksimum yang diizinkan adalah 256 karakter dan jumlah entri yang diizinkan adalah 10.
description	string	Deskripsi objek .
displayName	string	Nama tampilan objek.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string	Stempel waktu ketika status saat ini dimasukkan. Stempel waktu dikodekan sebagai format tanggal dan waktu ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", lihat https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string	Lokasi entitas ini.
status	Status	Status Menjelaskan status API saat ini
webUrl	string	URL terdaftar yang akan digunakan untuk mengirim permintaan POST untuk peristiwa terdaftar.

WebHookEvents

Nama	Jenis	Deskripsi
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

Nama	Jenis	Deskripsi
ping	string	URL yang dapat digunakan untuk memicu pengiriman peristiwa ping ke URL terdaftar dari pendaftaran webhook. Lihat operasi "WebHooks_Ping" untuk detail selengkapnya.
test	string	URL yang dapat digunakan untuk mengirim peristiwa pengujian ke URL terdaftar dari pendaftaran webhook. Lihat operasi "WebHooks_Test" untuk detail selengkapnya.

WebHookProperties

Nama	Jenis	Deskripsi
apiVersion	string	Versi API tempat webhook dibuat. Ini mendefinisikan bentuk payload dalam panggilan balik. Jika jenis payload tidak didukung lagi, karena bentuk berubah dan versi API yang menggunakannya dihapus (setelah penghentian), webhook akan dinonaktifkan.
error	EntityError	EntityError
secret	string	Rahasia yang akan digunakan untuk membuat hash SHA256 dari payload dengan rahasia sebagai kunci HMAC. Hash ini akan ditetapkan sebagai header X-MicrosoftSpeechServices-Signature saat memanggil kembali ke URL terdaftar.

Share via

Web Hooks - Create

Parameter URI

Isi Permintaan

Respons

Keamanan

Ocp-Apim-Subscription-Key

Authorization

Contoh

Create a web hook

Sample Request

Sample Response

Definisi

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

Sumber Daya Tambahan: