com.google.cloud.vertexai.api

Class ExplanationMetadata.OutputMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.vertexai.api.ExplanationMetadata.OutputMetadata

All Implemented Interfaces:

ExplanationMetadata.OutputMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

ExplanationMetadata

public static final class ExplanationMetadata.OutputMetadata
extends com.google.protobuf.GeneratedMessageV3
implements ExplanationMetadata.OutputMetadataOrBuilder

 Metadata of the prediction output to be explained.
 

Protobuf type google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExplanationMetadata.OutputMetadata.Builder Metadata of the prediction output to be explained.
static class	ExplanationMetadata.OutputMetadata.DisplayNameMappingCase

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 and Description
static int	DISPLAY_NAME_MAPPING_KEY_FIELD_NUMBER
static int	INDEX_DISPLAY_NAME_MAPPING_FIELD_NUMBER
static int	OUTPUT_TENSOR_NAME_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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ExplanationMetadata.OutputMetadata	getDefaultInstance()
ExplanationMetadata.OutputMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ExplanationMetadata.OutputMetadata.DisplayNameMappingCase	getDisplayNameMappingCase()
String	getDisplayNameMappingKey() Specify a field name in the prediction to look for the display name.
com.google.protobuf.ByteString	getDisplayNameMappingKeyBytes() Specify a field name in the prediction to look for the display name.
com.google.protobuf.Value	getIndexDisplayNameMapping() Static mapping between the index and display name.
com.google.protobuf.ValueOrBuilder	getIndexDisplayNameMappingOrBuilder() Static mapping between the index and display name.
String	getOutputTensorName() Name of the output tensor.
com.google.protobuf.ByteString	getOutputTensorNameBytes() Name of the output tensor.
com.google.protobuf.Parser<ExplanationMetadata.OutputMetadata>	getParserForType()
int	getSerializedSize()
boolean	hasDisplayNameMappingKey() Specify a field name in the prediction to look for the display name.
int	hashCode()
boolean	hasIndexDisplayNameMapping() Static mapping between the index and display name.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ExplanationMetadata.OutputMetadata.Builder	newBuilder()
static ExplanationMetadata.OutputMetadata.Builder	newBuilder(ExplanationMetadata.OutputMetadata prototype)
ExplanationMetadata.OutputMetadata.Builder	newBuilderForType()
protected ExplanationMetadata.OutputMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExplanationMetadata.OutputMetadata	parseDelimitedFrom(InputStream input)
static ExplanationMetadata.OutputMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationMetadata.OutputMetadata	parseFrom(byte[] data)
static ExplanationMetadata.OutputMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationMetadata.OutputMetadata	parseFrom(ByteBuffer data)
static ExplanationMetadata.OutputMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationMetadata.OutputMetadata	parseFrom(com.google.protobuf.ByteString data)
static ExplanationMetadata.OutputMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationMetadata.OutputMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static ExplanationMetadata.OutputMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationMetadata.OutputMetadata	parseFrom(InputStream input)
static ExplanationMetadata.OutputMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExplanationMetadata.OutputMetadata>	parser()
ExplanationMetadata.OutputMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INDEX_DISPLAY_NAME_MAPPING_FIELD_NUMBER

public static final int INDEX_DISPLAY_NAME_MAPPING_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_MAPPING_KEY_FIELD_NUMBER

public static final int DISPLAY_NAME_MAPPING_KEY_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_TENSOR_NAME_FIELD_NUMBER

public static final int OUTPUT_TENSOR_NAME_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

getDisplayNameMappingCase

public ExplanationMetadata.OutputMetadata.DisplayNameMappingCase getDisplayNameMappingCase()

Specified by:

getDisplayNameMappingCase in interface ExplanationMetadata.OutputMetadataOrBuilder

hasIndexDisplayNameMapping

public boolean hasIndexDisplayNameMapping()

 Static mapping between the index and display name.

 Use this if the outputs are a deterministic n-dimensional array, e.g. a
 list of scores of all the classes in a pre-defined order for a
 multi-classification Model. It's not feasible if the outputs are
 non-deterministic, e.g. the Model produces top-k classes or sort the
 outputs by their values.

 The shape of the value must be an n-dimensional array of strings. The
 number of dimensions must match that of the outputs to be explained.
 The
 [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]
 is populated by locating in the mapping with
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index].
 

.google.protobuf.Value index_display_name_mapping = 1;

Specified by:

hasIndexDisplayNameMapping in interface ExplanationMetadata.OutputMetadataOrBuilder

Returns:

Whether the indexDisplayNameMapping field is set.

getIndexDisplayNameMapping

public com.google.protobuf.Value getIndexDisplayNameMapping()

 Static mapping between the index and display name.

 Use this if the outputs are a deterministic n-dimensional array, e.g. a
 list of scores of all the classes in a pre-defined order for a
 multi-classification Model. It's not feasible if the outputs are
 non-deterministic, e.g. the Model produces top-k classes or sort the
 outputs by their values.

 The shape of the value must be an n-dimensional array of strings. The
 number of dimensions must match that of the outputs to be explained.
 The
 [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]
 is populated by locating in the mapping with
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index].
 

.google.protobuf.Value index_display_name_mapping = 1;

Specified by:

getIndexDisplayNameMapping in interface ExplanationMetadata.OutputMetadataOrBuilder

Returns:

The indexDisplayNameMapping.

getIndexDisplayNameMappingOrBuilder

public com.google.protobuf.ValueOrBuilder getIndexDisplayNameMappingOrBuilder()

 Static mapping between the index and display name.

 Use this if the outputs are a deterministic n-dimensional array, e.g. a
 list of scores of all the classes in a pre-defined order for a
 multi-classification Model. It's not feasible if the outputs are
 non-deterministic, e.g. the Model produces top-k classes or sort the
 outputs by their values.

 The shape of the value must be an n-dimensional array of strings. The
 number of dimensions must match that of the outputs to be explained.
 The
 [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]
 is populated by locating in the mapping with
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index].
 

.google.protobuf.Value index_display_name_mapping = 1;

Specified by:

getIndexDisplayNameMappingOrBuilder in interface ExplanationMetadata.OutputMetadataOrBuilder

hasDisplayNameMappingKey

public boolean hasDisplayNameMappingKey()

 Specify a field name in the prediction to look for the display name.

 Use this if the prediction contains the display names for the outputs.

 The display names in the prediction must have the same shape of the
 outputs, so that it can be located by
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 for a specific output.
 

string display_name_mapping_key = 2;

Specified by:

hasDisplayNameMappingKey in interface ExplanationMetadata.OutputMetadataOrBuilder

Returns:

Whether the displayNameMappingKey field is set.

getDisplayNameMappingKey

public String getDisplayNameMappingKey()

 Specify a field name in the prediction to look for the display name.

 Use this if the prediction contains the display names for the outputs.

 The display names in the prediction must have the same shape of the
 outputs, so that it can be located by
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 for a specific output.
 

string display_name_mapping_key = 2;

Specified by:

getDisplayNameMappingKey in interface ExplanationMetadata.OutputMetadataOrBuilder

Returns:

The displayNameMappingKey.

getDisplayNameMappingKeyBytes

public com.google.protobuf.ByteString getDisplayNameMappingKeyBytes()

 Specify a field name in the prediction to look for the display name.

 Use this if the prediction contains the display names for the outputs.

 The display names in the prediction must have the same shape of the
 outputs, so that it can be located by
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 for a specific output.
 

string display_name_mapping_key = 2;

Specified by:

getDisplayNameMappingKeyBytes in interface ExplanationMetadata.OutputMetadataOrBuilder

Returns:

The bytes for displayNameMappingKey.

getOutputTensorName

public String getOutputTensorName()

 Name of the output tensor. Required and is only applicable to Vertex
 AI provided images for Tensorflow.
 

string output_tensor_name = 3;

Specified by:

getOutputTensorName in interface ExplanationMetadata.OutputMetadataOrBuilder

Returns:

The outputTensorName.

getOutputTensorNameBytes

public com.google.protobuf.ByteString getOutputTensorNameBytes()

 Name of the output tensor. Required and is only applicable to Vertex
 AI provided images for Tensorflow.
 

string output_tensor_name = 3;

Specified by:

getOutputTensorNameBytes in interface ExplanationMetadata.OutputMetadataOrBuilder

Returns:

The bytes for outputTensorName.

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.OutputMetadata parseFrom(ByteBuffer data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExplanationMetadata.OutputMetadata parseFrom(com.google.protobuf.ByteString data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExplanationMetadata.OutputMetadata 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.OutputMetadata parseFrom(byte[] data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExplanationMetadata.OutputMetadata parseFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static ExplanationMetadata.OutputMetadata parseFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExplanationMetadata.OutputMetadata parseDelimitedFrom(InputStream input)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExplanationMetadata.OutputMetadata parseDelimitedFrom(InputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseFrom

public static ExplanationMetadata.OutputMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ExplanationMetadata.OutputMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ExplanationMetadata.OutputMetadata.Builder newBuilder()

newBuilder

public static ExplanationMetadata.OutputMetadata.Builder newBuilder(ExplanationMetadata.OutputMetadata prototype)

toBuilder

public ExplanationMetadata.OutputMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ExplanationMetadata.OutputMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ExplanationMetadata.OutputMetadata getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ExplanationMetadata.OutputMetadata> 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.OutputMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder