Google Cloud Recommendation Engine V1beta1 Client - Class PredictionServiceClient (0.7.0)

Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 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. Sample code to get started:

$predictionServiceClient = new PredictionServiceClient();
try {
    $formattedName = $predictionServiceClient->placementName('[PROJECT]', '[LOCATION]', '[CATALOG]', '[EVENT_STORE]', '[PLACEMENT]');
    $userEvent = new UserEvent();
    // Iterate over pages of elements
    $pagedResponse = $predictionServiceClient->predict($formattedName, $userEvent);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $predictionServiceClient->predict($formattedName, $userEvent);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $predictionServiceClient->close();
}

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 \ RecommendationEngine \ V1beta1

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.

predict

Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. Learn more.

Parameters
Name	Description
`name`	`string` Required. Full resource name of the format: `{name=projects//locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/}` The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
`userEvent`	`Google\Cloud\RecommendationEngine\V1beta1\UserEvent` Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging.
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ filter`	`string` Optional. Filter for restricting prediction results. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-"tagA"` is also supported and is equivalent to `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB. * filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-"promotional") * filterOutOfStockItems
`↳ dryRun`	`bool` Optional. Use dryRun mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary catalog items. Note that the dryRun mode should only be used for testing the API, or if the model is not ready.
`↳ params`	`array` Optional. Additional domain specific parameters for the predictions. Allowed values: * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem object will be returned in the `PredictResponse.PredictionResult.itemMetadata` object in the method response. * `returnItemScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the `metadata` field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
`↳ labels`	`array` Optional. The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.
`↳ 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\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\RecommendationEngine\V1beta1\Client\PredictionServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\PredictRequest;
use Google\Cloud\RecommendationEngine\V1beta1\PredictResponse\PredictionResult;
use Google\Cloud\RecommendationEngine\V1beta1\UserEvent;
use Google\Cloud\RecommendationEngine\V1beta1\UserInfo;

/**
 * @param string $formattedName              Full resource name of the format:
 *                                           `{name=projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}`
 *                                           The id of the recommendation engine placement. This id is used to identify
 *                                           the set of models that will be used to make the prediction.
 *
 *                                           We currently support three placements with the following IDs by default:
 *
 *                                           * `shopping_cart`: Predicts items frequently bought together with one or
 *                                           more catalog items in the same shopping session. Commonly displayed after
 *                                           `add-to-cart` events, on product detail pages, or on the shopping cart
 *                                           page.
 *
 *                                           * `home_page`: Predicts the next product that a user will most likely
 *                                           engage with or purchase based on the shopping or viewing history of the
 *                                           specified `userId` or `visitorId`. For example - Recommendations for you.
 *
 *                                           * `product_detail`: Predicts the next product that a user will most likely
 *                                           engage with or purchase. The prediction is based on the shopping or
 *                                           viewing history of the specified `userId` or `visitorId` and its
 *                                           relevance to a specified `CatalogItem`. Typically used on product detail
 *                                           pages. For example - More items like this.
 *
 *                                           * `recently_viewed_default`: Returns up to 75 items recently viewed by the
 *                                           specified `userId` or `visitorId`, most recent ones first. Returns
 *                                           nothing if neither of them has viewed any items yet. For example -
 *                                           Recently viewed.
 *
 *                                           The full list of available placements can be seen at
 *                                           https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
 *                                           Please see {@see PredictionServiceClient::placementName()} for help formatting this field.
 * @param string $userEventEventType         User event type. Allowed values are:
 *
 *                                           * `add-to-cart` Products being added to cart.
 *                                           * `add-to-list` Items being added to a list (shopping list, favorites
 *                                           etc).
 *                                           * `category-page-view` Special pages such as sale or promotion pages
 *                                           viewed.
 *                                           * `checkout-start` User starting a checkout process.
 *                                           * `detail-page-view` Products detail page viewed.
 *                                           * `home-page-view` Homepage viewed.
 *                                           * `page-visit` Generic page visits not included in the event types above.
 *                                           * `purchase-complete` User finishing a purchase.
 *                                           * `refund` Purchased items being refunded or returned.
 *                                           * `remove-from-cart` Products being removed from cart.
 *                                           * `remove-from-list` Items being removed from a list.
 *                                           * `search` Product search.
 *                                           * `shopping-cart-page-view` User viewing a shopping cart.
 *                                           * `impression` List of items displayed. Used by Google Tag Manager.
 * @param string $userEventUserInfoVisitorId A unique identifier for tracking visitors with a length limit of
 *                                           128 bytes.
 *
 *                                           For example, this could be implemented with a 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.
 *                                           Maximum length 128 bytes. Cannot be empty.
 */
function predict_sample(
    string $formattedName,
    string $userEventEventType,
    string $userEventUserInfoVisitorId
): void {
    // Create a client.
    $predictionServiceClient = new PredictionServiceClient();

    // Prepare the request message.
    $userEventUserInfo = (new UserInfo())
        ->setVisitorId($userEventUserInfoVisitorId);
    $userEvent = (new UserEvent())
        ->setEventType($userEventEventType)
        ->setUserInfo($userEventUserInfo);
    $request = (new PredictRequest())
        ->setName($formattedName)
        ->setUserEvent($userEvent);

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

        /** @var PredictionResult $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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::placementName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[EVENT_STORE]',
        '[PLACEMENT]'
    );
    $userEventEventType = '[EVENT_TYPE]';
    $userEventUserInfoVisitorId = '[VISITOR_ID]';

    predict_sample($formattedName, $userEventEventType, $userEventUserInfoVisitorId);
}

static::placementName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`catalog`	`string`
`eventStore`	`string`
`placement`	`string`

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

placement: projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement}

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.

Constants

SERVICE_NAME

Value: 'google.cloud.recommendationengine.v1beta1.PredictionService'

The name of the service.

SERVICE_ADDRESS

Value: 'recommendationengine.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.