Package com.google.cloud.aiplatform.v1

Class Explanation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Explanation
All Implemented Interfaces:
ExplanationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Explanation extends com.google.protobuf.GeneratedMessage 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

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

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    Attribution
    getAttributions(int index)
    Output only.
    int
    getAttributionsCount()
    Output only.
    List<Attribution>
    getAttributionsList()
    Output only.
    AttributionOrBuilder
    getAttributionsOrBuilder(int index)
    Output only.
    List<? extends AttributionOrBuilder>
    getAttributionsOrBuilderList()
    Output only.
    static Explanation
    getDefaultInstance()
     
    Explanation
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Neighbor
    getNeighbors(int index)
    Output only.
    int
    getNeighborsCount()
    Output only.
    List<Neighbor>
    getNeighborsList()
    Output only.
    NeighborOrBuilder
    getNeighborsOrBuilder(int index)
    Output only.
    List<? extends NeighborOrBuilder>
    getNeighborsOrBuilderList()
    Output only.
    com.google.protobuf.Parser<Explanation>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Explanation.Builder
    newBuilder()
     
    static Explanation.Builder
    newBuilder(Explanation prototype)
     
    Explanation.Builder
    newBuilderForType()
     
    protected Explanation.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Explanation
    parseDelimitedFrom(InputStream input)
     
    static Explanation
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Explanation
    parseFrom(byte[] data)
     
    static Explanation
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Explanation
    parseFrom(com.google.protobuf.ByteString data)
     
    static Explanation
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Explanation
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Explanation
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Explanation
    parseFrom(InputStream input)
     
    static Explanation
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Explanation
    parseFrom(ByteBuffer data)
     
    static Explanation
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Explanation>
    parser()
     
    Explanation.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • ATTRIBUTIONS_FIELD_NUMBER

      public static final int ATTRIBUTIONS_FIELD_NUMBER
      See Also:

    • NEIGHBORS_FIELD_NUMBER

      public static final int NEIGHBORS_FIELD_NUMBER
      See Also:

  • 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

    • 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.

 By default, we provide Shapley values for the predicted class. However,
 you can configure the explanation request to generate Shapley values for
 any other classes too. For example, if a model predicts a probability of
 `0.4` for approving a loan application, the model's decision is to reject
 the application since `p(reject) = 0.6 > p(approve) = 0.4`, and the default
 Shapley values would be computed for rejection decision and not approval,
 even though the latter might be the positive class.

 If users set
 [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
 the attributions are sorted by
 [instance_output_value][google.cloud.aiplatform.v1.Attribution.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.

 By default, we provide Shapley values for the predicted class. However,
 you can configure the explanation request to generate Shapley values for
 any other classes too. For example, if a model predicts a probability of
 `0.4` for approving a loan application, the model's decision is to reject
 the application since `p(reject) = 0.6 > p(approve) = 0.4`, and the default
 Shapley values would be computed for rejection decision and not approval,
 even though the latter might be the positive class.

 If users set
 [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
 the attributions are sorted by
 [instance_output_value][google.cloud.aiplatform.v1.Attribution.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.

 By default, we provide Shapley values for the predicted class. However,
 you can configure the explanation request to generate Shapley values for
 any other classes too. For example, if a model predicts a probability of
 `0.4` for approving a loan application, the model's decision is to reject
 the application since `p(reject) = 0.6 > p(approve) = 0.4`, and the default
 Shapley values would be computed for rejection decision and not approval,
 even though the latter might be the positive class.

 If users set
 [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
 the attributions are sorted by
 [instance_output_value][google.cloud.aiplatform.v1.Attribution.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.

 By default, we provide Shapley values for the predicted class. However,
 you can configure the explanation request to generate Shapley values for
 any other classes too. For example, if a model predicts a probability of
 `0.4` for approving a loan application, the model's decision is to reject
 the application since `p(reject) = 0.6 > p(approve) = 0.4`, and the default
 Shapley values would be computed for rejection decision and not approval,
 even though the latter might be the positive class.

 If users set
 [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
 the attributions are sorted by
 [instance_output_value][google.cloud.aiplatform.v1.Attribution.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.

 By default, we provide Shapley values for the predicted class. However,
 you can configure the explanation request to generate Shapley values for
 any other classes too. For example, if a model predicts a probability of
 `0.4` for approving a loan application, the model's decision is to reject
 the application since `p(reject) = 0.6 > p(approve) = 0.4`, and the default
 Shapley values would be computed for rejection decision and not approval,
 even though the latter might be the positive class.

 If users set
 [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
 the attributions are sorted by
 [instance_output_value][google.cloud.aiplatform.v1.Attribution.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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Explanation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Explanation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static Explanation.Builder newBuilder()

    • newBuilder

      public static Explanation.Builder newBuilder(Explanation prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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