Google Cloud Ai Platform V1 Client - Class PredictRequest (1.12.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PredictRequest.

Request message for PredictionService.Predict.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ endpoint`	`string` Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
`↳ instances`	`array<Google\Protobuf\Value>` Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
`↳ parameters`	`Google\Protobuf\Value` The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

getEndpoint

Required. The name of the Endpoint requested to serve the prediction.

Format: projects/{project}/locations/{location}/endpoints/{endpoint}

Returns
Type	Description
`string`

setEndpoint

Required. The name of the Endpoint requested to serve the prediction.

Format: projects/{project}/locations/{location}/endpoints/{endpoint}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInstances

Required. The instances that are the input to the prediction call.

A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

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

setInstances

Required. The instances that are the input to the prediction call.

Parameter
Name	Description
`var`	`array<Google\Protobuf\Value>`

Returns
Type	Description
`$this`

getParameters

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

Returns
Type	Description
`Google\Protobuf\Value\|null`

hasParameters

clearParameters

setParameters

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

Parameter
Name	Description
`var`	`Google\Protobuf\Value`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`endpoint`	`string` Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` Please see PredictionServiceClient::endpointName() for help formatting this field.
`instances`	`array<Google\Protobuf\Value>` Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
`parameters`	`Google\Protobuf\Value` The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

Returns
Type	Description
`PredictRequest`