Class ExplanationMetadata.OutputMetadata (3.42.0)

public static final class ExplanationMetadata.OutputMetadata extends GeneratedMessageV3 implements ExplanationMetadata.OutputMetadataOrBuilder

Metadata of the prediction output to be explained.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExplanationMetadata.OutputMetadata

Static Fields

DISPLAY_NAME_MAPPING_KEY_FIELD_NUMBER

public static final int DISPLAY_NAME_MAPPING_KEY_FIELD_NUMBER
Field Value
Type Description
int

INDEX_DISPLAY_NAME_MAPPING_FIELD_NUMBER

public static final int INDEX_DISPLAY_NAME_MAPPING_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_TENSOR_NAME_FIELD_NUMBER

public static final int OUTPUT_TENSOR_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExplanationMetadata.OutputMetadata getDefaultInstance()
Returns
Type Description
ExplanationMetadata.OutputMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExplanationMetadata.OutputMetadata.Builder newBuilder()
Returns
Type Description
ExplanationMetadata.OutputMetadata.Builder

newBuilder(ExplanationMetadata.OutputMetadata prototype)

public static ExplanationMetadata.OutputMetadata.Builder newBuilder(ExplanationMetadata.OutputMetadata prototype)
Parameter
Name Description
prototype ExplanationMetadata.OutputMetadata
Returns
Type Description
ExplanationMetadata.OutputMetadata.Builder

parseDelimitedFrom(InputStream input)

public static ExplanationMetadata.OutputMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.OutputMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExplanationMetadata.OutputMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.OutputMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplanationMetadata.OutputMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.OutputMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplanationMetadata.OutputMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.OutputMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExplanationMetadata.OutputMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.OutputMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExplanationMetadata.OutputMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.OutputMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.OutputMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExplanationMetadata.OutputMetadata> parser()
Returns
Type Description
Parser<OutputMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ExplanationMetadata.OutputMetadata getDefaultInstanceForType()
Returns
Type Description
ExplanationMetadata.OutputMetadata

getDisplayNameMappingCase()

public ExplanationMetadata.OutputMetadata.DisplayNameMappingCase getDisplayNameMappingCase()
Returns
Type Description
ExplanationMetadata.OutputMetadata.DisplayNameMappingCase

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 for a specific output.

string display_name_mapping_key = 2;

Returns
Type Description
String

The displayNameMappingKey.

getDisplayNameMappingKeyBytes()

public 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 for a specific output.

string display_name_mapping_key = 2;

Returns
Type Description
ByteString

The bytes for displayNameMappingKey.

getIndexDisplayNameMapping()

public 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 is populated by locating in the mapping with Attribution.output_index.

.google.protobuf.Value index_display_name_mapping = 1;

Returns
Type Description
Value

The indexDisplayNameMapping.

getIndexDisplayNameMappingOrBuilder()

public 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 is populated by locating in the mapping with Attribution.output_index.

.google.protobuf.Value index_display_name_mapping = 1;

Returns
Type Description
ValueOrBuilder

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;

Returns
Type Description
String

The outputTensorName.

getOutputTensorNameBytes()

public ByteString getOutputTensorNameBytes()

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

string output_tensor_name = 3;

Returns
Type Description
ByteString

The bytes for outputTensorName.

getParserForType()

public Parser<ExplanationMetadata.OutputMetadata> getParserForType()
Returns
Type Description
Parser<OutputMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 for a specific output.

string display_name_mapping_key = 2;

Returns
Type Description
boolean

Whether the displayNameMappingKey field is set.

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 is populated by locating in the mapping with Attribution.output_index.

.google.protobuf.Value index_display_name_mapping = 1;

Returns
Type Description
boolean

Whether the indexDisplayNameMapping field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExplanationMetadata.OutputMetadata.Builder newBuilderForType()
Returns
Type Description
ExplanationMetadata.OutputMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplanationMetadata.OutputMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExplanationMetadata.OutputMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExplanationMetadata.OutputMetadata.Builder toBuilder()
Returns
Type Description
ExplanationMetadata.OutputMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException