Datasets - Create

リファレンス

Service:: Azure AI Services

API Version:: v3.2-preview.2

指定した URL からデータを取得して新しいデータセットをアップロードして作成するか、データブロックがアップロードされるまで待機を開始します。

POST {endpoint}/speechtotext/v3.2-preview.2/datasets

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus.api.cognitive.microsoft.com

要求本文

名前	必須	型	説明
displayName	True	string	オブジェクトの表示名。
kind	True	DatasetKind	DatasetKind データインポートの種類。
locale	True	string	包含データのロケール。
contentUrl		string	データセットのデータの URL。
customProperties		object	このエンティティのカスタムプロパティ。許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。
description		string	オブジェクトの説明。
project		EntityReference	EntityReference
properties		DatasetProperties	DatasetProperties

応答

名前	型	説明
201 Created	Dataset	応答には、ペイロードとしてのエンティティに関する情報と、ヘッダーとしての場所が含まれます。 Headers Location: string
Other Status Codes	Error	エラーが発生しました。

名前

型

説明

201 Created

Dataset

応答には、ペイロードとしてのエンティティに関する情報と、ヘッダーとしての場所が含まれます。

Headers

Location: string

Other Status Codes

Error

エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

Authorization

このリージョンの STS によって返される JWT からアクセストークンを指定します。 STS URL に次のクエリ文字列を追加して、トークンに管理スコープを追加してください: ?scope=speechservicesmanagement

Type: apiKey
In: header

例

Create a dataset with content url

Create dataset from data blocks

Create a dataset with content url

Sample Request

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/datasets

{
  "kind": "Acoustic",
  "contentUrl": "https://contoso.com/location",
  "locale": "en-US",
  "displayName": "My speech dataset name",
  "description": "My speech dataset description"
}

Sample Response

Status code:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1

Response Body

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
  "kind": "Acoustic",
  "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
  },
  "properties": {
    "textNormalizationKind": "Default",
    "acceptedLineCount": 11,
    "rejectedLineCount": 2,
    "duration": "PT4M12S"
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Acoustic dataset"
}

Create dataset from data blocks

Sample Request

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/datasets

{
  "kind": "Acoustic",
  "locale": "en-US",
  "displayName": "My speech dataset name",
  "description": "My speech dataset description"
}

Sample Response

Status code:: 201

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
  "kind": "Acoustic",
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files",
    "commitBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks:commit",
    "listBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks",
    "uploadBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks"
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "NotStarted",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Acoustic dataset"
}

定義

名前	説明
Dataset	データセット
DatasetKind	DatasetKind
DatasetLinks	DatasetLinks
DatasetProperties	DatasetProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	エラー
ErrorCode	ErrorCode
InnerError	InnerError
Status	Status
TextNormalizationKind	TextNormalizationKind

Dataset

データセット

名前	型	説明
contentUrl	string	データセットのデータの URL。
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 です。
description	string	オブジェクトの説明。
displayName	string	オブジェクトの表示名。
kind	DatasetKind	DatasetKind データインポートの種類。
lastActionDateTime	string	現在の状態が入力されたときのタイムスタンプ。タイムスタンプは ISO 8601 の日付と時刻の形式 ("YYYY-MM-DDThh:mm:ssZ"、を参照) https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representationsとしてエンコードされます。
links	DatasetLinks	DatasetLinks
locale	string	格納されているデータのロケール。
project	EntityReference	EntityReference
properties	DatasetProperties	DatasetProperties
self	string	このエンティティの場所。
status	Status	Status API の現在の状態について説明する

DatasetKind

名前	型	説明
Acoustic	string	音響データセット。
AudioFiles	string	オーディオファイルデータセット。
Language	string	言語データセット。
LanguageMarkdown	string	言語マークダウンデータセット。
OutputFormatting	string	逆テキスト正規化、大文字と小文字の変換、再変換、不適切な表現をカスタマイズし、データセット検証のテストも定義するルールを含むデータセット
Pronunciation	string	発音データセット。

DatasetLinks

名前	型	説明
commitBlocks	string	ブロックを使用してデータセットをアップロードするときにブロックの一覧をコミットする場所。詳細については、操作 "Datasets_CommitBlocks" を参照してください。
files	string	このエンティティのすべてのファイルを取得する場所。詳細については、操作 "Datasets_ListFiles" を参照してください。
listBlocks	string	ブロックを使用してデータセットをアップロードするときに、このエンティティのアップロード済みブロックを一覧表示する場所。詳細については、操作 "Datasets_GetBlocks" を参照してください。
uploadBlocks	string	ブロックを使用してデータセットをアップロードするときにブロックをアップロードする場所。詳細については、操作 "Datasets_UploadBlock" を参照してください。

DatasetProperties

名前	型	説明
acceptedLineCount	integer	このデータセットに対して受け入れられる行数。
duration	string	オーディオファイルが含まれている場合のデータセットの合計期間。期間は ISO 8601 期間としてエンコードされます (「PnYnMnDTnHnMnS」を参照)。https://en.wikipedia.org/wiki/ISO_8601#Durations
email	string	操作が完了した場合に電子メール通知を送信する電子メールアドレス。値は、電子メールを正常に送信した後に削除されます。
error	EntityError	EntityError
rejectedLineCount	integer	このデータ・セットに対して拒否された行数。
textNormalizationKind	TextNormalizationKind	TextNormalizationKind テキスト正規化の種類。

DetailedErrorCode

名前	型	説明
DataImportFailed	string	データのインポートに失敗しました。
DeleteNotAllowed	string	削除は許可されません。
DeployNotAllowed	string	デプロイは許可されていません。
DeployingFailedModel	string	失敗したモデルのデプロイ。
EmptyRequest	string	空の要求。
EndpointCannotBeDefault	string	エンドポイントを既定にすることはできません。
EndpointNotUpdatable	string	エンドポイントは更新できません。
EndpointWithoutLogging	string	ログを記録しないエンドポイント。
ExceededNumberOfRecordingsUris	string	記録 URI の数を超えました。
FailedDataset	string	失敗したデータセット。
Forbidden	string	Forbidden.
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	ログ 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	入力レコードがありません。
ModelCopyOperationExists	string	モデルのコピー操作が存在します。
ModelDeploymentNotCompleteState	string	モデルのデプロイが完了していない状態です。
ModelDeprecated	string	モデルは非推奨になりました。
ModelExists	string	モデルが存在します。
ModelMismatch	string	モデルの不一致。
ModelNotDeployable	string	モデルはデプロイできません。
ModelVersionIncorrect	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	サポートされていない時間範囲。

EntityError

名前	型	説明
code	string	このエラーのコード。
message	string	このエラーのメッセージ。

EntityReference

名前	型	説明
self	string	参照先エンティティの場所。

Error

エラー

名前	型	説明
code	ErrorCode	ErrorCode 高レベルのエラーコード。
details	Error[]	エラーや予想されるポリシーに関する追加のサポートの詳細。
innerError	InnerError	InnerError で使用できる https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owCognitive Services API ガイドラインに準拠した新しい内部エラー形式。必須プロパティとして ErrorCode、message、省略可能プロパティとして target、details (キーと値のペア)、inner error (入れ子が可能) が含まれています。
message	string	高レベルのエラーメッセージ。
target	string	エラーのソースです。たとえば、無効なドキュメントの場合は "documents" または "document id" になります。

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	サポートされていないメディアの種類のエラーコードを表します。

InnerError

名前	型	説明
code	DetailedErrorCode	DetailedErrorCode 詳細なエラーコード列挙型。
details	object	エラーや予想されるポリシーに関する追加のサポートの詳細。
innerError	InnerError	InnerError で使用できる https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owCognitive Services API ガイドラインに準拠した新しい内部エラー形式。必須プロパティとして ErrorCode、message、省略可能プロパティとして target、details (キーと値のペア)、inner error (入れ子が可能) が含まれています。
message	string	高レベルのエラーメッセージ。
target	string	エラーのソースです。たとえば、無効なドキュメントの場合は "documents" または "document id" になります。

Status

名前	型	説明
Failed	string	実行時間の長い操作が失敗しました。
NotStarted	string	実行時間の長い操作はまだ開始されていません。
Running	string	実行時間の長い操作は現在処理中です。
Succeeded	string	実行時間の長い操作が正常に完了しました。

TextNormalizationKind

名前	型	説明
Default	string	既定のテキスト正規化 (例: '2 から 3' は en-US では '2 から 3' に置き換えられます)。
None	string	入力テキストにテキスト正規化は適用されません。これは、アップロード前にテキストを正規化する場合にのみ使用する必要があるオーバーライドオプションです。

Datasets - Create

URI パラメーター

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

Authorization

例

Create a dataset with content url

Sample Request

Sample Response

Create dataset from data blocks

Sample Request

Sample Response

定義

Dataset

DatasetKind

DatasetLinks

DatasetProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

TextNormalizationKind

その他のリソース