Datasets - Update
既存のデータセットのプロパティを更新します。
返される状態コード:
- 200: 操作が正常に完了しました。
- 400: 要求の形式が正しくありません。
- 404: 指定した名前のデータセットが見つかりませんでした。
- 412: If-Match ヘッダーが指定されましたが、指定された ETag が現在の ETag 値と一致しませんでした。
PATCH /datasets/{name}?api-version=2023-04-01-preview
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
name
|
path | True |
string maxLength: 255pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ |
更新するデータセットの名前。 |
|
api-version
|
query | True |
string |
要求された API バージョン。 |
要求ヘッダー
Media Types: "application/json-patch+json"
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| If-Match |
string |
更新するデータセットのオプションの ETag。 |
要求本文
Media Types: "application/json-patch+json"
| 名前 | 型 | 説明 |
|---|---|---|
| annotationFileUris |
string[] (uri) |
注釈ファイルに対する絶対 URI の一覧。各 URI は、Azure Storage BLOB コンテナーに BLOB として格納する必要があります。 各ファイルは、指定された AnnotationKind の COCO 形式に従う必要があります。各イメージ パスは BLOB コンテナー内の BLOB への絶対 URI です。 Computer Vision リソースには、注釈ファイルと参照されているすべての画像ファイルを読み取るアクセス許可が必要です。 これを行うには、Computer Vision リソースのシステム マネージド ID を有効にしてから、注釈とイメージ ファイルを含む BLOB コンテナーから読み取るアクセス許可を持つロールに ID を割り当てます。 |
| annotationKind |
注釈ファイルに含まれる注釈の種類。 たとえば、多クラス画像分類モデルをトレーニングまたはテストするためのオブジェクト ラベルが注釈ファイルに含まれていることを指定する "ImageClassification" などです。 |
|
| authentication |
ストレージ認証の設定について説明します。 |
|
| createdDateTime |
string (date-time) |
読み取り専用です。 データセットが最初に登録された日時 (UTC)。 |
| customProperties |
object |
アプリケーションで使用する任意のキーと値のペアのディクショナリ。 最大 10 個のキーと値のペアを使用できます。 |
| eTag |
string |
読み取り専用です。 データセットの最新の ETag。 データセットを更新または削除するときに、'If-Match' ヘッダーと共に使用できます。 |
| name |
string maxLength: 255pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ |
読み取り専用です。 データセットを一意に識別するために使用される名前。 |
| updatedDateTime |
string (date-time) |
読み取り専用です。 データセットが最後に更新された日時 (UTC)。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
成功 |
|
| Other Status Codes |
エラー ヘッダー x-ms-error-code: string |
例
Datasets_Update
要求のサンプル
PATCH /datasets/my_dataset_name?api-version=2023-04-01-preview
{
"annotationKind": "imageClassification",
"annotationFileUris": [
"https://microsoft.com/a"
]
}
応答のサンプル
{
"annotationKind": "imageClassification",
"annotationFileUris": [
"https://microsoft.com/a"
],
"name": "my_dataset_name",
"createdDateTime": "2023-01-13T20:46:20.189Z",
"updatedDateTime": "2023-01-13T20:46:20.189Z",
"eTag": "kzktjgnqkjagdlkualdzikaseg"
}
定義
| 名前 | 説明 |
|---|---|
|
Annotation |
注釈ファイルに含まれる注釈の種類。 たとえば、多クラス画像分類モデルをトレーニングまたはテストするためのオブジェクト ラベルが注釈ファイルに含まれていることを指定する "ImageClassification" などです。 |
| Dataset |
モデルのトレーニングまたはテストに使用できる一連の画像と注釈を表すデータセットについて説明します。 |
|
Error |
エラーが発生したときに返される応答。 |
|
Error |
エラー情報。 |
|
Error |
詳細なエラー。 |
|
Storage |
ストレージ認証の種類。 |
|
Storage |
ストレージ認証の設定について説明します。 |
AnnotationKind
注釈ファイルに含まれる注釈の種類。 たとえば、多クラス画像分類モデルをトレーニングまたはテストするためのオブジェクト ラベルが注釈ファイルに含まれていることを指定する "ImageClassification" などです。
| 値 | 説明 |
|---|---|
| imageClassification | |
| imageObjectDetection |
Dataset
モデルのトレーニングまたはテストに使用できる一連の画像と注釈を表すデータセットについて説明します。
| 名前 | 型 | 説明 |
|---|---|---|
| annotationFileUris |
string[] (uri) |
注釈ファイルに対する絶対 URI の一覧。各 URI は、Azure Storage BLOB コンテナーに BLOB として格納する必要があります。 各ファイルは、指定された AnnotationKind の COCO 形式に従う必要があります。各イメージ パスは BLOB コンテナー内の BLOB への絶対 URI です。 Computer Vision リソースには、注釈ファイルと参照されているすべての画像ファイルを読み取るアクセス許可が必要です。 これを行うには、Computer Vision リソースのシステム マネージド ID を有効にしてから、注釈とイメージ ファイルを含む BLOB コンテナーから読み取るアクセス許可を持つロールに ID を割り当てます。 |
| annotationKind |
注釈ファイルに含まれる注釈の種類。 たとえば、多クラス画像分類モデルをトレーニングまたはテストするためのオブジェクト ラベルが注釈ファイルに含まれていることを指定する "ImageClassification" などです。 |
|
| authentication |
ストレージ認証の設定について説明します。 |
|
| createdDateTime |
string (date-time) |
読み取り専用です。 データセットが最初に登録された日時 (UTC)。 |
| customProperties |
object |
アプリケーションで使用する任意のキーと値のペアのディクショナリ。 最大 10 個のキーと値のペアを使用できます。 |
| eTag |
string |
読み取り専用です。 データセットの最新の ETag。 データセットを更新または削除するときに、'If-Match' ヘッダーと共に使用できます。 |
| name |
string maxLength: 255pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ |
読み取り専用です。 データセットを一意に識別するために使用される名前。 |
| updatedDateTime |
string (date-time) |
読み取り専用です。 データセットが最後に更新された日時 (UTC)。 |
ErrorResponse
エラーが発生したときに返される応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー情報。 |
ErrorResponseDetails
エラー情報。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラー コード。 |
| details |
詳細なエラーの一覧。 |
|
| innererror |
詳細なエラー。 |
|
| message |
string |
エラーメッセージ。 |
| target |
string |
エラーのターゲット。 |
ErrorResponseInnerError
詳細なエラー。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラー コード。 |
| innererror |
詳細なエラー。 |
|
| message |
string |
エラーメッセージ。 |
StorageAuthenticationKind
ストレージ認証の種類。
| 値 | 説明 |
|---|---|
| none | |
| managedIdentity | |
| sas |
StorageAuthenticationSettingsApiModel
ストレージ認証の設定について説明します。
| 名前 | 型 | 説明 |
|---|---|---|
| kind |
ストレージ認証の種類。 |
|
| sasToken |
string |
随意。 コンテナーにアクセスするための SAS トークン。 Kind = Sas の場合にのみ必要です。 |