Google Cloud Retail V2 Client - Class PredictionServiceClient (1.7.0)

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/*/locations/global/catalogs/default_catalog/servingConfigs/*}`
 *                                   or
 *                                   `{placement=projects/*/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);
}