Google Cloud Retail V2 Client - Class PredictionServiceClient (2.1.2)

Reference documentation and code samples for the Google Cloud Retail V2 Client class PredictionServiceClient.

Service Description: Service for making recommendation prediction.

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 \ Retail \ V2 \ 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.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

predict

Makes a recommendation prediction.

The async variant is PredictionServiceClient::predictAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\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\Retail\V2\PredictResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\PredictionServiceClient;
use Google\Cloud\Retail\V2\PredictRequest;
use Google\Cloud\Retail\V2\PredictResponse;
use Google\Cloud\Retail\V2\UserEvent;

/**
 * @param string $placement          Full resource name of the format:
 *                                   `{placement=projects/&#42;/locations/global/catalogs/default_catalog/servingConfigs/*}`
 *                                   or
 *                                   `{placement=projects/&#42;/locations/global/catalogs/default_catalog/placements/*}`.
 *                                   We recommend using the `servingConfigs` resource. `placements` is a legacy
 *                                   resource.
 *                                   The ID of the Recommendations AI serving config or placement.
 *                                   Before you can request predictions from your model, you must create at
 *                                   least one serving config or placement for it. For more information, see
 *                                   [Manage serving configs]
 *                                   (https://cloud.google.com/retail/docs/manage-configs).
 *
 *                                   The full list of available serving configs can be seen at
 *                                   https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
 * @param string $userEventEventType User event type. Allowed values are:
 *
 *                                   * `add-to-cart`: Products being added to cart.
 *                                   * `remove-from-cart`: Products being removed from cart.
 *                                   * `category-page-view`: Special pages such as sale or promotion pages
 *                                   viewed.
 *                                   * `detail-page-view`: Products detail page viewed.
 *                                   * `home-page-view`: Homepage viewed.
 *                                   * `promotion-offered`: Promotion is offered to a user.
 *                                   * `promotion-not-offered`: Promotion is not offered to a user.
 *                                   * `purchase-complete`: User finishing a purchase.
 *                                   * `search`: Product search.
 *                                   * `shopping-cart-page-view`: User viewing a shopping cart.
 * @param string $userEventVisitorId A unique identifier for tracking visitors.
 *
 *                                   For example, this could be implemented with an HTTP cookie, which should be
 *                                   able to uniquely identify a visitor on a single device. This unique
 *                                   identifier should not change if the visitor log in/out of the website.
 *
 *                                   Don't set the field to the same fixed ID for different users. This mixes
 *                                   the event history of those users together, which results in degraded model
 *                                   quality.
 *
 *                                   The field must be a UTF-8 encoded string with a length limit of 128
 *                                   characters. Otherwise, an INVALID_ARGUMENT error is returned.
 *
 *                                   The field should not contain PII or user-data. We recommend to use Google
 *                                   Analytics [Client
 *                                   ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 *                                   for this field.
 */
function predict_sample(
    string $placement,
    string $userEventEventType,
    string $userEventVisitorId
): void {
    // Create a client.
    $predictionServiceClient = new PredictionServiceClient();

    // Prepare the request message.
    $userEvent = (new UserEvent())
        ->setEventType($userEventEventType)
        ->setVisitorId($userEventVisitorId);
    $request = (new PredictRequest())
        ->setPlacement($placement)
        ->setUserEvent($userEvent);

    // 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
{
    $placement = '[PLACEMENT]';
    $userEventEventType = '[EVENT_TYPE]';
    $userEventVisitorId = '[VISITOR_ID]';

    predict_sample($placement, $userEventEventType, $userEventVisitorId);
}

predictAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\PredictRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Retail\V2\PredictResponse>`

static::productName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`catalog`	`string`
`branch`	`string`
`product`	`string`

Returns
Type	Description
`string`	The formatted product 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

product: projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}

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.