Models - Get File

參考

Service:: Azure AI Services

API Version:: v3.2-preview.2

從標識碼 () 識別的模型 (，取得使用 fileId) 識別的一個特定檔案。

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

With optional parameters:

GET {endpoint}/speechtotext/v3.2-preview.2/models/{id}/files/{fileId}?sasValidityInSeconds={sasValidityInSeconds}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus.api.cognitive.microsoft.com) 。
fileId	path	True	string uuid	檔案的標識碼。
id	path	True	string uuid	模型的識別碼。
sasValidityInSeconds	query		integer int32	SAS URL 應有效秒的持續時間。默認持續時間為12小時。使用 BYOS (https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging) ：值為 0 表示會產生不含 SAS 令牌的一般 Blob URI。

回應

名稱	類型	Description
200 OK	File	確定
Other Status Codes	Error	發生錯誤。

安全性

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

Authorization

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

Type: apiKey
In: header

範例

Get a file

Sample Request

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?sasValidityInSeconds=120

Sample Response

Status code:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
  "name": "report.json",
  "kind": "ModelReport",
  "properties": {
    "size": 200
  },
  "createdDateTime": "2020-01-13T08:00:00Z",
  "links": {
    "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
  }
}

定義

名稱	Description
DetailedErrorCode	DetailedErrorCode
Error	錯誤
ErrorCode	ErrorCode
File	檔案
FileKind	FileKind
FileLinks	FileLinks
FileProperties	FileProperties
InnerError	InnerError

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	不支援的時間範圍。

Error

錯誤

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

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	表示不支援的媒體類型錯誤碼。

File

檔案

名稱	類型	Description
createdDateTime	string	此檔案的建立時間。時間戳會編碼為 ISO 8601 日期和時間格式， (請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。
kind	FileKind	FileKind 數據類型。
links	FileLinks	FileLinks
name	string	這個檔案的名稱。
properties	FileProperties	FileProperties
self	string	此實體的位置。

FileKind

名稱	類型	Description
AcousticDataArchive	string	數據類型是原音數據封存。
AcousticDataTranscriptionV2	string	數據類型是原音數據轉譯 v2。
Audio	string	數據類型為音訊。
DatasetReport	string	數據類型是數據集報表。
EvaluationDetails	string	數據類型是評估詳細數據。
LanguageData	string	數據類型是語言數據。
ModelReport	string	數據類型為模型報表。
OutputFormattingData	string	數據類型是輸出格式輸入檔。
PronunciationData	string	數據類型是發音數據。
Transcription	string	數據類型為轉譯。
TranscriptionReport	string	數據類型為轉譯報告。

FileLinks

名稱	類型	Description
contentUrl	string	要擷取此檔案內容的URL。

FileProperties

名稱	類型	Description
duration	string	如果此檔案是音訊檔案，則持續時間。持續時間會編碼為 ISO 8601 持續時間 (“PnYnMnDTnHnMnS”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Durations) 。
size	integer	以位元組為單位的數據大小。

InnerError

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