Class EvaluationJobConfig.Builder (0.161.0)

public static final class EvaluationJobConfig.Builder extends GeneratedMessageV3.Builder<EvaluationJobConfig.Builder> implements EvaluationJobConfigOrBuilder

Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob.

Protobuf type google.cloud.datalabeling.v1beta1.EvaluationJobConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EvaluationJobConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides

build()

public EvaluationJobConfig build()
Returns
TypeDescription
EvaluationJobConfig

buildPartial()

public EvaluationJobConfig buildPartial()
Returns
TypeDescription
EvaluationJobConfig

clear()

public EvaluationJobConfig.Builder clear()
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides

clearBigqueryImportKeys()

public EvaluationJobConfig.Builder clearBigqueryImportKeys()
Returns
TypeDescription
EvaluationJobConfig.Builder

clearBoundingPolyConfig()

public EvaluationJobConfig.Builder clearBoundingPolyConfig()

Specify this field if your model version performs image object detection (bounding box detection).

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet.

.google.cloud.datalabeling.v1beta1.BoundingPolyConfig bounding_poly_config = 5;

Returns
TypeDescription
EvaluationJobConfig.Builder

clearEvaluationConfig()

public EvaluationJobConfig.Builder clearEvaluationConfig()

Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the boundingBoxEvaluationOptions field within this configuration. Otherwise, provide an empty object for this configuration.

.google.cloud.datalabeling.v1beta1.EvaluationConfig evaluation_config = 2;

Returns
TypeDescription
EvaluationJobConfig.Builder

clearEvaluationJobAlertConfig()

public EvaluationJobConfig.Builder clearEvaluationJobAlertConfig()

Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run.

.google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig evaluation_job_alert_config = 13;

Returns
TypeDescription
EvaluationJobConfig.Builder

clearExampleCount()

public EvaluationJobConfig.Builder clearExampleCount()

Required. The maximum number of predictions to sample and save to BigQuery during each evaluation interval. This limit overrides example_sample_percentage: even if the service has not sampled enough predictions to fulfill example_sample_perecentage during an interval, it stops sampling predictions when it meets this limit.

int32 example_count = 10;

Returns
TypeDescription
EvaluationJobConfig.Builder

This builder for chaining.

clearExampleSamplePercentage()

public EvaluationJobConfig.Builder clearExampleSamplePercentage()

Required. Fraction of predictions to sample and save to BigQuery during each evaluation interval. For example, 0.1 means 10% of predictions served by your model version get saved to BigQuery.

double example_sample_percentage = 11;

Returns
TypeDescription
EvaluationJobConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public EvaluationJobConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides

clearHumanAnnotationConfig()

public EvaluationJobConfig.Builder clearHumanAnnotationConfig()

Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to true for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field.

Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the instruction field within this configuration.

.google.cloud.datalabeling.v1beta1.HumanAnnotationConfig human_annotation_config = 3;

Returns
TypeDescription
EvaluationJobConfig.Builder

clearHumanAnnotationRequestConfig()

public EvaluationJobConfig.Builder clearHumanAnnotationRequestConfig()
Returns
TypeDescription
EvaluationJobConfig.Builder

clearImageClassificationConfig()

public EvaluationJobConfig.Builder clearImageClassificationConfig()

Specify this field if your model version performs image classification or general classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.ImageClassificationConfig image_classification_config = 4;

Returns
TypeDescription
EvaluationJobConfig.Builder

clearInputConfig()

public EvaluationJobConfig.Builder clearInputConfig()

Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields:

  • dataType must be one of IMAGE, TEXT, or GENERAL_DATA.
  • annotationType must be one of IMAGE_CLASSIFICATION_ANNOTATION, TEXT_CLASSIFICATION_ANNOTATION, GENERAL_CLASSIFICATION_ANNOTATION, or IMAGE_BOUNDING_BOX_ANNOTATION (image object detection).
  • If your machine learning model performs classification, you must specify classificationMetadata.isMultiLabel.
  • You must specify bigquerySource (not gcsSource).

.google.cloud.datalabeling.v1beta1.InputConfig input_config = 1;

Returns
TypeDescription
EvaluationJobConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public EvaluationJobConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides

clearTextClassificationConfig()

public EvaluationJobConfig.Builder clearTextClassificationConfig()

Specify this field if your model version performs text classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.TextClassificationConfig text_classification_config = 8;

Returns
TypeDescription
EvaluationJobConfig.Builder

clone()

public EvaluationJobConfig.Builder clone()
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides

containsBigqueryImportKeys(String key)

public boolean containsBigqueryImportKeys(String key)

Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON.

You can provide the following entries in this field:

  • data_json_key: the data key for prediction input. You must provide either this key or reference_json_key.
  • reference_json_key: the data reference key for prediction input. You must provide either this key or data_json_key.
  • label_json_key: the label key for prediction output. Required.
  • label_score_json_key: the score key for prediction output. Required.
  • bounding_box_json_key: the bounding box key for prediction output. Required if your model version perform image object detection.

    Learn how to configure prediction keys.

map<string, string> bigquery_import_keys = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getBigqueryImportKeys() (deprecated)

public Map<String,String> getBigqueryImportKeys()
Returns
TypeDescription
Map<String,String>

getBigqueryImportKeysCount()

public int getBigqueryImportKeysCount()

Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON.

You can provide the following entries in this field:

  • data_json_key: the data key for prediction input. You must provide either this key or reference_json_key.
  • reference_json_key: the data reference key for prediction input. You must provide either this key or data_json_key.
  • label_json_key: the label key for prediction output. Required.
  • label_score_json_key: the score key for prediction output. Required.
  • bounding_box_json_key: the bounding box key for prediction output. Required if your model version perform image object detection.

    Learn how to configure prediction keys.

map<string, string> bigquery_import_keys = 9;

Returns
TypeDescription
int

getBigqueryImportKeysMap()

public Map<String,String> getBigqueryImportKeysMap()

Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON.

You can provide the following entries in this field:

  • data_json_key: the data key for prediction input. You must provide either this key or reference_json_key.
  • reference_json_key: the data reference key for prediction input. You must provide either this key or data_json_key.
  • label_json_key: the label key for prediction output. Required.
  • label_score_json_key: the score key for prediction output. Required.
  • bounding_box_json_key: the bounding box key for prediction output. Required if your model version perform image object detection.

    Learn how to configure prediction keys.

map<string, string> bigquery_import_keys = 9;

Returns
TypeDescription
Map<String,String>

getBigqueryImportKeysOrDefault(String key, String defaultValue)

public String getBigqueryImportKeysOrDefault(String key, String defaultValue)

Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON.

You can provide the following entries in this field:

  • data_json_key: the data key for prediction input. You must provide either this key or reference_json_key.
  • reference_json_key: the data reference key for prediction input. You must provide either this key or data_json_key.
  • label_json_key: the label key for prediction output. Required.
  • label_score_json_key: the score key for prediction output. Required.
  • bounding_box_json_key: the bounding box key for prediction output. Required if your model version perform image object detection.

    Learn how to configure prediction keys.

map<string, string> bigquery_import_keys = 9;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getBigqueryImportKeysOrThrow(String key)

public String getBigqueryImportKeysOrThrow(String key)

Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON.

You can provide the following entries in this field:

  • data_json_key: the data key for prediction input. You must provide either this key or reference_json_key.
  • reference_json_key: the data reference key for prediction input. You must provide either this key or data_json_key.
  • label_json_key: the label key for prediction output. Required.
  • label_score_json_key: the score key for prediction output. Required.
  • bounding_box_json_key: the bounding box key for prediction output. Required if your model version perform image object detection.

    Learn how to configure prediction keys.

map<string, string> bigquery_import_keys = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getBoundingPolyConfig()

public BoundingPolyConfig getBoundingPolyConfig()

Specify this field if your model version performs image object detection (bounding box detection).

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet.

.google.cloud.datalabeling.v1beta1.BoundingPolyConfig bounding_poly_config = 5;

Returns
TypeDescription
BoundingPolyConfig

The boundingPolyConfig.

getBoundingPolyConfigBuilder()

public BoundingPolyConfig.Builder getBoundingPolyConfigBuilder()

Specify this field if your model version performs image object detection (bounding box detection).

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet.

.google.cloud.datalabeling.v1beta1.BoundingPolyConfig bounding_poly_config = 5;

Returns
TypeDescription
BoundingPolyConfig.Builder

getBoundingPolyConfigOrBuilder()

public BoundingPolyConfigOrBuilder getBoundingPolyConfigOrBuilder()

Specify this field if your model version performs image object detection (bounding box detection).

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet.

.google.cloud.datalabeling.v1beta1.BoundingPolyConfig bounding_poly_config = 5;

Returns
TypeDescription
BoundingPolyConfigOrBuilder

getDefaultInstanceForType()

public EvaluationJobConfig getDefaultInstanceForType()
Returns
TypeDescription
EvaluationJobConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEvaluationConfig()

public EvaluationConfig getEvaluationConfig()

Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the boundingBoxEvaluationOptions field within this configuration. Otherwise, provide an empty object for this configuration.

.google.cloud.datalabeling.v1beta1.EvaluationConfig evaluation_config = 2;

Returns
TypeDescription
EvaluationConfig

The evaluationConfig.

getEvaluationConfigBuilder()

public EvaluationConfig.Builder getEvaluationConfigBuilder()

Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the boundingBoxEvaluationOptions field within this configuration. Otherwise, provide an empty object for this configuration.

.google.cloud.datalabeling.v1beta1.EvaluationConfig evaluation_config = 2;

Returns
TypeDescription
EvaluationConfig.Builder

getEvaluationConfigOrBuilder()

public EvaluationConfigOrBuilder getEvaluationConfigOrBuilder()

Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the boundingBoxEvaluationOptions field within this configuration. Otherwise, provide an empty object for this configuration.

.google.cloud.datalabeling.v1beta1.EvaluationConfig evaluation_config = 2;

Returns
TypeDescription
EvaluationConfigOrBuilder

getEvaluationJobAlertConfig()

public EvaluationJobAlertConfig getEvaluationJobAlertConfig()

Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run.

.google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig evaluation_job_alert_config = 13;

Returns
TypeDescription
EvaluationJobAlertConfig

The evaluationJobAlertConfig.

getEvaluationJobAlertConfigBuilder()

public EvaluationJobAlertConfig.Builder getEvaluationJobAlertConfigBuilder()

Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run.

.google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig evaluation_job_alert_config = 13;

Returns
TypeDescription
EvaluationJobAlertConfig.Builder

getEvaluationJobAlertConfigOrBuilder()

public EvaluationJobAlertConfigOrBuilder getEvaluationJobAlertConfigOrBuilder()

Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run.

.google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig evaluation_job_alert_config = 13;

Returns
TypeDescription
EvaluationJobAlertConfigOrBuilder

getExampleCount()

public int getExampleCount()

Required. The maximum number of predictions to sample and save to BigQuery during each evaluation interval. This limit overrides example_sample_percentage: even if the service has not sampled enough predictions to fulfill example_sample_perecentage during an interval, it stops sampling predictions when it meets this limit.

int32 example_count = 10;

Returns
TypeDescription
int

The exampleCount.

getExampleSamplePercentage()

public double getExampleSamplePercentage()

Required. Fraction of predictions to sample and save to BigQuery during each evaluation interval. For example, 0.1 means 10% of predictions served by your model version get saved to BigQuery.

double example_sample_percentage = 11;

Returns
TypeDescription
double

The exampleSamplePercentage.

getHumanAnnotationConfig()

public HumanAnnotationConfig getHumanAnnotationConfig()

Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to true for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field.

Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the instruction field within this configuration.

.google.cloud.datalabeling.v1beta1.HumanAnnotationConfig human_annotation_config = 3;

Returns
TypeDescription
HumanAnnotationConfig

The humanAnnotationConfig.

getHumanAnnotationConfigBuilder()

public HumanAnnotationConfig.Builder getHumanAnnotationConfigBuilder()

Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to true for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field.

Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the instruction field within this configuration.

.google.cloud.datalabeling.v1beta1.HumanAnnotationConfig human_annotation_config = 3;

Returns
TypeDescription
HumanAnnotationConfig.Builder

getHumanAnnotationConfigOrBuilder()

public HumanAnnotationConfigOrBuilder getHumanAnnotationConfigOrBuilder()

Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to true for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field.

Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the instruction field within this configuration.

.google.cloud.datalabeling.v1beta1.HumanAnnotationConfig human_annotation_config = 3;

Returns
TypeDescription
HumanAnnotationConfigOrBuilder

getHumanAnnotationRequestConfigCase()

public EvaluationJobConfig.HumanAnnotationRequestConfigCase getHumanAnnotationRequestConfigCase()
Returns
TypeDescription
EvaluationJobConfig.HumanAnnotationRequestConfigCase

getImageClassificationConfig()

public ImageClassificationConfig getImageClassificationConfig()

Specify this field if your model version performs image classification or general classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.ImageClassificationConfig image_classification_config = 4;

Returns
TypeDescription
ImageClassificationConfig

The imageClassificationConfig.

getImageClassificationConfigBuilder()

public ImageClassificationConfig.Builder getImageClassificationConfigBuilder()

Specify this field if your model version performs image classification or general classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.ImageClassificationConfig image_classification_config = 4;

Returns
TypeDescription
ImageClassificationConfig.Builder

getImageClassificationConfigOrBuilder()

public ImageClassificationConfigOrBuilder getImageClassificationConfigOrBuilder()

Specify this field if your model version performs image classification or general classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.ImageClassificationConfig image_classification_config = 4;

Returns
TypeDescription
ImageClassificationConfigOrBuilder

getInputConfig()

public InputConfig getInputConfig()

Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields:

  • dataType must be one of IMAGE, TEXT, or GENERAL_DATA.
  • annotationType must be one of IMAGE_CLASSIFICATION_ANNOTATION, TEXT_CLASSIFICATION_ANNOTATION, GENERAL_CLASSIFICATION_ANNOTATION, or IMAGE_BOUNDING_BOX_ANNOTATION (image object detection).
  • If your machine learning model performs classification, you must specify classificationMetadata.isMultiLabel.
  • You must specify bigquerySource (not gcsSource).

.google.cloud.datalabeling.v1beta1.InputConfig input_config = 1;

Returns
TypeDescription
InputConfig

The inputConfig.

getInputConfigBuilder()

public InputConfig.Builder getInputConfigBuilder()

Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields:

  • dataType must be one of IMAGE, TEXT, or GENERAL_DATA.
  • annotationType must be one of IMAGE_CLASSIFICATION_ANNOTATION, TEXT_CLASSIFICATION_ANNOTATION, GENERAL_CLASSIFICATION_ANNOTATION, or IMAGE_BOUNDING_BOX_ANNOTATION (image object detection).
  • If your machine learning model performs classification, you must specify classificationMetadata.isMultiLabel.
  • You must specify bigquerySource (not gcsSource).

.google.cloud.datalabeling.v1beta1.InputConfig input_config = 1;

Returns
TypeDescription
InputConfig.Builder

getInputConfigOrBuilder()

public InputConfigOrBuilder getInputConfigOrBuilder()

Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields:

  • dataType must be one of IMAGE, TEXT, or GENERAL_DATA.
  • annotationType must be one of IMAGE_CLASSIFICATION_ANNOTATION, TEXT_CLASSIFICATION_ANNOTATION, GENERAL_CLASSIFICATION_ANNOTATION, or IMAGE_BOUNDING_BOX_ANNOTATION (image object detection).
  • If your machine learning model performs classification, you must specify classificationMetadata.isMultiLabel.
  • You must specify bigquerySource (not gcsSource).

.google.cloud.datalabeling.v1beta1.InputConfig input_config = 1;

Returns
TypeDescription
InputConfigOrBuilder

getMutableBigqueryImportKeys() (deprecated)

public Map<String,String> getMutableBigqueryImportKeys()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getTextClassificationConfig()

public TextClassificationConfig getTextClassificationConfig()

Specify this field if your model version performs text classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.TextClassificationConfig text_classification_config = 8;

Returns
TypeDescription
TextClassificationConfig

The textClassificationConfig.

getTextClassificationConfigBuilder()

public TextClassificationConfig.Builder getTextClassificationConfigBuilder()

Specify this field if your model version performs text classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.TextClassificationConfig text_classification_config = 8;

Returns
TypeDescription
TextClassificationConfig.Builder

getTextClassificationConfigOrBuilder()

public TextClassificationConfigOrBuilder getTextClassificationConfigOrBuilder()

Specify this field if your model version performs text classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.TextClassificationConfig text_classification_config = 8;

Returns
TypeDescription
TextClassificationConfigOrBuilder

hasBoundingPolyConfig()

public boolean hasBoundingPolyConfig()

Specify this field if your model version performs image object detection (bounding box detection).

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet.

.google.cloud.datalabeling.v1beta1.BoundingPolyConfig bounding_poly_config = 5;

Returns
TypeDescription
boolean

Whether the boundingPolyConfig field is set.

hasEvaluationConfig()

public boolean hasEvaluationConfig()

Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the boundingBoxEvaluationOptions field within this configuration. Otherwise, provide an empty object for this configuration.

.google.cloud.datalabeling.v1beta1.EvaluationConfig evaluation_config = 2;

Returns
TypeDescription
boolean

Whether the evaluationConfig field is set.

hasEvaluationJobAlertConfig()

public boolean hasEvaluationJobAlertConfig()

Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run.

.google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig evaluation_job_alert_config = 13;

Returns
TypeDescription
boolean

Whether the evaluationJobAlertConfig field is set.

hasHumanAnnotationConfig()

public boolean hasHumanAnnotationConfig()

Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to true for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field.

Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the instruction field within this configuration.

.google.cloud.datalabeling.v1beta1.HumanAnnotationConfig human_annotation_config = 3;

Returns
TypeDescription
boolean

Whether the humanAnnotationConfig field is set.

hasImageClassificationConfig()

public boolean hasImageClassificationConfig()

Specify this field if your model version performs image classification or general classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.ImageClassificationConfig image_classification_config = 4;

Returns
TypeDescription
boolean

Whether the imageClassificationConfig field is set.

hasInputConfig()

public boolean hasInputConfig()

Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields:

  • dataType must be one of IMAGE, TEXT, or GENERAL_DATA.
  • annotationType must be one of IMAGE_CLASSIFICATION_ANNOTATION, TEXT_CLASSIFICATION_ANNOTATION, GENERAL_CLASSIFICATION_ANNOTATION, or IMAGE_BOUNDING_BOX_ANNOTATION (image object detection).
  • If your machine learning model performs classification, you must specify classificationMetadata.isMultiLabel.
  • You must specify bigquerySource (not gcsSource).

.google.cloud.datalabeling.v1beta1.InputConfig input_config = 1;

Returns
TypeDescription
boolean

Whether the inputConfig field is set.

hasTextClassificationConfig()

public boolean hasTextClassificationConfig()

Specify this field if your model version performs text classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.TextClassificationConfig text_classification_config = 8;

Returns
TypeDescription
boolean

Whether the textClassificationConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBoundingPolyConfig(BoundingPolyConfig value)

public EvaluationJobConfig.Builder mergeBoundingPolyConfig(BoundingPolyConfig value)

Specify this field if your model version performs image object detection (bounding box detection).

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet.

.google.cloud.datalabeling.v1beta1.BoundingPolyConfig bounding_poly_config = 5;

Parameter
NameDescription
valueBoundingPolyConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

mergeEvaluationConfig(EvaluationConfig value)

public EvaluationJobConfig.Builder mergeEvaluationConfig(EvaluationConfig value)

Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the boundingBoxEvaluationOptions field within this configuration. Otherwise, provide an empty object for this configuration.

.google.cloud.datalabeling.v1beta1.EvaluationConfig evaluation_config = 2;

Parameter
NameDescription
valueEvaluationConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

mergeEvaluationJobAlertConfig(EvaluationJobAlertConfig value)

public EvaluationJobConfig.Builder mergeEvaluationJobAlertConfig(EvaluationJobAlertConfig value)

Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run.

.google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig evaluation_job_alert_config = 13;

Parameter
NameDescription
valueEvaluationJobAlertConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

mergeFrom(EvaluationJobConfig other)

public EvaluationJobConfig.Builder mergeFrom(EvaluationJobConfig other)
Parameter
NameDescription
otherEvaluationJobConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EvaluationJobConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public EvaluationJobConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides

mergeHumanAnnotationConfig(HumanAnnotationConfig value)

public EvaluationJobConfig.Builder mergeHumanAnnotationConfig(HumanAnnotationConfig value)

Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to true for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field.

Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the instruction field within this configuration.

.google.cloud.datalabeling.v1beta1.HumanAnnotationConfig human_annotation_config = 3;

Parameter
NameDescription
valueHumanAnnotationConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

mergeImageClassificationConfig(ImageClassificationConfig value)

public EvaluationJobConfig.Builder mergeImageClassificationConfig(ImageClassificationConfig value)

Specify this field if your model version performs image classification or general classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.ImageClassificationConfig image_classification_config = 4;

Parameter
NameDescription
valueImageClassificationConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

mergeInputConfig(InputConfig value)

public EvaluationJobConfig.Builder mergeInputConfig(InputConfig value)

Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields:

  • dataType must be one of IMAGE, TEXT, or GENERAL_DATA.
  • annotationType must be one of IMAGE_CLASSIFICATION_ANNOTATION, TEXT_CLASSIFICATION_ANNOTATION, GENERAL_CLASSIFICATION_ANNOTATION, or IMAGE_BOUNDING_BOX_ANNOTATION (image object detection).
  • If your machine learning model performs classification, you must specify classificationMetadata.isMultiLabel.
  • You must specify bigquerySource (not gcsSource).

.google.cloud.datalabeling.v1beta1.InputConfig input_config = 1;

Parameter
NameDescription
valueInputConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

mergeTextClassificationConfig(TextClassificationConfig value)

public EvaluationJobConfig.Builder mergeTextClassificationConfig(TextClassificationConfig value)

Specify this field if your model version performs text classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.TextClassificationConfig text_classification_config = 8;

Parameter
NameDescription
valueTextClassificationConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EvaluationJobConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides

putAllBigqueryImportKeys(Map<String,String> values)

public EvaluationJobConfig.Builder putAllBigqueryImportKeys(Map<String,String> values)

Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON.

You can provide the following entries in this field:

  • data_json_key: the data key for prediction input. You must provide either this key or reference_json_key.
  • reference_json_key: the data reference key for prediction input. You must provide either this key or data_json_key.
  • label_json_key: the label key for prediction output. Required.
  • label_score_json_key: the score key for prediction output. Required.
  • bounding_box_json_key: the bounding box key for prediction output. Required if your model version perform image object detection.

    Learn how to configure prediction keys.

map<string, string> bigquery_import_keys = 9;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
EvaluationJobConfig.Builder

putBigqueryImportKeys(String key, String value)

public EvaluationJobConfig.Builder putBigqueryImportKeys(String key, String value)

Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON.

You can provide the following entries in this field:

  • data_json_key: the data key for prediction input. You must provide either this key or reference_json_key.
  • reference_json_key: the data reference key for prediction input. You must provide either this key or data_json_key.
  • label_json_key: the label key for prediction output. Required.
  • label_score_json_key: the score key for prediction output. Required.
  • bounding_box_json_key: the bounding box key for prediction output. Required if your model version perform image object detection.

    Learn how to configure prediction keys.

map<string, string> bigquery_import_keys = 9;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
EvaluationJobConfig.Builder

removeBigqueryImportKeys(String key)

public EvaluationJobConfig.Builder removeBigqueryImportKeys(String key)

Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON.

You can provide the following entries in this field:

  • data_json_key: the data key for prediction input. You must provide either this key or reference_json_key.
  • reference_json_key: the data reference key for prediction input. You must provide either this key or data_json_key.
  • label_json_key: the label key for prediction output. Required.
  • label_score_json_key: the score key for prediction output. Required.
  • bounding_box_json_key: the bounding box key for prediction output. Required if your model version perform image object detection.

    Learn how to configure prediction keys.

map<string, string> bigquery_import_keys = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
EvaluationJobConfig.Builder

setBoundingPolyConfig(BoundingPolyConfig value)

public EvaluationJobConfig.Builder setBoundingPolyConfig(BoundingPolyConfig value)

Specify this field if your model version performs image object detection (bounding box detection).

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet.

.google.cloud.datalabeling.v1beta1.BoundingPolyConfig bounding_poly_config = 5;

Parameter
NameDescription
valueBoundingPolyConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

setBoundingPolyConfig(BoundingPolyConfig.Builder builderForValue)

public EvaluationJobConfig.Builder setBoundingPolyConfig(BoundingPolyConfig.Builder builderForValue)

Specify this field if your model version performs image object detection (bounding box detection).

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet.

.google.cloud.datalabeling.v1beta1.BoundingPolyConfig bounding_poly_config = 5;

Parameter
NameDescription
builderForValueBoundingPolyConfig.Builder
Returns
TypeDescription
EvaluationJobConfig.Builder

setEvaluationConfig(EvaluationConfig value)

public EvaluationJobConfig.Builder setEvaluationConfig(EvaluationConfig value)

Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the boundingBoxEvaluationOptions field within this configuration. Otherwise, provide an empty object for this configuration.

.google.cloud.datalabeling.v1beta1.EvaluationConfig evaluation_config = 2;

Parameter
NameDescription
valueEvaluationConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

setEvaluationConfig(EvaluationConfig.Builder builderForValue)

public EvaluationJobConfig.Builder setEvaluationConfig(EvaluationConfig.Builder builderForValue)

Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the boundingBoxEvaluationOptions field within this configuration. Otherwise, provide an empty object for this configuration.

.google.cloud.datalabeling.v1beta1.EvaluationConfig evaluation_config = 2;

Parameter
NameDescription
builderForValueEvaluationConfig.Builder
Returns
TypeDescription
EvaluationJobConfig.Builder

setEvaluationJobAlertConfig(EvaluationJobAlertConfig value)

public EvaluationJobConfig.Builder setEvaluationJobAlertConfig(EvaluationJobAlertConfig value)

Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run.

.google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig evaluation_job_alert_config = 13;

Parameter
NameDescription
valueEvaluationJobAlertConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

setEvaluationJobAlertConfig(EvaluationJobAlertConfig.Builder builderForValue)

public EvaluationJobConfig.Builder setEvaluationJobAlertConfig(EvaluationJobAlertConfig.Builder builderForValue)

Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run.

.google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig evaluation_job_alert_config = 13;

Parameter
NameDescription
builderForValueEvaluationJobAlertConfig.Builder
Returns
TypeDescription
EvaluationJobConfig.Builder

setExampleCount(int value)

public EvaluationJobConfig.Builder setExampleCount(int value)

Required. The maximum number of predictions to sample and save to BigQuery during each evaluation interval. This limit overrides example_sample_percentage: even if the service has not sampled enough predictions to fulfill example_sample_perecentage during an interval, it stops sampling predictions when it meets this limit.

int32 example_count = 10;

Parameter
NameDescription
valueint

The exampleCount to set.

Returns
TypeDescription
EvaluationJobConfig.Builder

This builder for chaining.

setExampleSamplePercentage(double value)

public EvaluationJobConfig.Builder setExampleSamplePercentage(double value)

Required. Fraction of predictions to sample and save to BigQuery during each evaluation interval. For example, 0.1 means 10% of predictions served by your model version get saved to BigQuery.

double example_sample_percentage = 11;

Parameter
NameDescription
valuedouble

The exampleSamplePercentage to set.

Returns
TypeDescription
EvaluationJobConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public EvaluationJobConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides

setHumanAnnotationConfig(HumanAnnotationConfig value)

public EvaluationJobConfig.Builder setHumanAnnotationConfig(HumanAnnotationConfig value)

Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to true for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field.

Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the instruction field within this configuration.

.google.cloud.datalabeling.v1beta1.HumanAnnotationConfig human_annotation_config = 3;

Parameter
NameDescription
valueHumanAnnotationConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

setHumanAnnotationConfig(HumanAnnotationConfig.Builder builderForValue)

public EvaluationJobConfig.Builder setHumanAnnotationConfig(HumanAnnotationConfig.Builder builderForValue)

Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to true for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field.

Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the instruction field within this configuration.

.google.cloud.datalabeling.v1beta1.HumanAnnotationConfig human_annotation_config = 3;

Parameter
NameDescription
builderForValueHumanAnnotationConfig.Builder
Returns
TypeDescription
EvaluationJobConfig.Builder

setImageClassificationConfig(ImageClassificationConfig value)

public EvaluationJobConfig.Builder setImageClassificationConfig(ImageClassificationConfig value)

Specify this field if your model version performs image classification or general classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.ImageClassificationConfig image_classification_config = 4;

Parameter
NameDescription
valueImageClassificationConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

setImageClassificationConfig(ImageClassificationConfig.Builder builderForValue)

public EvaluationJobConfig.Builder setImageClassificationConfig(ImageClassificationConfig.Builder builderForValue)

Specify this field if your model version performs image classification or general classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.ImageClassificationConfig image_classification_config = 4;

Parameter
NameDescription
builderForValueImageClassificationConfig.Builder
Returns
TypeDescription
EvaluationJobConfig.Builder

setInputConfig(InputConfig value)

public EvaluationJobConfig.Builder setInputConfig(InputConfig value)

Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields:

  • dataType must be one of IMAGE, TEXT, or GENERAL_DATA.
  • annotationType must be one of IMAGE_CLASSIFICATION_ANNOTATION, TEXT_CLASSIFICATION_ANNOTATION, GENERAL_CLASSIFICATION_ANNOTATION, or IMAGE_BOUNDING_BOX_ANNOTATION (image object detection).
  • If your machine learning model performs classification, you must specify classificationMetadata.isMultiLabel.
  • You must specify bigquerySource (not gcsSource).

.google.cloud.datalabeling.v1beta1.InputConfig input_config = 1;

Parameter
NameDescription
valueInputConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

setInputConfig(InputConfig.Builder builderForValue)

public EvaluationJobConfig.Builder setInputConfig(InputConfig.Builder builderForValue)

Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields:

  • dataType must be one of IMAGE, TEXT, or GENERAL_DATA.
  • annotationType must be one of IMAGE_CLASSIFICATION_ANNOTATION, TEXT_CLASSIFICATION_ANNOTATION, GENERAL_CLASSIFICATION_ANNOTATION, or IMAGE_BOUNDING_BOX_ANNOTATION (image object detection).
  • If your machine learning model performs classification, you must specify classificationMetadata.isMultiLabel.
  • You must specify bigquerySource (not gcsSource).

.google.cloud.datalabeling.v1beta1.InputConfig input_config = 1;

Parameter
NameDescription
builderForValueInputConfig.Builder
Returns
TypeDescription
EvaluationJobConfig.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public EvaluationJobConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides

setTextClassificationConfig(TextClassificationConfig value)

public EvaluationJobConfig.Builder setTextClassificationConfig(TextClassificationConfig value)

Specify this field if your model version performs text classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.TextClassificationConfig text_classification_config = 8;

Parameter
NameDescription
valueTextClassificationConfig
Returns
TypeDescription
EvaluationJobConfig.Builder

setTextClassificationConfig(TextClassificationConfig.Builder builderForValue)

public EvaluationJobConfig.Builder setTextClassificationConfig(TextClassificationConfig.Builder builderForValue)

Specify this field if your model version performs text classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

.google.cloud.datalabeling.v1beta1.TextClassificationConfig text_classification_config = 8;

Parameter
NameDescription
builderForValueTextClassificationConfig.Builder
Returns
TypeDescription
EvaluationJobConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final EvaluationJobConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
EvaluationJobConfig.Builder
Overrides