Class ExplainRequest.Builder (3.32.0) 

public static final class ExplainRequest.Builder extends GeneratedMessageV3.Builder<ExplainRequest.Builder> implements ExplainRequestOrBuilder

Request message for PredictionService.Explain.

Protobuf type google.cloud.aiplatform.v1beta1.ExplainRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExplainRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllInstances(Iterable<? extends Value> values)

public ExplainRequest.Builder addAllInstances(Iterable<? extends Value> values)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuesIterable<? extends com.google.protobuf.Value>
Returns
TypeDescription
ExplainRequest.Builder

addInstances(Value value)

public ExplainRequest.Builder addInstances(Value value)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueValue
Returns
TypeDescription
ExplainRequest.Builder

addInstances(Value.Builder builderForValue)

public ExplainRequest.Builder addInstances(Value.Builder builderForValue)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ExplainRequest.Builder

addInstances(int index, Value value)

public ExplainRequest.Builder addInstances(int index, Value value)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
valueValue
Returns
TypeDescription
ExplainRequest.Builder

addInstances(int index, Value.Builder builderForValue)

public ExplainRequest.Builder addInstances(int index, Value.Builder builderForValue)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
builderForValueBuilder
Returns
TypeDescription
ExplainRequest.Builder

addInstancesBuilder()

public Value.Builder addInstancesBuilder()

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Builder

addInstancesBuilder(int index)

public Value.Builder addInstancesBuilder(int index)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExplainRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExplainRequest.Builder
Overrides

build()

public ExplainRequest build()
Returns
TypeDescription
ExplainRequest

buildPartial()

public ExplainRequest buildPartial()
Returns
TypeDescription
ExplainRequest

clear()

public ExplainRequest.Builder clear()
Returns
TypeDescription
ExplainRequest.Builder
Overrides

clearConcurrentExplanationSpecOverride()

public ExplainRequest.Builder clearConcurrentExplanationSpecOverride()
Returns
TypeDescription
ExplainRequest.Builder

clearDeployedModelId()

public ExplainRequest.Builder clearDeployedModelId()

If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.

string deployed_model_id = 3;

Returns
TypeDescription
ExplainRequest.Builder

This builder for chaining.

clearEndpoint()

public ExplainRequest.Builder clearEndpoint()

Required. The name of the Endpoint requested to serve the explanation. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ExplainRequest.Builder

This builder for chaining.

clearExplanationSpecOverride()

public ExplainRequest.Builder clearExplanationSpecOverride()

If specified, overrides the explanation_spec of the DeployedModel. Can be used for explaining prediction results with different configurations, such as:

  • Explaining top-5 predictions results as opposed to top-1;
  • Increasing path count or step count of the attribution methods to reduce approximate errors;
  • Using different baselines for explaining the prediction results.

.google.cloud.aiplatform.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

Returns
TypeDescription
ExplainRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ExplainRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExplainRequest.Builder
Overrides

clearInstances()

public ExplainRequest.Builder clearInstances()

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ExplainRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ExplainRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExplainRequest.Builder
Overrides

clearParameters()

public ExplainRequest.Builder clearParameters()

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 4;

Returns
TypeDescription
ExplainRequest.Builder

clone()

public ExplainRequest.Builder clone()
Returns
TypeDescription
ExplainRequest.Builder
Overrides

containsConcurrentExplanationSpecOverride(String key)

public boolean containsConcurrentExplanationSpecOverride(String key)

Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model, then its explanations will be grouped together.

Note - these explanations are run In Addition to the default Explanation in the deployed model.

map<string, .google.cloud.aiplatform.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getConcurrentExplanationSpecOverride() (deprecated)

public Map<String,ExplanationSpecOverride> getConcurrentExplanationSpecOverride()

Use #getConcurrentExplanationSpecOverrideMap() instead.

Returns
TypeDescription
Map<String,ExplanationSpecOverride>

getConcurrentExplanationSpecOverrideCount()

public int getConcurrentExplanationSpecOverrideCount()

Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model, then its explanations will be grouped together.

Note - these explanations are run In Addition to the default Explanation in the deployed model.

map<string, .google.cloud.aiplatform.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getConcurrentExplanationSpecOverrideMap()

public Map<String,ExplanationSpecOverride> getConcurrentExplanationSpecOverrideMap()

Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model, then its explanations will be grouped together.

Note - these explanations are run In Addition to the default Explanation in the deployed model.

map<string, .google.cloud.aiplatform.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,ExplanationSpecOverride>

getConcurrentExplanationSpecOverrideOrDefault(String key, ExplanationSpecOverride defaultValue)

public ExplanationSpecOverride getConcurrentExplanationSpecOverrideOrDefault(String key, ExplanationSpecOverride defaultValue)

Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model, then its explanations will be grouped together.

Note - these explanations are run In Addition to the default Explanation in the deployed model.

map<string, .google.cloud.aiplatform.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueExplanationSpecOverride
Returns
TypeDescription
ExplanationSpecOverride

getConcurrentExplanationSpecOverrideOrThrow(String key)

public ExplanationSpecOverride getConcurrentExplanationSpecOverrideOrThrow(String key)

Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model, then its explanations will be grouped together.

Note - these explanations are run In Addition to the default Explanation in the deployed model.

map<string, .google.cloud.aiplatform.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
ExplanationSpecOverride

getDefaultInstanceForType()

public ExplainRequest getDefaultInstanceForType()
Returns
TypeDescription
ExplainRequest

getDeployedModelId()

public String getDeployedModelId()

If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.

string deployed_model_id = 3;

Returns
TypeDescription
String

The deployedModelId.

getDeployedModelIdBytes()

public ByteString getDeployedModelIdBytes()

If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.

string deployed_model_id = 3;

Returns
TypeDescription
ByteString

The bytes for deployedModelId.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndpoint()

public String getEndpoint()

Required. The name of the Endpoint requested to serve the explanation. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The endpoint.

getEndpointBytes()

public ByteString getEndpointBytes()

Required. The name of the Endpoint requested to serve the explanation. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for endpoint.

getExplanationSpecOverride()

public ExplanationSpecOverride getExplanationSpecOverride()

If specified, overrides the explanation_spec of the DeployedModel. Can be used for explaining prediction results with different configurations, such as:

  • Explaining top-5 predictions results as opposed to top-1;
  • Increasing path count or step count of the attribution methods to reduce approximate errors;
  • Using different baselines for explaining the prediction results.

.google.cloud.aiplatform.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

Returns
TypeDescription
ExplanationSpecOverride

The explanationSpecOverride.

getExplanationSpecOverrideBuilder()

public ExplanationSpecOverride.Builder getExplanationSpecOverrideBuilder()

If specified, overrides the explanation_spec of the DeployedModel. Can be used for explaining prediction results with different configurations, such as:

  • Explaining top-5 predictions results as opposed to top-1;
  • Increasing path count or step count of the attribution methods to reduce approximate errors;
  • Using different baselines for explaining the prediction results.

.google.cloud.aiplatform.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

Returns
TypeDescription
ExplanationSpecOverride.Builder

getExplanationSpecOverrideOrBuilder()

public ExplanationSpecOverrideOrBuilder getExplanationSpecOverrideOrBuilder()

If specified, overrides the explanation_spec of the DeployedModel. Can be used for explaining prediction results with different configurations, such as:

  • Explaining top-5 predictions results as opposed to top-1;
  • Increasing path count or step count of the attribution methods to reduce approximate errors;
  • Using different baselines for explaining the prediction results.

.google.cloud.aiplatform.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

Returns
TypeDescription
ExplanationSpecOverrideOrBuilder

getInstances(int index)

public Value getInstances(int index)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
Value

getInstancesBuilder(int index)

public Value.Builder getInstancesBuilder(int index)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
Builder

getInstancesBuilderList()

public List<Value.Builder> getInstancesBuilderList()

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Builder>

getInstancesCount()

public int getInstancesCount()

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getInstancesList()

public List<Value> getInstancesList()

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Value>

getInstancesOrBuilder(int index)

public ValueOrBuilder getInstancesOrBuilder(int index)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
ValueOrBuilder

getInstancesOrBuilderList()

public List<? extends ValueOrBuilder> getInstancesOrBuilderList()

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.protobuf.ValueOrBuilder>

getMutableConcurrentExplanationSpecOverride() (deprecated)

public Map<String,ExplanationSpecOverride> getMutableConcurrentExplanationSpecOverride()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,ExplanationSpecOverride>

getParameters()

public Value getParameters()

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 4;

Returns
TypeDescription
Value

The parameters.

getParametersBuilder()

public Value.Builder getParametersBuilder()

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 4;

Returns
TypeDescription
Builder

getParametersOrBuilder()

public ValueOrBuilder getParametersOrBuilder()

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 4;

Returns
TypeDescription
ValueOrBuilder

hasExplanationSpecOverride()

public boolean hasExplanationSpecOverride()

If specified, overrides the explanation_spec of the DeployedModel. Can be used for explaining prediction results with different configurations, such as:

  • Explaining top-5 predictions results as opposed to top-1;
  • Increasing path count or step count of the attribution methods to reduce approximate errors;
  • Using different baselines for explaining the prediction results.

.google.cloud.aiplatform.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

Returns
TypeDescription
boolean

Whether the explanationSpecOverride field is set.

hasParameters()

public boolean hasParameters()

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 4;

Returns
TypeDescription
boolean

Whether the parameters field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeExplanationSpecOverride(ExplanationSpecOverride value)

public ExplainRequest.Builder mergeExplanationSpecOverride(ExplanationSpecOverride value)

If specified, overrides the explanation_spec of the DeployedModel. Can be used for explaining prediction results with different configurations, such as:

  • Explaining top-5 predictions results as opposed to top-1;
  • Increasing path count or step count of the attribution methods to reduce approximate errors;
  • Using different baselines for explaining the prediction results.

.google.cloud.aiplatform.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

Parameter
NameDescription
valueExplanationSpecOverride
Returns
TypeDescription
ExplainRequest.Builder

mergeFrom(ExplainRequest other)

public ExplainRequest.Builder mergeFrom(ExplainRequest other)
Parameter
NameDescription
otherExplainRequest
Returns
TypeDescription
ExplainRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExplainRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExplainRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExplainRequest.Builder
Overrides

mergeParameters(Value value)

public ExplainRequest.Builder mergeParameters(Value value)

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 4;

Parameter
NameDescription
valueValue
Returns
TypeDescription
ExplainRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExplainRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExplainRequest.Builder
Overrides

putAllConcurrentExplanationSpecOverride(Map<String,ExplanationSpecOverride> values)

public ExplainRequest.Builder putAllConcurrentExplanationSpecOverride(Map<String,ExplanationSpecOverride> values)

Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model, then its explanations will be grouped together.

Note - these explanations are run In Addition to the default Explanation in the deployed model.

map<string, .google.cloud.aiplatform.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuesMap<String,ExplanationSpecOverride>
Returns
TypeDescription
ExplainRequest.Builder

putConcurrentExplanationSpecOverride(String key, ExplanationSpecOverride value)

public ExplainRequest.Builder putConcurrentExplanationSpecOverride(String key, ExplanationSpecOverride value)

Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model, then its explanations will be grouped together.

Note - these explanations are run In Addition to the default Explanation in the deployed model.

map<string, .google.cloud.aiplatform.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
valueExplanationSpecOverride
Returns
TypeDescription
ExplainRequest.Builder

removeConcurrentExplanationSpecOverride(String key)

public ExplainRequest.Builder removeConcurrentExplanationSpecOverride(String key)

Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model, then its explanations will be grouped together.

Note - these explanations are run In Addition to the default Explanation in the deployed model.

map<string, .google.cloud.aiplatform.v1beta1.ExplanationSpecOverride> concurrent_explanation_spec_override = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
ExplainRequest.Builder

removeInstances(int index)

public ExplainRequest.Builder removeInstances(int index)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainRequest.Builder

setDeployedModelId(String value)

public ExplainRequest.Builder setDeployedModelId(String value)

If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.

string deployed_model_id = 3;

Parameter
NameDescription
valueString

The deployedModelId to set.

Returns
TypeDescription
ExplainRequest.Builder

This builder for chaining.

setDeployedModelIdBytes(ByteString value)

public ExplainRequest.Builder setDeployedModelIdBytes(ByteString value)

If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.

string deployed_model_id = 3;

Parameter
NameDescription
valueByteString

The bytes for deployedModelId to set.

Returns
TypeDescription
ExplainRequest.Builder

This builder for chaining.

setEndpoint(String value)

public ExplainRequest.Builder setEndpoint(String value)

Required. The name of the Endpoint requested to serve the explanation. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The endpoint to set.

Returns
TypeDescription
ExplainRequest.Builder

This builder for chaining.

setEndpointBytes(ByteString value)

public ExplainRequest.Builder setEndpointBytes(ByteString value)

Required. The name of the Endpoint requested to serve the explanation. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for endpoint to set.

Returns
TypeDescription
ExplainRequest.Builder

This builder for chaining.

setExplanationSpecOverride(ExplanationSpecOverride value)

public ExplainRequest.Builder setExplanationSpecOverride(ExplanationSpecOverride value)

If specified, overrides the explanation_spec of the DeployedModel. Can be used for explaining prediction results with different configurations, such as:

  • Explaining top-5 predictions results as opposed to top-1;
  • Increasing path count or step count of the attribution methods to reduce approximate errors;
  • Using different baselines for explaining the prediction results.

.google.cloud.aiplatform.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

Parameter
NameDescription
valueExplanationSpecOverride
Returns
TypeDescription
ExplainRequest.Builder

setExplanationSpecOverride(ExplanationSpecOverride.Builder builderForValue)

public ExplainRequest.Builder setExplanationSpecOverride(ExplanationSpecOverride.Builder builderForValue)

If specified, overrides the explanation_spec of the DeployedModel. Can be used for explaining prediction results with different configurations, such as:

  • Explaining top-5 predictions results as opposed to top-1;
  • Increasing path count or step count of the attribution methods to reduce approximate errors;
  • Using different baselines for explaining the prediction results.

.google.cloud.aiplatform.v1beta1.ExplanationSpecOverride explanation_spec_override = 5;

Parameter
NameDescription
builderForValueExplanationSpecOverride.Builder
Returns
TypeDescription
ExplainRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExplainRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExplainRequest.Builder
Overrides

setInstances(int index, Value value)

public ExplainRequest.Builder setInstances(int index, Value value)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
valueValue
Returns
TypeDescription
ExplainRequest.Builder

setInstances(int index, Value.Builder builderForValue)

public ExplainRequest.Builder setInstances(int index, Value.Builder builderForValue)

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
builderForValueBuilder
Returns
TypeDescription
ExplainRequest.Builder

setParameters(Value value)

public ExplainRequest.Builder setParameters(Value value)

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 4;

Parameter
NameDescription
valueValue
Returns
TypeDescription
ExplainRequest.Builder

setParameters(Value.Builder builderForValue)

public ExplainRequest.Builder setParameters(Value.Builder builderForValue)

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ExplainRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExplainRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExplainRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ExplainRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExplainRequest.Builder
Overrides