Class ExplanationMetadata (3.10.0)

public final class ExplanationMetadata extends GeneratedMessageV3 implements ExplanationMetadataOrBuilder

Metadata describing the Model's input and output for explanation.

Protobuf type google.cloud.aiplatform.v1.ExplanationMetadata

Static Fields

FEATURE_ATTRIBUTIONS_SCHEMA_URI_FIELD_NUMBER

public static final int FEATURE_ATTRIBUTIONS_SCHEMA_URI_FIELD_NUMBER
Field Value
TypeDescription
int

INPUTS_FIELD_NUMBER

public static final int INPUTS_FIELD_NUMBER
Field Value
TypeDescription
int

LATENT_SPACE_SOURCE_FIELD_NUMBER

public static final int LATENT_SPACE_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUTS_FIELD_NUMBER

public static final int OUTPUTS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExplanationMetadata getDefaultInstance()
Returns
TypeDescription
ExplanationMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExplanationMetadata.Builder newBuilder()
Returns
TypeDescription
ExplanationMetadata.Builder

newBuilder(ExplanationMetadata prototype)

public static ExplanationMetadata.Builder newBuilder(ExplanationMetadata prototype)
Parameter
NameDescription
prototypeExplanationMetadata
Returns
TypeDescription
ExplanationMetadata.Builder

parseDelimitedFrom(InputStream input)

public static ExplanationMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExplanationMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplanationMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplanationMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExplanationMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExplanationMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplanationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExplanationMetadata> parser()
Returns
TypeDescription
Parser<ExplanationMetadata>

Methods

containsInputs(String key)

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. 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 are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.

map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsOutputs(String key)

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];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ExplanationMetadata getDefaultInstanceForType()
Returns
TypeDescription
ExplanationMetadata

getFeatureAttributionsSchemaUri()

public String getFeatureAttributionsSchemaUri()

Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 Schema Object. 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;

Returns
TypeDescription
String

The featureAttributionsSchemaUri.

getFeatureAttributionsSchemaUriBytes()

public ByteString getFeatureAttributionsSchemaUriBytes()

Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 Schema Object. 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;

Returns
TypeDescription
ByteString

The bytes for featureAttributionsSchemaUri.

getInputs()

public Map<String,ExplanationMetadata.InputMetadata> getInputs()

Use #getInputsMap() instead.

Returns
TypeDescription
Map<String,InputMetadata>

getInputsCount()

public int getInputsCount()

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. 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 are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.

map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

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. 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 are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.

map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Map<String,InputMetadata>

getInputsOrDefault(String key, ExplanationMetadata.InputMetadata defaultValue)

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. 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 are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.

map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
keyString
defaultValueExplanationMetadata.InputMetadata
Returns
TypeDescription
ExplanationMetadata.InputMetadata

getInputsOrThrow(String key)

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. 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 are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.

map<string, .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
keyString
Returns
TypeDescription
ExplanationMetadata.InputMetadata

getLatentSpaceSource()

public String getLatentSpaceSource()

Name of the source to generate embeddings for example based explanations.

string latent_space_source = 5;

Returns
TypeDescription
String

The latentSpaceSource.

getLatentSpaceSourceBytes()

public ByteString getLatentSpaceSourceBytes()

Name of the source to generate embeddings for example based explanations.

string latent_space_source = 5;

Returns
TypeDescription
ByteString

The bytes for latentSpaceSource.

getOutputs()

public Map<String,ExplanationMetadata.OutputMetadata> getOutputs()

Use #getOutputsMap() instead.

Returns
TypeDescription
Map<String,OutputMetadata>

getOutputsCount()

public int getOutputsCount()

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];

Returns
TypeDescription
int

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];

Returns
TypeDescription
Map<String,OutputMetadata>

getOutputsOrDefault(String key, ExplanationMetadata.OutputMetadata defaultValue)

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];

Parameters
NameDescription
keyString
defaultValueExplanationMetadata.OutputMetadata
Returns
TypeDescription
ExplanationMetadata.OutputMetadata

getOutputsOrThrow(String key)

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];

Parameter
NameDescription
keyString
Returns
TypeDescription
ExplanationMetadata.OutputMetadata

getParserForType()

public Parser<ExplanationMetadata> getParserForType()
Returns
TypeDescription
Parser<ExplanationMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExplanationMetadata.Builder newBuilderForType()
Returns
TypeDescription
ExplanationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplanationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExplanationMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExplanationMetadata.Builder toBuilder()
Returns
TypeDescription
ExplanationMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException