Package com.google.cloud.automl.v1

Interface PredictRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PredictRequest, PredictRequest.Builder

public interface PredictRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsParams(String key)	Additional domain-specific parameters, any string must be up to 25000 characters long.
String	getName()	Required.
com.google.protobuf.ByteString	getNameBytes()	Required.
Map<String,String>	getParams()	Deprecated.
int	getParamsCount()	Additional domain-specific parameters, any string must be up to 25000 characters long.
Map<String,String>	getParamsMap()	Additional domain-specific parameters, any string must be up to 25000 characters long.
String	getParamsOrDefault(String key, String defaultValue)	Additional domain-specific parameters, any string must be up to 25000 characters long.
String	getParamsOrThrow(String key)	Additional domain-specific parameters, any string must be up to 25000 characters long.
ExamplePayload	getPayload()	Required.
ExamplePayloadOrBuilder	getPayloadOrBuilder()	Required.
boolean	hasPayload()	Required.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getName

String getName()

 Required. Name of the model requested to serve the prediction.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. Name of the model requested to serve the prediction.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for name.

hasPayload

boolean hasPayload()

 Required. Payload to perform a prediction on. The payload must match the
 problem type that the model was trained to solve.
 

.google.cloud.automl.v1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the payload field is set.

getPayload

ExamplePayload getPayload()

 Required. Payload to perform a prediction on. The payload must match the
 problem type that the model was trained to solve.
 

.google.cloud.automl.v1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The payload.

getPayloadOrBuilder

ExamplePayloadOrBuilder getPayloadOrBuilder()

 Required. Payload to perform a prediction on. The payload must match the
 problem type that the model was trained to solve.
 

.google.cloud.automl.v1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];

getParamsCount

int getParamsCount()

 Additional domain-specific parameters, any string must be up to 25000
 characters long.

 AutoML Vision Classification

 `score_threshold`
 : (float) A value from 0.0 to 1.0. When the model
   makes predictions for an image, it will only produce results that have
   at least this confidence score. The default is 0.5.

 AutoML Vision Object Detection

 `score_threshold`
 : (float) When Model detects objects on the image,
   it will only produce bounding boxes which have at least this
   confidence score. Value in 0 to 1 range, default is 0.5.

 `max_bounding_box_count`
 : (int64) The maximum number of bounding
   boxes returned. The default is 100. The
   number of returned bounding boxes might be limited by the server.

 AutoML Tables

 `feature_importance`
 : (boolean) Whether
 [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
   is populated in the returned list of
   [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
   objects. The default is false.
 

map<string, string> params = 3;

containsParams

boolean containsParams(String key)

 Additional domain-specific parameters, any string must be up to 25000
 characters long.

 AutoML Vision Classification

 `score_threshold`
 : (float) A value from 0.0 to 1.0. When the model
   makes predictions for an image, it will only produce results that have
   at least this confidence score. The default is 0.5.

 AutoML Vision Object Detection

 `score_threshold`
 : (float) When Model detects objects on the image,
   it will only produce bounding boxes which have at least this
   confidence score. Value in 0 to 1 range, default is 0.5.

 `max_bounding_box_count`
 : (int64) The maximum number of bounding
   boxes returned. The default is 100. The
   number of returned bounding boxes might be limited by the server.

 AutoML Tables

 `feature_importance`
 : (boolean) Whether
 [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
   is populated in the returned list of
   [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
   objects. The default is false.
 

map<string, string> params = 3;

getParams

@Deprecated
Map<String,String> getParams()

Deprecated.

Use getParamsMap() instead.

getParamsMap

Map<String,String> getParamsMap()

 Additional domain-specific parameters, any string must be up to 25000
 characters long.

 AutoML Vision Classification

 `score_threshold`
 : (float) A value from 0.0 to 1.0. When the model
   makes predictions for an image, it will only produce results that have
   at least this confidence score. The default is 0.5.

 AutoML Vision Object Detection

 `score_threshold`
 : (float) When Model detects objects on the image,
   it will only produce bounding boxes which have at least this
   confidence score. Value in 0 to 1 range, default is 0.5.

 `max_bounding_box_count`
 : (int64) The maximum number of bounding
   boxes returned. The default is 100. The
   number of returned bounding boxes might be limited by the server.

 AutoML Tables

 `feature_importance`
 : (boolean) Whether
 [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
   is populated in the returned list of
   [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
   objects. The default is false.
 

map<string, string> params = 3;

getParamsOrDefault

String getParamsOrDefault(String key,
                          String defaultValue)

 Additional domain-specific parameters, any string must be up to 25000
 characters long.

 AutoML Vision Classification

 `score_threshold`
 : (float) A value from 0.0 to 1.0. When the model
   makes predictions for an image, it will only produce results that have
   at least this confidence score. The default is 0.5.

 AutoML Vision Object Detection

 `score_threshold`
 : (float) When Model detects objects on the image,
   it will only produce bounding boxes which have at least this
   confidence score. Value in 0 to 1 range, default is 0.5.

 `max_bounding_box_count`
 : (int64) The maximum number of bounding
   boxes returned. The default is 100. The
   number of returned bounding boxes might be limited by the server.

 AutoML Tables

 `feature_importance`
 : (boolean) Whether
 [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
   is populated in the returned list of
   [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
   objects. The default is false.
 

map<string, string> params = 3;

getParamsOrThrow

String getParamsOrThrow(String key)

 Additional domain-specific parameters, any string must be up to 25000
 characters long.

 AutoML Vision Classification

 `score_threshold`
 : (float) A value from 0.0 to 1.0. When the model
   makes predictions for an image, it will only produce results that have
   at least this confidence score. The default is 0.5.

 AutoML Vision Object Detection

 `score_threshold`
 : (float) When Model detects objects on the image,
   it will only produce bounding boxes which have at least this
   confidence score. Value in 0 to 1 range, default is 0.5.

 `max_bounding_box_count`
 : (int64) The maximum number of bounding
   boxes returned. The default is 100. The
   number of returned bounding boxes might be limited by the server.

 AutoML Tables

 `feature_importance`
 : (boolean) Whether
 [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
   is populated in the returned list of
   [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
   objects. The default is false.
 

map<string, string> params = 3;