Endpoints - Update

參考

服務:: Azure AI Services

API 版本:: v3.2-preview.2

更新指定標識碼所識別端點的元數據。

PATCH {endpoint}/speechtotext/v3.2-preview.2/endpoints/{id}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點（通訊協定和主機名，例如：https://westus.api.cognitive.microsoft.com）。
id	path	True	string (uuid)	端點的標識碼。

要求本文

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

名稱	類型	Description
customProperties	object	此實體的自定義屬性。允許的索引鍵長度上限為 64 個字元，允許的最大值長度為 256 個字元，允許的項目計數為 10。
description	string	物件的描述。
displayName	string	物件的名稱。
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointPropertiesUpdate	EndpointPropertiesUpdate

回應

名稱	類型	Description
200 OK	Endpoint	還行標題 Retry-After: integer
Other Status Codes	Error	發生錯誤。

名稱

類型

Description

200 OK

Endpoint

還行

標題

Retry-After: integer

Other Status Codes

Error

發生錯誤。

安全性

Ocp-Apim-Subscription-Key

在這裡提供您的認知服務帳戶金鑰。

類型: apiKey
位於: header

Authorization

提供來自此區域 STS 所傳回之 JWT 的存取令牌。請務必將下列查詢字串新增至 STS URL，將管理範圍新增至令牌：？scope=speechservicesmanagement

類型: apiKey
位於: header

範例

Update an endpoint

範例要求

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

範例回覆

狀態碼:: 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"
}

定義

名稱	Description
DetailedErrorCode	DetailedErrorCode
Endpoint	端點
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EndpointPropertiesUpdate	EndpointPropertiesUpdate
EndpointUpdate	EndpointUpdate
EntityError	EntityError
EntityReference	EntityReference
Error	錯誤
ErrorCode	錯誤代碼
InnerError	InnerError
Status	地位

DetailedErrorCode

列舉型別

DetailedErrorCode

值	Description
DataImportFailed	數據匯入失敗。
DeleteNotAllowed	不允許刪除。
DeployNotAllowed	不允許部署。
DeployingFailedModel	部署失敗的模型。
EmptyRequest	空白要求。
EndpointCannotBeDefault	端點不可為預設值。
EndpointNotUpdatable	端點無法更新。
EndpointWithoutLogging	沒有記錄的端點。
ExceededNumberOfRecordingsUris	超過錄製 URI 的數目。
FailedDataset	失敗的數據集。
Forbidden	禁止。
InUseViolation	在使用違規中。
InaccessibleCustomerStorage	無法存取的客戶記憶體。
InvalidAdaptationMapping	無效的適應對應。
InvalidBaseModel	基底模型無效。
InvalidCallbackUri	無效的回呼 URI。
InvalidCollection	無效的集合。
InvalidDataset	無效的數據集。
InvalidDocument	無效的檔。
InvalidDocumentBatch	檔批次無效。
InvalidLocale	地區設定無效。
InvalidLogDate	無效的記錄日期。
InvalidLogEndTime	無效的記錄結束時間。
InvalidLogId	無效的記錄標識碼。
InvalidLogStartTime	無效的記錄開始時間。
InvalidModel	無效的模型。
InvalidModelUri	無效的模型 URI。
InvalidParameter	無效的參數。
InvalidParameterValue	無效的參數值。
InvalidPayload	無效的承載。
InvalidPermissions	許可權無效。
InvalidPrerequisite	無效的必要條件。
InvalidProductId	無效的產品標識碼。
InvalidProject	無效的專案。
InvalidProjectKind	無效的項目種類。
InvalidRecordingsUri	無效的錄製 URI。
InvalidRequestBodyFormat	要求本文格式無效。
InvalidSasValidityDuration	無效的 sas 有效性持續時間。
InvalidSkipTokenForLogs	記錄的略過令牌無效。
InvalidSourceAzureResourceId	來源 Azure 資源標識碼無效。
InvalidSubscription	無效的訂用帳戶。
InvalidTest	無效的測試。
InvalidTimeToLive	存留時間無效。
InvalidTopForLogs	記錄的頂端無效。
InvalidTranscription	無效的轉譯。
InvalidWebHookEventKind	無效的 Web 攔截事件種類。
MissingInputRecords	遺漏輸入記錄。
ModelCopyOperationExists	模型複製作業存在。
ModelDeploymentNotCompleteState	模型部署未完成狀態。
ModelDeprecated	模型已被取代。
ModelExists	模型存在。
ModelMismatch	模型不符。
ModelNotDeployable	模型不可部署。
ModelVersionIncorrect	模型版本不正確。
NoUtf8WithBom	沒有 utf8 與 bom。
OnlyOneOfUrlsOrContainerOrDataset	只有一個 URL 或容器或數據集。
ProjectGenderMismatch	專案性別不符。
QuotaViolation	配額違規。
SingleDefaultEndpoint	單一預設端點。
SkuLimitsExist	Sku 限制存在。
SubscriptionNotFound	找不到訂用帳戶。
UnexpectedError	未預期的錯誤。
UnsupportedClassBasedAdaptation	不支援的類別型調整。
UnsupportedDelta	不支持的差異。
UnsupportedDynamicConfiguration	不支援的動態設定。
UnsupportedFilter	不支援的篩選。
UnsupportedLanguageCode	不支援的語言代碼。
UnsupportedOrderBy	不支援的順序依據。
UnsupportedPagination	不支援的分頁。
UnsupportedTimeRange	不支援的時間範圍。

Endpoint

Object

端點

名稱	類型	Description
createdDateTime	string (date-time)	物件建立時的時間戳。時間戳會編碼為 ISO 8601 日期和時間格式（“YYYY-MM-DDThh：mm：ssZ”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations）。
customProperties	object	此實體的自定義屬性。允許的索引鍵長度上限為 64 個字元，允許的最大值長度為 256 個字元，允許的項目計數為 10。
description	string	物件的描述。
displayName	string minLength: 1	對象的顯示名稱。
lastActionDateTime	string (date-time)	輸入目前狀態時的時間戳。時間戳會編碼為 ISO 8601 日期和時間格式（“YYYY-MM-DDThh：mm：ssZ”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations）。
links	EndpointLinks	EndpointLinks
locale	string minLength: 1	自主數據的地區設定。
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string (uri)	此實體的位置。
status	Status	地位描述 API 的目前狀態
text	string	用來調整此端點語言模型的文字。

EndpointLinks

Object

EndpointLinks

名稱	類型	Description
logs	string (uri)	此端點的音訊和轉譯記錄。如需詳細資訊，請參閱作業「Endpoints_ListLogs」。
restConversation	string (uri)	要求最多 60 秒的 REST 端點。
restDictation	string (uri)	要求最多 60 秒的 REST 端點，支持標點符號的聽寫。
restInteractive	string (uri)	最多 15 秒的簡短要求的 REST 端點。
webSocketConversation	string (uri)	具有多個最終結果之長時間要求的語音 SDK 端點。
webSocketDictation	string (uri)	具有多個最終結果之長時間要求的語音 SDK 端點，支援標點符號的聽寫。
webSocketInteractive	string (uri)	語音 SDK 端點，要求最多 15 秒，併產生單一最終結果。

EndpointProperties

Object

EndpointProperties

名稱	類型	Description
email	string	傳送電子郵件通知的電子郵件位址，以防作業完成。成功傳送電子郵件之後，將會移除此值。
error	EntityError	EntityError
loggingEnabled	boolean	值，指出是否要用於部署的內容記錄（音訊 & 轉譯）。
timeToLive	string	端點會保留在系統中的時間長度。一旦端點到達完成後存留時間（成功或失敗），系統就會自動刪除。若未將此值設定為 0，將會停用自動刪除。最長支持的持續時間為31天。持續時間會編碼為 ISO 8601 持續時間（“PnYnMnDTnHnMnS”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Durations）。

EndpointPropertiesUpdate

Object

EndpointPropertiesUpdate

名稱	類型	Description
contentLoggingEnabled	boolean	值，指出是否要用於部署的內容記錄（音訊 & 轉譯）。

EndpointUpdate

Object

EndpointUpdate

名稱	類型	Description
customProperties	object	此實體的自定義屬性。允許的索引鍵長度上限為 64 個字元，允許的最大值長度為 256 個字元，允許的項目計數為 10。
description	string	物件的描述。
displayName	string	物件的名稱。
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointPropertiesUpdate	EndpointPropertiesUpdate

EntityError

Object

EntityError

名稱	類型	Description
code	string	此錯誤的程序代碼。
message	string	此錯誤的訊息。

EntityReference

Object

EntityReference

名稱	類型	Description
self	string (uri)	參考實體的位置。

Error

Object

錯誤

名稱	類型	Description
code	ErrorCode	錯誤代碼高階錯誤碼。
details	Error[]	有關錯誤和/或預期原則的其他支持詳細數據。
innerError	InnerError	InnerError 符合認知服務 API 指導方針的新內部錯誤格式，可在 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow取得。這包括必要的屬性 ErrorCode、訊息和選擇性屬性目標、details（索引鍵值組）、內部錯誤（這可以是巢狀的）。
message	string	高階錯誤訊息。
target	string	錯誤的來源。例如，如果檔無效，則會是「檔」或「文件標識碼」。

ErrorCode

列舉型別

錯誤代碼

值	Description
Conflict	表示衝突錯誤碼。
Forbidden	表示禁止的錯誤碼。
InternalCommunicationFailed	表示內部通訊失敗的錯誤碼。
InternalServerError	表示內部伺服器錯誤碼。
InvalidArgument	表示無效的自變數錯誤碼。
InvalidRequest	表示無效的要求錯誤碼。
NotAllowed	表示不允許的錯誤碼。
NotFound	表示找不到的錯誤碼。
PipelineError	表示管線錯誤碼。
ServiceUnavailable	表示服務無法使用的錯誤碼。
TooManyRequests	表示太多要求錯誤碼。
Unauthorized	表示未經授權的錯誤碼。
UnprocessableEntity	表示無法處理的實體錯誤碼。
UnsupportedMediaType	表示不支援的媒體類型錯誤碼。

InnerError

Object

InnerError

名稱	類型	Description
code	DetailedErrorCode	DetailedErrorCode 詳細的錯誤碼列舉。
details	object	有關錯誤和/或預期原則的其他支持詳細數據。
innerError	InnerError	InnerError 符合認知服務 API 指導方針的新內部錯誤格式，可在 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow取得。這包括必要的屬性 ErrorCode、訊息和選擇性屬性目標、details（索引鍵值組）、內部錯誤（這可以是巢狀的）。
message	string	高階錯誤訊息。
target	string	錯誤的來源。例如，如果檔無效，則會是「檔」或「文件標識碼」。

Status

列舉型別

地位

值	Description
Failed	長時間執行的作業失敗。
NotStarted	長時間執行的作業尚未啟動。
Running	長時間執行的作業目前正在處理中。
Succeeded	長時間執行的作業已順利完成。

共用方式為

Endpoints - Update

URI 參數

要求本文

回應

安全性

Ocp-Apim-Subscription-Key

Authorization

範例

Update an endpoint

範例要求

範例回覆

定義

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EndpointPropertiesUpdate

EndpointUpdate

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

其他資源