Class ModelEvaluationSlice.Builder (3.44.0)

public static final class ModelEvaluationSlice.Builder extends GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder> implements ModelEvaluationSliceOrBuilder

A collection of metrics calculated by comparing Model's predictions on a slice of the test data against ground truth annotations.

Protobuf type google.cloud.aiplatform.v1beta1.ModelEvaluationSlice

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ModelEvaluationSlice.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides

build()

public ModelEvaluationSlice build()
Returns
Type Description
ModelEvaluationSlice

buildPartial()

public ModelEvaluationSlice buildPartial()
Returns
Type Description
ModelEvaluationSlice

clear()

public ModelEvaluationSlice.Builder clear()
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides

clearCreateTime()

public ModelEvaluationSlice.Builder clearCreateTime()

Output only. Timestamp when this ModelEvaluationSlice was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.Builder

clearField(Descriptors.FieldDescriptor field)

public ModelEvaluationSlice.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides

clearMetrics()

public ModelEvaluationSlice.Builder clearMetrics()

Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.Builder

clearMetricsSchemaUri()

public ModelEvaluationSlice.Builder clearMetricsSchemaUri()

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.Builder

This builder for chaining.

clearModelExplanation()

public ModelEvaluationSlice.Builder clearModelExplanation()

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.Builder

clearName()

public ModelEvaluationSlice.Builder clearName()

Output only. The resource name of the ModelEvaluationSlice.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ModelEvaluationSlice.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides

clearSlice()

public ModelEvaluationSlice.Builder clearSlice()

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.Builder

clone()

public ModelEvaluationSlice.Builder clone()
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this ModelEvaluationSlice was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this ModelEvaluationSlice was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this ModelEvaluationSlice was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ModelEvaluationSlice getDefaultInstanceForType()
Returns
Type Description
ModelEvaluationSlice

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMetrics()

public Value getMetrics()

Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Value

The metrics.

getMetricsBuilder()

public Value.Builder getMetricsBuilder()

Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getMetricsOrBuilder()

public ValueOrBuilder getMetricsOrBuilder()

Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ValueOrBuilder

getMetricsSchemaUri()

public String getMetricsSchemaUri()

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The metricsSchemaUri.

getMetricsSchemaUriBytes()

public ByteString getMetricsSchemaUriBytes()

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for metricsSchemaUri.

getModelExplanation()

public ModelExplanation getModelExplanation()

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelExplanation

The modelExplanation.

getModelExplanationBuilder()

public ModelExplanation.Builder getModelExplanationBuilder()

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelExplanation.Builder

getModelExplanationOrBuilder()

public ModelExplanationOrBuilder getModelExplanationOrBuilder()

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelExplanationOrBuilder

getName()

public String getName()

Output only. The resource name of the ModelEvaluationSlice.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the ModelEvaluationSlice.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getSlice()

public ModelEvaluationSlice.Slice getSlice()

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.Slice

The slice.

getSliceBuilder()

public ModelEvaluationSlice.Slice.Builder getSliceBuilder()

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.Slice.Builder

getSliceOrBuilder()

public ModelEvaluationSlice.SliceOrBuilder getSliceOrBuilder()

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.SliceOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this ModelEvaluationSlice was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasMetrics()

public boolean hasMetrics()

Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the metrics field is set.

hasModelExplanation()

public boolean hasModelExplanation()

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the modelExplanation field is set.

hasSlice()

public boolean hasSlice()

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the slice field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public ModelEvaluationSlice.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this ModelEvaluationSlice was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ModelEvaluationSlice.Builder

mergeFrom(ModelEvaluationSlice other)

public ModelEvaluationSlice.Builder mergeFrom(ModelEvaluationSlice other)
Parameter
Name Description
other ModelEvaluationSlice
Returns
Type Description
ModelEvaluationSlice.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ModelEvaluationSlice.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ModelEvaluationSlice.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides

mergeMetrics(Value value)

public ModelEvaluationSlice.Builder mergeMetrics(Value value)

Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Value
Returns
Type Description
ModelEvaluationSlice.Builder

mergeModelExplanation(ModelExplanation value)

public ModelEvaluationSlice.Builder mergeModelExplanation(ModelExplanation value)

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ModelExplanation
Returns
Type Description
ModelEvaluationSlice.Builder

mergeSlice(ModelEvaluationSlice.Slice value)

public ModelEvaluationSlice.Builder mergeSlice(ModelEvaluationSlice.Slice value)

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ModelEvaluationSlice.Slice
Returns
Type Description
ModelEvaluationSlice.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ModelEvaluationSlice.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides

setCreateTime(Timestamp value)

public ModelEvaluationSlice.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this ModelEvaluationSlice was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ModelEvaluationSlice.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ModelEvaluationSlice.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this ModelEvaluationSlice was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ModelEvaluationSlice.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ModelEvaluationSlice.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides

setMetrics(Value value)

public ModelEvaluationSlice.Builder setMetrics(Value value)

Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Value
Returns
Type Description
ModelEvaluationSlice.Builder

setMetrics(Value.Builder builderForValue)

public ModelEvaluationSlice.Builder setMetrics(Value.Builder builderForValue)

Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ModelEvaluationSlice.Builder

setMetricsSchemaUri(String value)

public ModelEvaluationSlice.Builder setMetricsSchemaUri(String value)

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The metricsSchemaUri to set.

Returns
Type Description
ModelEvaluationSlice.Builder

This builder for chaining.

setMetricsSchemaUriBytes(ByteString value)

public ModelEvaluationSlice.Builder setMetricsSchemaUriBytes(ByteString value)

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for metricsSchemaUri to set.

Returns
Type Description
ModelEvaluationSlice.Builder

This builder for chaining.

setModelExplanation(ModelExplanation value)

public ModelEvaluationSlice.Builder setModelExplanation(ModelExplanation value)

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ModelExplanation
Returns
Type Description
ModelEvaluationSlice.Builder

setModelExplanation(ModelExplanation.Builder builderForValue)

public ModelEvaluationSlice.Builder setModelExplanation(ModelExplanation.Builder builderForValue)

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ModelExplanation.Builder
Returns
Type Description
ModelEvaluationSlice.Builder

setName(String value)

public ModelEvaluationSlice.Builder setName(String value)

Output only. The resource name of the ModelEvaluationSlice.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ModelEvaluationSlice.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ModelEvaluationSlice.Builder setNameBytes(ByteString value)

Output only. The resource name of the ModelEvaluationSlice.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ModelEvaluationSlice.Builder

This builder for chaining.

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

public ModelEvaluationSlice.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides

setSlice(ModelEvaluationSlice.Slice value)

public ModelEvaluationSlice.Builder setSlice(ModelEvaluationSlice.Slice value)

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ModelEvaluationSlice.Slice
Returns
Type Description
ModelEvaluationSlice.Builder

setSlice(ModelEvaluationSlice.Slice.Builder builderForValue)

public ModelEvaluationSlice.Builder setSlice(ModelEvaluationSlice.Slice.Builder builderForValue)

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ModelEvaluationSlice.Slice.Builder
Returns
Type Description
ModelEvaluationSlice.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ModelEvaluationSlice.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ModelEvaluationSlice.Builder
Overrides