Interface PredictRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PredictRequest, PredictRequest.Builder

    public interface PredictRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • getName

        String getName()
         Required. Name of the model requested to serve the prediction.
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The name.
      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Required. Name of the model requested to serve the prediction.
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for name.
      • hasPayload

        boolean hasPayload()
         Required. Payload to perform a prediction on. The payload must match the
         problem type that the model was trained to solve.
         
        .google.cloud.automl.v1beta1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the payload field is set.
      • getPayload

        ExamplePayload getPayload()
         Required. Payload to perform a prediction on. The payload must match the
         problem type that the model was trained to solve.
         
        .google.cloud.automl.v1beta1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The payload.
      • getPayloadOrBuilder

        ExamplePayloadOrBuilder getPayloadOrBuilder()
         Required. Payload to perform a prediction on. The payload must match the
         problem type that the model was trained to solve.
         
        .google.cloud.automl.v1beta1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];
      • getParamsCount

        int getParamsCount()
         Additional domain-specific parameters, any string must be up to 25000
         characters long.
        
         *  For Image Classification:
        
            `score_threshold` - (float) A value from 0.0 to 1.0. When the model
             makes predictions for an image, it will only produce results that have
             at least this confidence score. The default is 0.5.
        
          *  For Image Object Detection:
            `score_threshold` - (float) When Model detects objects on the image,
                it will only produce bounding boxes which have at least this
                confidence score. Value in 0 to 1 range, default is 0.5.
            `max_bounding_box_count` - (int64) No more than this number of bounding
                boxes will be returned in the response. Default is 100, the
                requested value may be limited by server.
         *  For Tables:
            feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
                should be populated in the returned TablesAnnotation.
                The default is false.
         
        map<string, string> params = 3;
      • containsParams

        boolean containsParams​(String key)
         Additional domain-specific parameters, any string must be up to 25000
         characters long.
        
         *  For Image Classification:
        
            `score_threshold` - (float) A value from 0.0 to 1.0. When the model
             makes predictions for an image, it will only produce results that have
             at least this confidence score. The default is 0.5.
        
          *  For Image Object Detection:
            `score_threshold` - (float) When Model detects objects on the image,
                it will only produce bounding boxes which have at least this
                confidence score. Value in 0 to 1 range, default is 0.5.
            `max_bounding_box_count` - (int64) No more than this number of bounding
                boxes will be returned in the response. Default is 100, the
                requested value may be limited by server.
         *  For Tables:
            feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
                should be populated in the returned TablesAnnotation.
                The default is false.
         
        map<string, string> params = 3;
      • getParamsMap

        Map<String,​String> getParamsMap()
         Additional domain-specific parameters, any string must be up to 25000
         characters long.
        
         *  For Image Classification:
        
            `score_threshold` - (float) A value from 0.0 to 1.0. When the model
             makes predictions for an image, it will only produce results that have
             at least this confidence score. The default is 0.5.
        
          *  For Image Object Detection:
            `score_threshold` - (float) When Model detects objects on the image,
                it will only produce bounding boxes which have at least this
                confidence score. Value in 0 to 1 range, default is 0.5.
            `max_bounding_box_count` - (int64) No more than this number of bounding
                boxes will be returned in the response. Default is 100, the
                requested value may be limited by server.
         *  For Tables:
            feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
                should be populated in the returned TablesAnnotation.
                The default is false.
         
        map<string, string> params = 3;
      • getParamsOrDefault

        String getParamsOrDefault​(String key,
                                  String defaultValue)
         Additional domain-specific parameters, any string must be up to 25000
         characters long.
        
         *  For Image Classification:
        
            `score_threshold` - (float) A value from 0.0 to 1.0. When the model
             makes predictions for an image, it will only produce results that have
             at least this confidence score. The default is 0.5.
        
          *  For Image Object Detection:
            `score_threshold` - (float) When Model detects objects on the image,
                it will only produce bounding boxes which have at least this
                confidence score. Value in 0 to 1 range, default is 0.5.
            `max_bounding_box_count` - (int64) No more than this number of bounding
                boxes will be returned in the response. Default is 100, the
                requested value may be limited by server.
         *  For Tables:
            feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
                should be populated in the returned TablesAnnotation.
                The default is false.
         
        map<string, string> params = 3;
      • getParamsOrThrow

        String getParamsOrThrow​(String key)
         Additional domain-specific parameters, any string must be up to 25000
         characters long.
        
         *  For Image Classification:
        
            `score_threshold` - (float) A value from 0.0 to 1.0. When the model
             makes predictions for an image, it will only produce results that have
             at least this confidence score. The default is 0.5.
        
          *  For Image Object Detection:
            `score_threshold` - (float) When Model detects objects on the image,
                it will only produce bounding boxes which have at least this
                confidence score. Value in 0 to 1 range, default is 0.5.
            `max_bounding_box_count` - (int64) No more than this number of bounding
                boxes will be returned in the response. Default is 100, the
                requested value may be limited by server.
         *  For Tables:
            feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
                should be populated in the returned TablesAnnotation.
                The default is false.
         
        map<string, string> params = 3;