Google Cloud Discovery Engine V1beta Client - Class CompletionServiceClient (0.11.3)

Namespace

Methods

__construct

completeQuery

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\CompletionServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\CompleteQueryRequest;
use Google\Cloud\DiscoveryEngine\V1beta\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);
}

importSuggestionDenyListEntries

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1beta\Client\CompletionServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\ImportSuggestionDenyListEntriesRequest;
use Google\Cloud\DiscoveryEngine\V1beta\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);
}

purgeSuggestionDenyListEntries

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1beta\Client\CompletionServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\PurgeSuggestionDenyListEntriesRequest;
use Google\Cloud\DiscoveryEngine\V1beta\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

importSuggestionDenyListEntriesAsync

purgeSuggestionDenyListEntriesAsync

getOperationsClient

resumeOperation

static::dataStoreName

static::projectLocationCollectionDataStoreName

static::projectLocationDataStoreName

static::parseName