Class ExplainRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.ExplainRequest
All Implemented Interfaces:
ExplainRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ExplainRequest extends com.google.protobuf.GeneratedMessage implements ExplainRequestOrBuilder
 Request message for
 [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
 
Protobuf type google.cloud.aiplatform.v1.ExplainRequest
See Also:
  • Nested Class Summary

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

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
     
     
    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
    If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
    static final com.google.protobuf.Descriptors.Descriptor
     
    Required.
    com.google.protobuf.ByteString
    Required.
    If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
    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
    Required.
    List<com.google.protobuf.Value>
    Required.
    com.google.protobuf.ValueOrBuilder
    Required.
    List<? extends com.google.protobuf.ValueOrBuilder>
    Required.
    com.google.protobuf.Value
    The parameters that govern the prediction.
    com.google.protobuf.ValueOrBuilder
    The parameters that govern the prediction.
    com.google.protobuf.Parser<ExplainRequest>
     
    int
     
    boolean
    If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
    int
     
    boolean
    The parameters that govern the prediction.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ExplainRequest>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Field Details

    • ENDPOINT_FIELD_NUMBER

      public static final int ENDPOINT_FIELD_NUMBER
      See Also:
    • INSTANCES_FIELD_NUMBER

      public static final int INSTANCES_FIELD_NUMBER
      See Also:
    • PARAMETERS_FIELD_NUMBER

      public static final int PARAMETERS_FIELD_NUMBER
      See Also:
    • EXPLANATION_SPEC_OVERRIDE_FIELD_NUMBER

      public static final int EXPLANATION_SPEC_OVERRIDE_FIELD_NUMBER
      See Also:
    • DEPLOYED_MODEL_ID_FIELD_NUMBER

      public static final int DEPLOYED_MODEL_ID_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ExplainRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ExplainRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ExplainRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ExplainRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • 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
    • newBuilder

      public static ExplainRequest.Builder newBuilder()
    • newBuilder

      public static ExplainRequest.Builder newBuilder(ExplainRequest prototype)
    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • 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.GeneratedMessage
    • getDefaultInstanceForType

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