Cloud AutoML V1 Client - Class PredictionServiceClient (2.0.1)

Reference documentation and code samples for the Cloud AutoML V1 Client class PredictionServiceClient.

Service Description: AutoML Prediction API.

On any input that is documented to expect a string parameter in snake_case or dash-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.

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 parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ AutoMl \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

batchPredict

Perform a batch prediction. Unlike the online Predict, batch prediction result won't be immediately available in the response. Instead, a long running operation object is returned. User can poll the operation result via GetOperation method. Once the operation is done, BatchPredictResult is returned in the response field.

Available for following ML scenarios:

AutoML Vision Classification
AutoML Vision Object Detection
AutoML Video Intelligence Classification
AutoML Video Intelligence Object Tracking * AutoML Natural Language Classification
AutoML Natural Language Entity Extraction
AutoML Natural Language Sentiment Analysis
AutoML Tables

The async variant is PredictionServiceClient::batchPredictAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AutoMl\V1\BatchPredictRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AutoMl\V1\BatchPredictInputConfig;
use Google\Cloud\AutoMl\V1\BatchPredictOutputConfig;
use Google\Cloud\AutoMl\V1\BatchPredictRequest;
use Google\Cloud\AutoMl\V1\BatchPredictResult;
use Google\Cloud\AutoMl\V1\Client\PredictionServiceClient;
use Google\Cloud\AutoMl\V1\GcsDestination;
use Google\Cloud\AutoMl\V1\GcsSource;
use Google\Rpc\Status;

/**
 * @param string $formattedName                             Name of the model requested to serve the batch prediction. Please see
 *                                                          {@see PredictionServiceClient::modelName()} for help formatting this field.
 * @param string $inputConfigGcsSourceInputUrisElement      Google Cloud Storage URIs to input files, up to 2000
 *                                                          characters long. Accepted forms:
 *                                                          * Full object path, e.g. gs://bucket/directory/object.csv
 * @param string $outputConfigGcsDestinationOutputUriPrefix Google Cloud Storage URI to output directory, up to 2000
 *                                                          characters long.
 *                                                          Accepted forms:
 *                                                          * Prefix path: gs://bucket/directory
 *                                                          The requesting user must have write permission to the bucket.
 *                                                          The directory is created if it doesn't exist.
 */
function batch_predict_sample(
    string $formattedName,
    string $inputConfigGcsSourceInputUrisElement,
    string $outputConfigGcsDestinationOutputUriPrefix
): void {
    // Create a client.
    $predictionServiceClient = new PredictionServiceClient();

    // Prepare the request message.
    $inputConfigGcsSourceInputUris = [$inputConfigGcsSourceInputUrisElement,];
    $inputConfigGcsSource = (new GcsSource())
        ->setInputUris($inputConfigGcsSourceInputUris);
    $inputConfig = (new BatchPredictInputConfig())
        ->setGcsSource($inputConfigGcsSource);
    $outputConfigGcsDestination = (new GcsDestination())
        ->setOutputUriPrefix($outputConfigGcsDestinationOutputUriPrefix);
    $outputConfig = (new BatchPredictOutputConfig())
        ->setGcsDestination($outputConfigGcsDestination);
    $request = (new BatchPredictRequest())
        ->setName($formattedName)
        ->setInputConfig($inputConfig)
        ->setOutputConfig($outputConfig);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $predictionServiceClient->batchPredict($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var BatchPredictResult $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PredictionServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');
    $inputConfigGcsSourceInputUrisElement = '[INPUT_URIS]';
    $outputConfigGcsDestinationOutputUriPrefix = '[OUTPUT_URI_PREFIX]';

    batch_predict_sample(
        $formattedName,
        $inputConfigGcsSourceInputUrisElement,
        $outputConfigGcsDestinationOutputUriPrefix
    );
}

predict

Perform an online prediction. The prediction result is directly returned in the response.

Available for following ML scenarios, and their expected request payloads:

AutoML Vision Classification

An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.

AutoML Vision Object Detection

An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.

AutoML Natural Language Classification

A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB.

AutoML Natural Language Entity Extraction

A TextSnippet up to 10,000 characters, UTF-8 NFC encoded or a document in .PDF, .TIF or .TIFF format with size upto 20MB.

AutoML Natural Language Sentiment Analysis

A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB.

AutoML Translation

A TextSnippet up to 25,000 characters, UTF-8 encoded.

AutoML Tables

A row with column values matching the columns of the model, up to 5MB. Not available for FORECASTING prediction_type.

The async variant is PredictionServiceClient::predictAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AutoMl\V1\PredictRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AutoMl\V1\PredictResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AutoMl\V1\Client\PredictionServiceClient;
use Google\Cloud\AutoMl\V1\ExamplePayload;
use Google\Cloud\AutoMl\V1\PredictRequest;
use Google\Cloud\AutoMl\V1\PredictResponse;

/**
 * @param string $formattedName Name of the model requested to serve the prediction. Please see
 *                              {@see PredictionServiceClient::modelName()} for help formatting this field.
 */
function predict_sample(string $formattedName): void
{
    // Create a client.
    $predictionServiceClient = new PredictionServiceClient();

    // Prepare the request message.
    $payload = new ExamplePayload();
    $request = (new PredictRequest())
        ->setName($formattedName)
        ->setPayload($payload);

    // Call the API and handle any network failures.
    try {
        /** @var PredictResponse $response */
        $response = $predictionServiceClient->predict($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PredictionServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');

    predict_sample($formattedName);
}

batchPredictAsync

Parameters
Name	Description
`request`	`Google\Cloud\AutoMl\V1\BatchPredictRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

predictAsync

Parameters
Name	Description
`request`	`Google\Cloud\AutoMl\V1\PredictRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AutoMl\V1\PredictResponse>`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\LongRunning\Client\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::modelName

Formats a string containing the fully-qualified path to represent a model resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`model`	`string`

Returns
Type	Description
`string`	The formatted model resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

model: projects/{project}/locations/{location}/models/{model}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.