Google Cloud Retail V2 Client - Class CompletionServiceClient (1.5.0)

Reference documentation and code samples for the Google Cloud Retail V2 Client class CompletionServiceClient.

Service Description: Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

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 \ Retail \ V2 \ Client

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.

completeQuery

Completes the specified prefix with keyword suggestions.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

The async variant is Google\Cloud\Retail\V2\Client\CompletionServiceClient::completeQueryAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\CompleteQueryRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ 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\Cloud\Retail\V2\CompleteQueryResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\CompletionServiceClient;
use Google\Cloud\Retail\V2\CompleteQueryRequest;
use Google\Cloud\Retail\V2\CompleteQueryResponse;

/**
 * @param string $formattedCatalog Catalog for which the completion is performed.
 *
 *                                 Full resource name of catalog, such as
 *                                 `projects/&#42;/locations/global/catalogs/default_catalog`. Please see
 *                                 {@see CompletionServiceClient::catalogName()} for help formatting this field.
 * @param string $query            The query used to generate suggestions.
 *
 *                                 The maximum number of allowed characters is 255.
 */
function complete_query_sample(string $formattedCatalog, string $query): void
{
    // Create a client.
    $completionServiceClient = new CompletionServiceClient();

    // Prepare the request message.
    $request = (new CompleteQueryRequest())
        ->setCatalog($formattedCatalog)
        ->setQuery($query);

    // Call the API and handle any network failures.
    try {
        /** @var CompleteQueryResponse $response */
        $response = $completionServiceClient->completeQuery($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
{
    $formattedCatalog = CompletionServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');
    $query = '[QUERY]';

    complete_query_sample($formattedCatalog, $query);
}

importCompletionData

Bulk import of processed completion dataset.

Request processing is asynchronous. Partial updating is not supported.

The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

The async variant is Google\Cloud\Retail\V2\Client\CompletionServiceClient::importCompletionDataAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\ImportCompletionDataRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ 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\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Retail\V2\BigQuerySource;
use Google\Cloud\Retail\V2\Client\CompletionServiceClient;
use Google\Cloud\Retail\V2\CompletionDataInputConfig;
use Google\Cloud\Retail\V2\ImportCompletionDataRequest;
use Google\Cloud\Retail\V2\ImportCompletionDataResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                    The catalog which the suggestions dataset belongs to.
 *
 *                                                   Format: `projects/1234/locations/global/catalogs/default_catalog`. Please see
 *                                                   {@see CompletionServiceClient::catalogName()} for help formatting this field.
 * @param string $inputConfigBigQuerySourceDatasetId The BigQuery data set to copy the data from with a length limit
 *                                                   of 1,024 characters.
 * @param string $inputConfigBigQuerySourceTableId   The BigQuery table to copy the data from with a length limit of
 *                                                   1,024 characters.
 */
function import_completion_data_sample(
    string $formattedParent,
    string $inputConfigBigQuerySourceDatasetId,
    string $inputConfigBigQuerySourceTableId
): void {
    // Create a client.
    $completionServiceClient = new CompletionServiceClient();

    // Prepare the request message.
    $inputConfigBigQuerySource = (new BigQuerySource())
        ->setDatasetId($inputConfigBigQuerySourceDatasetId)
        ->setTableId($inputConfigBigQuerySourceTableId);
    $inputConfig = (new CompletionDataInputConfig())
        ->setBigQuerySource($inputConfigBigQuerySource);
    $request = (new ImportCompletionDataRequest())
        ->setParent($formattedParent)
        ->setInputConfig($inputConfig);

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

        if ($response->operationSucceeded()) {
            /** @var ImportCompletionDataResponse $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 = CompletionServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');
    $inputConfigBigQuerySourceDatasetId = '[DATASET_ID]';
    $inputConfigBigQuerySourceTableId = '[TABLE_ID]';

    import_completion_data_sample(
        $formattedParent,
        $inputConfigBigQuerySourceDatasetId,
        $inputConfigBigQuerySourceTableId
    );
}

completeQueryAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\CompleteQueryRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

importCompletionDataAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\ImportCompletionDataRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::catalogName

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

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

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

catalog: projects/{project}/locations/{location}/catalogs/{catalog}

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.