Package com.google.cloud.aiplatform.v1

Interface ExplanationMetadata.OutputMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExplanationMetadata.OutputMetadata, ExplanationMetadata.OutputMetadata.Builder
Enclosing class:
ExplanationMetadata
public static interface ExplanationMetadata.OutputMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasIndexDisplayNameMapping

      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;
      Returns:
      Whether the indexDisplayNameMapping field is set.

    • getIndexDisplayNameMapping

      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;
      Returns:
      The indexDisplayNameMapping.

    • getIndexDisplayNameMappingOrBuilder

      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;

    • hasDisplayNameMappingKey

      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;
      Returns:
      Whether the displayNameMappingKey field is set.

    • getDisplayNameMappingKey

      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;
      Returns:
      The displayNameMappingKey.

    • getDisplayNameMappingKeyBytes

      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;
      Returns:
      The bytes for displayNameMappingKey.

    • getOutputTensorName

      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:
      The outputTensorName.

    • getOutputTensorNameBytes

      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;
      Returns:
      The bytes for outputTensorName.

    • getDisplayNameMappingCase

      ExplanationMetadata.OutputMetadata.DisplayNameMappingCase getDisplayNameMappingCase()