Interface BatchPredictRequestOrBuilder

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

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

      • getName

        String getName()
         Required. Name of the model requested to serve the batch 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 batch prediction.
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for name.
      • hasInputConfig

        boolean hasInputConfig()
         Required. The input configuration for batch prediction.
         
        .google.cloud.automl.v1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the inputConfig field is set.
      • getInputConfig

        BatchPredictInputConfig getInputConfig()
         Required. The input configuration for batch prediction.
         
        .google.cloud.automl.v1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The inputConfig.
      • getInputConfigOrBuilder

        BatchPredictInputConfigOrBuilder getInputConfigOrBuilder()
         Required. The input configuration for batch prediction.
         
        .google.cloud.automl.v1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
      • hasOutputConfig

        boolean hasOutputConfig()
         Required. The Configuration specifying where output predictions should
         be written.
         
        .google.cloud.automl.v1.BatchPredictOutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the outputConfig field is set.
      • getOutputConfig

        BatchPredictOutputConfig getOutputConfig()
         Required. The Configuration specifying where output predictions should
         be written.
         
        .google.cloud.automl.v1.BatchPredictOutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The outputConfig.
      • getOutputConfigOrBuilder

        BatchPredictOutputConfigOrBuilder getOutputConfigOrBuilder()
         Required. The Configuration specifying where output predictions should
         be written.
         
        .google.cloud.automl.v1.BatchPredictOutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
      • getParamsCount

        int getParamsCount()
         Additional domain-specific parameters for the predictions, any string must
         be up to 25000 characters long.
        
         AutoML Natural Language Classification
        
         `score_threshold`
         : (float) A value from 0.0 to 1.0. When the model
           makes predictions for a text snippet, it will only produce results
           that have at least this confidence score. The default is 0.5.
        
        
         AutoML Vision 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.
        
         AutoML Vision 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) The maximum number of bounding
           boxes returned per image. The default is 100, the
           number of bounding boxes returned might be limited by the server.
         AutoML Video Intelligence Classification
        
         `score_threshold`
         : (float) A value from 0.0 to 1.0. When the model
           makes predictions for a video, it will only produce results that
           have at least this confidence score. The default is 0.5.
        
         `segment_classification`
         : (boolean) Set to true to request
           segment-level classification. AutoML Video Intelligence returns
           labels and their confidence scores for the entire segment of the
           video that user specified in the request configuration.
           The default is true.
        
         `shot_classification`
         : (boolean) Set to true to request shot-level
           classification. AutoML Video Intelligence determines the boundaries
           for each camera shot in the entire segment of the video that user
           specified in the request configuration. AutoML Video Intelligence
           then returns labels and their confidence scores for each detected
           shot, along with the start and end time of the shot.
           The default is false.
        
           WARNING: Model evaluation is not done for this classification type,
           the quality of it depends on training data, but there are no metrics
           provided to describe that quality.
        
         `1s_interval_classification`
         : (boolean) Set to true to request
           classification for a video at one-second intervals. AutoML Video
           Intelligence returns labels and their confidence scores for each
           second of the entire segment of the video that user specified in the
           request configuration. The default is false.
        
           WARNING: Model evaluation is not done for this classification
           type, the quality of it depends on training data, but there are no
           metrics provided to describe that quality.
        
         AutoML Video Intelligence Object Tracking
        
         `score_threshold`
         : (float) When Model detects objects on video frames,
           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) The maximum number of bounding
           boxes returned per image. The default is 100, the
           number of bounding boxes returned might be limited by the server.
        
         `min_bounding_box_size`
         : (float) Only bounding boxes with shortest edge
           at least that long as a relative value of video frame size are
           returned. Value in 0 to 1 range. Default is 0.
         
        map<string, string> params = 5;
      • containsParams

        boolean containsParams​(String key)
         Additional domain-specific parameters for the predictions, any string must
         be up to 25000 characters long.
        
         AutoML Natural Language Classification
        
         `score_threshold`
         : (float) A value from 0.0 to 1.0. When the model
           makes predictions for a text snippet, it will only produce results
           that have at least this confidence score. The default is 0.5.
        
        
         AutoML Vision 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.
        
         AutoML Vision 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) The maximum number of bounding
           boxes returned per image. The default is 100, the
           number of bounding boxes returned might be limited by the server.
         AutoML Video Intelligence Classification
        
         `score_threshold`
         : (float) A value from 0.0 to 1.0. When the model
           makes predictions for a video, it will only produce results that
           have at least this confidence score. The default is 0.5.
        
         `segment_classification`
         : (boolean) Set to true to request
           segment-level classification. AutoML Video Intelligence returns
           labels and their confidence scores for the entire segment of the
           video that user specified in the request configuration.
           The default is true.
        
         `shot_classification`
         : (boolean) Set to true to request shot-level
           classification. AutoML Video Intelligence determines the boundaries
           for each camera shot in the entire segment of the video that user
           specified in the request configuration. AutoML Video Intelligence
           then returns labels and their confidence scores for each detected
           shot, along with the start and end time of the shot.
           The default is false.
        
           WARNING: Model evaluation is not done for this classification type,
           the quality of it depends on training data, but there are no metrics
           provided to describe that quality.
        
         `1s_interval_classification`
         : (boolean) Set to true to request
           classification for a video at one-second intervals. AutoML Video
           Intelligence returns labels and their confidence scores for each
           second of the entire segment of the video that user specified in the
           request configuration. The default is false.
        
           WARNING: Model evaluation is not done for this classification
           type, the quality of it depends on training data, but there are no
           metrics provided to describe that quality.
        
         AutoML Video Intelligence Object Tracking
        
         `score_threshold`
         : (float) When Model detects objects on video frames,
           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) The maximum number of bounding
           boxes returned per image. The default is 100, the
           number of bounding boxes returned might be limited by the server.
        
         `min_bounding_box_size`
         : (float) Only bounding boxes with shortest edge
           at least that long as a relative value of video frame size are
           returned. Value in 0 to 1 range. Default is 0.
         
        map<string, string> params = 5;
      • getParamsMap

        Map<String,​String> getParamsMap()
         Additional domain-specific parameters for the predictions, any string must
         be up to 25000 characters long.
        
         AutoML Natural Language Classification
        
         `score_threshold`
         : (float) A value from 0.0 to 1.0. When the model
           makes predictions for a text snippet, it will only produce results
           that have at least this confidence score. The default is 0.5.
        
        
         AutoML Vision 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.
        
         AutoML Vision 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) The maximum number of bounding
           boxes returned per image. The default is 100, the
           number of bounding boxes returned might be limited by the server.
         AutoML Video Intelligence Classification
        
         `score_threshold`
         : (float) A value from 0.0 to 1.0. When the model
           makes predictions for a video, it will only produce results that
           have at least this confidence score. The default is 0.5.
        
         `segment_classification`
         : (boolean) Set to true to request
           segment-level classification. AutoML Video Intelligence returns
           labels and their confidence scores for the entire segment of the
           video that user specified in the request configuration.
           The default is true.
        
         `shot_classification`
         : (boolean) Set to true to request shot-level
           classification. AutoML Video Intelligence determines the boundaries
           for each camera shot in the entire segment of the video that user
           specified in the request configuration. AutoML Video Intelligence
           then returns labels and their confidence scores for each detected
           shot, along with the start and end time of the shot.
           The default is false.
        
           WARNING: Model evaluation is not done for this classification type,
           the quality of it depends on training data, but there are no metrics
           provided to describe that quality.
        
         `1s_interval_classification`
         : (boolean) Set to true to request
           classification for a video at one-second intervals. AutoML Video
           Intelligence returns labels and their confidence scores for each
           second of the entire segment of the video that user specified in the
           request configuration. The default is false.
        
           WARNING: Model evaluation is not done for this classification
           type, the quality of it depends on training data, but there are no
           metrics provided to describe that quality.
        
         AutoML Video Intelligence Object Tracking
        
         `score_threshold`
         : (float) When Model detects objects on video frames,
           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) The maximum number of bounding
           boxes returned per image. The default is 100, the
           number of bounding boxes returned might be limited by the server.
        
         `min_bounding_box_size`
         : (float) Only bounding boxes with shortest edge
           at least that long as a relative value of video frame size are
           returned. Value in 0 to 1 range. Default is 0.
         
        map<string, string> params = 5;
      • getParamsOrDefault

        String getParamsOrDefault​(String key,
                                  String defaultValue)
         Additional domain-specific parameters for the predictions, any string must
         be up to 25000 characters long.
        
         AutoML Natural Language Classification
        
         `score_threshold`
         : (float) A value from 0.0 to 1.0. When the model
           makes predictions for a text snippet, it will only produce results
           that have at least this confidence score. The default is 0.5.
        
        
         AutoML Vision 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.
        
         AutoML Vision 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) The maximum number of bounding
           boxes returned per image. The default is 100, the
           number of bounding boxes returned might be limited by the server.
         AutoML Video Intelligence Classification
        
         `score_threshold`
         : (float) A value from 0.0 to 1.0. When the model
           makes predictions for a video, it will only produce results that
           have at least this confidence score. The default is 0.5.
        
         `segment_classification`
         : (boolean) Set to true to request
           segment-level classification. AutoML Video Intelligence returns
           labels and their confidence scores for the entire segment of the
           video that user specified in the request configuration.
           The default is true.
        
         `shot_classification`
         : (boolean) Set to true to request shot-level
           classification. AutoML Video Intelligence determines the boundaries
           for each camera shot in the entire segment of the video that user
           specified in the request configuration. AutoML Video Intelligence
           then returns labels and their confidence scores for each detected
           shot, along with the start and end time of the shot.
           The default is false.
        
           WARNING: Model evaluation is not done for this classification type,
           the quality of it depends on training data, but there are no metrics
           provided to describe that quality.
        
         `1s_interval_classification`
         : (boolean) Set to true to request
           classification for a video at one-second intervals. AutoML Video
           Intelligence returns labels and their confidence scores for each
           second of the entire segment of the video that user specified in the
           request configuration. The default is false.
        
           WARNING: Model evaluation is not done for this classification
           type, the quality of it depends on training data, but there are no
           metrics provided to describe that quality.
        
         AutoML Video Intelligence Object Tracking
        
         `score_threshold`
         : (float) When Model detects objects on video frames,
           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) The maximum number of bounding
           boxes returned per image. The default is 100, the
           number of bounding boxes returned might be limited by the server.
        
         `min_bounding_box_size`
         : (float) Only bounding boxes with shortest edge
           at least that long as a relative value of video frame size are
           returned. Value in 0 to 1 range. Default is 0.
         
        map<string, string> params = 5;
      • getParamsOrThrow

        String getParamsOrThrow​(String key)
         Additional domain-specific parameters for the predictions, any string must
         be up to 25000 characters long.
        
         AutoML Natural Language Classification
        
         `score_threshold`
         : (float) A value from 0.0 to 1.0. When the model
           makes predictions for a text snippet, it will only produce results
           that have at least this confidence score. The default is 0.5.
        
        
         AutoML Vision 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.
        
         AutoML Vision 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) The maximum number of bounding
           boxes returned per image. The default is 100, the
           number of bounding boxes returned might be limited by the server.
         AutoML Video Intelligence Classification
        
         `score_threshold`
         : (float) A value from 0.0 to 1.0. When the model
           makes predictions for a video, it will only produce results that
           have at least this confidence score. The default is 0.5.
        
         `segment_classification`
         : (boolean) Set to true to request
           segment-level classification. AutoML Video Intelligence returns
           labels and their confidence scores for the entire segment of the
           video that user specified in the request configuration.
           The default is true.
        
         `shot_classification`
         : (boolean) Set to true to request shot-level
           classification. AutoML Video Intelligence determines the boundaries
           for each camera shot in the entire segment of the video that user
           specified in the request configuration. AutoML Video Intelligence
           then returns labels and their confidence scores for each detected
           shot, along with the start and end time of the shot.
           The default is false.
        
           WARNING: Model evaluation is not done for this classification type,
           the quality of it depends on training data, but there are no metrics
           provided to describe that quality.
        
         `1s_interval_classification`
         : (boolean) Set to true to request
           classification for a video at one-second intervals. AutoML Video
           Intelligence returns labels and their confidence scores for each
           second of the entire segment of the video that user specified in the
           request configuration. The default is false.
        
           WARNING: Model evaluation is not done for this classification
           type, the quality of it depends on training data, but there are no
           metrics provided to describe that quality.
        
         AutoML Video Intelligence Object Tracking
        
         `score_threshold`
         : (float) When Model detects objects on video frames,
           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) The maximum number of bounding
           boxes returned per image. The default is 100, the
           number of bounding boxes returned might be limited by the server.
        
         `min_bounding_box_size`
         : (float) Only bounding boxes with shortest edge
           at least that long as a relative value of video frame size are
           returned. Value in 0 to 1 range. Default is 0.
         
        map<string, string> params = 5;