Models - Get Custom Model
取得指定標識碼所識別的模型。
GET {endpoint}/speechtotext/v3.2-preview.2/models/{id}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
支援的認知服務端點 (通訊協定和主機名,例如: https://westus.api.cognitive.microsoft.com) 。 |
id
|
path | True |
string uuid |
模型的識別碼。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 標題 Retry-After: integer |
|
Other Status Codes |
發生錯誤。 |
安全性
Ocp-Apim-Subscription-Key
在這裡提供認知服務帳戶金鑰。
類型:
apiKey
位於:
header
Authorization
從此區域的 STS 傳回的 JWT 提供存取令牌。 請務必將下列查詢字串新增至 STS URL,將管理範圍新增至令牌:?scope=speechservicesmanagement
類型:
apiKey
位於:
header
範例
Get a model |
Get a model with custom model weight |
Get a model
範例要求
GET {endpoint}/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b
範例回覆
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
"baseModel": {
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
},
"datasets": [
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
}
],
"links": {
"manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
"copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
"copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
"files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
},
"properties": {
"deprecationDates": {
"transcriptionDateTime": "2023-05-04T00:00:00Z"
},
"customModelWeightPercent": 30,
"features": {
"supportsTranscriptions": true,
"supportsEndpoints": true,
"supportsTranscriptionsOnSpeechContainers": false,
"supportedOutputFormats": [
"Lexical",
"Display"
]
}
},
"lastActionDateTime": "2019-01-07T11:36:07Z",
"status": "Running",
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"displayName": "Language model",
"description": "This is a language model"
}
Get a model with custom model weight
範例要求
GET {endpoint}/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b
範例回覆
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b",
"baseModel": {
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
},
"datasets": [
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
}
],
"links": {
"manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
"copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
"copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
"files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
},
"properties": {
"deprecationDates": {
"transcriptionDateTime": "2023-05-04T00:00:00Z"
},
"customModelWeightPercent": 42,
"features": {
"supportsTranscriptions": true,
"supportsEndpoints": true,
"supportsTranscriptionsOnSpeechContainers": false,
"supportedOutputFormats": [
"Lexical",
"Display"
]
}
},
"lastActionDateTime": "2019-01-07T11:36:07Z",
"status": "Running",
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"displayName": "Language model",
"description": "This is a language model"
}
定義
名稱 | Description |
---|---|
Custom |
CustomModel |
Custom |
CustomModelDeprecationDates |
Custom |
CustomModelFeatures |
Custom |
CustomModelLinks |
Custom |
CustomModelProperties |
Detailed |
DetailedErrorCode |
Entity |
EntityError |
Entity |
EntityReference |
Error |
錯誤 |
Error |
ErrorCode |
Inner |
InnerError |
Output |
OutputFormatType |
Status |
狀態 |
CustomModel
CustomModel
名稱 | 類型 | Description |
---|---|---|
baseModel |
EntityReference |
|
createdDateTime |
string |
建立物件時的時間戳。 時間戳會編碼為 ISO 8601 日期和時間格式, (“YYYY-MM-DDThh:mm:ssZ”,請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。 |
customProperties |
object |
此實體的自定義屬性。 允許的金鑰長度上限為 64 個字元,允許的最大值長度為 256 個字元,允許的項目計數為 10。 |
datasets |
用於調適的數據集。 |
|
description |
string |
物件的描述。 |
displayName |
string |
對象的顯示名稱。 |
lastActionDateTime |
string |
輸入目前狀態時的時間戳。 時間戳會編碼為 ISO 8601 日期和時間格式, (“YYYY-MM-DDThh:mm:ssZ”,請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。 |
links |
CustomModelLinks |
|
locale |
string |
自主數據的地區設定。 |
project |
EntityReference |
|
properties |
CustomModelProperties |
|
self |
string |
此實體的位置。 |
status |
狀態 |
|
text |
string |
用來調整此語言模型的文字。 |
CustomModelDeprecationDates
CustomModelDeprecationDates
名稱 | 類型 | Description |
---|---|---|
transcriptionDateTime |
string |
轉譯變成已被取代的日期。 |
CustomModelFeatures
CustomModelFeatures
名稱 | 類型 | Description |
---|---|---|
supportedOutputFormats |
支援的輸出格式。 |
|
supportsEndpoints |
boolean |
值,指出是否支援建立即時轉譯的端點。 |
supportsTranscriptions |
boolean |
值,指出是否支援批次轉譯。 |
supportsTranscriptionsOnSpeechContainers |
boolean |
值,指出此模型是否可以用於語音容器的轉譯。 在語音容器上使用此功能時,可以在現有模型上新增此功能。 |
CustomModelLinks
CustomModelLinks
名稱 | 類型 | Description |
---|---|---|
copy |
string |
模型複製動作的位置。 如需詳細資訊,請參閱作業「Models_Copy」。 |
copyTo |
string |
過時模型複製動作的位置。 如需詳細資訊,請參閱作業「Models_CopyTo」。 |
files |
string |
取得此實體所有檔案的位置。 如需詳細資訊,請參閱作業「Models_ListFiles」。 |
manifest |
string |
要取得此模型在內部部署容器中使用的指令清單的位置。 如需詳細資訊,請參閱作業「Models_GetCustomModelManifest」。 |
CustomModelProperties
CustomModelProperties
名稱 | 類型 | Description |
---|---|---|
customModelWeightPercent |
integer |
1% (1% 自定義模型與 99% 基底模型之間的權數,) 和 100% (100% 自定義模型和 0% 基底模型) 。 如果未設定此屬性,服務會選擇適當的值, (取得模型以擷取選取的權數) 。 不使用這個屬性啟動。 如有需要,請選擇較大的 (或較小的) 權數,以增加 (或減少) 自定義模型的影響。 |
deprecationDates |
CustomModelDeprecationDates |
|
string |
在作業完成時,傳送電子郵件通知的電子郵件位址。 成功傳送電子郵件之後,將會移除此值。 |
|
error |
EntityError |
|
features |
CustomModelFeatures |
DetailedErrorCode
DetailedErrorCode
名稱 | 類型 | Description |
---|---|---|
DataImportFailed |
string |
數據匯入失敗。 |
DeleteNotAllowed |
string |
不允許刪除。 |
DeployNotAllowed |
string |
不允許部署。 |
DeployingFailedModel |
string |
部署失敗的模型。 |
EmptyRequest |
string |
空白要求。 |
EndpointCannotBeDefault |
string |
端點不可為預設值。 |
EndpointNotUpdatable |
string |
端點無法更新。 |
EndpointWithoutLogging |
string |
沒有記錄的端點。 |
ExceededNumberOfRecordingsUris |
string |
超過錄製 URI 的數目。 |
FailedDataset |
string |
失敗的數據集。 |
Forbidden |
string |
禁止。 |
InUseViolation |
string |
在使用違規中。 |
InaccessibleCustomerStorage |
string |
無法存取的客戶記憶體。 |
InvalidAdaptationMapping |
string |
調整對應無效。 |
InvalidBaseModel |
string |
基底模型無效。 |
InvalidCallbackUri |
string |
無效的回呼 URI。 |
InvalidCollection |
string |
無效的集合。 |
InvalidDataset |
string |
無效的數據集。 |
InvalidDocument |
string |
無效的檔。 |
InvalidDocumentBatch |
string |
檔批次無效。 |
InvalidLocale |
string |
無效的地區設定。 |
InvalidLogDate |
string |
無效的記錄日期。 |
InvalidLogEndTime |
string |
無效的記錄結束時間。 |
InvalidLogId |
string |
無效的記錄標識碼。 |
InvalidLogStartTime |
string |
無效的記錄開始時間。 |
InvalidModel |
string |
無效的模型。 |
InvalidModelUri |
string |
無效的模型 URI。 |
InvalidParameter |
string |
無效的參數。 |
InvalidParameterValue |
string |
無效的參數值。 |
InvalidPayload |
string |
承載無效。 |
InvalidPermissions |
string |
無效的許可權。 |
InvalidPrerequisite |
string |
無效的必要條件。 |
InvalidProductId |
string |
無效的產品標識碼。 |
InvalidProject |
string |
無效的專案。 |
InvalidProjectKind |
string |
無效的項目種類。 |
InvalidRecordingsUri |
string |
無效的錄製 URI。 |
InvalidRequestBodyFormat |
string |
要求本文格式無效。 |
InvalidSasValidityDuration |
string |
無效的 sas 有效性持續時間。 |
InvalidSkipTokenForLogs |
string |
記錄的略過令牌無效。 |
InvalidSourceAzureResourceId |
string |
無效的來源 Azure 資源識別碼。 |
InvalidSubscription |
string |
無效的訂用帳戶。 |
InvalidTest |
string |
測試無效。 |
InvalidTimeToLive |
string |
存留時間無效。 |
InvalidTopForLogs |
string |
記錄的頂端無效。 |
InvalidTranscription |
string |
無效的轉譯。 |
InvalidWebHookEventKind |
string |
無效的 Web 攔截事件種類。 |
MissingInputRecords |
string |
遺漏輸入記錄。 |
ModelCopyOperationExists |
string |
模型複製作業存在。 |
ModelDeploymentNotCompleteState |
string |
模型部署未完成狀態。 |
ModelDeprecated |
string |
模型已被取代。 |
ModelExists |
string |
模型存在。 |
ModelMismatch |
string |
模型不符。 |
ModelNotDeployable |
string |
模型無法部署。 |
ModelVersionIncorrect |
string |
模型版本不正確。 |
NoUtf8WithBom |
string |
沒有 bom 的 utf8。 |
OnlyOneOfUrlsOrContainerOrDataset |
string |
只有其中一個 URL 或容器或數據集。 |
ProjectGenderMismatch |
string |
專案性別不符。 |
QuotaViolation |
string |
配額違規。 |
SingleDefaultEndpoint |
string |
單一預設端點。 |
SkuLimitsExist |
string |
Sku 限制存在。 |
SubscriptionNotFound |
string |
找不到訂用帳戶。 |
UnexpectedError |
string |
非預期的錯誤。 |
UnsupportedClassBasedAdaptation |
string |
不支援的類別型調整。 |
UnsupportedDelta |
string |
不支持的差異。 |
UnsupportedDynamicConfiguration |
string |
不支援的動態設定。 |
UnsupportedFilter |
string |
不支援的篩選。 |
UnsupportedLanguageCode |
string |
不支援的語言代碼。 |
UnsupportedOrderBy |
string |
不支援的順序。 |
UnsupportedPagination |
string |
不支援的分頁。 |
UnsupportedTimeRange |
string |
不支援的時間範圍。 |
EntityError
EntityError
名稱 | 類型 | Description |
---|---|---|
code |
string |
此錯誤的程序代碼。 |
message |
string |
此錯誤的訊息。 |
EntityReference
EntityReference
名稱 | 類型 | Description |
---|---|---|
self |
string |
參考實體的位置。 |
Error
錯誤
名稱 | 類型 | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
關於錯誤和/或預期原則的其他支持詳細數據。 |
innerError |
InnerError |
|
message |
string |
高階錯誤訊息。 |
target |
string |
錯誤的來源。 例如,如果文件無效,則會是「documents」或「document id」。 |
ErrorCode
ErrorCode
名稱 | 類型 | Description |
---|---|---|
Conflict |
string |
表示衝突錯誤碼。 |
Forbidden |
string |
表示禁止的錯誤碼。 |
InternalCommunicationFailed |
string |
表示內部通訊失敗的錯誤碼。 |
InternalServerError |
string |
表示內部伺服器錯誤碼。 |
InvalidArgument |
string |
表示無效的自變數錯誤碼。 |
InvalidRequest |
string |
表示無效的要求錯誤碼。 |
NotAllowed |
string |
表示不允許的錯誤碼。 |
NotFound |
string |
表示找不到的錯誤碼。 |
PipelineError |
string |
表示管線錯誤碼。 |
ServiceUnavailable |
string |
表示服務無法使用的錯誤碼。 |
TooManyRequests |
string |
表示太多要求錯誤碼。 |
Unauthorized |
string |
表示未經授權的錯誤碼。 |
UnprocessableEntity |
string |
表示無法處理的實體錯誤碼。 |
UnsupportedMediaType |
string |
表示不支援的媒體類型錯誤碼。 |
InnerError
InnerError
名稱 | 類型 | Description |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
關於錯誤和/或預期原則的其他支持詳細數據。 |
innerError |
InnerError |
|
message |
string |
高階錯誤訊息。 |
target |
string |
錯誤的來源。 例如,如果文件無效,則會是「documents」或「document id」。 |
OutputFormatType
OutputFormatType
名稱 | 類型 | Description |
---|---|---|
Display |
string |
模型支持顯示格式化轉譯輸出或端點。 |
Lexical |
string |
模型會提供不具格式的轉譯輸出。 |
Status
狀態
名稱 | 類型 | Description |
---|---|---|
Failed |
string |
長時間執行的作業失敗。 |
NotStarted |
string |
長時間執行的作業尚未啟動。 |
Running |
string |
長時間執行的作業目前正在處理。 |
Succeeded |
string |
長時間執行的作業已順利完成。 |