public static final class ExplanationMetadata.OutputMetadata extends GeneratedMessageV3 implements ExplanationMetadata.OutputMetadataOrBuilder
Metadata of the prediction output to be explained.
Protobuf type google.cloud.vertexai.v1beta1.ExplanationMetadata.OutputMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DISPLAY_NAME_MAPPING_KEY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INDEX_DISPLAY_NAME_MAPPING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int OUTPUT_TENSOR_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ExplanationMetadata.OutputMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ExplanationMetadata.OutputMetadata.Builder newBuilder()
public static ExplanationMetadata.OutputMetadata.Builder newBuilder(ExplanationMetadata.OutputMetadata prototype)
public static ExplanationMetadata.OutputMetadata parseDelimitedFrom(InputStream input)
public static ExplanationMetadata.OutputMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExplanationMetadata.OutputMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ExplanationMetadata.OutputMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExplanationMetadata.OutputMetadata parseFrom(ByteString data)
public static ExplanationMetadata.OutputMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExplanationMetadata.OutputMetadata parseFrom(CodedInputStream input)
public static ExplanationMetadata.OutputMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExplanationMetadata.OutputMetadata parseFrom(InputStream input)
public static ExplanationMetadata.OutputMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExplanationMetadata.OutputMetadata parseFrom(ByteBuffer data)
public static ExplanationMetadata.OutputMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ExplanationMetadata.OutputMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public ExplanationMetadata.OutputMetadata getDefaultInstanceForType()
public ExplanationMetadata.OutputMetadata.DisplayNameMappingCase getDisplayNameMappingCase()
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.
|
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.
|
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.
|
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;
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.
|
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.
|
public Parser<ExplanationMetadata.OutputMetadata> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ExplanationMetadata.OutputMetadata.Builder newBuilderForType()
protected ExplanationMetadata.OutputMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ExplanationMetadata.OutputMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
