public static final class Explanation.Builder extends GeneratedMessageV3.Builder<Explanation.Builder> implements ExplanationOrBuilder
Explanation of a prediction (provided in
PredictResponse.predictions)
produced by the Model on a given
instance.
Protobuf type google.cloud.aiplatform.v1beta1.Explanation
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
public Explanation.Builder addAllAttributions(Iterable<? extends Attribution> values)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
values | Iterable<? extends com.google.cloud.aiplatform.v1beta1.Attribution>
|
Returns
public Explanation.Builder addAllNeighbors(Iterable<? extends Neighbor> values)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
values | Iterable<? extends com.google.cloud.aiplatform.v1beta1.Neighbor>
|
Returns
public Explanation.Builder addAttributions(Attribution value)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder addAttributions(Attribution.Builder builderForValue)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder addAttributions(int index, Attribution value)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder addAttributions(int index, Attribution.Builder builderForValue)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Attribution.Builder addAttributionsBuilder()
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Attribution.Builder addAttributionsBuilder(int index)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder addNeighbors(Neighbor value)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder addNeighbors(Neighbor.Builder builderForValue)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder addNeighbors(int index, Neighbor value)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder addNeighbors(int index, Neighbor.Builder builderForValue)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Neighbor.Builder addNeighborsBuilder()
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Neighbor.Builder addNeighborsBuilder(int index)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public Explanation build()
Returns
public Explanation buildPartial()
Returns
public Explanation.Builder clear()
Returns
Overrides
public Explanation.Builder clearAttributions()
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
public Explanation.Builder clearNeighbors()
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
public Explanation.Builder clone()
Returns
Overrides
public Attribution getAttributions(int index)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Attribution.Builder getAttributionsBuilder(int index)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<Attribution.Builder> getAttributionsBuilderList()
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getAttributionsCount()
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<Attribution> getAttributionsList()
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public AttributionOrBuilder getAttributionsOrBuilder(int index)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<? extends AttributionOrBuilder> getAttributionsOrBuilderList()
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.AttributionOrBuilder> | |
public Explanation getDefaultInstanceForType()
Returns
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
public Neighbor getNeighbors(int index)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Neighbor.Builder getNeighborsBuilder(int index)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<Neighbor.Builder> getNeighborsBuilderList()
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getNeighborsCount()
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<Neighbor> getNeighborsList()
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public NeighborOrBuilder getNeighborsOrBuilder(int index)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<? extends NeighborOrBuilder> getNeighborsOrBuilderList()
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.NeighborOrBuilder> | |
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public Explanation.Builder mergeFrom(Explanation other)
Parameter
Returns
public Explanation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
public Explanation.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
public final Explanation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
public Explanation.Builder removeAttributions(int index)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder removeNeighbors(int index)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder setAttributions(int index, Attribution value)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder setAttributions(int index, Attribution.Builder builderForValue)
Output only. Feature attributions grouped by predicted outputs.
For Models that predict only one output, such as regression Models that
predict only one score, there is only one attibution that explains the
predicted output. For Models that predict multiple outputs, such as
multiclass Models that predict multiple classes, each element explains one
specific item.
Attribution.output_index
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.aiplatform.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public Explanation.Builder setNeighbors(int index, Neighbor value)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder setNeighbors(int index, Neighbor.Builder builderForValue)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.aiplatform.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Explanation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
public final Explanation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
