Package com.google.cloud.aiplatform.v1

Class Attribution.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Attribution.Builder>
com.google.cloud.aiplatform.v1.Attribution.Builder
All Implemented Interfaces:
AttributionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Attribution
public static final class Attribution.Builder extends com.google.protobuf.GeneratedMessage.Builder<Attribution.Builder> implements AttributionOrBuilder
 Attribution that explains a particular prediction output.
Protobuf type google.cloud.aiplatform.v1.Attribution

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Attribution.Builder>

    • clear

      public Attribution.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Attribution.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Attribution.Builder>

    • getDefaultInstanceForType

      public Attribution getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Attribution build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Attribution buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Attribution.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Attribution.Builder>

    • mergeFrom

      public Attribution.Builder mergeFrom(Attribution other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Attribution.Builder>

    • mergeFrom

      public Attribution.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Attribution.Builder>
      Throws:
      IOException

    • getBaselineOutputValue

      public double getBaselineOutputValue()
       Output only. Model predicted output if the input instance is constructed
 from the baselines of all the features defined in
 [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
 The field name of the output is determined by the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].

 If the Model's predicted output has multiple dimensions (rank > 1), this is
 the value in the output located by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index].

 If there are multiple baselines, their output values are averaged.
      double baseline_output_value = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getBaselineOutputValue in interface AttributionOrBuilder
      Returns:
      The baselineOutputValue.

    • setBaselineOutputValue

      public Attribution.Builder setBaselineOutputValue(double value)
       Output only. Model predicted output if the input instance is constructed
 from the baselines of all the features defined in
 [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
 The field name of the output is determined by the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].

 If the Model's predicted output has multiple dimensions (rank > 1), this is
 the value in the output located by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index].

 If there are multiple baselines, their output values are averaged.
      double baseline_output_value = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The baselineOutputValue to set.
      Returns:
      This builder for chaining.

    • clearBaselineOutputValue

      public Attribution.Builder clearBaselineOutputValue()
       Output only. Model predicted output if the input instance is constructed
 from the baselines of all the features defined in
 [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
 The field name of the output is determined by the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].

 If the Model's predicted output has multiple dimensions (rank > 1), this is
 the value in the output located by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index].

 If there are multiple baselines, their output values are averaged.
      double baseline_output_value = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getInstanceOutputValue

      public double getInstanceOutputValue()
       Output only. Model predicted output on the corresponding [explanation
 instance][ExplainRequest.instances]. The field name of the output is
 determined by the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].

 If the Model predicted output has multiple dimensions, this is the value in
 the output located by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
      double instance_output_value = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getInstanceOutputValue in interface AttributionOrBuilder
      Returns:
      The instanceOutputValue.

    • setInstanceOutputValue

      public Attribution.Builder setInstanceOutputValue(double value)
       Output only. Model predicted output on the corresponding [explanation
 instance][ExplainRequest.instances]. The field name of the output is
 determined by the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].

 If the Model predicted output has multiple dimensions, this is the value in
 the output located by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
      double instance_output_value = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The instanceOutputValue to set.
      Returns:
      This builder for chaining.

    • clearInstanceOutputValue

      public Attribution.Builder clearInstanceOutputValue()
       Output only. Model predicted output on the corresponding [explanation
 instance][ExplainRequest.instances]. The field name of the output is
 determined by the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].

 If the Model predicted output has multiple dimensions, this is the value in
 the output located by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
      double instance_output_value = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasFeatureAttributions

      public boolean hasFeatureAttributions()
       Output only. Attributions of each explained feature. Features are extracted
 from the [prediction
 instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
 to [explanation metadata for
 inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].

 The value is a struct, whose keys are the name of the feature. The values
 are how much the feature in the
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
 to the predicted result.

 The format of the value is determined by the feature's input format:

 * If the feature is a scalar value, the attribution value is a
 [floating number][google.protobuf.Value.number_value].

 * If the feature is an array of scalar values, the attribution value is
 an [array][google.protobuf.Value.list_value].

 * If the feature is a struct, the attribution value is a
 [struct][google.protobuf.Value.struct_value]. The keys in the
 attribution value struct are the same as the keys in the feature
 struct. The formats of the values in the attribution struct are
 determined by the formats of the values in the feature struct.

 The
 [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
 field, pointed to by the
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
 [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
 object, points to the schema file that describes the features and their
 attribution values (if it is populated).
      .google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasFeatureAttributions in interface AttributionOrBuilder
      Returns:
      Whether the featureAttributions field is set.

    • getFeatureAttributions

      public com.google.protobuf.Value getFeatureAttributions()
       Output only. Attributions of each explained feature. Features are extracted
 from the [prediction
 instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
 to [explanation metadata for
 inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].

 The value is a struct, whose keys are the name of the feature. The values
 are how much the feature in the
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
 to the predicted result.

 The format of the value is determined by the feature's input format:

 * If the feature is a scalar value, the attribution value is a
 [floating number][google.protobuf.Value.number_value].

 * If the feature is an array of scalar values, the attribution value is
 an [array][google.protobuf.Value.list_value].

 * If the feature is a struct, the attribution value is a
 [struct][google.protobuf.Value.struct_value]. The keys in the
 attribution value struct are the same as the keys in the feature
 struct. The formats of the values in the attribution struct are
 determined by the formats of the values in the feature struct.

 The
 [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
 field, pointed to by the
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
 [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
 object, points to the schema file that describes the features and their
 attribution values (if it is populated).
      .google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFeatureAttributions in interface AttributionOrBuilder
      Returns:
      The featureAttributions.

    • setFeatureAttributions

      public Attribution.Builder setFeatureAttributions(com.google.protobuf.Value value)
       Output only. Attributions of each explained feature. Features are extracted
 from the [prediction
 instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
 to [explanation metadata for
 inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].

 The value is a struct, whose keys are the name of the feature. The values
 are how much the feature in the
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
 to the predicted result.

 The format of the value is determined by the feature's input format:

 * If the feature is a scalar value, the attribution value is a
 [floating number][google.protobuf.Value.number_value].

 * If the feature is an array of scalar values, the attribution value is
 an [array][google.protobuf.Value.list_value].

 * If the feature is a struct, the attribution value is a
 [struct][google.protobuf.Value.struct_value]. The keys in the
 attribution value struct are the same as the keys in the feature
 struct. The formats of the values in the attribution struct are
 determined by the formats of the values in the feature struct.

 The
 [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
 field, pointed to by the
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
 [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
 object, points to the schema file that describes the features and their
 attribution values (if it is populated).
      .google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setFeatureAttributions

      public Attribution.Builder setFeatureAttributions(com.google.protobuf.Value.Builder builderForValue)
       Output only. Attributions of each explained feature. Features are extracted
 from the [prediction
 instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
 to [explanation metadata for
 inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].

 The value is a struct, whose keys are the name of the feature. The values
 are how much the feature in the
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
 to the predicted result.

 The format of the value is determined by the feature's input format:

 * If the feature is a scalar value, the attribution value is a
 [floating number][google.protobuf.Value.number_value].

 * If the feature is an array of scalar values, the attribution value is
 an [array][google.protobuf.Value.list_value].

 * If the feature is a struct, the attribution value is a
 [struct][google.protobuf.Value.struct_value]. The keys in the
 attribution value struct are the same as the keys in the feature
 struct. The formats of the values in the attribution struct are
 determined by the formats of the values in the feature struct.

 The
 [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
 field, pointed to by the
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
 [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
 object, points to the schema file that describes the features and their
 attribution values (if it is populated).
      .google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeFeatureAttributions

      public Attribution.Builder mergeFeatureAttributions(com.google.protobuf.Value value)
       Output only. Attributions of each explained feature. Features are extracted
 from the [prediction
 instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
 to [explanation metadata for
 inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].

 The value is a struct, whose keys are the name of the feature. The values
 are how much the feature in the
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
 to the predicted result.

 The format of the value is determined by the feature's input format:

 * If the feature is a scalar value, the attribution value is a
 [floating number][google.protobuf.Value.number_value].

 * If the feature is an array of scalar values, the attribution value is
 an [array][google.protobuf.Value.list_value].

 * If the feature is a struct, the attribution value is a
 [struct][google.protobuf.Value.struct_value]. The keys in the
 attribution value struct are the same as the keys in the feature
 struct. The formats of the values in the attribution struct are
 determined by the formats of the values in the feature struct.

 The
 [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
 field, pointed to by the
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
 [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
 object, points to the schema file that describes the features and their
 attribution values (if it is populated).
      .google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearFeatureAttributions

      public Attribution.Builder clearFeatureAttributions()
       Output only. Attributions of each explained feature. Features are extracted
 from the [prediction
 instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
 to [explanation metadata for
 inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].

 The value is a struct, whose keys are the name of the feature. The values
 are how much the feature in the
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
 to the predicted result.

 The format of the value is determined by the feature's input format:

 * If the feature is a scalar value, the attribution value is a
 [floating number][google.protobuf.Value.number_value].

 * If the feature is an array of scalar values, the attribution value is
 an [array][google.protobuf.Value.list_value].

 * If the feature is a struct, the attribution value is a
 [struct][google.protobuf.Value.struct_value]. The keys in the
 attribution value struct are the same as the keys in the feature
 struct. The formats of the values in the attribution struct are
 determined by the formats of the values in the feature struct.

 The
 [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
 field, pointed to by the
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
 [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
 object, points to the schema file that describes the features and their
 attribution values (if it is populated).
      .google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getFeatureAttributionsBuilder

      public com.google.protobuf.Value.Builder getFeatureAttributionsBuilder()
       Output only. Attributions of each explained feature. Features are extracted
 from the [prediction
 instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
 to [explanation metadata for
 inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].

 The value is a struct, whose keys are the name of the feature. The values
 are how much the feature in the
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
 to the predicted result.

 The format of the value is determined by the feature's input format:

 * If the feature is a scalar value, the attribution value is a
 [floating number][google.protobuf.Value.number_value].

 * If the feature is an array of scalar values, the attribution value is
 an [array][google.protobuf.Value.list_value].

 * If the feature is a struct, the attribution value is a
 [struct][google.protobuf.Value.struct_value]. The keys in the
 attribution value struct are the same as the keys in the feature
 struct. The formats of the values in the attribution struct are
 determined by the formats of the values in the feature struct.

 The
 [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
 field, pointed to by the
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
 [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
 object, points to the schema file that describes the features and their
 attribution values (if it is populated).
      .google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getFeatureAttributionsOrBuilder

      public com.google.protobuf.ValueOrBuilder getFeatureAttributionsOrBuilder()
       Output only. Attributions of each explained feature. Features are extracted
 from the [prediction
 instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
 to [explanation metadata for
 inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].

 The value is a struct, whose keys are the name of the feature. The values
 are how much the feature in the
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
 to the predicted result.

 The format of the value is determined by the feature's input format:

 * If the feature is a scalar value, the attribution value is a
 [floating number][google.protobuf.Value.number_value].

 * If the feature is an array of scalar values, the attribution value is
 an [array][google.protobuf.Value.list_value].

 * If the feature is a struct, the attribution value is a
 [struct][google.protobuf.Value.struct_value]. The keys in the
 attribution value struct are the same as the keys in the feature
 struct. The formats of the values in the attribution struct are
 determined by the formats of the values in the feature struct.

 The
 [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
 field, pointed to by the
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
 [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
 object, points to the schema file that describes the features and their
 attribution values (if it is populated).
      .google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFeatureAttributionsOrBuilder in interface AttributionOrBuilder

    • getOutputIndexList

      public List<Integer> getOutputIndexList()
       Output only. The index that locates the explained prediction output.

 If the prediction output is a scalar value, output_index is not populated.
 If the prediction output has multiple dimensions, the length of the
 output_index list is the same as the number of dimensions of the output.
 The i-th element in output_index is the element index of the i-th dimension
 of the output vector. Indices start from 0.
      repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOutputIndexList in interface AttributionOrBuilder
      Returns:
      A list containing the outputIndex.

    • getOutputIndexCount

      public int getOutputIndexCount()
       Output only. The index that locates the explained prediction output.

 If the prediction output is a scalar value, output_index is not populated.
 If the prediction output has multiple dimensions, the length of the
 output_index list is the same as the number of dimensions of the output.
 The i-th element in output_index is the element index of the i-th dimension
 of the output vector. Indices start from 0.
      repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOutputIndexCount in interface AttributionOrBuilder
      Returns:
      The count of outputIndex.

    • getOutputIndex

      public int getOutputIndex(int index)
       Output only. The index that locates the explained prediction output.

 If the prediction output is a scalar value, output_index is not populated.
 If the prediction output has multiple dimensions, the length of the
 output_index list is the same as the number of dimensions of the output.
 The i-th element in output_index is the element index of the i-th dimension
 of the output vector. Indices start from 0.
      repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOutputIndex in interface AttributionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The outputIndex at the given index.

    • setOutputIndex

      public Attribution.Builder setOutputIndex(int index, int value)
       Output only. The index that locates the explained prediction output.

 If the prediction output is a scalar value, output_index is not populated.
 If the prediction output has multiple dimensions, the length of the
 output_index list is the same as the number of dimensions of the output.
 The i-th element in output_index is the element index of the i-th dimension
 of the output vector. Indices start from 0.
      repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index to set the value at.
      value - The outputIndex to set.
      Returns:
      This builder for chaining.

    • addOutputIndex

      public Attribution.Builder addOutputIndex(int value)
       Output only. The index that locates the explained prediction output.

 If the prediction output is a scalar value, output_index is not populated.
 If the prediction output has multiple dimensions, the length of the
 output_index list is the same as the number of dimensions of the output.
 The i-th element in output_index is the element index of the i-th dimension
 of the output vector. Indices start from 0.
      repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The outputIndex to add.
      Returns:
      This builder for chaining.

    • addAllOutputIndex

      public Attribution.Builder addAllOutputIndex(Iterable<? extends Integer> values)
       Output only. The index that locates the explained prediction output.

 If the prediction output is a scalar value, output_index is not populated.
 If the prediction output has multiple dimensions, the length of the
 output_index list is the same as the number of dimensions of the output.
 The i-th element in output_index is the element index of the i-th dimension
 of the output vector. Indices start from 0.
      repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      values - The outputIndex to add.
      Returns:
      This builder for chaining.

    • clearOutputIndex

      public Attribution.Builder clearOutputIndex()
       Output only. The index that locates the explained prediction output.

 If the prediction output is a scalar value, output_index is not populated.
 If the prediction output has multiple dimensions, the length of the
 output_index list is the same as the number of dimensions of the output.
 The i-th element in output_index is the element index of the i-th dimension
 of the output vector. Indices start from 0.
      repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getOutputDisplayName

      public String getOutputDisplayName()
       Output only. The display name of the output identified by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For
 example, the predicted class name by a multi-classification Model.

 This field is only populated iff the Model predicts display names as a
 separate field along with the explained output. The predicted display name
 must has the same shape of the explained output, and can be located using
 output_index.
      string output_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOutputDisplayName in interface AttributionOrBuilder
      Returns:
      The outputDisplayName.

    • getOutputDisplayNameBytes

      public com.google.protobuf.ByteString getOutputDisplayNameBytes()
       Output only. The display name of the output identified by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For
 example, the predicted class name by a multi-classification Model.

 This field is only populated iff the Model predicts display names as a
 separate field along with the explained output. The predicted display name
 must has the same shape of the explained output, and can be located using
 output_index.
      string output_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOutputDisplayNameBytes in interface AttributionOrBuilder
      Returns:
      The bytes for outputDisplayName.

    • setOutputDisplayName

      public Attribution.Builder setOutputDisplayName(String value)
       Output only. The display name of the output identified by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For
 example, the predicted class name by a multi-classification Model.

 This field is only populated iff the Model predicts display names as a
 separate field along with the explained output. The predicted display name
 must has the same shape of the explained output, and can be located using
 output_index.
      string output_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The outputDisplayName to set.
      Returns:
      This builder for chaining.

    • clearOutputDisplayName

      public Attribution.Builder clearOutputDisplayName()
       Output only. The display name of the output identified by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For
 example, the predicted class name by a multi-classification Model.

 This field is only populated iff the Model predicts display names as a
 separate field along with the explained output. The predicted display name
 must has the same shape of the explained output, and can be located using
 output_index.
      string output_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setOutputDisplayNameBytes

      public Attribution.Builder setOutputDisplayNameBytes(com.google.protobuf.ByteString value)
       Output only. The display name of the output identified by
 [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For
 example, the predicted class name by a multi-classification Model.

 This field is only populated iff the Model predicts display names as a
 separate field along with the explained output. The predicted display name
 must has the same shape of the explained output, and can be located using
 output_index.
      string output_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for outputDisplayName to set.
      Returns:
      This builder for chaining.

    • getApproximationError

      public double getApproximationError()
       Output only. Error of
 [feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 caused by approximation used in the explanation method. Lower value means
 more precise attributions.

 * For Sampled Shapley
 [attribution][google.cloud.aiplatform.v1.ExplanationParameters.sampled_shapley_attribution],
 increasing
 [path_count][google.cloud.aiplatform.v1.SampledShapleyAttribution.path_count]
 might reduce the error.
 * For Integrated Gradients
 [attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
 increasing
 [step_count][google.cloud.aiplatform.v1.IntegratedGradientsAttribution.step_count]
 might reduce the error.
 * For [XRAI
 attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
 increasing
 [step_count][google.cloud.aiplatform.v1.XraiAttribution.step_count] might
 reduce the error.

 See [this introduction](/vertex-ai/docs/explainable-ai/overview)
 for more information.
      double approximation_error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getApproximationError in interface AttributionOrBuilder
      Returns:
      The approximationError.

    • setApproximationError

      public Attribution.Builder setApproximationError(double value)
       Output only. Error of
 [feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 caused by approximation used in the explanation method. Lower value means
 more precise attributions.

 * For Sampled Shapley
 [attribution][google.cloud.aiplatform.v1.ExplanationParameters.sampled_shapley_attribution],
 increasing
 [path_count][google.cloud.aiplatform.v1.SampledShapleyAttribution.path_count]
 might reduce the error.
 * For Integrated Gradients
 [attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
 increasing
 [step_count][google.cloud.aiplatform.v1.IntegratedGradientsAttribution.step_count]
 might reduce the error.
 * For [XRAI
 attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
 increasing
 [step_count][google.cloud.aiplatform.v1.XraiAttribution.step_count] might
 reduce the error.

 See [this introduction](/vertex-ai/docs/explainable-ai/overview)
 for more information.
      double approximation_error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The approximationError to set.
      Returns:
      This builder for chaining.

    • clearApproximationError

      public Attribution.Builder clearApproximationError()
       Output only. Error of
 [feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 caused by approximation used in the explanation method. Lower value means
 more precise attributions.

 * For Sampled Shapley
 [attribution][google.cloud.aiplatform.v1.ExplanationParameters.sampled_shapley_attribution],
 increasing
 [path_count][google.cloud.aiplatform.v1.SampledShapleyAttribution.path_count]
 might reduce the error.
 * For Integrated Gradients
 [attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
 increasing
 [step_count][google.cloud.aiplatform.v1.IntegratedGradientsAttribution.step_count]
 might reduce the error.
 * For [XRAI
 attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
 increasing
 [step_count][google.cloud.aiplatform.v1.XraiAttribution.step_count] might
 reduce the error.

 See [this introduction](/vertex-ai/docs/explainable-ai/overview)
 for more information.
      double approximation_error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getOutputName

      public String getOutputName()
       Output only. Name of the explain output. Specified as the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
      string output_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOutputName in interface AttributionOrBuilder
      Returns:
      The outputName.

    • getOutputNameBytes

      public com.google.protobuf.ByteString getOutputNameBytes()
       Output only. Name of the explain output. Specified as the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
      string output_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOutputNameBytes in interface AttributionOrBuilder
      Returns:
      The bytes for outputName.

    • setOutputName

      public Attribution.Builder setOutputName(String value)
       Output only. Name of the explain output. Specified as the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
      string output_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The outputName to set.
      Returns:
      This builder for chaining.

    • clearOutputName

      public Attribution.Builder clearOutputName()
       Output only. Name of the explain output. Specified as the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
      string output_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setOutputNameBytes

      public Attribution.Builder setOutputNameBytes(com.google.protobuf.ByteString value)
       Output only. Name of the explain output. Specified as the key in
 [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
      string output_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for outputName to set.
      Returns:
      This builder for chaining.