Google Cloud Discovery Engine V1 Client - Class SearchTuningServiceClient (1.3.1)

Namespace

Methods

__construct

listCustomModels

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\SearchTuningServiceClient;
use Google\Cloud\DiscoveryEngine\V1\ListCustomModelsRequest;
use Google\Cloud\DiscoveryEngine\V1\ListCustomModelsResponse;

/**
 * @param string $formattedDataStore The resource name of the parent Data Store, such as
 *                                   `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
 *                                   This field is used to identify the data store where to fetch the models
 *                                   from. Please see
 *                                   {@see SearchTuningServiceClient::dataStoreName()} for help formatting this field.
 */
function list_custom_models_sample(string $formattedDataStore): void
{
    // Create a client.
    $searchTuningServiceClient = new SearchTuningServiceClient();

    // Prepare the request message.
    $request = (new ListCustomModelsRequest())
        ->setDataStore($formattedDataStore);

    // Call the API and handle any network failures.
    try {
        /** @var ListCustomModelsResponse $response */
        $response = $searchTuningServiceClient->listCustomModels($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
{
    $formattedDataStore = SearchTuningServiceClient::dataStoreName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]'
    );

    list_custom_models_sample($formattedDataStore);
}

trainCustomModel

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\SearchTuningServiceClient;
use Google\Cloud\DiscoveryEngine\V1\TrainCustomModelRequest;
use Google\Cloud\DiscoveryEngine\V1\TrainCustomModelResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedDataStore The resource name of the Data Store, such as
 *                                   `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
 *                                   This field is used to identify the data store where to train the models. Please see
 *                                   {@see SearchTuningServiceClient::dataStoreName()} for help formatting this field.
 */
function train_custom_model_sample(string $formattedDataStore): void
{
    // Create a client.
    $searchTuningServiceClient = new SearchTuningServiceClient();

    // Prepare the request message.
    $request = (new TrainCustomModelRequest())
        ->setDataStore($formattedDataStore);

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

        if ($response->operationSucceeded()) {
            /** @var TrainCustomModelResponse $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
{
    $formattedDataStore = SearchTuningServiceClient::dataStoreName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]'
    );

    train_custom_model_sample($formattedDataStore);
}

listCustomModelsAsync

trainCustomModelAsync

getOperationsClient

resumeOperation

static::dataStoreName

static::projectLocationCollectionDataStoreName

static::projectLocationDataStoreName

static::parseName