Cloud AI Platform v1 API - Class DataLabelingJob (2.8.0)

public sealed class DataLabelingJob : IMessage<DataLabelingJob>, IEquatable<DataLabelingJob>, IDeepCloneable<DataLabelingJob>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class DataLabelingJob.

DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:

Inheritance

Object > DataLabelingJob

Implements

IMessage<DataLabelingJob>, IEquatable<DataLabelingJob>, IDeepCloneable<DataLabelingJob>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

DataLabelingJob()

public DataLabelingJob()

DataLabelingJob(DataLabelingJob)

public DataLabelingJob(DataLabelingJob other)

Parameter
Name	Description
`other`	`DataLabelingJob`

Properties

ActiveLearningConfig

public ActiveLearningConfig ActiveLearningConfig { get; set; }

Parameters that configure the active learning pipeline. Active learning will label the data incrementally via several iterations. For every iteration, it will select a batch of data based on the sampling strategy.

Property Value
Type	Description
`ActiveLearningConfig`

AnnotationLabels

public MapField<string, string> AnnotationLabels { get; }

Labels to assign to annotations generated by this DataLabelingJob.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Property Value
Type	Description
`MapField<String, String>`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when this DataLabelingJob was created.

Property Value
Type	Description
`Timestamp`

CurrentSpend

public Money CurrentSpend { get; set; }

Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.

Property Value
Type	Description
`Money`

DataLabelingJobName

public DataLabelingJobName DataLabelingJobName { get; set; }

DataLabelingJobName-typed view over the Name resource name property.

Property Value
Type	Description
`DataLabelingJobName`

Datasets

public RepeatedField<string> Datasets { get; }

Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}

Property Value
Type	Description
`RepeatedField<String>`

DatasetsAsDatasetNames

public ResourceNameList<DatasetName> DatasetsAsDatasetNames { get; }

DatasetName-typed view over the Datasets resource name property.

Property Value
Type	Description
`ResourceNameList<DatasetName>`

DisplayName

public string DisplayName { get; set; }

Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a DataLabelingJob.

Property Value
Type	Description
`String`

EncryptionSpec

public EncryptionSpec EncryptionSpec { get; set; }

Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will be secured by this key.

Note: Annotations created in the DataLabelingJob are associated with the EncryptionSpec of the Dataset they are exported to.

Property Value
Type	Description
`EncryptionSpec`

Error

public Status Error { get; set; }

Output only. DataLabelingJob errors. It is only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

Property Value
Type	Description
`Status`

Inputs

public Value Inputs { get; set; }

Required. Input config parameters for the DataLabelingJob.

Property Value
Type	Description
`Value`

InputsSchemaUri

public string InputsSchemaUri { get; set; }

Required. Points to a YAML file stored on Google Cloud Storage describing the config for a specific type of DataLabelingJob. The schema files that can be used here are found in the https://storage.googleapis.com/google-cloud-aiplatform bucket in the /schema/datalabelingjob/inputs/ folder.

Property Value
Type	Description
`String`

InstructionUri

public string InstructionUri { get; set; }

Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with labelers, and provides detailed description on how to label DataItems in Datasets.

Property Value
Type	Description
`String`

LabelerCount

public int LabelerCount { get; set; }

Required. Number of labelers to work on each DataItem.

Property Value
Type	Description
`Int32`

LabelingProgress

public int LabelingProgress { get; set; }

Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished.

Property Value
Type	Description
`Int32`

Labels

public MapField<string, string> Labels { get; }

The labels with user-defined metadata to organize your DataLabelingJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each DataLabelingJob:

"aiplatform.googleapis.com/schema": output only, its value is the [inputs_schema][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s title.

Property Value
Type	Description
`MapField<String, String>`

Name

public string Name { get; set; }

Output only. Resource name of the DataLabelingJob.

Property Value
Type	Description
`String`

SpecialistPools

public RepeatedField<string> SpecialistPools { get; }

The SpecialistPools' resource names associated with this job.

Property Value
Type	Description
`RepeatedField<String>`

State

public JobState State { get; set; }

Output only. The detailed state of the job.

Property Value
Type	Description
`JobState`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when this DataLabelingJob was updated most recently.

Property Value
Type	Description
`Timestamp`