Package com.google.cloud.aiplatform.v1

Class ExplanationMetadata

  • All Implemented Interfaces:
    ExplanationMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ExplanationMetadata
extends com.google.protobuf.GeneratedMessageV3
implements ExplanationMetadataOrBuilder
     Metadata describing the Model's input and output for explanation.
    Protobuf type google.cloud.aiplatform.v1.ExplanationMetadata
    See Also:
    Serialized Form

    • Field Detail

      • FEATURE_ATTRIBUTIONS_SCHEMA_URI_FIELD_NUMBER

        public static final int FEATURE_ATTRIBUTIONS_SCHEMA_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LATENT_SPACE_SOURCE_FIELD_NUMBER

        public static final int LATENT_SPACE_SOURCE_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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getInputsCount

        public int getInputsCount()
        Description copied from interface: ExplanationMetadataOrBuilder
         Required. Map from feature names to feature input metadata. Keys are the
 name of the features. Values are the specification of the feature.

 An empty InputMetadata is valid. It describes a text feature which has the
 name specified as the key in
 [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
 The baseline of the empty feature is chosen by Vertex AI.

 For Vertex AI-provided Tensorflow images, the key can be any friendly
 name of the feature. Once specified,
 [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 are keyed by this key (if not grouped with another feature).

 For custom images, the key must match with the key in
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
        map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputsCount in interface ExplanationMetadataOrBuilder

      • containsInputs

        public boolean containsInputs​(String key)
         Required. Map from feature names to feature input metadata. Keys are the
 name of the features. Values are the specification of the feature.

 An empty InputMetadata is valid. It describes a text feature which has the
 name specified as the key in
 [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
 The baseline of the empty feature is chosen by Vertex AI.

 For Vertex AI-provided Tensorflow images, the key can be any friendly
 name of the feature. Once specified,
 [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 are keyed by this key (if not grouped with another feature).

 For custom images, the key must match with the key in
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
        map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        containsInputs in interface ExplanationMetadataOrBuilder

      • getInputsMap

        public Map<String,​ExplanationMetadata.InputMetadata> getInputsMap()
         Required. Map from feature names to feature input metadata. Keys are the
 name of the features. Values are the specification of the feature.

 An empty InputMetadata is valid. It describes a text feature which has the
 name specified as the key in
 [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
 The baseline of the empty feature is chosen by Vertex AI.

 For Vertex AI-provided Tensorflow images, the key can be any friendly
 name of the feature. Once specified,
 [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 are keyed by this key (if not grouped with another feature).

 For custom images, the key must match with the key in
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
        map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputsMap in interface ExplanationMetadataOrBuilder

      • getInputsOrDefault

        public ExplanationMetadata.InputMetadata getInputsOrDefault​(String key,
                                                            ExplanationMetadata.InputMetadata defaultValue)
         Required. Map from feature names to feature input metadata. Keys are the
 name of the features. Values are the specification of the feature.

 An empty InputMetadata is valid. It describes a text feature which has the
 name specified as the key in
 [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
 The baseline of the empty feature is chosen by Vertex AI.

 For Vertex AI-provided Tensorflow images, the key can be any friendly
 name of the feature. Once specified,
 [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 are keyed by this key (if not grouped with another feature).

 For custom images, the key must match with the key in
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
        map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputsOrDefault in interface ExplanationMetadataOrBuilder

      • getInputsOrThrow

        public ExplanationMetadata.InputMetadata getInputsOrThrow​(String key)
         Required. Map from feature names to feature input metadata. Keys are the
 name of the features. Values are the specification of the feature.

 An empty InputMetadata is valid. It describes a text feature which has the
 name specified as the key in
 [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
 The baseline of the empty feature is chosen by Vertex AI.

 For Vertex AI-provided Tensorflow images, the key can be any friendly
 name of the feature. Once specified,
 [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 are keyed by this key (if not grouped with another feature).

 For custom images, the key must match with the key in
 [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
        map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputsOrThrow in interface ExplanationMetadataOrBuilder

      • getOutputsCount

        public int getOutputsCount()
        Description copied from interface: ExplanationMetadataOrBuilder
         Required. Map from output names to output metadata.

 For Vertex AI-provided Tensorflow images, keys can be any user defined
 string that consists of any UTF-8 characters.

 For custom images, keys are the name of the output field in the prediction
 to be explained.

 Currently only one key is allowed.
        map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOutputsCount in interface ExplanationMetadataOrBuilder

      • containsOutputs

        public boolean containsOutputs​(String key)
         Required. Map from output names to output metadata.

 For Vertex AI-provided Tensorflow images, keys can be any user defined
 string that consists of any UTF-8 characters.

 For custom images, keys are the name of the output field in the prediction
 to be explained.

 Currently only one key is allowed.
        map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        containsOutputs in interface ExplanationMetadataOrBuilder

      • getOutputsMap

        public Map<String,​ExplanationMetadata.OutputMetadata> getOutputsMap()
         Required. Map from output names to output metadata.

 For Vertex AI-provided Tensorflow images, keys can be any user defined
 string that consists of any UTF-8 characters.

 For custom images, keys are the name of the output field in the prediction
 to be explained.

 Currently only one key is allowed.
        map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOutputsMap in interface ExplanationMetadataOrBuilder

      • getOutputsOrDefault

        public ExplanationMetadata.OutputMetadata getOutputsOrDefault​(String key,
                                                              ExplanationMetadata.OutputMetadata defaultValue)
         Required. Map from output names to output metadata.

 For Vertex AI-provided Tensorflow images, keys can be any user defined
 string that consists of any UTF-8 characters.

 For custom images, keys are the name of the output field in the prediction
 to be explained.

 Currently only one key is allowed.
        map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOutputsOrDefault in interface ExplanationMetadataOrBuilder

      • getOutputsOrThrow

        public ExplanationMetadata.OutputMetadata getOutputsOrThrow​(String key)
         Required. Map from output names to output metadata.

 For Vertex AI-provided Tensorflow images, keys can be any user defined
 string that consists of any UTF-8 characters.

 For custom images, keys are the name of the output field in the prediction
 to be explained.

 Currently only one key is allowed.
        map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOutputsOrThrow in interface ExplanationMetadataOrBuilder

      • getFeatureAttributionsSchemaUri

        public String getFeatureAttributionsSchemaUri()
         Points to a YAML file stored on Google Cloud Storage describing the format
 of the [feature
 attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
 The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 AutoML tabular Models always have this field populated by Vertex AI.
 Note: The URI given on output may be different, including the URI scheme,
 than the one given on input. The output URI will point to a location where
 the user only has a read access.
        string feature_attributions_schema_uri = 3;
        Specified by:
        getFeatureAttributionsSchemaUri in interface ExplanationMetadataOrBuilder
        Returns:
        The featureAttributionsSchemaUri.

      • getFeatureAttributionsSchemaUriBytes

        public com.google.protobuf.ByteString getFeatureAttributionsSchemaUriBytes()
         Points to a YAML file stored on Google Cloud Storage describing the format
 of the [feature
 attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
 The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 AutoML tabular Models always have this field populated by Vertex AI.
 Note: The URI given on output may be different, including the URI scheme,
 than the one given on input. The output URI will point to a location where
 the user only has a read access.
        string feature_attributions_schema_uri = 3;
        Specified by:
        getFeatureAttributionsSchemaUriBytes in interface ExplanationMetadataOrBuilder
        Returns:
        The bytes for featureAttributionsSchemaUri.

      • getLatentSpaceSource

        public String getLatentSpaceSource()
         Name of the source to generate embeddings for example based explanations.
        string latent_space_source = 5;
        Specified by:
        getLatentSpaceSource in interface ExplanationMetadataOrBuilder
        Returns:
        The latentSpaceSource.

      • getLatentSpaceSourceBytes

        public com.google.protobuf.ByteString getLatentSpaceSourceBytes()
         Name of the source to generate embeddings for example based explanations.
        string latent_space_source = 5;
        Specified by:
        getLatentSpaceSourceBytes in interface ExplanationMetadataOrBuilder
        Returns:
        The bytes for latentSpaceSource.

      • 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 ExplanationMetadata parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ExplanationMetadata> 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 ExplanationMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder