Datasets - Create

リファレンス

サービス:: Azure AI Services

API バージョン:: 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 minLength: 1	オブジェクトの表示名。
kind	True	DatasetKind	DatasetKind データインポートの種類。
locale	True	string minLength: 1	格納されているデータのロケール。
contentUrl		string (uri)	データセットのデータの URL。
customProperties		object	このエンティティのカスタムプロパティ。許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。
description		string	オブジェクトの説明。
project		EntityReference	EntityReference
properties		DatasetProperties	DatasetProperties

応答

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

名前

型

説明

201 Created

Dataset

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

ヘッダー

Location: string

Other Status Codes

Error

エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

Authorization

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

型: apiKey
/: header

例

Create a dataset with content url

Create dataset from data blocks

Create a dataset with content url

要求のサンプル

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

応答のサンプル

状態コード:: 201

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

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

要求のサンプル

HTTP

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

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

応答のサンプル

状態コード:: 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	エラーコード
InnerError	InnerError
Status	ステータス
TextNormalizationKind	TextNormalizationKind

Dataset

Object

データセット

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

DatasetKind

列挙

DatasetKind

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

DatasetLinks

Object

DatasetLinks

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

DatasetProperties

Object

DatasetProperties

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

DetailedErrorCode

列挙

DetailedErrorCode

値	説明
DataImportFailed	データのインポートに失敗しました。
DeleteNotAllowed	削除は許可されていません。
DeployNotAllowed	デプロイは許可されていません。
DeployingFailedModel	失敗したモデルのデプロイ。
EmptyRequest	空の要求。
EndpointCannotBeDefault	エンドポイントを既定にすることはできません。
EndpointNotUpdatable	エンドポイントは更新できません。
EndpointWithoutLogging	ログ記録なしのエンドポイント。
ExceededNumberOfRecordingsUris	記録 URI の数を超えました。
FailedDataset	失敗したデータセット。
Forbidden	禁じられた。
InUseViolation	使用中の違反。
InaccessibleCustomerStorage	お客様のストレージにアクセスできません。
InvalidAdaptationMapping	適応マッピングが無効です。
InvalidBaseModel	ベースモデルが無効です。
InvalidCallbackUri	コールバック URI が無効です。
InvalidCollection	コレクションが無効です。
InvalidDataset	データセットが無効です。
InvalidDocument	ドキュメントが無効です。
InvalidDocumentBatch	ドキュメントバッチが無効です。
InvalidLocale	ロケールが無効です。
InvalidLogDate	ログの日付が無効です。
InvalidLogEndTime	ログの終了時刻が無効です。
InvalidLogId	無効なログ ID です。
InvalidLogStartTime	ログの開始時刻が無効です。
InvalidModel	モデルが無効です。
InvalidModelUri	モデル URI が無効です。
InvalidParameter	パラメーターが無効です。
InvalidParameterValue	パラメーター値が無効です。
InvalidPayload	ペイロードが無効です。
InvalidPermissions	アクセス許可が無効です。
InvalidPrerequisite	前提条件が無効です。
InvalidProductId	製品 ID が無効です。
InvalidProject	プロジェクトが無効です。
InvalidProjectKind	プロジェクトの種類が無効です。
InvalidRecordingsUri	無効な記録 URI。
InvalidRequestBodyFormat	要求本文の形式が無効です。
InvalidSasValidityDuration	SAS の有効期間が無効です。
InvalidSkipTokenForLogs	ログのスキップトークンが無効です。
InvalidSourceAzureResourceId	ソース Azure リソース ID が無効です。
InvalidSubscription	サブスクリプションが無効です。
InvalidTest	テストが無効です。
InvalidTimeToLive	有効期限が無効です。
InvalidTopForLogs	ログの top が無効です。
InvalidTranscription	文字起こしが無効です。
InvalidWebHookEventKind	Web フックイベントの種類が無効です。
MissingInputRecords	入力レコードがありません。
ModelCopyOperationExists	モデルのコピー操作が存在します。
ModelDeploymentNotCompleteState	モデルのデプロイが完了していない状態です。
ModelDeprecated	モデルは非推奨になりました。
ModelExists	モデルが存在します。
ModelMismatch	モデルの不一致。
ModelNotDeployable	モデルはデプロイできません。
ModelVersionIncorrect	モデルのバージョンが正しくありません。
NoUtf8WithBom	bom を含む utf8 はありません。
OnlyOneOfUrlsOrContainerOrDataset	URL またはコンテナーまたはデータセットのいずれか 1 つだけ。
ProjectGenderMismatch	プロジェクトの性別の不一致。
QuotaViolation	クォータ違反。
SingleDefaultEndpoint	単一の既定のエンドポイント。
SkuLimitsExist	SKU の制限が存在します。
SubscriptionNotFound	サブスクリプションが見つかりません。
UnexpectedError	予期しないエラー。
UnsupportedClassBasedAdaptation	サポートされていないクラスベースの適応。
UnsupportedDelta	サポートされていないデルタ。
UnsupportedDynamicConfiguration	サポートされていない動的構成。
UnsupportedFilter	サポートされていないフィルター。
UnsupportedLanguageCode	サポートされていない言語コード。
UnsupportedOrderBy	サポートされていない注文者。
UnsupportedPagination	サポートされていない改ページ位置。
UnsupportedTimeRange	サポートされていない時間範囲。

EntityError

Object

EntityError

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

EntityReference

Object

EntityReference

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

Error

Object

エラー

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

列挙

エラーコード

値	説明
Conflict	競合エラーコードを表します。
Forbidden	禁止されているエラーコードを表します。
InternalCommunicationFailed	内部通信に失敗したエラーコードを表します。
InternalServerError	内部サーバーエラーコードを表します。
InvalidArgument	無効な引数のエラーコードを表します。
InvalidRequest	無効な要求エラーコードを表します。
NotAllowed	許可されていないエラーコードを表します。
NotFound	見つからないエラーコードを表します。
PipelineError	パイプラインエラーコードを表します。
ServiceUnavailable	サービスを使用できないエラーコードを表します。
TooManyRequests	要求の数が多すぎるエラーコードを表します。
Unauthorized	承認されていないエラーコードを表します。
UnprocessableEntity	処理不可能なエンティティエラーコードを表します。
UnsupportedMediaType	サポートされていないメディアの種類のエラーコードを表します。

InnerError

Object

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" になります。

Status

列挙

ステータス

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

TextNormalizationKind

列挙

TextNormalizationKind

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

次の方法で共有

Datasets - Create

URI パラメーター

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

Authorization

例

Create a dataset with content url

要求のサンプル

応答のサンプル

Create dataset from data blocks

要求のサンプル

応答のサンプル

定義

Dataset

DatasetKind

DatasetLinks

DatasetProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

TextNormalizationKind

その他のリソース