Show / Hide Table of Contents

Class GoogleCloudAiplatformV1DataLabelingJob

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

Inheritance
object
GoogleCloudAiplatformV1DataLabelingJob
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1DataLabelingJob : IDirectResponseSchema

Properties

ActiveLearningConfig

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.

Declaration
[JsonProperty("activeLearningConfig")]
public virtual GoogleCloudAiplatformV1ActiveLearningConfig ActiveLearningConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1ActiveLearningConfig

AnnotationLabels

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.

Declaration
[JsonProperty("annotationLabels")]
public virtual IDictionary<string, string> AnnotationLabels { get; set; }
Property Value
Type Description
IDictionary<string, string>

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp when this DataLabelingJob was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

CurrentSpend

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

Declaration
[JsonProperty("currentSpend")]
public virtual GoogleTypeMoney CurrentSpend { get; set; }
Property Value
Type Description
GoogleTypeMoney

Datasets

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

Declaration
[JsonProperty("datasets")]
public virtual IList<string> Datasets { get; set; }
Property Value
Type Description
IList<string>

DisplayName

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.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EncryptionSpec

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.

Declaration
[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1EncryptionSpec EncryptionSpec { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1EncryptionSpec

Error

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

Declaration
[JsonProperty("error")]
public virtual GoogleRpcStatus Error { get; set; }
Property Value
Type Description
GoogleRpcStatus

Inputs

Required. Input config parameters for the DataLabelingJob.

Declaration
[JsonProperty("inputs")]
public virtual object Inputs { get; set; }
Property Value
Type Description
object

InputsSchemaUri

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.

Declaration
[JsonProperty("inputsSchemaUri")]
public virtual string InputsSchemaUri { get; set; }
Property Value
Type Description
string

InstructionUri

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.

Declaration
[JsonProperty("instructionUri")]
public virtual string InstructionUri { get; set; }
Property Value
Type Description
string

LabelerCount

Required. Number of labelers to work on each DataItem.

Declaration
[JsonProperty("labelerCount")]
public virtual int? LabelerCount { get; set; }
Property Value
Type Description
int?

LabelingProgress

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

Declaration
[JsonProperty("labelingProgress")]
public virtual int? LabelingProgress { get; set; }
Property Value
Type Description
int?

Labels

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's title.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

Output only. Resource name of the DataLabelingJob.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

SpecialistPools

The SpecialistPools' resource names associated with this job.

Declaration
[JsonProperty("specialistPools")]
public virtual IList<string> SpecialistPools { get; set; }
Property Value
Type Description
IList<string>

State

Output only. The detailed state of the job.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX