Package com.google.cloud.aiplatform.v1

Class Explanation

  • All Implemented Interfaces:
    ExplanationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Explanation
extends com.google.protobuf.GeneratedMessageV3
implements ExplanationOrBuilder
     Explanation of a prediction (provided in
 [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions])
 produced by the Model on a given
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
    Protobuf type google.cloud.aiplatform.v1.Explanation
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Explanation.Builder
      Explanation of a prediction (provided in [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions]) produced by the Model on a given [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ATTRIBUTIONS_FIELD_NUMBER  
      static int NEIGHBORS_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • ATTRIBUTIONS_FIELD_NUMBER

        public static final int ATTRIBUTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getAttributionsList

        public List<Attribution> getAttributionsList()
         Output only. Feature attributions grouped by predicted outputs.

 For Models that predict only one output, such as regression Models that
 predict only one score, there is only one attibution that explains the
 predicted output. For Models that predict multiple outputs, such as
 multiclass Models that predict multiple classes, each element explains one
 specific item.
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 can be used to identify which output this attribution is explaining.

 If users set
 [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
 the attributions are sorted by
 [instance_output_value][Attributions.instance_output_value] in descending
 order. If
 [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices]
 is specified, the attributions are stored by
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 in the same order as they appear in the output_indices.
        repeated .google.cloud.aiplatform.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributionsList in interface ExplanationOrBuilder

      • getAttributionsOrBuilderList

        public List<? extends AttributionOrBuilder> getAttributionsOrBuilderList()
         Output only. Feature attributions grouped by predicted outputs.

 For Models that predict only one output, such as regression Models that
 predict only one score, there is only one attibution that explains the
 predicted output. For Models that predict multiple outputs, such as
 multiclass Models that predict multiple classes, each element explains one
 specific item.
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 can be used to identify which output this attribution is explaining.

 If users set
 [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
 the attributions are sorted by
 [instance_output_value][Attributions.instance_output_value] in descending
 order. If
 [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices]
 is specified, the attributions are stored by
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 in the same order as they appear in the output_indices.
        repeated .google.cloud.aiplatform.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributionsOrBuilderList in interface ExplanationOrBuilder

      • getAttributionsCount

        public int getAttributionsCount()
         Output only. Feature attributions grouped by predicted outputs.

 For Models that predict only one output, such as regression Models that
 predict only one score, there is only one attibution that explains the
 predicted output. For Models that predict multiple outputs, such as
 multiclass Models that predict multiple classes, each element explains one
 specific item.
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 can be used to identify which output this attribution is explaining.

 If users set
 [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
 the attributions are sorted by
 [instance_output_value][Attributions.instance_output_value] in descending
 order. If
 [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices]
 is specified, the attributions are stored by
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 in the same order as they appear in the output_indices.
        repeated .google.cloud.aiplatform.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributionsCount in interface ExplanationOrBuilder

      • getAttributions

        public Attribution getAttributions​(int index)
         Output only. Feature attributions grouped by predicted outputs.

 For Models that predict only one output, such as regression Models that
 predict only one score, there is only one attibution that explains the
 predicted output. For Models that predict multiple outputs, such as
 multiclass Models that predict multiple classes, each element explains one
 specific item.
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 can be used to identify which output this attribution is explaining.

 If users set
 [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
 the attributions are sorted by
 [instance_output_value][Attributions.instance_output_value] in descending
 order. If
 [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices]
 is specified, the attributions are stored by
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 in the same order as they appear in the output_indices.
        repeated .google.cloud.aiplatform.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributions in interface ExplanationOrBuilder

      • getAttributionsOrBuilder

        public AttributionOrBuilder getAttributionsOrBuilder​(int index)
         Output only. Feature attributions grouped by predicted outputs.

 For Models that predict only one output, such as regression Models that
 predict only one score, there is only one attibution that explains the
 predicted output. For Models that predict multiple outputs, such as
 multiclass Models that predict multiple classes, each element explains one
 specific item.
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 can be used to identify which output this attribution is explaining.

 If users set
 [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
 the attributions are sorted by
 [instance_output_value][Attributions.instance_output_value] in descending
 order. If
 [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices]
 is specified, the attributions are stored by
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 in the same order as they appear in the output_indices.
        repeated .google.cloud.aiplatform.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributionsOrBuilder in interface ExplanationOrBuilder

      • getNeighborsList

        public List<Neighbor> getNeighborsList()
         Output only. List of the nearest neighbors for example-based explanations.

 For models deployed with the examples explanations feature enabled, the
 attributions field is empty and instead the neighbors field is populated.
        repeated .google.cloud.aiplatform.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNeighborsList in interface ExplanationOrBuilder

      • getNeighborsOrBuilderList

        public List<? extends NeighborOrBuilder> getNeighborsOrBuilderList()
         Output only. List of the nearest neighbors for example-based explanations.

 For models deployed with the examples explanations feature enabled, the
 attributions field is empty and instead the neighbors field is populated.
        repeated .google.cloud.aiplatform.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNeighborsOrBuilderList in interface ExplanationOrBuilder

      • getNeighborsCount

        public int getNeighborsCount()
         Output only. List of the nearest neighbors for example-based explanations.

 For models deployed with the examples explanations feature enabled, the
 attributions field is empty and instead the neighbors field is populated.
        repeated .google.cloud.aiplatform.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNeighborsCount in interface ExplanationOrBuilder

      • getNeighbors

        public Neighbor getNeighbors​(int index)
         Output only. List of the nearest neighbors for example-based explanations.

 For models deployed with the examples explanations feature enabled, the
 attributions field is empty and instead the neighbors field is populated.
        repeated .google.cloud.aiplatform.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNeighbors in interface ExplanationOrBuilder

      • getNeighborsOrBuilder

        public NeighborOrBuilder getNeighborsOrBuilder​(int index)
         Output only. List of the nearest neighbors for example-based explanations.

 For models deployed with the examples explanations feature enabled, the
 attributions field is empty and instead the neighbors field is populated.
        repeated .google.cloud.aiplatform.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNeighborsOrBuilder in interface ExplanationOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Explanation parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Explanation parseFrom​(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Explanation parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Explanation parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Explanation parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Explanation parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Explanation parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Explanation.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Explanation.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Explanation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Explanation getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Explanation> parser()

      • getParserForType

        public com.google.protobuf.Parser<Explanation> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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