Reference documentation and code samples for the Cloud AutoML V1 Client class BatchPredictRequest.
Request message for PredictionService.BatchPredict.
Generated from protobuf message google.cloud.automl.v1.BatchPredictRequest
Namespace
Google \ Cloud \ AutoMl \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Name of the model requested to serve the batch prediction. |
↳ input_config |
BatchPredictInputConfig
Required. The input configuration for batch prediction. |
↳ output_config |
BatchPredictOutputConfig
Required. The Configuration specifying where output predictions should be written. |
↳ params |
array|Google\Protobuf\Internal\MapField
Additional domain-specific parameters for the predictions, any string must be up to 25000 characters long. AutoML Natural Language Classification |
getName
Required. Name of the model requested to serve the batch prediction.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Name of the model requested to serve the batch prediction.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInputConfig
Required. The input configuration for batch prediction.
| Returns | |
|---|---|
| Type | Description |
BatchPredictInputConfig|null |
|
hasInputConfig
clearInputConfig
setInputConfig
Required. The input configuration for batch prediction.
| Parameter | |
|---|---|
| Name | Description |
var |
BatchPredictInputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOutputConfig
Required. The Configuration specifying where output predictions should be written.
| Returns | |
|---|---|
| Type | Description |
BatchPredictOutputConfig|null |
|
hasOutputConfig
clearOutputConfig
setOutputConfig
Required. The Configuration specifying where output predictions should be written.
| Parameter | |
|---|---|
| Name | Description |
var |
BatchPredictOutputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParams
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setParams
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Name of the model requested to serve the batch prediction. Please see PredictionServiceClient::modelName() for help formatting this field. |
inputConfig |
BatchPredictInputConfig
Required. The input configuration for batch prediction. |
outputConfig |
BatchPredictOutputConfig
Required. The Configuration specifying where output predictions should be written. |
params |
array
Additional domain-specific parameters for the predictions, any string must be up to 25000 characters long. AutoML Natural Language Classification
AutoML Vision Classification
AutoML Vision Object Detection
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.
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
|
| Returns | |
|---|---|
| Type | Description |
BatchPredictRequest |
|