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.
↳ display_name_mapping_key
string
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.
↳ output_tensor_name
string
Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
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.
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.
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.
Returns
Type
Description
string
hasDisplayNameMappingKey
setDisplayNameMappingKey
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOutputTensorName
Name of the output tensor. Required and is only applicable to Vertex
AI provided images for Tensorflow.
Returns
Type
Description
string
setOutputTensorName
Name of the output tensor. Required and is only applicable to Vertex
AI provided images for Tensorflow.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class OutputMetadata (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.ExplanationMetadata.OutputMetadata)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.ExplanationMetadata.OutputMetadata)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.ExplanationMetadata.OutputMetadata)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.ExplanationMetadata.OutputMetadata)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.ExplanationMetadata.OutputMetadata)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.ExplanationMetadata.OutputMetadata)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.ExplanationMetadata.OutputMetadata)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.ExplanationMetadata.OutputMetadata)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.ExplanationMetadata.OutputMetadata) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class OutputMetadata.\n\nMetadata of the prediction output to be explained.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.ExplanationMetadata.OutputMetadata`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1 \\\\ ExplanationMetadata\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getIndexDisplayNameMapping\n\nStatic mapping between the index and display name.\n\nUse this if the outputs are a deterministic n-dimensional array, e.g. a\nlist of scores of all the classes in a pre-defined order for a\nmulti-classification Model. It's not feasible if the outputs are\nnon-deterministic, e.g. the Model produces top-k classes or sort the\noutputs by their values.\nThe shape of the value must be an n-dimensional array of strings. The\nnumber of dimensions must match that of the outputs to be explained.\nThe\n[Attribution.output_display_name](/php/docs/reference/cloud-ai-platform/latest/V1.Attribution#_Google_Cloud_AIPlatform_V1_Attribution__getOutputDisplayName__)\nis populated by locating in the mapping with\n[Attribution.output_index](/php/docs/reference/cloud-ai-platform/latest/V1.Attribution#_Google_Cloud_AIPlatform_V1_Attribution__getOutputIndex__).\n\n### hasIndexDisplayNameMapping\n\n### setIndexDisplayNameMapping\n\nStatic mapping between the index and display name.\n\nUse this if the outputs are a deterministic n-dimensional array, e.g. a\nlist of scores of all the classes in a pre-defined order for a\nmulti-classification Model. It's not feasible if the outputs are\nnon-deterministic, e.g. the Model produces top-k classes or sort the\noutputs by their values.\nThe shape of the value must be an n-dimensional array of strings. The\nnumber of dimensions must match that of the outputs to be explained.\nThe\n[Attribution.output_display_name](/php/docs/reference/cloud-ai-platform/latest/V1.Attribution#_Google_Cloud_AIPlatform_V1_Attribution__getOutputDisplayName__)\nis populated by locating in the mapping with\n[Attribution.output_index](/php/docs/reference/cloud-ai-platform/latest/V1.Attribution#_Google_Cloud_AIPlatform_V1_Attribution__getOutputIndex__).\n\n### getDisplayNameMappingKey\n\nSpecify a field name in the prediction to look for the display name.\n\nUse this if the prediction contains the display names for the outputs.\nThe display names in the prediction must have the same shape of the\noutputs, so that it can be located by\n[Attribution.output_index](/php/docs/reference/cloud-ai-platform/latest/V1.Attribution#_Google_Cloud_AIPlatform_V1_Attribution__getOutputIndex__)\nfor a specific output.\n\n### hasDisplayNameMappingKey\n\n### setDisplayNameMappingKey\n\nSpecify a field name in the prediction to look for the display name.\n\nUse this if the prediction contains the display names for the outputs.\nThe display names in the prediction must have the same shape of the\noutputs, so that it can be located by\n[Attribution.output_index](/php/docs/reference/cloud-ai-platform/latest/V1.Attribution#_Google_Cloud_AIPlatform_V1_Attribution__getOutputIndex__)\nfor a specific output.\n\n### getOutputTensorName\n\nName of the output tensor. Required and is only applicable to Vertex\nAI provided images for Tensorflow.\n\n### setOutputTensorName\n\nName of the output tensor. Required and is only applicable to Vertex\nAI provided images for Tensorflow.\n\n### getDisplayNameMapping"]]