Google Cloud Ai Platform V1 Client - Class PredictResponse (0.31.0)

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

Response message for PredictionService.Predict.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ predictions array<Google\Protobuf\Value>

The predictions that are the output of the predictions call. The schema of any single prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's prediction_schema_uri.

↳ deployed_model_id string

ID of the Endpoint's DeployedModel that served this prediction.

↳ model string

Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits.

↳ model_version_id string

Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.

↳ model_display_name string

Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.

↳ metadata Google\Protobuf\Value

Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.

getPredictions

The predictions that are the output of the predictions call.

The schema of any single prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's prediction_schema_uri.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPredictions

The predictions that are the output of the predictions call.

The schema of any single prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's prediction_schema_uri.

Parameter
NameDescription
var array<Google\Protobuf\Value>
Returns
TypeDescription
$this

getDeployedModelId

ID of the Endpoint's DeployedModel that served this prediction.

Returns
TypeDescription
string

setDeployedModelId

ID of the Endpoint's DeployedModel that served this prediction.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getModel

Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits.

Returns
TypeDescription
string

setModel

Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getModelVersionId

Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.

Returns
TypeDescription
string

setModelVersionId

Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getModelDisplayName

Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.

Returns
TypeDescription
string

setModelDisplayName

Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMetadata

Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.

Returns
TypeDescription
Google\Protobuf\Value|null

hasMetadata

clearMetadata

setMetadata

Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.

Parameter
NameDescription
var Google\Protobuf\Value
Returns
TypeDescription
$this