Package com.google.cloud.automl.v1beta1

Class BatchPredictRequest

  • All Implemented Interfaces:
    BatchPredictRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class BatchPredictRequest
extends com.google.protobuf.GeneratedMessageV3
implements BatchPredictRequestOrBuilder
     Request message for [PredictionService.BatchPredict][google.cloud.automl.v1beta1.PredictionService.BatchPredict].
    Protobuf type google.cloud.automl.v1beta1.BatchPredictRequest
    See Also:
    Serialized Form

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public 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) = { ... }
        Specified by:
        getName in interface BatchPredictRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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) = { ... }
        Specified by:
        getNameBytes in interface BatchPredictRequestOrBuilder
        Returns:
        The bytes for name.

      • hasInputConfig

        public boolean hasInputConfig()
         Required. The input configuration for batch prediction.
        .google.cloud.automl.v1beta1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasInputConfig in interface BatchPredictRequestOrBuilder
        Returns:
        Whether the inputConfig field is set.

      • getInputConfig

        public BatchPredictInputConfig getInputConfig()
         Required. The input configuration for batch prediction.
        .google.cloud.automl.v1beta1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfig in interface BatchPredictRequestOrBuilder
        Returns:
        The inputConfig.

      • hasOutputConfig

        public boolean hasOutputConfig()
         Required. The Configuration specifying where output predictions should
 be written.
        .google.cloud.automl.v1beta1.BatchPredictOutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasOutputConfig in interface BatchPredictRequestOrBuilder
        Returns:
        Whether the outputConfig field is set.

      • getOutputConfig

        public BatchPredictOutputConfig getOutputConfig()
         Required. The Configuration specifying where output predictions should
 be written.
        .google.cloud.automl.v1beta1.BatchPredictOutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOutputConfig in interface BatchPredictRequestOrBuilder
        Returns:
        The outputConfig.

      • getParamsCount

        public int getParamsCount()
        Description copied from interface: BatchPredictRequestOrBuilder
         Required. Additional domain-specific parameters for the predictions, any string must
 be up to 25000 characters long.

 *  For Text 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.

 *  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 produced per image. Default is 100, the
        requested value may be limited by server.

 *  For Video 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.
        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. The default is "false".
    `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.
        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. The default is
        "false".

 *  For Tables:

    feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
        should be populated in the returned TablesAnnotations. The
        default is false.

 *  For Video 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) No more than this number of bounding
        boxes will be returned per frame. Default is 100, the requested
        value may be limited by server.
    `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
      at least that long as a relative value of video frame size will be
      returned. Value in 0 to 1 range. Default is 0.
        map<string, string> params = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getParamsCount in interface BatchPredictRequestOrBuilder

      • containsParams

        public boolean containsParams​(String key)
         Required. Additional domain-specific parameters for the predictions, any string must
 be up to 25000 characters long.

 *  For Text 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.

 *  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 produced per image. Default is 100, the
        requested value may be limited by server.

 *  For Video 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.
        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. The default is "false".
    `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.
        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. The default is
        "false".

 *  For Tables:

    feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
        should be populated in the returned TablesAnnotations. The
        default is false.

 *  For Video 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) No more than this number of bounding
        boxes will be returned per frame. Default is 100, the requested
        value may be limited by server.
    `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
      at least that long as a relative value of video frame size will be
      returned. Value in 0 to 1 range. Default is 0.
        map<string, string> params = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        containsParams in interface BatchPredictRequestOrBuilder

      • getParamsMap

        public Map<String,​String> getParamsMap()
         Required. Additional domain-specific parameters for the predictions, any string must
 be up to 25000 characters long.

 *  For Text 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.

 *  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 produced per image. Default is 100, the
        requested value may be limited by server.

 *  For Video 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.
        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. The default is "false".
    `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.
        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. The default is
        "false".

 *  For Tables:

    feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
        should be populated in the returned TablesAnnotations. The
        default is false.

 *  For Video 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) No more than this number of bounding
        boxes will be returned per frame. Default is 100, the requested
        value may be limited by server.
    `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
      at least that long as a relative value of video frame size will be
      returned. Value in 0 to 1 range. Default is 0.
        map<string, string> params = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getParamsMap in interface BatchPredictRequestOrBuilder

      • getParamsOrDefault

        public String getParamsOrDefault​(String key,
                                 String defaultValue)
         Required. Additional domain-specific parameters for the predictions, any string must
 be up to 25000 characters long.

 *  For Text 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.

 *  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 produced per image. Default is 100, the
        requested value may be limited by server.

 *  For Video 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.
        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. The default is "false".
    `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.
        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. The default is
        "false".

 *  For Tables:

    feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
        should be populated in the returned TablesAnnotations. The
        default is false.

 *  For Video 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) No more than this number of bounding
        boxes will be returned per frame. Default is 100, the requested
        value may be limited by server.
    `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
      at least that long as a relative value of video frame size will be
      returned. Value in 0 to 1 range. Default is 0.
        map<string, string> params = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getParamsOrDefault in interface BatchPredictRequestOrBuilder

      • getParamsOrThrow

        public String getParamsOrThrow​(String key)
         Required. Additional domain-specific parameters for the predictions, any string must
 be up to 25000 characters long.

 *  For Text 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.

 *  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 produced per image. Default is 100, the
        requested value may be limited by server.

 *  For Video 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.
        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. The default is "false".
    `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.
        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. The default is
        "false".

 *  For Tables:

    feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
        should be populated in the returned TablesAnnotations. The
        default is false.

 *  For Video 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) No more than this number of bounding
        boxes will be returned per frame. Default is 100, the requested
        value may be limited by server.
    `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
      at least that long as a relative value of video frame size will be
      returned. Value in 0 to 1 range. Default is 0.
        map<string, string> params = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getParamsOrThrow in interface BatchPredictRequestOrBuilder

      • 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 BatchPredictRequest parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<BatchPredictRequest> 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 BatchPredictRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder