public final class ExplainRequest extends com.google.protobuf.GeneratedMessageV3 implements ExplainRequestOrBuilder
Request message for [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].Protobuf type
google.cloud.vertexai.v1.ExplainRequest| Modifier and Type | Class and Description |
|---|---|
static class |
ExplainRequest.Builder
Request message for
[PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
DEPLOYED_MODEL_ID_FIELD_NUMBER |
static int |
ENDPOINT_FIELD_NUMBER |
static int |
EXPLANATION_SPEC_OVERRIDE_FIELD_NUMBER |
static int |
INSTANCES_FIELD_NUMBER |
static int |
PARAMETERS_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static ExplainRequest |
getDefaultInstance() |
ExplainRequest |
getDefaultInstanceForType() |
String |
getDeployedModelId()
If specified, this ExplainRequest will be served by the chosen
DeployedModel, overriding
[Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
|
com.google.protobuf.ByteString |
getDeployedModelIdBytes()
If specified, this ExplainRequest will be served by the chosen
DeployedModel, overriding
[Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getEndpoint()
Required.
|
com.google.protobuf.ByteString |
getEndpointBytes()
Required.
|
ExplanationSpecOverride |
getExplanationSpecOverride()
If specified, overrides the
[explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
of the DeployedModel.
|
ExplanationSpecOverrideOrBuilder |
getExplanationSpecOverrideOrBuilder()
If specified, overrides the
[explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
of the DeployedModel.
|
com.google.protobuf.Value |
getInstances(int index)
Required.
|
int |
getInstancesCount()
Required.
|
List<com.google.protobuf.Value> |
getInstancesList()
Required.
|
com.google.protobuf.ValueOrBuilder |
getInstancesOrBuilder(int index)
Required.
|
List<? extends com.google.protobuf.ValueOrBuilder> |
getInstancesOrBuilderList()
Required.
|
com.google.protobuf.Value |
getParameters()
The parameters that govern the prediction.
|
com.google.protobuf.ValueOrBuilder |
getParametersOrBuilder()
The parameters that govern the prediction.
|
com.google.protobuf.Parser<ExplainRequest> |
getParserForType() |
int |
getSerializedSize() |
boolean |
hasExplanationSpecOverride()
If specified, overrides the
[explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
of the DeployedModel.
|
int |
hashCode() |
boolean |
hasParameters()
The parameters that govern the prediction.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ExplainRequest.Builder |
newBuilder() |
static ExplainRequest.Builder |
newBuilder(ExplainRequest prototype) |
ExplainRequest.Builder |
newBuilderForType() |
protected ExplainRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ExplainRequest |
parseDelimitedFrom(InputStream input) |
static ExplainRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExplainRequest |
parseFrom(byte[] data) |
static ExplainRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExplainRequest |
parseFrom(ByteBuffer data) |
static ExplainRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExplainRequest |
parseFrom(com.google.protobuf.ByteString data) |
static ExplainRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExplainRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ExplainRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExplainRequest |
parseFrom(InputStream input) |
static ExplainRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ExplainRequest> |
parser() |
ExplainRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int ENDPOINT_FIELD_NUMBER
public static final int INSTANCES_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
public static final int EXPLANATION_SPEC_OVERRIDE_FIELD_NUMBER
public static final int DEPLOYED_MODEL_ID_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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) = { ... }
getEndpoint in interface ExplainRequestOrBuilderpublic com.google.protobuf.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) = { ... }
getEndpointBytes in interface ExplainRequestOrBuilderpublic List<com.google.protobuf.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][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];
getInstancesList in interface ExplainRequestOrBuilderpublic List<? extends com.google.protobuf.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][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];
getInstancesOrBuilderList in interface ExplainRequestOrBuilderpublic 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][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];
getInstancesCount in interface ExplainRequestOrBuilderpublic com.google.protobuf.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][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];
getInstances in interface ExplainRequestOrBuilderpublic com.google.protobuf.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][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];
getInstancesOrBuilder in interface ExplainRequestOrBuilderpublic boolean hasParameters()
The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
.google.protobuf.Value parameters = 4;hasParameters in interface ExplainRequestOrBuilderpublic com.google.protobuf.Value getParameters()
The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
.google.protobuf.Value parameters = 4;getParameters in interface ExplainRequestOrBuilderpublic com.google.protobuf.ValueOrBuilder getParametersOrBuilder()
The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
.google.protobuf.Value parameters = 4;getParametersOrBuilder in interface ExplainRequestOrBuilderpublic boolean hasExplanationSpecOverride()
If specified, overrides the
[explanation_spec][google.cloud.aiplatform.v1.DeployedModel.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.vertexai.v1.ExplanationSpecOverride explanation_spec_override = 5;hasExplanationSpecOverride in interface ExplainRequestOrBuilderpublic ExplanationSpecOverride getExplanationSpecOverride()
If specified, overrides the
[explanation_spec][google.cloud.aiplatform.v1.DeployedModel.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.vertexai.v1.ExplanationSpecOverride explanation_spec_override = 5;getExplanationSpecOverride in interface ExplainRequestOrBuilderpublic ExplanationSpecOverrideOrBuilder getExplanationSpecOverrideOrBuilder()
If specified, overrides the
[explanation_spec][google.cloud.aiplatform.v1.DeployedModel.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.vertexai.v1.ExplanationSpecOverride explanation_spec_override = 5;getExplanationSpecOverrideOrBuilder in interface ExplainRequestOrBuilderpublic String getDeployedModelId()
If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
string deployed_model_id = 3;getDeployedModelId in interface ExplainRequestOrBuilderpublic com.google.protobuf.ByteString getDeployedModelIdBytes()
If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
string deployed_model_id = 3;getDeployedModelIdBytes in interface ExplainRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ExplainRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplainRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplainRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplainRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplainRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplainRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplainRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ExplainRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ExplainRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ExplainRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ExplainRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ExplainRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ExplainRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ExplainRequest.Builder newBuilder()
public static ExplainRequest.Builder newBuilder(ExplainRequest prototype)
public ExplainRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ExplainRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ExplainRequest getDefaultInstance()
public static com.google.protobuf.Parser<ExplainRequest> parser()
public com.google.protobuf.Parser<ExplainRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ExplainRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.