Google Cloud Retail V2 Client - Class ModelServiceClient (2.1.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Retail\V2\Client\ModelServiceClient;
use Google\Cloud\Retail\V2\CreateModelRequest;
use Google\Cloud\Retail\V2\Model;
use Google\Rpc\Status;

/**
 * @param string $formattedParent  The parent resource under which to create the model. Format:
 *                                 `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
 *                                 Please see {@see ModelServiceClient::catalogName()} for help formatting this field.
 * @param string $modelName        The fully qualified resource name of the model.
 *
 *                                 Format:
 *                                 `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
 *                                 catalog_id has char limit of 50.
 *                                 recommendation_model_id has char limit of 40.
 * @param string $modelDisplayName The display name of the model.
 *
 *                                 Should be human readable, used to display Recommendation Models in the
 *                                 Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024
 *                                 characters.
 * @param string $modelType        The type of model e.g. `home-page`.
 *
 *                                 Currently supported values: `recommended-for-you`, `others-you-may-like`,
 *                                 `frequently-bought-together`, `page-optimization`, `similar-items`,
 *                                 `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value).
 *
 *
 *                                 This field together with
 *                                 [optimization_objective][google.cloud.retail.v2.Model.optimization_objective]
 *                                 describe model metadata to use to control model training and serving.
 *                                 See https://cloud.google.com/retail/docs/models
 *                                 for more details on what the model metadata control and which combination
 *                                 of parameters are valid. For invalid combinations of parameters (e.g. type
 *                                 = `frequently-bought-together` and optimization_objective = `ctr`), you
 *                                 receive an error 400 if you try to create/update a recommendation with
 *                                 this set of knobs.
 */
function create_model_sample(
    string $formattedParent,
    string $modelName,
    string $modelDisplayName,
    string $modelType
): void {
    // Create a client.
    $modelServiceClient = new ModelServiceClient();

    // Prepare the request message.
    $model = (new Model())
        ->setName($modelName)
        ->setDisplayName($modelDisplayName)
        ->setType($modelType);
    $request = (new CreateModelRequest())
        ->setParent($formattedParent)
        ->setModel($model);

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

        if ($response->operationSucceeded()) {
            /** @var Model $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
{
    $formattedParent = ModelServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');
    $modelName = '[NAME]';
    $modelDisplayName = '[DISPLAY_NAME]';
    $modelType = '[TYPE]';

    create_model_sample($formattedParent, $modelName, $modelDisplayName, $modelType);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\ModelServiceClient;
use Google\Cloud\Retail\V2\DeleteModelRequest;

/**
 * @param string $formattedName The resource name of the [Model][google.cloud.retail.v2.Model] to
 *                              delete. Format:
 *                              `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
 *                              Please see {@see ModelServiceClient::modelName()} for help formatting this field.
 */
function delete_model_sample(string $formattedName): void
{
    // Create a client.
    $modelServiceClient = new ModelServiceClient();

    // Prepare the request message.
    $request = (new DeleteModelRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $modelServiceClient->deleteModel($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[CATALOG]', '[MODEL]');

    delete_model_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\ModelServiceClient;
use Google\Cloud\Retail\V2\GetModelRequest;
use Google\Cloud\Retail\V2\Model;

/**
 * @param string $formattedName The resource name of the [Model][google.cloud.retail.v2.Model] to
 *                              get. Format:
 *                              `projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}`
 *                              Please see {@see ModelServiceClient::modelName()} for help formatting this field.
 */
function get_model_sample(string $formattedName): void
{
    // Create a client.
    $modelServiceClient = new ModelServiceClient();

    // Prepare the request message.
    $request = (new GetModelRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Model $response */
        $response = $modelServiceClient->getModel($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 = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[CATALOG]', '[MODEL]');

    get_model_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Retail\V2\Client\ModelServiceClient;
use Google\Cloud\Retail\V2\ListModelsRequest;
use Google\Cloud\Retail\V2\Model;

/**
 * @param string $formattedParent The parent for which to list models.
 *                                Format:
 *                                `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
 *                                Please see {@see ModelServiceClient::catalogName()} for help formatting this field.
 */
function list_models_sample(string $formattedParent): void
{
    // Create a client.
    $modelServiceClient = new ModelServiceClient();

    // Prepare the request message.
    $request = (new ListModelsRequest())
        ->setParent($formattedParent);

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

        /** @var Model $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
{
    $formattedParent = ModelServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');

    list_models_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\ModelServiceClient;
use Google\Cloud\Retail\V2\Model;
use Google\Cloud\Retail\V2\PauseModelRequest;

/**
 * @param string $formattedName The name of the model to pause.
 *                              Format:
 *                              `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
 *                              Please see {@see ModelServiceClient::modelName()} for help formatting this field.
 */
function pause_model_sample(string $formattedName): void
{
    // Create a client.
    $modelServiceClient = new ModelServiceClient();

    // Prepare the request message.
    $request = (new PauseModelRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Model $response */
        $response = $modelServiceClient->pauseModel($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 = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[CATALOG]', '[MODEL]');

    pause_model_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\ModelServiceClient;
use Google\Cloud\Retail\V2\Model;
use Google\Cloud\Retail\V2\ResumeModelRequest;

/**
 * @param string $name The name of the model to resume.
 *                     Format:
 *                     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
 */
function resume_model_sample(string $name): void
{
    // Create a client.
    $modelServiceClient = new ModelServiceClient();

    // Prepare the request message.
    $request = (new ResumeModelRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var Model $response */
        $response = $modelServiceClient->resumeModel($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
{
    $name = '[NAME]';

    resume_model_sample($name);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Retail\V2\Client\ModelServiceClient;
use Google\Cloud\Retail\V2\TuneModelRequest;
use Google\Cloud\Retail\V2\TuneModelResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the model to tune.
 *                              Format:
 *                              `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
 *                              Please see {@see ModelServiceClient::modelName()} for help formatting this field.
 */
function tune_model_sample(string $formattedName): void
{
    // Create a client.
    $modelServiceClient = new ModelServiceClient();

    // Prepare the request message.
    $request = (new TuneModelRequest())
        ->setName($formattedName);

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

        if ($response->operationSucceeded()) {
            /** @var TuneModelResponse $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 = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[CATALOG]', '[MODEL]');

    tune_model_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\ModelServiceClient;
use Google\Cloud\Retail\V2\Model;
use Google\Cloud\Retail\V2\UpdateModelRequest;

/**
 * @param string $modelName        The fully qualified resource name of the model.
 *
 *                                 Format:
 *                                 `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
 *                                 catalog_id has char limit of 50.
 *                                 recommendation_model_id has char limit of 40.
 * @param string $modelDisplayName The display name of the model.
 *
 *                                 Should be human readable, used to display Recommendation Models in the
 *                                 Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024
 *                                 characters.
 * @param string $modelType        The type of model e.g. `home-page`.
 *
 *                                 Currently supported values: `recommended-for-you`, `others-you-may-like`,
 *                                 `frequently-bought-together`, `page-optimization`, `similar-items`,
 *                                 `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value).
 *
 *
 *                                 This field together with
 *                                 [optimization_objective][google.cloud.retail.v2.Model.optimization_objective]
 *                                 describe model metadata to use to control model training and serving.
 *                                 See https://cloud.google.com/retail/docs/models
 *                                 for more details on what the model metadata control and which combination
 *                                 of parameters are valid. For invalid combinations of parameters (e.g. type
 *                                 = `frequently-bought-together` and optimization_objective = `ctr`), you
 *                                 receive an error 400 if you try to create/update a recommendation with
 *                                 this set of knobs.
 */
function update_model_sample(string $modelName, string $modelDisplayName, string $modelType): void
{
    // Create a client.
    $modelServiceClient = new ModelServiceClient();

    // Prepare the request message.
    $model = (new Model())
        ->setName($modelName)
        ->setDisplayName($modelDisplayName)
        ->setType($modelType);
    $request = (new UpdateModelRequest())
        ->setModel($model);

    // Call the API and handle any network failures.
    try {
        /** @var Model $response */
        $response = $modelServiceClient->updateModel($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
{
    $modelName = '[NAME]';
    $modelDisplayName = '[DISPLAY_NAME]';
    $modelType = '[TYPE]';

    update_model_sample($modelName, $modelDisplayName, $modelType);
}