Method: projects.templates.templatePredict

Perform an online prediction using a server-side prompt template

HTTP request

POST https://firebasevertexai.googleapis.com/v1beta/{name=projects/*/templates/*}:templatePredict

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the template to use in the request. projects/project-id/location/location-name/template/template-id

Request body

The request body contains data with the following structure:

JSON representation
{
  "inputs": {
    object
  }
}
Fields
inputs

object (Struct format)

Optional. Client provided data that can be used when rendering the template. When calling via JSON/http surfaces this should be wire compatible with an arbitrary JSON object.

Response body

Response message for [PredictionService.Predict].

If successful, the response body contains data with the following structure:

JSON representation
{
  "predictions": [
    value
  ]
}
Fields
predictions[]

value (Value format)

The outputs of the prediction call.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the OAuth 2.0 Overview.