google/cloud-recommendations-ai

Google Cloud Recommendation Engine Client for PHP

v0.7.7 2024-12-12 21:15 UTC

Requires

• php: ^8.0
• google/gax: ^1.36.0

Requires (Dev)

• phpunit/phpunit: ^9.0

Suggests

• ext-grpc: Enables use of gRPC, a universal high-performance RPC framework created by Google.
• ext-protobuf: Provides a significant increase in throughput over the pure PHP protobuf implementation. See https://cloud.google.com/php/grpc for installation instructions.

Apache-2.0

README

Idiomatic PHP client for Google Cloud Recommendations AI.

• API documentation

NOTE: This repository is part of Google Cloud PHP. Any support requests, bug reports, or development contributions should be directed to that project.

Installation

To begin, install the preferred dependency manager for PHP, Composer.

Now install this component:

$ composer require google/cloud-recommendations-ai

This component supports both REST over HTTP/1.1 and gRPC. In order to take advantage of the benefits offered by gRPC (such as streaming methods) please see our gRPC installation guide.

Authentication

Please see our Authentication guide for more information on authenticating your client. Once authenticated, you'll be ready to start making requests.

Sample

use Google\Cloud\RecommendationEngine\V1beta1\PredictionServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\UserEvent;

$client = new PredictionServiceClient();
$formattedName = $predictionServiceClient->placementName(
    '[PROJECT]',
    '[LOCATION]',
    '[CATALOG]',
    '[EVENT_STORE]',
    '[PLACEMENT]'
);
$userEvent = new UserEvent();

$predictions = $predictionServiceClient->predict($formattedName, $userEvent);

Debugging

Please see our Debugging guide for more information about the debugging tools.

Version

This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority.

Next Steps

1. Understand the official documentation.