Method: endpoints.predict

Full name: projects.locations.endpoints.predict

Perform an online prediction.

Endpoint

post

https:  
/  
/{service-endpoint}  
/v1  
/{endpoint}:predict

Where {service-endpoint} is one of the supported service endpoints .

Path parameters

endpoint string

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

Request body

The request body contains data with the following structure:

Fields

instances[]

value (  Value 
 
format)

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 instanceSchemaUri .

parameters

value (  Value 
 
format)

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

labels map (key: string, value: string)

Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.

Response body

If successful, the response body contains an instance of PredictResponse .