Models - Get Base Model

服務:: Azure AI Services

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

取得指定標識碼所識別的基底模型。

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/{id}

URI 參數

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

回應

名稱	類型	Description
200 OK	BaseModel	還行
Other Status Codes	Error	發生錯誤。

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

Authorization

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

類型: apiKey
位於: header

範例

Get a base model

範例要求

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b

範例回覆

狀態碼:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "deprecationDates": {
      "adaptationDateTime": "2022-11-04T00:00:00Z",
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": true,
      "supportsAdaptationsWith": [
        "Language",
        "Acoustic"
      ],
      "supportedOutputFormats": [
        "Display",
        "Lexical"
      ]
    },
    "chargeForAdaptation": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "en-US Base model"
}

定義

名稱	Description
BaseModel	BaseModel
BaseModelDeprecationDates	BaseModelDeprecationDates
BaseModelFeatures	BaseModelFeatures
BaseModelLinks	BaseModelLinks
BaseModelProperties	BaseModelProperties
DatasetKind	DatasetKind
DetailedErrorCode	DetailedErrorCode
Error	錯誤
ErrorCode	錯誤代碼
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	地位

BaseModel

Object

BaseModel

名稱	類型	Description
createdDateTime	string (date-time)	物件建立時的時間戳。時間戳會編碼為 ISO 8601 日期和時間格式（“YYYY-MM-DDThh：mm：ssZ”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations）。
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	BaseModelLinks	BaseModelLinks
locale	string minLength: 1	自主數據的地區設定。
properties	BaseModelProperties	BaseModelProperties
self	string (uri)	此實體的位置。
status	Status	地位描述 API 的目前狀態

BaseModelDeprecationDates

Object

BaseModelDeprecationDates

名稱	類型	Description
adaptationDateTime	string (date-time)	改編已過時的日期。
transcriptionDateTime	string (date-time)	轉譯已過時的日期。

BaseModelFeatures

Object

BaseModelFeatures

名稱	類型	Description
supportedOutputFormats	OutputFormatType[]	支援的輸出格式。
supportsAdaptationsWith	DatasetKind[]	支援的數據集類型可調整模型。
supportsEndpoints	boolean	值，指出是否支援建立即時轉譯的端點。
supportsTranscriptions	boolean	值，指出是否支援批次轉譯。
supportsTranscriptionsOnSpeechContainers	boolean	值，指出此模型是否可用於語音容器的轉譯。當現有模型在語音容器上可供使用時，即可在現有模型上新增此功能。

BaseModelLinks

Object

BaseModelLinks

名稱	類型	Description
manifest	string (uri)	取得要用於內部部署容器中之此模型指令清單的位置。如需詳細資訊，請參閱作業「Models_GetCustomModelManifest」。

BaseModelProperties

Object

BaseModelProperties

名稱	類型	Description
chargeForAdaptation	boolean	值，指出模型調整是否收費。
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures 模型支援的功能。

DatasetKind

列舉型別

DatasetKind

值	Description
Language	語言數據集。
Acoustic	原音數據集。
Pronunciation	發音數據集。
AudioFiles	音訊檔案數據集。
LanguageMarkdown	語言 Markdown 數據集。
OutputFormatting	包含規則的數據集，可自定義反向文字正規化、大寫、重新調整、粗話，以及定義數據集驗證的測試

DetailedErrorCode

列舉型別

DetailedErrorCode

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

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

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	錯誤的來源。例如，如果檔無效，則會是「檔」或「文件標識碼」。

OutputFormatType

列舉型別

OutputFormatType

值	Description
Lexical	模型提供不格式化的轉譯輸出。
Display	模型支持顯示格式化轉譯輸出或端點。

Status

列舉型別

地位

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

共用方式為

Models - Get Base Model

URI 參數

回應

安全性

Ocp-Apim-Subscription-Key

Authorization

範例

Get a base model

範例要求

範例回覆

定義

BaseModel

BaseModelDeprecationDates

BaseModelFeatures

BaseModelLinks

BaseModelProperties

DatasetKind

DetailedErrorCode

Error

ErrorCode

InnerError

OutputFormatType

Status