Web Hooks - Create
Yeni bir web kancası oluşturur.
Yapılandırmadaki özellik gizli dizisi varsa ve boş olmayan bir dize içeriyorsa, yükün HMAC anahtarı olarak gizli anahtarıyla sha256 karması oluşturmak için kullanılır. Bu karma, kayıtlı URL'ye geri çağrılırken X-MicrosoftSpeechServices-Signature üst bilgisi olarak ayarlanır.
Kayıtlı URL'ye geri çağrı yapılırken istek, kayıtlı olay türlerinden birini içeren bir X-MicrosoftSpeechServices-Event üst bilgisi içerir. Kayıtlı olay türü başına bir istek olacaktır.
Web kancası başarıyla kaydettikten sonra, sınama/yanıt tamamlanana kadar kullanılamaz. Bunu yapmak için validationToken adlı bir sorgu parametresiyle olay türü sınamasına sahip bir istek yapılır. Yanıt gövdesi olarak validationToken sorgu parametresinin değerini içeren 200 Ok ile sınamaya yanıt verin. Sınama/yanıt başarıyla tamamlandığında web kancası olayları almaya başlar.
POST {endpoint}/speechtotext/v3.2/webhooks
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve konak adı, örneğin: https://westus.api.cognitive.microsoft.com). |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
displayName | True |
string |
Nesnenin görünen adı. |
events | True |
WebHookEvents |
|
webUrl | True |
string |
Kayıtlı olaylar için POST isteklerini göndermek için kullanılacak kayıtlı URL. |
customProperties |
object |
Bu varlığın özel özellikleri. İzin verilen anahtar uzunluğu üst sınırı 64 karakter, izin verilen değer uzunluğu üst sınırı 256 karakter ve izin verilen girdi sayısı 10'dur. |
|
description |
string |
Nesnenin açıklaması. |
|
properties |
WebHookProperties |
Yanıtlar
Name | Tür | Description |
---|---|---|
201 Created |
Yanıt, yük olarak varlık ve üst bilgi olarak konumu hakkında bilgi içerir. Üst Bilgiler Location: string |
|
Other Status Codes |
Bir hata oluşmuştur. |
Güvenlik
Ocp-Apim-Subscription-Key
Bilişsel hizmetler hesap anahtarınızı burada sağlayın.
Tür:
apiKey
İçinde:
header
Authorization
Bu bölgenin STS tarafından döndürülen JWT'den bir erişim belirteci sağlayın. STS URL'sine aşağıdaki sorgu dizesini ekleyerek yönetim kapsamını belirteci eklediğinizden emin olun: ?scope=speechservicesmanagement
Tür:
apiKey
İçinde:
header
Örnekler
Create a web hook
Örnek isteği
POST {endpoint}/speechtotext/v3.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."
}
Örnek yanıt
Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d
{
"displayName": "TranscriptionCompletionWebHook",
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d",
"links": {
"ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test",
"test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping"
},
"properties": {
"apiVersion": "v3.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"
}
Tanımlar
Name | Description |
---|---|
Detailed |
DetailedErrorCode |
Entity |
EntityError |
Error |
Hata |
Error |
ErrorCode |
Inner |
InnerError |
Status |
Durum |
Web |
Web Kancası |
Web |
WebHookEvents |
Web |
Web Kancası Bağlantıları |
Web |
WebHookProperties |
DetailedErrorCode
DetailedErrorCode
Name | Tür | Description |
---|---|---|
DataImportFailed |
string |
Veri içeri aktarma başarısız oldu. |
DeleteNotAllowed |
string |
Silmeye izin verilmiyor. |
DeployNotAllowed |
string |
Dağıtıma izin verilmiyor. |
DeployingFailedModel |
string |
Başarısız modeli dağıtma. |
EmptyRequest |
string |
Boş İstek. |
EndpointCannotBeDefault |
string |
Uç nokta varsayılan olamaz. |
EndpointNotUpdatable |
string |
Uç nokta güncelleştirilebilir değil. |
EndpointWithoutLogging |
string |
Günlüğe kaydetmeden uç nokta. |
ExceededNumberOfRecordingsUris |
string |
Kayıt sayısı aşıldı uris. |
FailedDataset |
string |
Başarısız veri kümesi. |
Forbidden |
string |
Yasak. |
InUseViolation |
string |
Kullanım ihlali. |
InaccessibleCustomerStorage |
string |
Erişilemez müşteri depolama alanı. |
InvalidAdaptationMapping |
string |
Geçersiz uyarlama eşlemesi. |
InvalidBaseModel |
string |
Geçersiz temel model. |
InvalidCallbackUri |
string |
Geçersiz geri çağırma uri'si. |
InvalidChannels |
string |
Geçersiz kanallar. |
InvalidCollection |
string |
Geçersiz koleksiyon. |
InvalidDataset |
string |
Geçersiz veri kümesi. |
InvalidDocument |
string |
Geçersiz Belge. |
InvalidDocumentBatch |
string |
Geçersiz Belge Toplu İşlemi. |
InvalidLocale |
string |
Geçersiz yerel ayar. |
InvalidLogDate |
string |
Geçersiz günlük tarihi. |
InvalidLogEndTime |
string |
Geçersiz günlük bitiş saati. |
InvalidLogId |
string |
Geçersiz günlük kimliği. |
InvalidLogStartTime |
string |
Geçersiz günlük başlangıç saati. |
InvalidModel |
string |
Geçersiz model. |
InvalidModelUri |
string |
Geçersiz model uri'si. |
InvalidParameter |
string |
Geçersiz parametre. |
InvalidParameterValue |
string |
Geçersiz parametre değeri. |
InvalidPayload |
string |
Geçersiz yük. |
InvalidPermissions |
string |
Geçersiz izinler. |
InvalidPrerequisite |
string |
Geçersiz önkoşul. |
InvalidProductId |
string |
Geçersiz ürün kimliği. |
InvalidProject |
string |
Geçersiz proje. |
InvalidProjectKind |
string |
Geçersiz proje türü. |
InvalidRecordingsUri |
string |
Geçersiz kayıt uri'si. |
InvalidRequestBodyFormat |
string |
Geçersiz istek gövdesi biçimi. |
InvalidSasValidityDuration |
string |
Geçersiz sas geçerlilik süresi. |
InvalidSkipTokenForLogs |
string |
Günlükler için geçersiz atlama belirteci. |
InvalidSourceAzureResourceId |
string |
Geçersiz kaynak Azure kaynak kimliği. |
InvalidSubscription |
string |
Geçersiz abonelik. |
InvalidTest |
string |
Geçersiz test. |
InvalidTimeToLive |
string |
Geçersiz yaşam süresi. |
InvalidTopForLogs |
string |
Günlükler için geçersiz üst. |
InvalidTranscription |
string |
Geçersiz transkripsiyon. |
InvalidWebHookEventKind |
string |
Geçersiz web kancası olay türü. |
MissingInputRecords |
string |
Eksik Giriş Kayıtları. |
ModelCopyAuthorizationExpired |
string |
Süresi Dolan ModelCopyAuthorization. |
ModelDeploymentNotCompleteState |
string |
Model dağıtımı tamamlanamadı durumu. |
ModelDeprecated |
string |
Model kullanım dışı bırakıldı. |
ModelExists |
string |
Model var. |
ModelMismatch |
string |
Model uyuşmazlığı. |
ModelNotDeployable |
string |
Model dağıtılamaz. |
ModelVersionIncorrect |
string |
Model Sürümü Yanlış. |
NoUtf8WithBom |
string |
Bom ile utf8 yok. |
OnlyOneOfUrlsOrContainerOrDataset |
string |
Url'lerden, kapsayıcılardan veya veri kümelerinden yalnızca biri. |
ProjectGenderMismatch |
string |
Proje cinsiyet uyuşmazlığı. |
QuotaViolation |
string |
Kota ihlali. |
SingleDefaultEndpoint |
string |
Tek varsayılan uç nokta. |
SkuLimitsExist |
string |
Sku sınırları vardır. |
SubscriptionNotFound |
string |
Abonelik bulunamadı. |
UnexpectedError |
string |
Beklenmeyen hata. |
UnsupportedClassBasedAdaptation |
string |
Desteklenmeyen sınıf tabanlı uyarlama. |
UnsupportedDelta |
string |
Desteklenmeyen delta. |
UnsupportedDynamicConfiguration |
string |
Desteklenmeyen dinamik yapılandırma. |
UnsupportedFilter |
string |
Desteklenmeyen filtre. |
UnsupportedLanguageCode |
string |
Desteklenmeyen dil kodu. |
UnsupportedOrderBy |
string |
Desteklenmeyen sipariş ölçütü. |
UnsupportedPagination |
string |
Desteklenmeyen sayfalandırma. |
UnsupportedTimeRange |
string |
Desteklenmeyen zaman aralığı. |
EntityError
EntityError
Name | Tür | Description |
---|---|---|
code |
string |
Bu hatanın kodu. |
message |
string |
Bu hatanın iletisi. |
Error
Hata
Name | Tür | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Hata ve/veya beklenen ilkelerle ilgili ek destek ayrıntıları. |
innerError |
InnerError |
|
message |
string |
Üst düzey hata iletisi. |
target |
string |
Hatanın kaynağı. Örneğin, geçersiz belge olması durumunda "belgeler" veya "belge kimliği" olabilir. |
ErrorCode
ErrorCode
Name | Tür | Description |
---|---|---|
Conflict |
string |
Çakışma hata kodunu temsil ediyor. |
Forbidden |
string |
Yasak hata kodunu temsil ediyor. |
InternalCommunicationFailed |
string |
İç iletişim başarısız hata kodunu temsil eder. |
InternalServerError |
string |
İç sunucu hata kodunu temsil etme. |
InvalidArgument |
string |
Geçersiz bağımsız değişken hata kodunu temsil ediyor. |
InvalidRequest |
string |
Geçersiz istek hata kodunu temsil ediyor. |
NotAllowed |
string |
İzin verilmeyen hata kodunu temsil ediyor. |
NotFound |
string |
Bulunamadı hata kodunu temsil ediyor. |
PipelineError |
string |
İşlem hattı hata kodunu temsil eder. |
ServiceUnavailable |
string |
Hizmet kullanılamıyor hata kodunu temsil etme. |
TooManyRequests |
string |
Çok fazla istek hata kodunu temsil eder. |
Unauthorized |
string |
Yetkisiz hata kodunu temsil etme. |
UnprocessableEntity |
string |
İşlenemeyen varlık hata kodunu temsil eder. |
UnsupportedMediaType |
string |
Desteklenmeyen medya türü hata kodunu temsil eder. |
InnerError
InnerError
Name | Tür | Description |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
Hata ve/veya beklenen ilkelerle ilgili ek destek ayrıntıları. |
innerError |
InnerError |
|
message |
string |
Üst düzey hata iletisi. |
target |
string |
Hatanın kaynağı. Örneğin, geçersiz belge olması durumunda "belgeler" veya "belge kimliği" olabilir. |
Status
Durum
Name | Tür | Description |
---|---|---|
Failed |
string |
Uzun süre çalışan işlem başarısız oldu. |
NotStarted |
string |
Uzun süre çalışan işlem henüz başlatılmadı. |
Running |
string |
Uzun süre çalışan işlem şu anda işleniyor. |
Succeeded |
string |
Uzun süre çalışan işlem başarıyla tamamlandı. |
WebHook
Web Kancası
Name | Tür | Description |
---|---|---|
createdDateTime |
string |
Nesnenin oluşturulduğu zaman damgası. Zaman damgası ISO 8601 tarih ve saat biçimi olarak kodlanmıştır ("YYYY-AA-GGThh:mm:ssZ", bkz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ). |
customProperties |
object |
Bu varlığın özel özellikleri. İzin verilen anahtar uzunluğu üst sınırı 64 karakter, izin verilen değer uzunluğu üst sınırı 256 karakter ve izin verilen girdi sayısı 10'dur. |
description |
string |
Nesnenin açıklaması. |
displayName |
string |
Nesnenin görünen adı. |
events |
WebHookEvents |
|
lastActionDateTime |
string |
Geçerli durumun girildiği zaman damgası. Zaman damgası ISO 8601 tarih ve saat biçimi olarak kodlanmıştır ("YYYY-AA-GGThh:mm:ssZ", bkz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ). |
links |
Web Kancası Bağlantıları |
|
properties |
WebHookProperties |
|
self |
string |
Bu varlığın konumu. |
status |
Durum |
|
webUrl |
string |
Kayıtlı olaylar için POST isteklerini göndermek için kullanılacak kayıtlı URL. |
WebHookEvents
WebHookEvents
Name | Tür | 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
Web Kancası Bağlantıları
Name | Tür | Description |
---|---|---|
ping |
string |
Web kancası kaydının kayıtlı URL'sine ping olayının gönderilmesini tetiklemede kullanılabilecek URL. Daha fazla ayrıntı için bkz. "WebHooks_Ping" işlemi. |
test |
string |
Test olaylarını web kancası kaydının kayıtlı URL'sine göndermek için kullanılabilecek URL. Daha fazla ayrıntı için bkz. "WebHooks_Test" işlemi. |
WebHookProperties
WebHookProperties
Name | Tür | Description |
---|---|---|
apiVersion |
string |
Web kancasının oluşturulduğu API sürümü. Bu, geri çağırmalardaki yükün şeklini tanımlar. Yük türü artık desteklenmiyorsa, şekil değiştiğinden ve bunu kullanan API sürümü kaldırıldığından (kullanımdan kaldırıldıktan sonra), web kancası devre dışı bırakılır. |
error |
EntityError |
|
secret |
string |
Yükün SHA256 karması oluşturmak için kullanılacak gizli dizi ve gizli dizi HMAC anahtarı olarak kullanılır. Bu karma, kayıtlı URL'ye geri çağrılırken X-MicrosoftSpeechServices-Signature üst bilgisi olarak ayarlanır. |