Google Cloud Dialogflow Cx V3 Client - Class GeneratorsClient (0.1.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class GeneratorsClient.

Service Description: Service for managing Generators

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$generatorsClient = new GeneratorsClient();
try {
    $formattedParent = $generatorsClient->agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $generator = new Generator();
    $response = $generatorsClient->createGenerator($formattedParent, $generator);
} finally {
    $generatorsClient->close();
}

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 \ Dialogflow \ Cx \ V3

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.

createGenerator

Creates a generator in the specified agent.

Parameters
Name	Description
`parent`	`string` Required. The agent to create a generator for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
`generator`	`Google\Cloud\Dialogflow\Cx\V3\Generator` Required. The generator to create.
`optionalArgs`	`array` Optional.
`↳ languageCode`	`string` The language to create generators for the following fields: * `Generator.prompt_text.text` If not specified, the agent's default language is used.
`↳ 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\Dialogflow\Cx\V3\Generator`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Generator;
use Google\Cloud\Dialogflow\Cx\V3\GeneratorsClient;
use Google\Cloud\Dialogflow\Cx\V3\Phrase;

/**
 * @param string $formattedParent         The agent to create a generator for.
 *                                        Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                                        {@see GeneratorsClient::agentName()} for help formatting this field.
 * @param string $generatorDisplayName    The human-readable name of the generator, unique within the
 *                                        agent. The prompt contains pre-defined parameters such as $conversation,
 *                                        $last-user-utterance, etc. populated by Dialogflow. It can also contain
 *                                        custom placeholders which will be resolved during fulfillment.
 * @param string $generatorPromptTextText Text input which can be used for prompt or banned phrases.
 */
function create_generator_sample(
    string $formattedParent,
    string $generatorDisplayName,
    string $generatorPromptTextText
): void {
    // Create a client.
    $generatorsClient = new GeneratorsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $generatorPromptText = (new Phrase())
        ->setText($generatorPromptTextText);
    $generator = (new Generator())
        ->setDisplayName($generatorDisplayName)
        ->setPromptText($generatorPromptText);

    // Call the API and handle any network failures.
    try {
        /** @var Generator $response */
        $response = $generatorsClient->createGenerator($formattedParent, $generator);
        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
{
    $formattedParent = GeneratorsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $generatorDisplayName = '[DISPLAY_NAME]';
    $generatorPromptTextText = '[TEXT]';

    create_generator_sample($formattedParent, $generatorDisplayName, $generatorPromptTextText);
}

deleteGenerator

Deletes the specified generators.

Parameters
Name	Description
`name`	`string` Required. The name of the generator to delete. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/generators/<Generator ID>`.
`optionalArgs`	`array` Optional.
`↳ force`	`bool` This field has no effect for generators not being used. For generators that are used by pages/flows/transition route groups: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the generator, as well as any references to the generator (i.e. Generator) in fulfillments.
`↳ 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\GeneratorsClient;

/**
 * @param string $formattedName The name of the generator to delete.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/generators/<Generator ID>`. Please see
 *                              {@see GeneratorsClient::generatorName()} for help formatting this field.
 */
function delete_generator_sample(string $formattedName): void
{
    // Create a client.
    $generatorsClient = new GeneratorsClient();

    // Call the API and handle any network failures.
    try {
        $generatorsClient->deleteGenerator($formattedName);
        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 = GeneratorsClient::generatorName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[GENERATOR]'
    );

    delete_generator_sample($formattedName);
}

getGenerator

Retrieves the specified generator.

Parameters
Name	Description
`name`	`string` Required. The name of the generator. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/generators/<Generator ID>`.
`optionalArgs`	`array` Optional.
`↳ languageCode`	`string` The language to list generators for.
`↳ 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\Dialogflow\Cx\V3\Generator`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Generator;
use Google\Cloud\Dialogflow\Cx\V3\GeneratorsClient;

/**
 * @param string $formattedName The name of the generator.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/generators/<Generator ID>`. Please see
 *                              {@see GeneratorsClient::generatorName()} for help formatting this field.
 */
function get_generator_sample(string $formattedName): void
{
    // Create a client.
    $generatorsClient = new GeneratorsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Generator $response */
        $response = $generatorsClient->getGenerator($formattedName);
        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 = GeneratorsClient::generatorName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[GENERATOR]'
    );

    get_generator_sample($formattedName);
}

listGenerators

Returns the list of all generators in the specified agent.

Parameters
Name	Description
`parent`	`string` Required. The agent to list all generators for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
`optionalArgs`	`array` Optional.
`↳ languageCode`	`string` The language to list generators for.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ 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\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Generator;
use Google\Cloud\Dialogflow\Cx\V3\GeneratorsClient;

/**
 * @param string $formattedParent The agent to list all generators for.
 *                                Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                                {@see GeneratorsClient::agentName()} for help formatting this field.
 */
function list_generators_sample(string $formattedParent): void
{
    // Create a client.
    $generatorsClient = new GeneratorsClient();

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

        /** @var Generator $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 = GeneratorsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    list_generators_sample($formattedParent);
}

updateGenerator

Update the specified generator.

Parameters
Name	Description
`generator`	`Google\Cloud\Dialogflow\Cx\V3\Generator` Required. The generator to update.
`optionalArgs`	`array` Optional.
`↳ languageCode`	`string` The language to list generators for.
`↳ updateMask`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`↳ 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\Dialogflow\Cx\V3\Generator`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Generator;
use Google\Cloud\Dialogflow\Cx\V3\GeneratorsClient;
use Google\Cloud\Dialogflow\Cx\V3\Phrase;

/**
 * @param string $generatorDisplayName    The human-readable name of the generator, unique within the
 *                                        agent. The prompt contains pre-defined parameters such as $conversation,
 *                                        $last-user-utterance, etc. populated by Dialogflow. It can also contain
 *                                        custom placeholders which will be resolved during fulfillment.
 * @param string $generatorPromptTextText Text input which can be used for prompt or banned phrases.
 */
function update_generator_sample(
    string $generatorDisplayName,
    string $generatorPromptTextText
): void {
    // Create a client.
    $generatorsClient = new GeneratorsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $generatorPromptText = (new Phrase())
        ->setText($generatorPromptTextText);
    $generator = (new Generator())
        ->setDisplayName($generatorDisplayName)
        ->setPromptText($generatorPromptText);

    // Call the API and handle any network failures.
    try {
        /** @var Generator $response */
        $response = $generatorsClient->updateGenerator($generator);
        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
{
    $generatorDisplayName = '[DISPLAY_NAME]';
    $generatorPromptTextText = '[TEXT]';

    update_generator_sample($generatorDisplayName, $generatorPromptTextText);
}

getLocation

Gets information about a location.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` Resource name for the location.
`↳ 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\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\GeneratorsClient;
use Google\Cloud\Location\Location;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $generatorsClient = new GeneratorsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $generatorsClient->getLocation();
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` The resource that owns the locations collection, if applicable.
`↳ filter`	`string` The standard list filter.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ 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\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\GeneratorsClient;
use Google\Cloud\Location\Location;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $generatorsClient = new GeneratorsClient();

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

        /** @var Location $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());
    }
}

static::agentName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`

Returns
Type	Description
`string`	The formatted agent resource.

static::generatorName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`generator`	`string`

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

agent: projects/{project}/locations/{location}/agents/{agent}
generator: projects/{project}/locations/{location}/agents/{agent}/generators/{generator}

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.

Constants

SERVICE_NAME

Value: 'google.cloud.dialogflow.cx.v3.Generators'

The name of the service.

SERVICE_ADDRESS

Value: 'dialogflow.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.