Datasets - Update

リファレンス

サービス:: Azure AI Services

API バージョン:: 2023-04-01-preview

既存のデータセットのプロパティを更新します。

返される状態コード:

200: 操作が正常に完了しました。
400: 要求の形式が正しくありません。
404: 指定した名前のデータセットが見つかりませんでした。
412: If-Match ヘッダーが指定されましたが、指定された ETag が現在の ETag 値と一致しませんでした。

PATCH /datasets/{name}?api-version=2023-04-01-preview

URI パラメーター

名前 / 必須型説明

名前	/	必須	型	説明
name	path	True	string	更新するデータセットの名前。正規表現パターン: `^[a-zA-Z0-9][a-zA-Z0-9._-]*$`
api-version	query	True	string	要求された API バージョン。

name

path

True

string

更新するデータセットの名前。

正規表現パターン: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$

api-version

query

True

string

要求された API バージョン。

要求ヘッダー

Media Types: "application/json-patch+json"

名前	必須	型	説明
If-Match		string	更新するデータセットのオプションの ETag。 ETag が指定されている場合、データセットは、現在の ETag 値が指定された ETag と一致する場合にのみ更新されます。 ETag 値が一致しない場合、更新操作は状態コード 412 (前提条件に失敗) で失敗します。これは、データセットの情報が最後に取得されてからデータセットが更新されたことを示します。 ETag が指定されていない場合、またはその値が '*' の場合、現在の ETag 値に関係なく、データセットは常に更新されます。

要求本文

Media Types: "application/json-patch+json"

名前	型	説明
annotationFileUris	string[]	注釈ファイルに対する絶対 URI の一覧。各 URI は、Azure Storage BLOB コンテナーに BLOB として格納する必要があります。各ファイルは、指定された AnnotationKind の COCO 形式に従う必要があります。各イメージパスは、BLOB コンテナー内の BLOB への絶対 URI です。 Computer Vision リソースには、注釈ファイルと参照されているすべてのイメージファイルを読み取るアクセス許可が必要です。これを行うには、Computer Vision リソースのシステムマネージド ID を有効にしてから、注釈ファイルとイメージファイルを含む BLOB コンテナーから読み取るアクセス許可を持つロールに ID を割り当てます。
annotationKind	AnnotationKind	注釈ファイルに含まれる注釈の種類。たとえば、"ImageClassification" を使用して、注釈ファイルに、多クラス画像分類モデルをトレーニングまたはテストするためのオブジェクトラベルが含まれていることを指定します。
authentication	StorageAuthenticationSettingsApiModel	ストレージ認証の設定について説明します。
createdDateTime	string	読み取り専用。データセットが最初に登録された日時 (UTC)。
customProperties	object	アプリケーションで使用する任意のキーと値のペアのディクショナリ。最大 10 個のキーと値のペアを使用できます。
eTag	string	読み取り専用。データセットの最新の ETag。データセットを更新または削除するときに、'If-Match' ヘッダーと共に使用できます。
name	string	読み取り専用。データセットを一意に識別するために使用される名前。
updatedDateTime	string	読み取り専用。データセットが最後に更新された日時 (UTC)。

応答

名前	型	説明
200 OK	Dataset	Success
Other Status Codes	ErrorResponse	エラーヘッダー x-ms-error-code: string

名前

型

説明

200 OK

Dataset

Success

Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

例

Datasets_Update

要求のサンプル

HTTP

PATCH /datasets/my_dataset_name?api-version=2023-04-01-preview

{
  "annotationKind": "imageClassification",
  "annotationFileUris": [
    "https://microsoft.com/a"
  ]
}

応答のサンプル

状態コード:: 200

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

定義

名前	説明
AnnotationKind	注釈ファイルに含まれる注釈の種類。たとえば、"ImageClassification" を使用して、注釈ファイルに、多クラス画像分類モデルをトレーニングまたはテストするためのオブジェクトラベルが含まれていることを指定します。
Dataset	モデルのトレーニングまたはテストに使用できる画像と注釈のセットを表すデータセットについて説明します。
ErrorResponse	エラーが発生したときに返される応答。
ErrorResponseDetails	エラー情報。
ErrorResponseInnerError	詳細なエラー。
StorageAuthenticationKind	ストレージ認証の種類。
StorageAuthenticationSettingsApiModel	ストレージ認証の設定について説明します。

AnnotationKind

注釈ファイルに含まれる注釈の種類。たとえば、"ImageClassification" を使用して、注釈ファイルに、多クラス画像分類モデルをトレーニングまたはテストするためのオブジェクトラベルが含まれていることを指定します。

名前	型	説明
imageClassification	string
imageObjectDetection	string

Dataset

モデルのトレーニングまたはテストに使用できる画像と注釈のセットを表すデータセットについて説明します。

名前	型	説明
annotationFileUris	string[]	注釈ファイルに対する絶対 URI の一覧。各 URI は、Azure Storage BLOB コンテナーに BLOB として格納する必要があります。各ファイルは、指定された AnnotationKind の COCO 形式に従う必要があります。各イメージパスは、BLOB コンテナー内の BLOB への絶対 URI です。 Computer Vision リソースには、注釈ファイルと参照されているすべてのイメージファイルを読み取るアクセス許可が必要です。これを行うには、Computer Vision リソースのシステムマネージド ID を有効にしてから、注釈ファイルとイメージファイルを含む BLOB コンテナーから読み取るアクセス許可を持つロールに ID を割り当てます。
annotationKind	AnnotationKind	注釈ファイルに含まれる注釈の種類。たとえば、"ImageClassification" を使用して、注釈ファイルに、多クラス画像分類モデルをトレーニングまたはテストするためのオブジェクトラベルが含まれていることを指定します。
authentication	StorageAuthenticationSettingsApiModel	ストレージ認証の設定について説明します。
createdDateTime	string	読み取り専用。データセットが最初に登録された日時 (UTC)。
customProperties	object	アプリケーションで使用する任意のキーと値のペアのディクショナリ。最大 10 個のキーと値のペアを使用できます。
eTag	string	読み取り専用。データセットの最新の ETag。データセットを更新または削除するときに、'If-Match' ヘッダーと共に使用できます。
name	string	読み取り専用。データセットを一意に識別するために使用される名前。
updatedDateTime	string	読み取り専用。データセットが最後に更新された日時 (UTC)。

ErrorResponse

エラーが発生したときに返される応答。

名前	型	説明
error	ErrorResponseDetails	エラー情報。

ErrorResponseDetails

エラー情報。

名前	型	説明
code	string	エラーコード。
details	ErrorResponseDetails[]	詳細なエラーの一覧。
innererror	ErrorResponseInnerError	詳細なエラー。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponseInnerError

詳細なエラー。

名前	型	説明
code	string	エラーコード。
innererror	ErrorResponseInnerError	詳細なエラー。
message	string	エラーメッセージ。

StorageAuthenticationKind

ストレージ認証の種類。

名前	型	説明
managedIdentity	string
none	string
sas	string

StorageAuthenticationSettingsApiModel

ストレージ認証の設定について説明します。

名前	型	説明
kind	StorageAuthenticationKind	ストレージ認証の種類。
sasToken	string	省略可能。コンテナーにアクセスするための sas トークン。 Kind = Sas の場合にのみ必要です。

次の方法で共有

Datasets - Update

URI パラメーター

要求ヘッダー

要求本文

応答

例

Datasets_Update

要求のサンプル

応答のサンプル

定義

AnnotationKind

Dataset

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

StorageAuthenticationKind

StorageAuthenticationSettingsApiModel

その他のリソース