你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 版本。

请求头

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 都必须作为 Blob 存储在 Azure 存储 Blob 容器中。 每个文件必须遵循指定 AnnotationKind 的 COCO 格式，每个图像路径都是 Blob 容器中 Blob 的绝对 URI。 计算机视觉资源必须有权读取注释文件和所有引用的图像文件。 为此，可以启用计算机视觉资源的系统托管标识，然后将标识分配给有权从包含批注和图像文件的 Blob 容器中读取的权限的角色。
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

示例

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 都必须作为 Blob 存储在 Azure 存储 Blob 容器中。 每个文件必须遵循指定 AnnotationKind 的 COCO 格式，每个图像路径都是 Blob 容器中 Blob 的绝对 URI。 计算机视觉资源必须有权读取注释文件和所有引用的图像文件。 为此，可以启用计算机视觉资源的系统托管标识，然后将标识分配给有权从包含批注和图像文件的 Blob 容器中读取的权限的角色。
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 时才需要。