Data Labeling v1beta1 API - Class EvaluationJob (2.0.0-beta05)

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

Reference documentation and code samples for the Data Labeling v1beta1 API class EvaluationJob.

Defines an evaluation job that runs periodically to generate [Evaluations][google.cloud.datalabeling.v1beta1.Evaluation]. Creating an evaluation job is the starting point for using continuous evaluation.

Inheritance

object > EvaluationJob

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Constructors

EvaluationJob()

public EvaluationJob()

EvaluationJob(EvaluationJob)

public EvaluationJob(EvaluationJob other)
Parameter
Name Description
other EvaluationJob

Properties

AnnotationSpecSet

public string AnnotationSpecSet { get; set; }

Required. Name of the [AnnotationSpecSet][google.cloud.datalabeling.v1beta1.AnnotationSpecSet] describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format:

"projects/<var>{project_id}</var>/annotationSpecSets/<var>{annotation_spec_set_id}</var>"

Property Value
Type Description
string

Attempts

public RepeatedField<Attempt> Attempts { get; }

Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array.

Property Value
Type Description
RepeatedFieldAttempt

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp of when this evaluation job was created.

Property Value
Type Description
Timestamp

Description

public string Description { get; set; }

Required. Description of the job. The description can be up to 25,000 characters long.

Property Value
Type Description
string

EvaluationJobConfig

public EvaluationJobConfig EvaluationJobConfig { get; set; }

Required. Configuration details for the evaluation job.

Property Value
Type Description
EvaluationJobConfig

EvaluationJobName

public EvaluationJobName EvaluationJobName { get; set; }

EvaluationJobName-typed view over the Name resource name property.

Property Value
Type Description
EvaluationJobName

LabelMissingGroundTruth

public bool LabelMissingGroundTruth { get; set; }

Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to true. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to false.

Property Value
Type Description
bool

ModelVersion

public string ModelVersion { get; set; }

Required. The AI Platform Prediction model version to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format:

"projects/<var>{project_id}</var>/models/<var>{model_name}</var>/versions/<var>{version_name}</var>"

There can only be one evaluation job per model version.

Property Value
Type Description
string

Name

public string Name { get; set; }

Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

Property Value
Type Description
string

Schedule

public string Schedule { get; set; }

Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days.

You can provide the schedule in crontab format or in an English-like format.

Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day.

Property Value
Type Description
string

State

public EvaluationJob.Types.State State { get; set; }

Output only. Describes the current state of the job.

Property Value
Type Description
EvaluationJobTypesState