public final class BatchPredictRequest extends GeneratedMessageV3 implements BatchPredictRequestOrBuilder
Request message for PredictionService.BatchPredict.
Protobuf type google.cloud.automl.v1beta1.BatchPredictRequest
Static Fields
public static final int INPUT_CONFIG_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
OUTPUT_CONFIG_FIELD_NUMBER
public static final int OUTPUT_CONFIG_FIELD_NUMBER
Field Value
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static BatchPredictRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static BatchPredictRequest.Builder newBuilder()
Returns
newBuilder(BatchPredictRequest prototype)
public static BatchPredictRequest.Builder newBuilder(BatchPredictRequest prototype)
Parameter
Returns
public static BatchPredictRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static BatchPredictRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static BatchPredictRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchPredictRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static BatchPredictRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchPredictRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BatchPredictRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static BatchPredictRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BatchPredictRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static BatchPredictRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static BatchPredictRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchPredictRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<BatchPredictRequest> parser()
Returns
Methods
containsParams(String key)
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public BatchPredictRequest getDefaultInstanceForType()
Returns
public BatchPredictInputConfig getInputConfig()
Required. The input configuration for batch prediction.
.google.cloud.automl.v1beta1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
public BatchPredictInputConfigOrBuilder getInputConfigOrBuilder()
Required. The input configuration for batch prediction.
.google.cloud.automl.v1beta1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
getName()
Required. Name of the model requested to serve the batch prediction.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The name.
|
getNameBytes()
public 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) = { ... }
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];
getOutputConfigOrBuilder()
public BatchPredictOutputConfigOrBuilder getOutputConfigOrBuilder()
Required. The Configuration specifying where output predictions should
be written.
.google.cloud.automl.v1beta1.BatchPredictOutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
getParams()
public Map<String,String> getParams()
Returns
getParamsCount()
public int getParamsCount()
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];
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];
getParamsOrDefault(String key, String defaultValue)
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];
getParamsOrThrow(String key)
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];
getParserForType()
public Parser<BatchPredictRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasInputConfig()
Required. The input configuration for batch prediction.
.google.cloud.automl.v1beta1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the inputConfig field is set.
|
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];
| Type | Description |
| boolean | Whether the outputConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public BatchPredictRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchPredictRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public BatchPredictRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
