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