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

Labeling Jobs - List

Lists工作区中的标记作业。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs?api-version=2024-04-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs?api-version=2024-04-01-preview&$skip={$skip}&$top={$top}

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

目标订阅的 ID。

workspaceName
path True

string

Azure 机器学习工作区的名称。

正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

要用于此操作的 API 版本。

$skip
query

string

分页的延续标记。

$top
query

integer

int32

要返回的标记作业数。

响应

名称 类型 说明
200 OK

LabelingJobResourceArmPaginatedResult

Success

Other Status Codes

ErrorResponse

错误

示例

List Labeling Job.

示例请求

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs?api-version=2024-04-01-preview

示例响应

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob",
      "name": "testLabelingJob",
      "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs",
      "properties": {
        "jobType": "Labeling",
        "description": "string",
        "tags": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "properties": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "labelCategories": {
          "myCategory1": {
            "displayName": "myCategory1Title",
            "multiSelect": "Disabled",
            "classes": {
              "myLabelClass1": {
                "displayName": "myLabelClass1",
                "subclasses": {}
              },
              "myLabelClass2": {
                "displayName": "myLabelClass2",
                "subclasses": {}
              }
            }
          },
          "myCategory2": {
            "displayName": "myCategory2Title",
            "multiSelect": "Disabled",
            "classes": {
              "myLabelClass1": {
                "displayName": "myLabelClass1",
                "subclasses": {}
              },
              "myLabelClass2": {
                "displayName": "myLabelClass2",
                "subclasses": {}
              }
            }
          }
        },
        "jobInstructions": {
          "uri": "link/to/instructions"
        },
        "mlAssistConfiguration": {
          "mlAssist": "Enabled",
          "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute",
          "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute"
        },
        "labelingJobMediaProperties": {
          "mediaType": "Image"
        },
        "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "status": "NotStarted",
        "progressMetrics": {
          "totalDatapointCount": 0,
          "completedDatapointCount": 0,
          "skippedDatapointCount": 0,
          "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z"
        },
        "statusMessages": [
          {
            "level": "Error",
            "code": "string",
            "message": "string",
            "createdDateTime": "2020-12-08T01:23:37.234Z"
          }
        ],
        "createdDateTime": "2020-12-08T01:23:37.234Z"
      },
      "systemData": {
        "createdAt": "2020-12-08T01:23:37.235Z",
        "createdBy": "string",
        "createdByType": "User",
        "lastModifiedAt": "2020-12-08T01:23:37.235Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User"
      }
    }
  ],
  "nextLink": "nextlink"
}

定义

名称 说明
AllNodes

所有节点意味着服务将在作业的所有节点上运行

AmlToken

AML 令牌标识配置。

AzureDevOpsWebhook

特定于 Azure DevOps 的 Webhook 详细信息

createdByType

创建资源的标识类型。

EmailNotificationEnableType

用于确定电子邮件通知类型的枚举。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

IdentityConfigurationType

用于确定标识框架的枚举。

ImageAnnotationType

图像数据的注释类型。

IncrementalDataRefresh

是否启用了 IncrementalDataRefresh

JobProvisioningState

用于确定作业预配状态的枚举。

JobService

作业终结点定义

JobStatus

作业的状态。

JobType

用于确定作业类型的枚举。

LabelCategory

标签类别定义

LabelClass

标签类定义

LabelingDataConfiguration

标记数据配置定义

LabelingJob

标记作业定义

LabelingJobImageProperties

图像数据的标记作业的属性

LabelingJobInstructions

标记作业的说明

LabelingJobResource

Azure 资源管理器资源信封。

LabelingJobResourceArmPaginatedResult

标记作业实体的分页列表。

LabelingJobTextProperties

文本数据的标记作业的属性

ManagedIdentity

托管标识配置。

MediaType

数据资产的媒体类型。

MLAssistConfigurationDisabled

禁用 MLAssist 时标记 MLAssist 配置定义

MLAssistConfigurationEnabled

启用 MLAssist 时标记 MLAssist 配置定义

MLAssistConfigurationType
MultiSelect

是否启用 multiSelect

NodesValueType

节点值的枚举类型

NotificationSetting

通知的配置。

ProgressMetrics

进度指标定义

SecretConfiguration

机密配置定义。

StatusMessage

与项目关联的活动消息

StatusMessageLevel
systemData

与资源的创建和上次修改相关的元数据。

TextAnnotationType

文本数据的批注类型。

UserIdentity

用户标识配置。

WebhookType

用于确定 Webhook 回调服务类型的枚举。

AllNodes

所有节点意味着服务将在作业的所有节点上运行

名称 类型 说明
nodesValueType string:

All

[必需]Nodes 值的类型

AmlToken

AML 令牌标识配置。

名称 类型 说明
identityType string:

AMLToken

[必需]指定标识框架的类型。

AzureDevOpsWebhook

特定于 Azure DevOps 的 Webhook 详细信息

名称 类型 说明
eventType

string

对指定的通知事件发送回调

webhookType string:

AzureDevOps

[必需]指定要发送回调的服务类型

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

EmailNotificationEnableType

用于确定电子邮件通知类型的枚举。

名称 类型 说明
JobCancelled

string

JobCompleted

string

JobFailed

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

IdentityConfigurationType

用于确定标识框架的枚举。

名称 类型 说明
AMLToken

string

Managed

string

UserIdentity

string

ImageAnnotationType

图像数据的注释类型。

名称 类型 说明
BoundingBox

string

Classification

string

InstanceSegmentation

string

IncrementalDataRefresh

是否启用了 IncrementalDataRefresh

名称 类型 说明
Disabled

string

Enabled

string

JobProvisioningState

用于确定作业预配状态的枚举。

名称 类型 说明
Canceled

string

Failed

string

InProgress

string

Succeeded

string

JobService

作业终结点定义

名称 类型 说明
endpoint

string

终结点的 URL。

errorMessage

string

服务中的任何错误。

jobServiceType

string

终结点类型。

nodes Nodes:

AllNodes

用户想要启动服务的节点。 如果未将 Nodes 设置为 null,则仅在领导节点上启动该服务。

port

integer

用户设置的终结点的端口。

properties

object

要对终结点设置的其他属性。

status

string

终结点的状态。

JobStatus

作业的状态。

名称 类型 说明
CancelRequested

string

已请求取消作业。

Canceled

string

取消请求后,作业现已成功取消。

Completed

string

作业已成功完成。 这反映了作业本身和输出集合状态都成功完成

Failed

string

作业失败。

Finalizing

string

作业在目标中完成。 它现在处于输出集合状态。

NotResponding

string

启用检测信号后,如果运行未将任何信息更新到 RunHistory,则运行将进入 NotResponding 状态。 NotResponding 是唯一不受严格转换命令约束的状态。 运行可以从 NotResponding 转到以前的任何状态。

NotStarted

string

运行尚未启动。

Paused

string

作业由用户暂停。 对标记作业的一些调整只能在暂停状态下进行。

Preparing

string

正在运行的环境正在准备中。

Provisioning

string

(当前未使用) 如果 ES 正在创建计算目标,将使用它。

Queued

string

作业在计算目标中排队。 例如,在 BatchAI 中,作业处于排队状态,同时等待所有必需的节点准备就绪。

Running

string

作业已开始在计算目标中运行。

Scheduled

string

作业处于计划状态。 作业未处于任何活动状态。

Starting

string

运行已启动。 用户具有运行 ID。

Unknown

string

如果未映射到所有其他状态,则默认作业状态

JobType

用于确定作业类型的枚举。

名称 类型 说明
AutoML

string

Command

string

FineTuning

string

Labeling

string

Pipeline

string

Spark

string

Sweep

string

LabelCategory

标签类别定义

名称 类型 默认值 说明
classes

<string,  LabelClass>

此类别中的标签类字典。

displayName

string

标签类别的显示名称。

multiSelect

MultiSelect

Disabled

指示是否允许在此类别中选择多个类。

LabelClass

标签类定义

名称 类型 说明
displayName

string

标签类的显示名称。

subclasses

<string,  LabelClass>

标签类的子类字典。

LabelingDataConfiguration

标记数据配置定义

名称 类型 默认值 说明
dataId

string

要执行标记的数据资产的资源 ID。

incrementalDataRefresh

IncrementalDataRefresh

Disabled

指示是否启用增量数据刷新。

LabelingJob

标记作业定义

名称 类型 默认值 说明
componentId

string

组件资源的 ARM 资源 ID。

computeId

string

计算资源的 ARM 资源 ID。

createdDateTime

string

作业的创建时间(UTC 时区)。

dataConfiguration

LabelingDataConfiguration

配置作业中使用的数据。

description

string

资产说明文本。

displayName

string

作业的显示名称。

experimentName

string

Default

作业所属的试验的名称。 如果未设置,作业将置于“默认”试验中。

identity IdentityConfiguration:

标识配置。 如果已设置,应为 AmlToken、ManagedIdentity、UserIdentity 或 null 之一。 如果为 null,则默认为 AmlToken。

isArchived

boolean

False

资产是否已存档?

jobInstructions

LabelingJobInstructions

作业的标记说明。

jobType string:

Labeling

[必需]指定作业的类型。

labelCategories

<string,  LabelCategory>

作业的标签类别。

labelingJobMediaProperties LabelingJobMediaProperties:

作业中的媒体类型特定属性。

mlAssistConfiguration MLAssistConfiguration: {"MLAssist":"Disabled"}

在作业中配置 MLAssist 功能。

notificationSetting

NotificationSetting

作业的通知设置

progressMetrics

ProgressMetrics

作业的进度指标。

projectId

string

作业的内部 ID (以前调用的项目) 。

properties

object

资产属性字典。

provisioningState

JobProvisioningState

指定标记作业预配状态。

secretsConfiguration

<string,  SecretConfiguration>

用于在运行时提供机密的配置。

services

<string,  JobService>

JobEndpoints 列表。 对于本地作业,作业终结点的终结点值为 FileStreamObject。

status

JobStatus

作业的状态。

statusMessages

StatusMessage[]

作业的状态消息。

tags

object

标记字典。 可以添加、删除和更新标记。

LabelingJobImageProperties

图像数据的标记作业的属性

名称 类型 默认值 说明
annotationType

ImageAnnotationType

Classification

图像标记作业的注释类型。

mediaType string:

Image

[必需]作业的媒体类型。

LabelingJobInstructions

标记作业的说明

名称 类型 说明
uri

string

指向包含标签器详细标记说明的页面的链接。

LabelingJobResource

Azure 资源管理器资源信封。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties

LabelingJob

[必需]实体的其他属性。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

LabelingJobResourceArmPaginatedResult

标记作业实体的分页列表。

名称 类型 说明
nextLink

string

指向标记作业对象的下一页的链接。 如果为 null,则没有其他页。

value

LabelingJobResource[]

LabelingJob 类型的对象的数组。

LabelingJobTextProperties

文本数据的标记作业的属性

名称 类型 默认值 说明
annotationType

TextAnnotationType

Classification

文本标记作业的注释类型。

mediaType string:

Text

[必需]作业的媒体类型。

ManagedIdentity

托管标识配置。

名称 类型 说明
clientId

string

按客户端 ID 指定用户分配的标识。 对于系统分配的,请勿设置此字段。

identityType string:

Managed

[必需]指定标识框架的类型。

objectId

string

按对象 ID 指定用户分配的标识。 对于系统分配的,请勿设置此字段。

resourceId

string

按 ARM 资源 ID 指定用户分配的标识。 对于系统分配的,请勿设置此字段。

MediaType

数据资产的媒体类型。

名称 类型 说明
Image

string

Text

string

MLAssistConfigurationDisabled

禁用 MLAssist 时标记 MLAssist 配置定义

名称 类型 说明
mlAssist string:

Disabled

[必需]指示是否启用 MLAssist 功能。

MLAssistConfigurationEnabled

启用 MLAssist 时标记 MLAssist 配置定义

名称 类型 说明
inferencingComputeBinding

string

[必需]用于推理的 AML 计算绑定。

mlAssist string:

Enabled

[必需]指示是否启用 MLAssist 功能。

trainingComputeBinding

string

[必需]训练中使用的 AML 计算绑定。

MLAssistConfigurationType

名称 类型 说明
Disabled

string

Enabled

string

MultiSelect

是否启用 multiSelect

名称 类型 说明
Disabled

string

Enabled

string

NodesValueType

节点值的枚举类型

名称 类型 说明
All

string

Custom

string

NotificationSetting

通知的配置。

名称 类型 说明
emailOn

EmailNotificationEnableType[]

使用指定通知类型向用户发送电子邮件通知

emails

string[]

这是电子邮件收件人列表,其总字符数限制为 499 个字符,带逗号分隔符

webhooks

object

将 Webhook 回调发送到服务。 密钥是用户为 Webhook 提供的名称。

ProgressMetrics

进度指标定义

名称 类型 说明
completedDatapointCount

integer

已完成的数据点计数。

incrementalDataLastRefreshDateTime

string

上次成功增量数据刷新的时间(UTC)。

skippedDatapointCount

integer

跳过的数据点计数。

totalDatapointCount

integer

总数据点计数。

SecretConfiguration

机密配置定义。

名称 类型 说明
uri

string

机密 URI。 示例 URI: https://myvault.vault.azure.net/secrets/mysecretname/secretversion

workspaceSecretName

string

工作区密钥保管库中的机密名称。

StatusMessage

与项目关联的活动消息

名称 类型 说明
code

string

服务定义的消息代码。

createdDateTime

string

创建消息的时间(UTC)。

level

StatusMessageLevel

消息的严重性级别。

message

string

消息代码的可读表示形式。

StatusMessageLevel

名称 类型 说明
Error

string

Information

string

Warning

string

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源的创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。

TextAnnotationType

文本数据的批注类型。

名称 类型 说明
Classification

string

NamedEntityRecognition

string

UserIdentity

用户标识配置。

名称 类型 说明
identityType string:

UserIdentity

[必需]指定标识框架的类型。

WebhookType

用于确定 Webhook 回调服务类型的枚举。

名称 类型 说明
AzureDevOps

string