Datasets - List Files

參考

服務:: Azure AI Services

API 版本:: 2024-11-15

取得指定標識碼所識別數據集的檔案。

GET {endpoint}/speechtotext/datasets/{id}/files?api-version=2024-11-15

含選擇性參數:

GET {endpoint}/speechtotext/datasets/{id}/files?sasLifetimeMinutes={sasLifetimeMinutes}&skip={skip}&top={top}&filter={filter}&api-version=2024-11-15

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點（通訊協定和主機名，例如：https://westus.api.cognitive.microsoft.com）。
id	path	True	string uuid	數據集的識別碼。
api-version	query	True	string	要求的 API 版本。
filter	query		string	選取可用檔案子集的篩選表達式。 `- Supported properties: name, createdDateTime, kind. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=name eq 'myaudio.wav' and kind eq 'Audio'`
sasLifetimeMinutes	query		integer int32	此參數會以分鐘為單位定義 SAS URL 應該有效的持續時間。 `The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS, returned urls do not contain an SAS token.`
skip	query		integer int32	將會略過的數據集數目。
top	query		integer int32	略過之後將包含的數據集數目。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	在這裡提供您的認知服務帳戶金鑰。

回應

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

名稱

類型

Description

200 OK

PaginatedFiles

還行

標題

Retry-After: integer

Other Status Codes

Error

發生錯誤。

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

範例

Get all dataset report files

Get all files

Get all dataset report files

範例要求

HTTP

GET {endpoint}/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?sasLifetimeMinutes=360&skip=0&top=10&filter=kind%20eq%20'DatasetReport'&api-version=2024-11-15

範例回覆

狀態碼:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
      "name": "report.json",
      "kind": "DatasetReport",
      "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"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    }
  ]
}

Get all files

範例要求

HTTP

GET {endpoint}/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?sasLifetimeMinutes=360&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15

範例回覆

狀態碼:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
      "name": "report.json",
      "kind": "DatasetReport",
      "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"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/f035cf2d-4051-4131-85e7-97e3a7349c86?api-version=3.2",
      "name": "language_data.txt",
      "kind": "LanguageData",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?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"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15"
}

定義

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

DetailedErrorCode

名稱	類型	Description
AudioLengthLimitExceeded	string	音訊檔案超過允許的持續時間上限。
BadChannelConfiguration	string	數據中的音訊通道、組態或應用程式的需求不符。
DataImportFailed	string	數據匯入失敗。
DeleteNotAllowed	string	不允許刪除。
DeployNotAllowed	string	不允許部署。
DeployingFailedModel	string	部署失敗的模型。
EmptyAudioFile	string	音訊檔案是空的。
EmptyRequest	string	空白要求。
EndpointCannotBeDefault	string	端點不可為預設值。
EndpointLoggingNotSupported	string	不支援端點記錄。
EndpointNotUpdatable	string	端點無法更新。
EndpointWithoutLogging	string	沒有記錄的端點。
ExceededNumberOfRecordingsUris	string	超過錄製 URI 的數目。
FailedDataset	string	失敗的數據集。
Forbidden	string	禁止。
InUseViolation	string	在使用違規中。
InaccessibleCustomerStorage	string	無法存取的客戶記憶體。
InvalidAdaptationMapping	string	無效的適應對應。
InvalidAudioFormat	string	不支援輸入音訊的格式。
InvalidBaseModel	string	基底模型無效。
InvalidCallbackUri	string	無效的回呼 URI。
InvalidChannelSpecification	string	不支援在轉譯要求中選取通道（例如，未選取 0 或 1）。
InvalidChannels	string	無效的通道。
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	遺漏輸入記錄。
ModelCopyAuthorizationExpired	string	過期的 ModelCopyAuthorization。
ModelDeploymentNotCompleteState	string	模型部署未完成狀態。
ModelDeprecated	string	模型已被取代。
ModelExists	string	模型存在。
ModelMismatch	string	模型不符。
ModelNotDeployable	string	模型不可部署。
ModelVersionIncorrect	string	模型版本不正確。
MultipleLanguagesIdentified	string	語言識別可辨識多種語言。無法判斷任何佔主導地位的語言。
NoLanguageIdentified	string	語言識別無法辨識任何語言。
NoUtf8WithBom	string	沒有 utf8 與 bom。
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、訊息和選擇性屬性目標、details（索引鍵值組）、內部錯誤（這可以是巢狀的）。
message	string	高階錯誤訊息。
target	string	錯誤的來源。例如，如果檔無效，則會是「檔」或「文件標識碼」。

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
durationMilliseconds	integer	0	如果這個檔案是音訊檔案，則檔案的總持續時間以毫秒為單位。
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、訊息和選擇性屬性目標、details（索引鍵值組）、內部錯誤（這可以是巢狀的）。
message	string	高階錯誤訊息。
target	string	錯誤的來源。例如，如果檔無效，則會是「檔」或「文件標識碼」。

PaginatedFiles

名稱	類型	Description
@nextLink	string	如果有更多實體可用，則為下一組編頁結果的連結;否則為 null。
values	File[]	由傳遞的查詢參數『skip』和『top』或其預設值所限制的實體清單。使用分頁和平行刪除實體逐一查看清單時，結果中會略過某些實體。建議在用戶端上建置清單，並在擷取完整清單之後刪除。

名稱

類型

Description

@nextLink

string

如果有更多實體可用，則為下一組編頁結果的連結;否則為 null。

values

File[]

由傳遞的查詢參數『skip』和『top』或其預設值所限制的實體清單。

使用分頁和平行刪除實體逐一查看清單時，結果中會略過某些實體。建議在用戶端上建置清單，並在擷取完整清單之後刪除。

共用方式為

Datasets - List Files

URI 參數

要求標頭

回應

安全性

Ocp-Apim-Subscription-Key

範例

Get all dataset report files

範例要求

範例回覆

Get all files

範例要求

範例回覆

定義

DetailedErrorCode

Error

ErrorCode

File

FileKind

FileLinks

FileProperties

InnerError

PaginatedFiles

其他資源