Endpoints - Update

Hizmet:: Azure AI Services

API Sürümü:: v3.2-preview.2

Verilen kimlik tarafından tanımlanan uç noktanın meta verilerini güncelleştirir.

PATCH {endpoint}/speechtotext/v3.2-preview.2/endpoints/{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)	Uç noktanı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ı.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointPropertiesUpdate	EndpointPropertiesUpdate

Yanıtlar

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

Name

Tür

Description

200 OK

Endpoint

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 an endpoint

Örnek isteği

HTTP

PATCH {endpoint}/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6

{
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "properties": {
    "contentLoggingEnabled": true
  },
  "displayName": "Updated endpoint with new model",
  "customProperties": {
    "key": "value"
  }
}

Örnek yanıt

Durum kodu:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
    "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
  },
  "properties": {
    "timeToLive": "PT30M",
    "loggingEnabled": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Speech endpoint",
  "description": "Example for speech endpoint"
}

Tanımlar

Name	Description
DetailedErrorCode	DetailedErrorCode
Endpoint	Bitiş noktası
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EndpointPropertiesUpdate	EndpointPropertiesUpdate
EndpointUpdate	EndpointUpdate
EntityError	EntityError
EntityReference	EntityReference
Error	Hata
ErrorCode	Hata Kodu
InnerError	InnerError
Status	Durum

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.
InvalidSourceAzureResourceId	Geçersiz kaynak Azure kaynak kimliği.
ModelCopyOperationExists	Model kopyalama işlemi var.

Endpoint

Object

Bitiş noktası

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 minLength: 1	Nesnenin görünen adı.
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	EndpointLinks	EndpointLinks
locale	string minLength: 1	İçerilen verilerin yerel ayarı.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string (uri)	Bu varlığın konumu.
status	Status	Durum API'nin geçerli durumunu açıklama
text	string	Bu uç nokta için dil modelini uyarlamak için kullanılan metin.

EndpointLinks

Object

EndpointLinks

Name	Tür	Description
logs	string (uri)	Bu uç nokta için ses ve transkripsiyon günlükleri. Daha fazla ayrıntı için "Endpoints_ListLogs" işlemine bakın.
restConversation	string (uri)	60 saniyeye kadar istekler için REST uç noktası.
restDictation	string (uri)	60 saniyeye kadar istekler için REST uç noktası, noktalama işaretlerinin diktesini destekler.
restInteractive	string (uri)	15 saniyeye kadar kısa istekler için REST uç noktası.
webSocketConversation	string (uri)	Birden çok nihai sonuç içeren uzun istekler için Konuşma SDK'sı uç noktası.
webSocketDictation	string (uri)	Noktalama işaretlerinin diktesini destekleyen, birden çok nihai sonuç içeren uzun istekler için Konuşma SDK'sı uç noktası.
webSocketInteractive	string (uri)	Tek bir nihai sonuçla 15 saniyeye kadar kısa istekler için Konuşma SDK'sı uç noktası.

EndpointProperties

Object

EndpointProperties

Name	Tür	Description
email	string	İşlemin tamamlanması durumunda adresine e-posta bildirimleri gönderilecek e-posta adresi. Değer, e-posta başarıyla gönderildikten sonra kaldırılır.
error	EntityError	EntityError
loggingEnabled	boolean	Dağıtım için içerik günlüğünün (ses & transkripsiyonlar) kullanılıp kullanılmadığını gösteren değer.
timeToLive	string	Uç noktanın sistemde ne kadar süre tutulacağı. Bitiş noktası tamamlandıktan (başarılı veya başarısız) sonra yaşam süresine ulaştığında otomatik olarak silinir. Bu değeri veya ayarı 0 olarak ayarlamamak otomatik silmeyi devre dışı bırakır. Desteklenen en uzun süre 31 gündür. Süre ISO 8601 süresi ("PnYnMnDTnHnMnS" olarak kodlanmıştır, bkz. https://en.wikipedia.org/wiki/ISO_8601#Durations).

EndpointPropertiesUpdate

Object

EndpointPropertiesUpdate

Name	Tür	Description
contentLoggingEnabled	boolean	Dağıtım için içerik günlüğünün (ses & transkripsiyonlar) kullanılıp kullanılmadığını gösteren değer.

EndpointUpdate

Object

EndpointUpdate

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ı.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointPropertiesUpdate	EndpointPropertiesUpdate

EntityError

Object

EntityError

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

EntityReference

Object

EntityReference

Name	Tür	Description
self	string (uri)	Başvuruda bulunılan varlığın konumu.

Error

Object

Hata

Name	Tür	Description
code	ErrorCode	Hata Kodu Ü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

Hata Kodu

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.