Cloud AutoML V1 Client - Class PredictRequest (1.5.4)

Reference documentation and code samples for the Cloud AutoML V1 Client class PredictRequest.

Request message for PredictionService.Predict.

Generated from protobuf message google.cloud.automl.v1.PredictRequest

Namespace

Google \ Cloud \ AutoMl \ V1

Methods

__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 prediction.
`↳ payload`	`Google\Cloud\AutoMl\V1\ExamplePayload` Required. Payload to perform a prediction on. The payload must match the problem type that the model was trained to solve.
`↳ params`	`array\|Google\Protobuf\Internal\MapField` Additional domain-specific parameters, any string must be up to 25000 characters long. 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. The default is 100. The number of returned bounding boxes might be limited by the server. AutoML Tables `feature_importance` : (boolean) Whether feature_importance is populated in the returned list of TablesAnnotation objects. The default is false.

getName

Required. Name of the model requested to serve the prediction.

Returns
Type	Description
`string`

setName

Required. Name of the model requested to serve the prediction.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPayload

Required. Payload to perform a prediction on. The payload must match the problem type that the model was trained to solve.

Returns
Type	Description
`Google\Cloud\AutoMl\V1\ExamplePayload\|null`

hasPayload

clearPayload

setPayload

Required. Payload to perform a prediction on. The payload must match the problem type that the model was trained to solve.

Parameter
Name	Description
`var`	`Google\Cloud\AutoMl\V1\ExamplePayload`

Returns
Type	Description
`$this`

getParams

Additional domain-specific parameters, any string must be up to 25000 characters long.

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. The default is 100. The number of returned bounding boxes might be limited by the server. AutoML Tables feature_importance : (boolean) Whether feature_importance is populated in the returned list of TablesAnnotation objects. The default is false.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setParams

Additional domain-specific parameters, any string must be up to 25000 characters long.

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 prediction. Please see Google\Cloud\AutoMl\V1\PredictionServiceClient::modelName() for help formatting this field.
`payload`	`Google\Cloud\AutoMl\V1\ExamplePayload` Required. Payload to perform a prediction on. The payload must match the problem type that the model was trained to solve.
`params`	`array` Additional domain-specific parameters, any string must be up to 25000 characters long. 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. The default is 100. The number of returned bounding boxes might be limited by the server. AutoML Tables `feature_importance` : (boolean) Whether feature_importance is populated in the returned list of TablesAnnotation objects. The default is false.

Returns
Type	Description
`Google\Cloud\AutoMl\V1\PredictRequest`