Google Cloud Discovery Engine V1 Client - Class CompletionServiceClient (1.2.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CompletionServiceClient.

Service Description: Service for Auto-Completion.

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 \ DiscoveryEngine \ V1 \ 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 user input with keyword suggestions.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\CompletionServiceClient::completeQueryAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\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\DiscoveryEngine\V1\CompleteQueryResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\CompletionServiceClient;
use Google\Cloud\DiscoveryEngine\V1\CompleteQueryRequest;
use Google\Cloud\DiscoveryEngine\V1\CompleteQueryResponse;

/**
 * @param string $formattedDataStore The parent data store resource name for which the completion is
 *                                   performed, such as
 *                                   `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. Please see
 *                                   {@see CompletionServiceClient::dataStoreName()} for help formatting this field.
 * @param string $query              The typeahead input used to fetch suggestions. Maximum length is
 *                                   128 characters.
 */
function complete_query_sample(string $formattedDataStore, string $query): void
{
    // Create a client.
    $completionServiceClient = new CompletionServiceClient();

    // Prepare the request message.
    $request = (new CompleteQueryRequest())
        ->setDataStore($formattedDataStore)
        ->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
{
    $formattedDataStore = CompletionServiceClient::dataStoreName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]'
    );
    $query = '[QUERY]';

    complete_query_sample($formattedDataStore, $query);
}

importCompletionSuggestions

Imports CompletionSuggestions for a DataStore.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\CompletionServiceClient::importCompletionSuggestionsAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\ImportCompletionSuggestionsRequest

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\DiscoveryEngine\V1\Client\CompletionServiceClient;
use Google\Cloud\DiscoveryEngine\V1\ImportCompletionSuggestionsRequest;
use Google\Cloud\DiscoveryEngine\V1\ImportCompletionSuggestionsResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent data store resource name for which to import customer
 *                                autocomplete suggestions.
 *
 *                                Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
 *                                Please see {@see CompletionServiceClient::dataStoreName()} for help formatting this field.
 */
function import_completion_suggestions_sample(string $formattedParent): void
{
    // Create a client.
    $completionServiceClient = new CompletionServiceClient();

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

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

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

    import_completion_suggestions_sample($formattedParent);
}

importSuggestionDenyListEntries

Imports all SuggestionDenyListEntry for a DataStore.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\CompletionServiceClient::importSuggestionDenyListEntriesAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\ImportSuggestionDenyListEntriesRequest

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\DiscoveryEngine\V1\Client\CompletionServiceClient;
use Google\Cloud\DiscoveryEngine\V1\ImportSuggestionDenyListEntriesRequest;
use Google\Cloud\DiscoveryEngine\V1\ImportSuggestionDenyListEntriesResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent data store resource name for which to import denylist
 *                                entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*. Please see
 *                                {@see CompletionServiceClient::dataStoreName()} for help formatting this field.
 */
function import_suggestion_deny_list_entries_sample(string $formattedParent): void
{
    // Create a client.
    $completionServiceClient = new CompletionServiceClient();

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

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

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

    import_suggestion_deny_list_entries_sample($formattedParent);
}

purgeCompletionSuggestions

Permanently deletes all CompletionSuggestions for a DataStore.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\CompletionServiceClient::purgeCompletionSuggestionsAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\PurgeCompletionSuggestionsRequest

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\DiscoveryEngine\V1\Client\CompletionServiceClient;
use Google\Cloud\DiscoveryEngine\V1\PurgeCompletionSuggestionsRequest;
use Google\Cloud\DiscoveryEngine\V1\PurgeCompletionSuggestionsResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent data store resource name for which to purge completion
 *                                suggestions. Follows pattern
 *                                projects/*/locations/*/collections/*/dataStores/*. Please see
 *                                {@see CompletionServiceClient::dataStoreName()} for help formatting this field.
 */
function purge_completion_suggestions_sample(string $formattedParent): void
{
    // Create a client.
    $completionServiceClient = new CompletionServiceClient();

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

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

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

    purge_completion_suggestions_sample($formattedParent);
}

purgeSuggestionDenyListEntries

Permanently deletes all SuggestionDenyListEntry for a DataStore.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\CompletionServiceClient::purgeSuggestionDenyListEntriesAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\PurgeSuggestionDenyListEntriesRequest

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\DiscoveryEngine\V1\Client\CompletionServiceClient;
use Google\Cloud\DiscoveryEngine\V1\PurgeSuggestionDenyListEntriesRequest;
use Google\Cloud\DiscoveryEngine\V1\PurgeSuggestionDenyListEntriesResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent data store resource name for which to import denylist
 *                                entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*. Please see
 *                                {@see CompletionServiceClient::dataStoreName()} for help formatting this field.
 */
function purge_suggestion_deny_list_entries_sample(string $formattedParent): void
{
    // Create a client.
    $completionServiceClient = new CompletionServiceClient();

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

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

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

    purge_suggestion_deny_list_entries_sample($formattedParent);
}

completeQueryAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\CompleteQueryRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

importCompletionSuggestionsAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\ImportCompletionSuggestionsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

importSuggestionDenyListEntriesAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\ImportSuggestionDenyListEntriesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

purgeCompletionSuggestionsAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\PurgeCompletionSuggestionsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

purgeSuggestionDenyListEntriesAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\PurgeSuggestionDenyListEntriesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

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

Returns
Type Description
Google\LongRunning\Client\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::dataStoreName

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

Parameters
Name Description
project string
location string
dataStore string
Returns
Type Description
string The formatted data_store resource.

static::projectLocationCollectionDataStoreName

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

Parameters
Name Description
project string
location string
collection string
dataStore string
Returns
Type Description
string The formatted project_location_collection_data_store resource.

static::projectLocationDataStoreName

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

Parameters
Name Description
project string
location string
dataStore string
Returns
Type Description
string The formatted project_location_data_store 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

  • dataStore: projects/{project}/locations/{location}/dataStores/{data_store}
  • projectLocationCollectionDataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
  • projectLocationDataStore: projects/{project}/locations/{location}/dataStores/{data_store}

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.