Class ModelMonitoringObjectiveConfig.ExplanationConfig.Builder (3.44.0)

public static final class ModelMonitoringObjectiveConfig.ExplanationConfig.Builder extends GeneratedMessageV3.Builder<ModelMonitoringObjectiveConfig.ExplanationConfig.Builder> implements ModelMonitoringObjectiveConfig.ExplanationConfigOrBuilder

The config for integrating with Vertex Explainable AI. Only applicable if the Model has explanation_spec populated.

Protobuf type google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ModelMonitoringObjectiveConfig.ExplanationConfig build()
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig

buildPartial()

public ModelMonitoringObjectiveConfig.ExplanationConfig buildPartial()
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig

clear()

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder clear()
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder
Overrides

clearEnableFeatureAttributes()

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder clearEnableFeatureAttributes()

If want to analyze the Vertex Explainable AI feature attribute scores or not. If set to true, Vertex AI will log the feature attributions from explain response and do the skew/drift detection for them.

bool enable_feature_attributes = 1;

Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

This builder for chaining.

clearExplanationBaseline()

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder clearExplanationBaseline()

Predictions generated by the BatchPredictionJob using baseline dataset.

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder clone()
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder
Overrides

getDefaultInstanceForType()

public ModelMonitoringObjectiveConfig.ExplanationConfig getDefaultInstanceForType()
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig

getDescriptorForType()

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

getEnableFeatureAttributes()

public boolean getEnableFeatureAttributes()

If want to analyze the Vertex Explainable AI feature attribute scores or not. If set to true, Vertex AI will log the feature attributions from explain response and do the skew/drift detection for them.

bool enable_feature_attributes = 1;

Returns
Type Description
boolean

The enableFeatureAttributes.

getExplanationBaseline()

public ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline getExplanationBaseline()

Predictions generated by the BatchPredictionJob using baseline dataset.

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline

The explanationBaseline.

getExplanationBaselineBuilder()

public ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline.Builder getExplanationBaselineBuilder()

Predictions generated by the BatchPredictionJob using baseline dataset.

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline.Builder

getExplanationBaselineOrBuilder()

public ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaselineOrBuilder getExplanationBaselineOrBuilder()

Predictions generated by the BatchPredictionJob using baseline dataset.

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaselineOrBuilder

hasExplanationBaseline()

public boolean hasExplanationBaseline()

Predictions generated by the BatchPredictionJob using baseline dataset.

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Returns
Type Description
boolean

Whether the explanationBaseline field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExplanationBaseline(ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline value)

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder mergeExplanationBaseline(ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline value)

Predictions generated by the BatchPredictionJob using baseline dataset.

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Parameter
Name Description
value ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

mergeFrom(ModelMonitoringObjectiveConfig.ExplanationConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setEnableFeatureAttributes(boolean value)

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder setEnableFeatureAttributes(boolean value)

If want to analyze the Vertex Explainable AI feature attribute scores or not. If set to true, Vertex AI will log the feature attributions from explain response and do the skew/drift detection for them.

bool enable_feature_attributes = 1;

Parameter
Name Description
value boolean

The enableFeatureAttributes to set.

Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

This builder for chaining.

setExplanationBaseline(ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline value)

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder setExplanationBaseline(ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline value)

Predictions generated by the BatchPredictionJob using baseline dataset.

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Parameter
Name Description
value ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

setExplanationBaseline(ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline.Builder builderForValue)

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder setExplanationBaseline(ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline.Builder builderForValue)

Predictions generated by the BatchPredictionJob using baseline dataset.

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Parameter
Name Description
builderForValue ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline.Builder
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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