public final class ExplainRequest extends GeneratedMessageV3 implements ExplainRequestOrBuilder
Request message for
PredictionService.Explain.
Protobuf type google.cloud.aiplatform.v1.ExplainRequest
Static Fields
public static final int DEPLOYED_MODEL_ID_FIELD_NUMBER
Field Value
public static final int ENDPOINT_FIELD_NUMBER
Field Value
public static final int EXPLANATION_SPEC_OVERRIDE_FIELD_NUMBER
Field Value
public static final int INSTANCES_FIELD_NUMBER
Field Value
public static final int PARAMETERS_FIELD_NUMBER
Field Value
Static Methods
public static ExplainRequest getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ExplainRequest.Builder newBuilder()
Returns
public static ExplainRequest.Builder newBuilder(ExplainRequest prototype)
Parameter
Returns
public static ExplainRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ExplainRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExplainRequest parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
public static ExplainRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExplainRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ExplainRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExplainRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ExplainRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExplainRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ExplainRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExplainRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ExplainRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ExplainRequest> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public ExplainRequest getDefaultInstanceForType()
Returns
public String getDeployedModelId()
If specified, this ExplainRequest will be served by the chosen
DeployedModel, overriding
Endpoint.traffic_split.
string deployed_model_id = 3;
| Type | Description |
String | The deployedModelId.
|
public ByteString getDeployedModelIdBytes()
If specified, this ExplainRequest will be served by the chosen
DeployedModel, overriding
Endpoint.traffic_split.
string deployed_model_id = 3;
| Type | Description |
ByteString | The bytes for deployedModelId.
|
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) = { ... }
| Type | Description |
String | The endpoint.
|
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) = { ... }
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.v1.ExplanationSpecOverride explanation_spec_override = 5;
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.v1.ExplanationSpecOverride explanation_spec_override = 5;
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];
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];
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];
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];
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];
| Type | Description |
List<? extends com.google.protobuf.ValueOrBuilder> | |
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;
| Type | Description |
Value | The parameters.
|
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;
public Parser<ExplainRequest> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.v1.ExplanationSpecOverride explanation_spec_override = 5;
| Type | Description |
boolean | Whether the explanationSpecOverride field is set.
|
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;
| Type | Description |
boolean | Whether the parameters field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ExplainRequest.Builder newBuilderForType()
Returns
protected ExplainRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ExplainRequest.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
