次の方法で共有

Datasets - List Files

  • リファレンス
サービス:
Azure AI Services
API バージョン:
2024-11-15

指定した ID で識別されるデータセットのファイルを取得します。

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 パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: 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

スキップ後に含まれるデータセットの数。

要求ヘッダー

名前 必須 型 説明
Ocp-Apim-Subscription-Key True

string

コグニティブ サービス アカウント キーをここで指定します。

応答

名前 型 説明
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

要求のサンプル

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

要求のサンプル

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

定義

名前 説明
DetailedErrorCode

DetailedErrorCode
Error

エラー
ErrorCode

ErrorCode
File

ファイル
FileKind

FileKind
FileLinks

FileLinks
FileProperties

FileProperties
InnerError

InnerError
PaginatedFiles

PaginatedFiles

DetailedErrorCode

DetailedErrorCode

名前 型 説明
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

無効なログ ID です。
InvalidLogStartTime

string

ログの開始時刻が無効です。
InvalidModel

string

モデルが無効です。
InvalidModelUri

string

モデル URI が無効です。
InvalidParameter

string

パラメーターが無効です。
InvalidParameterValue

string

パラメーター値が無効です。
InvalidPayload

string

ペイロードが無効です。
InvalidPermissions

string

アクセス許可が無効です。
InvalidPrerequisite

string

前提条件が無効です。
InvalidProductId

string

製品 ID が無効です。
InvalidProject

string

プロジェクトが無効です。
InvalidProjectKind

string

プロジェクトの種類が無効です。
InvalidRecordingsUri

string

無効な記録 URI。
InvalidRequestBodyFormat

string

要求本文の形式が無効です。
InvalidSasValidityDuration

string

SAS の有効期間が無効です。
InvalidSkipTokenForLogs

string

ログのスキップ トークンが無効です。
InvalidSourceAzureResourceId

string

ソース Azure リソース ID が無効です。
InvalidSubscription

string

サブスクリプションが無効です。
InvalidTest

string

テストが無効です。
InvalidTimeToLive

string

有効期限が無効です。
InvalidTopForLogs

string

ログの top が無効です。
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

bom を含む utf8 はありません。
OnlyOneOfUrlsOrContainerOrDataset

string

URL またはコンテナーまたはデータセットのいずれか 1 つだけ。
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

エラー

名前 型 説明
code

ErrorCode

ErrorCode
大まかなエラー コード。
details

Error[]

エラーや予想されるポリシーに関するその他のサポートの詳細。
innerError

InnerError

InnerError
https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owで利用可能な Cognitive Services API ガイドラインに準拠した新しい内部エラー形式。 これには、必須プロパティ ErrorCode、メッセージ、および省略可能なプロパティ ターゲット、details(キー値ペア)、内部エラー (入れ子にできます) が含まれます。
message

string

高レベルのエラー メッセージ。
target

string

エラーの原因。 たとえば、無効なドキュメントの場合は "documents" または "document id" になります。

ErrorCode

ErrorCode

名前 型 説明
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

ファイル

名前 型 説明
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

FileKind

名前 型 説明
AcousticDataArchive

string

データの種類は、音響データ アーカイブです。
AcousticDataTranscriptionV2

string

データの種類は、音響データ文字起こし v2 です。
Audio

string

データの種類はオーディオです。
DatasetReport

string

データの種類はデータセット レポートです。
EvaluationDetails

string

データの種類は評価の詳細です。
LanguageData

string

データの種類は言語データです。
ModelReport

string

データの種類はモデル レポートです。
OutputFormattingData

string

データの種類は、出力書式設定入力ファイルです。
PronunciationData

string

データの種類は発音データです。
Transcription

string

データの種類は文字起こしです。
TranscriptionReport

string

データの種類は文字起こしレポートです。

FileLinks

名前 型 説明
contentUrl

string

このファイルの内容を取得する URL。

FileProperties

FileProperties

名前 型 規定値 説明
durationMilliseconds

integer

0

このファイルがオーディオ ファイルの場合のファイルの合計時間 (ミリ秒単位)。
size

integer

データのサイズ (バイト単位)。

InnerError

InnerError

名前 型 説明
code

DetailedErrorCode

DetailedErrorCode
詳細なエラー コード列挙型。
details

object

エラーや予想されるポリシーに関するその他のサポートの詳細。
innerError

InnerError

InnerError
https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owで利用可能な Cognitive Services API ガイドラインに準拠した新しい内部エラー形式。 これには、必須プロパティ ErrorCode、メッセージ、および省略可能なプロパティ ターゲット、details(キー値ペア)、内部エラー (入れ子にできます) が含まれます。
message

string

高レベルのエラー メッセージ。
target

string

エラーの原因。 たとえば、無効なドキュメントの場合は "documents" または "document id" になります。

PaginatedFiles

PaginatedFiles

名前 型 説明
@nextLink

string

使用可能なエンティティが他にある場合は、ページ分割された結果の次のセットへのリンク。それ以外の場合は null。
values

File[]

渡されたクエリ パラメーター 'skip' と 'top' またはその既定値によって制限されるエンティティの一覧。

ページ分割を使用してリストを反復処理し、エンティティを並列で削除すると、一部のエンティティが結果でスキップされます。 クライアントでリストを作成し、完全なリストのフェッチ後に削除することをお勧めします。