Update Hook - Update Hook

Hizmet:: Azure AI Services

API Sürümü:: v3.0

Verilen kimlik tarafından tanımlanan web kancasını güncelleştirir.
Yapılandırmadaki özellik gizli dizisi atlanırsa veya boş bir dize içeriyorsa, gelecekteki geri çağırmalar X-MicrosoftSpeechServices-Signature üst bilgileri içermez. Özelliği boş olmayan bir dize içeriyorsa, yükün SHA256 karması oluşturmak için kullanılır ve gizli diziyi HMAC anahtarı olarak kullanır. Bu karma, kayıtlı URL'ye geri çağrılırken X-MicrosoftSpeechServices-Signature üst bilgisi olarak ayarlanır.

URL değişirse, bir sınama/yanıt tamamlanana kadar web kancası olayları almayı durdurur. 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.

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

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).
id	path	True	string (uuid)	Web kancasının tanımlayıcısı.

İstek Gövdesi

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

Name	Tür	Description
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'dir.
description	string	Nesnenin açıklaması.
displayName	string	Nesnenin adı.
events	WebHookEvents	Web KancasıEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	Kayıtlı olaylar için POST isteklerini göndermek için kullanılacak kayıtlı URL.

Yanıtlar

Name	Tür	Description
200 OK	WebHook	TAMAM Üst Bilgiler Retry-After: integer
Other Status Codes	Error	Bir hata oluştu.

Name

Tür

Description

200 OK

WebHook

TAMAM

Üst Bilgiler

Retry-After: integer

Other Status Codes

Error

Bir hata oluştu.

Güvenlik

Ocp-Apim-Subscription-Key

Bilişsel hizmetler hesap anahtarınızı burada belirtin.

Tür: apiKey
İçinde: header

Authorization

Bu bölgenin STS'leri 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

Update a web hook

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
}

Tanımlar

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Hata
ErrorCode	ErrorCode
InnerError	InnerError
Status	Durum
WebHook	Web Kancası
WebHookEvents	Web KancasıEvents
WebHookLinks	Web Kancası Bağlantıları
WebHookProperties	WebHookProperties
WebHookPropertiesUpdate	WebHookPropertiesUpdate
WebHookUpdate	Web KancasıGüncelleştirme

DetailedErrorCode

Listeleme

DetailedErrorCode

Değer	Description
InvalidParameterValue	Geçersiz parametre değeri.
InvalidRequestBodyFormat	Geçersiz istek gövdesi biçimi.
EmptyRequest	Boş İstek.
MissingInputRecords	Eksik Giriş Kayıtları.
InvalidDocument	Geçersiz Belge.
ModelVersionIncorrect	Model Sürümü Yanlış.
InvalidDocumentBatch	Geçersiz Belge Toplu İşlemi.
UnsupportedLanguageCode	Desteklenmeyen dil kodu.
DataImportFailed	Veri içeri aktarılamadı.
InUseViolation	Kullanım ihlali.
InvalidLocale	Geçersiz yerel ayar.
InvalidBaseModel	Geçersiz temel model.
InvalidAdaptationMapping	Geçersiz uyarlama eşlemesi.
InvalidDataset	Geçersiz veri kümesi.
InvalidTest	Geçersiz test.
FailedDataset	Başarısız veri kümesi.
InvalidModel	Geçersiz model.
InvalidTranscription	Geçersiz transkripsiyon.
InvalidPayload	Geçersiz yük.
InvalidParameter	Geçersiz parametre.
EndpointWithoutLogging	Günlüğe kaydetmeden uç nokta.
InvalidPermissions	Geçersiz izinler.
InvalidPrerequisite	Geçersiz önkoşul.
InvalidProductId	Geçersiz ürün kimliği.
InvalidSubscription	Geçersiz abonelik.
InvalidProject	Geçersiz proje.
InvalidProjectKind	Geçersiz proje türü.
InvalidRecordingsUri	Geçersiz kayıt uri'si.
OnlyOneOfUrlsOrContainerOrDataset	Url'lerden, kapsayıcılardan veya veri kümelerinden yalnızca biri.
ExceededNumberOfRecordingsUris	Kayıt sayısı aşıldı uris.
ModelMismatch	Model uyuşmazlığı.
ProjectGenderMismatch	Proje cinsiyet uyuşmazlığı.
ModelDeprecated	Model kullanım dışı bırakıldı.
ModelExists	Model var.
ModelNotDeployable	Model dağıtılamaz.
EndpointNotUpdatable	Uç nokta güncelleştirilebilir değil.
SingleDefaultEndpoint	Tek varsayılan uç nokta.
EndpointCannotBeDefault	Uç nokta varsayılan olamaz.
InvalidModelUri	Geçersiz model uri'si.
SubscriptionNotFound	Abonelik bulunamadı.
QuotaViolation	Kota ihlali.
UnsupportedDelta	Desteklenmeyen delta.
UnsupportedFilter	Desteklenmeyen filtre.
UnsupportedPagination	Desteklenmeyen sayfalandırma.
UnsupportedDynamicConfiguration	Desteklenmeyen dinamik yapılandırma.
UnsupportedOrderBy	Desteklenmeyen sipariş ölçütü.
NoUtf8WithBom	Ürün reçetesi ile utf8 yok.
ModelDeploymentNotCompleteState	Model dağıtımı tamamlanmadı durumu.
SkuLimitsExist	Sku sınırları vardır.
DeployingFailedModel	Başarısız modeli dağıtma.
UnsupportedTimeRange	Desteklenmeyen zaman aralığı.
InvalidLogDate	Geçersiz günlük tarihi.
InvalidLogId	Geçersiz günlük kimliği.
InvalidLogStartTime	Geçersiz günlük başlangıç saati.
InvalidLogEndTime	Geçersiz günlük bitiş saati.
InvalidTopForLogs	Günlükler için geçersiz üst.
InvalidSkipTokenForLogs	Günlükler için geçersiz atlama belirteci.
DeleteNotAllowed	Silmeye izin verilmiyor.
Forbidden	Yasak.
DeployNotAllowed	Dağıtıma izin verilmiyor.
UnexpectedError	Beklenmeyen hata.
InvalidCollection	Geçersiz koleksiyon.
InvalidCallbackUri	Geçersiz geri çağırma uri'si.
InvalidSasValidityDuration	Geçersiz sas geçerlilik süresi.
InaccessibleCustomerStorage	Erişilemeyen müşteri depolama alanı.
UnsupportedClassBasedAdaptation	Desteklenmeyen sınıf tabanlı uyarlama.
InvalidWebHookEventKind	Geçersiz web kancası olay türü.
InvalidTimeToLive	Geçersiz yaşam süresi.

EntityError

Object

EntityError

Name	Tür	Description
code	string	Bu hatanın kodu.
message	string	Bu hatanın iletisi.

Error

Object

Hata

Name	Tür	Description
code	ErrorCode	ErrorCode Üst düzey hata kodları.
details	Error[]	Hata ve/veya beklenen ilkelerle ilgili ek destekleyici ayrıntılar.
innerError	InnerError	InnerError https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owadresinde bulunan Bilişsel Hizmetler API Yönergelerine uygun yeni İç Hata biçimi. Bu, ErrorCode, ileti ve isteğe bağlı özellikler hedefi, ayrıntılar (anahtar değer çifti), iç hata (iç içe olabilir) özelliklerini içerir.
message	string	Üst düzey hata iletisi.
target	string	Hatanın kaynağı. Örneğin, geçersiz belge durumunda "belgeler" veya "belge kimliği" olabilir.

ErrorCode

Listeleme

ErrorCode

Değer	Description
InvalidRequest	Geçersiz istek hata kodunu temsil ediyor.
InvalidArgument	Geçersiz bağımsız değişken hata kodunu temsil ediyor.
InternalServerError	İç sunucu hata kodunu temsil etme.
ServiceUnavailable	Hizmet kullanılamıyor hata kodunu temsil ediyor.
NotFound	Bulunamadı hata kodunu temsil ediyor.
PipelineError	İşlem hattı hata kodunu temsil eder.
Conflict	Çakışma hata kodunu temsil eden.
InternalCommunicationFailed	İç iletişim başarısız hata kodunu temsil ediyor.
Forbidden	Yasak hata kodunu temsil ediyor.
NotAllowed	İzin verilmeyen hata kodunu temsil ediyor.
Unauthorized	Yetkisiz hata kodunu temsil etme.
UnsupportedMediaType	Desteklenmeyen medya türü hata kodunu temsil eder.
TooManyRequests	Çok fazla istek hata kodunu temsil eder.
UnprocessableEntity	İşlenemeyen varlık hata kodunu temsil eder.

InnerError

Object

InnerError

Name	Tür	Description
code	DetailedErrorCode	DetailedErrorCode Ayrıntılı hata kodu sabit listesi.
details	object	Hata ve/veya beklenen ilkelerle ilgili ek destekleyici ayrıntılar.
innerError	InnerError	InnerError https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owadresinde bulunan Bilişsel Hizmetler API Yönergelerine uygun yeni İç Hata biçimi. Bu, ErrorCode, ileti ve isteğe bağlı özellikler hedefi, ayrıntılar (anahtar değer çifti), iç hata (iç içe olabilir) özelliklerini içerir.
message	string	Üst düzey hata iletisi.
target	string	Hatanın kaynağı. Örneğin, geçersiz belge durumunda "belgeler" veya "belge kimliği" olabilir.

Status

Listeleme

Durum

Değer	Description
NotStarted	Uzun süre çalışan işlem henüz başlatılmadı.
Running	Uzun süre çalışan işlem şu anda işleniyor.
Succeeded	Uzun süre çalışan işlem başarıyla tamamlandı.
Failed	Uzun süre çalışan işlem başarısız oldu.

WebHook

Object

Web Kancası

Name	Tür	Description
createdDateTime	string (date-time)	Nesnenin oluşturulduğu zaman damgası. Zaman damgası ISO 8601 tarih ve saat biçimi olarak kodlanmıştır ("YYYY-MM-DDThh: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'dir.
description	string	Nesnenin açıklaması.
displayName	string	Nesnenin görünen adı.
events	WebHookEvents	Web KancasıEvents
lastActionDateTime	string (date-time)	Geçerli durumun girildiği zaman damgası. Zaman damgası ISO 8601 tarih ve saat biçimi olarak kodlanmıştır ("YYYY-MM-DDThh:mm:ssZ", bkz. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	Web Kancası Bağlantıları
properties	WebHookProperties	WebHookProperties
self	string (uri)	Bu varlığın konumu.
status	Status	Durum API'nin geçerli durumunu açıklama
webUrl	string (uri)	Kayıtlı olaylar için POST isteklerini göndermek için kullanılacak kayıtlı URL.

WebHookEvents

Object

Web KancasıEvents

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

Object

Web Kancası Bağlantıları

Name	Tür	Description
ping	string (uri)	Web kancası kaydının kayıtlı URL'sine ping olayının gönderilmesini tetiklemede kullanılabilecek URL.
test	string (uri)	Test olaylarını web kancası kaydının kayıtlı URL'sine gönderirken kullanılabilecek URL.

WebHookProperties

Object

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. Şekil değiştiği ve bunu kullanan API sürümü kaldırıldığı için yük türü artık desteklenmiyorsa (kullanımdan kaldırıldıktan sonra), web kancası devre dışı bırakılır.
error	EntityError	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.

WebHookPropertiesUpdate

Object

WebHookPropertiesUpdate

Name	Tür	Description
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.

WebHookUpdate

Object

Web KancasıGüncelleştirme

Name	Tür	Description
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'dir.
description	string	Nesnenin açıklaması.
displayName	string	Nesnenin adı.
events	WebHookEvents	Web KancasıEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string (uri)	Kayıtlı olaylar için POST isteklerini göndermek için kullanılacak kayıtlı URL.

Aracılığıyla paylaş

Update Hook - Update Hook

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

Ocp-Apim-Subscription-Key

Authorization

Örnekler

Update a web hook

Örnek isteği

Örnek yanıt

Tanımlar

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate