com.google.cloud.automl.v1

Class PredictionServiceClient

java.lang.Object

com.google.cloud.automl.v1.PredictionServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class PredictionServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: AutoML Prediction API.

On any input that is documented to expect a string parameter in snake_case or kebab-case, either of those cases is accepted.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   ExamplePayload payload = ExamplePayload.newBuilder().build();
   Map<String, String> params = new HashMap<>();
   PredictResponse response = predictionServiceClient.predict(name, payload, params);
 }
 
 

Note: close() needs to be called on the predictionServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of PredictionServiceSettings to create(). For example:

To customize credentials:

 
 PredictionServiceSettings predictionServiceSettings =
     PredictionServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PredictionServiceClient predictionServiceClient =
     PredictionServiceClient.create(predictionServiceSettings);
 
 

To customize the endpoint:

 
 PredictionServiceSettings predictionServiceSettings =
     PredictionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PredictionServiceClient predictionServiceClient =
     PredictionServiceClient.create(predictionServiceSettings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PredictionServiceClient(PredictionServiceSettings settings) Constructs an instance of PredictionServiceClient, using the given settings.
protected	PredictionServiceClient(PredictionServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static PredictionServiceClient	create() Constructs an instance of PredictionServiceClient with default settings.
static PredictionServiceClient	create(PredictionServiceSettings settings) Constructs an instance of PredictionServiceClient, using the given settings.
static PredictionServiceClient	create(PredictionServiceStub stub) Constructs an instance of PredictionServiceClient, using the given stub for making calls.
PredictionServiceSettings	getSettings()
PredictionServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
PredictResponse	predict(ModelName name, ExamplePayload payload, Map<String,String> params) Perform an online prediction.
PredictResponse	predict(PredictRequest request) Perform an online prediction.
PredictResponse	predict(String name, ExamplePayload payload, Map<String,String> params) Perform an online prediction.
com.google.api.gax.rpc.UnaryCallable<PredictRequest,PredictResponse>	predictCallable() Perform an online prediction.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PredictionServiceClient

protected PredictionServiceClient(PredictionServiceSettings settings)
                           throws IOException

Constructs an instance of PredictionServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

PredictionServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected PredictionServiceClient(PredictionServiceStub stub)

Method Detail

create

public static final PredictionServiceClient create()
                                            throws IOException

Constructs an instance of PredictionServiceClient with default settings.

Throws:

IOException

create

public static final PredictionServiceClient create(PredictionServiceSettings settings)
                                            throws IOException

Constructs an instance of PredictionServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final PredictionServiceClient create(PredictionServiceStub stub)

Constructs an instance of PredictionServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use PredictionServiceSettings}.

getSettings

public final PredictionServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public PredictionServiceStub getStub()

predict

public final PredictResponse predict(ModelName name,
                                     ExamplePayload payload,
                                     Map<String,String> params)

Perform an online prediction. The prediction result will be directly returned in the response. Available for following ML problems, and their expected request payloads: * Translation - TextSnippet, content up to 25,000 characters, UTF-8 encoded.

Sample code:

 try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   ExamplePayload payload = ExamplePayload.newBuilder().build();
   Map<String, String> params = new HashMap<>();
   PredictResponse response = predictionServiceClient.predict(name, payload, params);
 }
 

Parameters:

name - Name of the model requested to serve the prediction.

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.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

predict

public final PredictResponse predict(String name,
                                     ExamplePayload payload,
                                     Map<String,String> params)

Perform an online prediction. The prediction result will be directly returned in the response. Available for following ML problems, and their expected request payloads: * Translation - TextSnippet, content up to 25,000 characters, UTF-8 encoded.

Sample code:

 try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   ExamplePayload payload = ExamplePayload.newBuilder().build();
   Map<String, String> params = new HashMap<>();
   PredictResponse response = predictionServiceClient.predict(name.toString(), payload, params);
 }
 

Parameters:

name - Name of the model requested to serve the prediction.

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.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

predict

public final PredictResponse predict(PredictRequest request)

Perform an online prediction. The prediction result will be directly returned in the response. Available for following ML problems, and their expected request payloads: * Translation - TextSnippet, content up to 25,000 characters, UTF-8 encoded.

Sample code:

 try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   ExamplePayload payload = ExamplePayload.newBuilder().build();
   PredictRequest request = PredictRequest.newBuilder()
     .setName(name.toString())
     .setPayload(payload)
     .build();
   PredictResponse response = predictionServiceClient.predict(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

predictCallable

public final com.google.api.gax.rpc.UnaryCallable<PredictRequest,PredictResponse> predictCallable()

Perform an online prediction. The prediction result will be directly returned in the response. Available for following ML problems, and their expected request payloads: * Translation - TextSnippet, content up to 25,000 characters, UTF-8 encoded.

Sample code:

 try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   ExamplePayload payload = ExamplePayload.newBuilder().build();
   PredictRequest request = PredictRequest.newBuilder()
     .setName(name.toString())
     .setPayload(payload)
     .build();
   ApiFuture<PredictResponse> future = predictionServiceClient.predictCallable().futureCall(request);
   // Do something
   PredictResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException