Package com.google.cloud.aiplatform.v1

Class ExplainRequest

  • All Implemented Interfaces:
    ExplainRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    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.aiplatform.v1.ExplainRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ExplainRequest.Builder
      Request message for [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • PARAMETERS_FIELD_NUMBER

        public static final int PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPLANATION_SPEC_OVERRIDE_FIELD_NUMBER

        public static final int EXPLANATION_SPEC_OVERRIDE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEPLOYED_MODEL_ID_FIELD_NUMBER

        public static final int DEPLOYED_MODEL_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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) = { ... }
        Specified by:
        getEndpoint in interface ExplainRequestOrBuilder
        Returns:
        The endpoint.

      • getEndpointBytes

        public 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) = { ... }
        Specified by:
        getEndpointBytes in interface ExplainRequestOrBuilder
        Returns:
        The bytes for endpoint.

      • getInstancesList

        public 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];
        Specified by:
        getInstancesList in interface ExplainRequestOrBuilder

      • getInstancesOrBuilderList

        public 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];
        Specified by:
        getInstancesOrBuilderList in interface ExplainRequestOrBuilder

      • 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][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];
        Specified by:
        getInstancesCount in interface ExplainRequestOrBuilder

      • getInstances

        public 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];
        Specified by:
        getInstances in interface ExplainRequestOrBuilder

      • getInstancesOrBuilder

        public 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];
        Specified by:
        getInstancesOrBuilder in interface ExplainRequestOrBuilder

      • hasParameters

        public 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;
        Specified by:
        hasParameters in interface ExplainRequestOrBuilder
        Returns:
        Whether the parameters field is set.

      • getParameters

        public 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;
        Specified by:
        getParameters in interface ExplainRequestOrBuilder
        Returns:
        The parameters.

      • getParametersOrBuilder

        public 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;
        Specified by:
        getParametersOrBuilder in interface ExplainRequestOrBuilder

      • hasExplanationSpecOverride

        public 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.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;
        Specified by:
        hasExplanationSpecOverride in interface ExplainRequestOrBuilder
        Returns:
        Whether the explanationSpecOverride field is set.

      • getExplanationSpecOverride

        public 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.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;
        Specified by:
        getExplanationSpecOverride in interface ExplainRequestOrBuilder
        Returns:
        The explanationSpecOverride.

      • getExplanationSpecOverrideOrBuilder

        public 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.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;
        Specified by:
        getExplanationSpecOverrideOrBuilder in interface ExplainRequestOrBuilder

      • getDeployedModelId

        public 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;
        Specified by:
        getDeployedModelId in interface ExplainRequestOrBuilder
        Returns:
        The deployedModelId.

      • getDeployedModelIdBytes

        public 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;
        Specified by:
        getDeployedModelIdBytes in interface ExplainRequestOrBuilder
        Returns:
        The bytes for deployedModelId.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ExplainRequest parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExplainRequest parseFrom​(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExplainRequest parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExplainRequest parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExplainRequest parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExplainRequest parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExplainRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ExplainRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ExplainRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ExplainRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ExplainRequest getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<ExplainRequest> parser()

      • getParserForType

        public com.google.protobuf.Parser<ExplainRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ExplainRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder