Update Hook - Update Hook

Layanan:: Azure AI Services

Versi API:: v3.0

Memperbarui web hook yang diidentifikasi oleh ID yang diberikan.
Jika rahasia properti dalam konfigurasi dihilangkan atau berisi string kosong, panggilan balik di masa mendatang tidak akan berisi headerMicrosoftSpeechServices-Signature X. Jika properti berisi string yang tidak kosong, properti akan digunakan untuk membuat hash SHA256 dari payload dengan rahasia sebagai kunci HMAC. Hash ini akan diatur sebagai header X-MicrosoftSpeechServices-Signature saat memanggil kembali ke URL terdaftar.

Jika URL berubah, web hook akan berhenti menerima peristiwa hingga 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, web hook akan mulai menerima peristiwa.

PATCH {Endpoint}/speechtotext/v3.0/webhooks/{id}

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).
id	path	True	string (uuid)	Pengidentifikasi web hook.

Isi Permintaan

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

Nama	Jenis	Deskripsi
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 objek.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	URL terdaftar yang akan digunakan untuk mengirim permintaan POST untuk peristiwa terdaftar.

Respons

Nama	Jenis	Deskripsi
200 OK	WebHook	OKE Header Retry-After: integer
Other Status Codes	Error	Terjadi kesalahan.

Nama

Jenis

Deskripsi

200 OK

WebHook

OKE

Header

Retry-After: integer

Other Status Codes

Error

Terjadi kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Berikan kunci akun layanan kognitif Anda di sini.

Jenis: apiKey
Dalam: 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

Jenis: apiKey
Dalam: header

Contoh

Update a web hook

Permintaan sampel

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

Respon sampel

Kode status:: 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"
}

Definisi

Nama	Deskripsi
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Kesalahan
ErrorCode	ErrorCode
InnerError	InnerError
Status	Keadaan
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties
WebHookPropertiesUpdate	WebHookPropertiesUpdate
WebHookUpdate	WebHookUpdate

DetailedErrorCode

Enumeration

DetailedErrorCode

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

EntityError

Objek

EntityError

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

Error

Objek

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 Panduan API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ini berisi properti yang diperlukan ErrorCode, pesan, dan target properti opsional, detail(pasangan nilai kunci), kesalahan dalam (ini dapat ditumpuk).
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan. Misalnya akan menjadi "dokumen" atau "id dokumen" jika dokumen tidak valid.

ErrorCode

Enumeration

ErrorCode

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

InnerError

Objek

InnerError

Nama	Jenis	Deskripsi
code	DetailedErrorCode	DetailedErrorCode 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 Panduan API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ini berisi properti yang diperlukan ErrorCode, pesan, dan target properti opsional, detail(pasangan nilai kunci), kesalahan dalam (ini dapat ditumpuk).
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan. Misalnya akan menjadi "dokumen" atau "id dokumen" jika dokumen tidak valid.

Status

Enumeration

Keadaan

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

WebHook

Objek

WebHook

Nama	Jenis	Deskripsi
createdDateTime	string (date-time)	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 (date-time)	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 (uri)	Lokasi entitas ini.
status	Status	Keadaan Menjelaskan status API saat ini
webUrl	string (uri)	URL terdaftar yang akan digunakan untuk mengirim permintaan POST untuk peristiwa terdaftar.

WebHookEvents

Objek

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

Objek

WebHookLinks

Nama	Jenis	Deskripsi
ping	string (uri)	URL yang dapat digunakan untuk memicu pengiriman peristiwa ping ke URL terdaftar dari pendaftaran web hook.
test	string (uri)	URL yang dapat digunakan untuk mengirim peristiwa pengujian ke URL terdaftar pendaftaran web hook.

WebHookProperties

Objek

WebHookProperties

Nama	Jenis	Deskripsi
apiVersion	string	Versi API tempat web hook 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), web hook 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 diatur sebagai header X-MicrosoftSpeechServices-Signature saat memanggil kembali ke URL terdaftar.

WebHookPropertiesUpdate

Objek

WebHookPropertiesUpdate

Nama	Jenis	Deskripsi
secret	string	Rahasia yang akan digunakan untuk membuat hash SHA256 dari payload dengan rahasia sebagai kunci HMAC. Hash ini akan diatur sebagai header X-MicrosoftSpeechServices-Signature saat memanggil kembali ke URL terdaftar.

WebHookUpdate

Objek

WebHookUpdate

Nama	Jenis	Deskripsi
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 objek.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	URL terdaftar yang akan digunakan untuk mengirim permintaan POST untuk peristiwa terdaftar.

Bagikan melalui

Update Hook - Update Hook

Parameter URI

Isi Permintaan

Respons

Keamanan

Ocp-Apim-Subscription-Key

Authorization

Contoh

Update a web hook

Permintaan sampel

Respon sampel

Definisi

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate