- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- ExamplePayload
- AnnotationPayload
- ClassificationAnnotation
- VideoClassificationAnnotation
- TimeSegment
Not available for AutoML Video Intelligence.
HTTP request
POST https://automl.googleapis.com/v1beta1/{name}:predict
Path parameters
Parameters | |
---|---|
name |
Name of the model requested to serve the prediction. Authorization requires the following Google IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{
"payload": {
object( |
Fields | |
---|---|
payload |
Required. Payload to perform a prediction on. The payload must match the problem type that the model was trained to solve. |
params |
Additional domain-specific parameters, any string must be up to 25000 characters long. |
Response body
If successful, the response body contains data with the following structure:
Response message for PredictionService.Predict
.
JSON representation | |
---|---|
{
"payload": [
{
object( |
Fields | |
---|---|
payload[] |
Prediction result. |
metadata |
Additional domain-specific prediction response metadata. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
ExamplePayload
Example data used for training or prediction.
AnnotationPayload
Contains annotation information that is relevant to AutoML.
JSON representation | |
---|---|
{ "annotationSpecId": string, "displayName": string, // Union field |
Fields | ||
---|---|---|
annotationSpecId |
Output only . The resource ID of the annotation spec that this annotation pertains to. The annotation spec comes from either an ancestor dataset, or the dataset that was used to train the model in use. |
|
displayName |
Output only. The value of |
|
Union field detail . Output only . Additional information about the annotation specific to the AutoML domain. detail can be only one of the following: |
||
classification |
Annotation details for classification predictions. |
|
videoClassification |
Annotation details for video classification. Returned for Video Classification predictions. |
ClassificationAnnotation
Contains annotation details specific to classification.
JSON representation | |
---|---|
{ "score": number } |
Fields | |
---|---|
score |
Output only. A confidence estimate between 0.0 and 1.0. A higher value means greater confidence that the annotation is positive. If a user approves an annotation as negative or positive, the score value remains unchanged. If a user creates an annotation, the score is 0 for negative or 1 for positive. |
VideoClassificationAnnotation
Contains annotation details specific to video classification.
JSON representation | |
---|---|
{ "type": string, "classificationAnnotation": { object( |
Fields | |
---|---|
type |
Output only. Expresses the type of video classification. Possible values:
|
classificationAnnotation |
Output only . The classification details of this annotation. |
timeSegment |
Output only . The time segment of the video to which the annotation applies. |
TimeSegment
A time period inside of an example that has a time dimension (e.g. video).
JSON representation | |
---|---|
{ "startTimeOffset": string, "endTimeOffset": string } |
Fields | |
---|---|
startTimeOffset |
Start of the time segment (inclusive), represented as the duration since the example start. A duration in seconds with up to nine fractional digits, terminated by ' |
endTimeOffset |
End of the time segment (exclusive), represented as the duration since the example start. A duration in seconds with up to nine fractional digits, terminated by ' |