Google Cloud Dialogflow V2 Client - Class AgentsClient (1.6.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class AgentsClient.

Service Description: Service for managing Agents.

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:

$agentsClient = new AgentsClient();
try {
    $formattedParent = $agentsClient->projectName('[PROJECT]');
    $agentsClient->deleteAgent($formattedParent);
} finally {
    $agentsClient->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.

This service has a new (beta) implementation. See Google\Cloud\Dialogflow\V2\Client\AgentsClient to use the new surface.

Namespace

Google \ Cloud \ Dialogflow \ V2

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.

deleteAgent

Deletes the specified agent.

Parameters
Name	Description
`parent`	`string` Required. The project that the agent to delete is associated with. Format: `projects/<Project ID>`.
`optionalArgs`	`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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\AgentsClient;

/**
 * @param string $formattedParent The project that the agent to delete is associated with.
 *                                Format: `projects/<Project ID>`. Please see
 *                                {@see AgentsClient::projectName()} for help formatting this field.
 */
function delete_agent_sample(string $formattedParent): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        $agentsClient->deleteAgent($formattedParent);
        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
{
    $formattedParent = AgentsClient::projectName('[PROJECT]');

    delete_agent_sample($formattedParent);
}

exportAgent

Exports the specified agent to a ZIP file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: ExportAgentResponse

Parameters
Name	Description
`parent`	`string` Required. The project that the agent to export is associated with. Format: `projects/<Project ID>`.
`agentUri`	`string` Required. The Google Cloud Storage URI to export the agent to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If left unspecified, the serialized agent is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.
`optionalArgs`	`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\Dialogflow\V2\AgentsClient;
use Google\Cloud\Dialogflow\V2\ExportAgentResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The project that the agent to export is associated with.
 *                                Format: `projects/<Project ID>`. Please see
 *                                {@see AgentsClient::projectName()} for help formatting this field.
 * @param string $agentUri        The [Google Cloud
 *                                Storage](https://cloud.google.com/storage/docs/) URI to export the agent
 *                                to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If
 *                                left unspecified, the serialized agent is returned inline.
 *
 *                                Dialogflow performs a write operation for the Cloud Storage object
 *                                on the caller's behalf, so your request authentication must
 *                                have write permissions for the object. For more information, see
 *                                [Dialogflow access
 *                                control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
 */
function export_agent_sample(string $formattedParent, string $agentUri): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $agentsClient->exportAgent($formattedParent, $agentUri);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ExportAgentResponse $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 = AgentsClient::projectName('[PROJECT]');
    $agentUri = '[AGENT_URI]';

    export_agent_sample($formattedParent, $agentUri);
}

getAgent

Retrieves the specified agent.

Parameters
Name	Description
`parent`	`string` Required. The project that the agent to fetch is associated with. Format: `projects/<Project ID>`.
`optionalArgs`	`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\Dialogflow\V2\Agent`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Agent;
use Google\Cloud\Dialogflow\V2\AgentsClient;

/**
 * @param string $formattedParent The project that the agent to fetch is associated with.
 *                                Format: `projects/<Project ID>`. Please see
 *                                {@see AgentsClient::projectName()} for help formatting this field.
 */
function get_agent_sample(string $formattedParent): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Agent $response */
        $response = $agentsClient->getAgent($formattedParent);
        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 = AgentsClient::projectName('[PROJECT]');

    get_agent_sample($formattedParent);
}

getValidationResult

Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.

Parameters
Name	Description
`parent`	`string` Required. The project that the agent is associated with. Format: `projects/<Project ID>`.
`optionalArgs`	`array` Optional.
`↳ languageCode`	`string` Optional. The language for which you want a validation result. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be 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\V2\ValidationResult`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\AgentsClient;
use Google\Cloud\Dialogflow\V2\ValidationResult;

/**
 * @param string $formattedParent The project that the agent is associated with.
 *                                Format: `projects/<Project ID>`. Please see
 *                                {@see AgentsClient::projectName()} for help formatting this field.
 */
function get_validation_result_sample(string $formattedParent): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var ValidationResult $response */
        $response = $agentsClient->getValidationResult($formattedParent);
        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 = AgentsClient::projectName('[PROJECT]');

    get_validation_result_sample($formattedParent);
}

importAgent

Imports the specified agent from a ZIP file.

Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: An Empty message

The operation only tracks when importing is complete, not when it is done training.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name	Description
`parent`	`string` Required. The project that the agent to import is associated with. Format: `projects/<Project ID>`.
`optionalArgs`	`array` Optional.
`↳ agentUri`	`string` The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://". Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control.
`↳ agentContent`	`string` Zip compressed raw byte content for agent.
`↳ 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\Dialogflow\V2\AgentsClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The project that the agent to import is associated with.
 *                                Format: `projects/<Project ID>`. Please see
 *                                {@see AgentsClient::projectName()} for help formatting this field.
 */
function import_agent_sample(string $formattedParent): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

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

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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 = AgentsClient::projectName('[PROJECT]');

    import_agent_sample($formattedParent);
}

restoreAgent

Restores the specified agent from a ZIP file.

Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: An Empty message

The operation only tracks when restoring is complete, not when it is done training.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name	Description
`parent`	`string` Required. The project that the agent to restore is associated with. Format: `projects/<Project ID>`.
`optionalArgs`	`array` Optional.
`↳ agentUri`	`string` The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://". Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control.
`↳ agentContent`	`string` Zip compressed raw byte content for agent.
`↳ 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\Dialogflow\V2\AgentsClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The project that the agent to restore is associated with.
 *                                Format: `projects/<Project ID>`. Please see
 *                                {@see AgentsClient::projectName()} for help formatting this field.
 */
function restore_agent_sample(string $formattedParent): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

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

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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 = AgentsClient::projectName('[PROJECT]');

    restore_agent_sample($formattedParent);
}

searchAgents

Returns the list of agents.

Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Parameters
Name	Description
`parent`	`string` Required. The project to list agents from. Format: `projects/<Project ID or '-'>`.
`optionalArgs`	`array` Optional.
`↳ 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\V2\Agent;
use Google\Cloud\Dialogflow\V2\AgentsClient;

/**
 * @param string $formattedParent The project to list agents from.
 *                                Format: `projects/<Project ID or '-'>`. Please see
 *                                {@see AgentsClient::projectName()} for help formatting this field.
 */
function search_agents_sample(string $formattedParent): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

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

        /** @var Agent $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 = AgentsClient::projectName('[PROJECT]');

    search_agents_sample($formattedParent);
}

setAgent

Creates/updates the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name	Description
`agent`	`Google\Cloud\Dialogflow\V2\Agent` Required. The agent to update.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` Optional. The mask to control which fields get 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\V2\Agent`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Agent;
use Google\Cloud\Dialogflow\V2\AgentsClient;

/**
 * @param string $formattedAgentParent     The project of this agent.
 *                                         Format: `projects/<Project ID>`. Please see
 *                                         {@see AgentsClient::projectName()} for help formatting this field.
 * @param string $agentDisplayName         The name of this agent.
 * @param string $agentDefaultLanguageCode The default language of the agent as a language tag. See
 *                                         [Language
 *                                         Support](https://cloud.google.com/dialogflow/docs/reference/language)
 *                                         for a list of the currently supported language codes. This field cannot be
 *                                         set by the `Update` method.
 * @param string $agentTimeZone            The time zone of this agent from the
 *                                         [time zone database](https://www.iana.org/time-zones), e.g.,
 *                                         America/New_York, Europe/Paris.
 */
function set_agent_sample(
    string $formattedAgentParent,
    string $agentDisplayName,
    string $agentDefaultLanguageCode,
    string $agentTimeZone
): void {
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $agent = (new Agent())
        ->setParent($formattedAgentParent)
        ->setDisplayName($agentDisplayName)
        ->setDefaultLanguageCode($agentDefaultLanguageCode)
        ->setTimeZone($agentTimeZone);

    // Call the API and handle any network failures.
    try {
        /** @var Agent $response */
        $response = $agentsClient->setAgent($agent);
        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
{
    $formattedAgentParent = AgentsClient::projectName('[PROJECT]');
    $agentDisplayName = '[DISPLAY_NAME]';
    $agentDefaultLanguageCode = '[DEFAULT_LANGUAGE_CODE]';
    $agentTimeZone = '[TIME_ZONE]';

    set_agent_sample(
        $formattedAgentParent,
        $agentDisplayName,
        $agentDefaultLanguageCode,
        $agentTimeZone
    );
}

trainAgent

Trains the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: An Empty message

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name	Description
`parent`	`string` Required. The project that the agent to train is associated with. Format: `projects/<Project ID>`.
`optionalArgs`	`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\Dialogflow\V2\AgentsClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The project that the agent to train is associated with.
 *                                Format: `projects/<Project ID>`. Please see
 *                                {@see AgentsClient::projectName()} for help formatting this field.
 */
function train_agent_sample(string $formattedParent): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

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

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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 = AgentsClient::projectName('[PROJECT]');

    train_agent_sample($formattedParent);
}

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\V2\AgentsClient;
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.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $agentsClient->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\V2\AgentsClient;
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.
    $agentsClient = new AgentsClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $agentsClient->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());
    }
}

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::agentName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted agent resource.

static::locationName

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

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

Returns
Type	Description
`string`	The formatted location resource.

static::projectName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

static::projectAgentName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project_agent resource.

static::projectLocationAgentName

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

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

Returns
Type	Description
`string`	The formatted project_location_agent 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}/agent
location: projects/{project}/locations/{location}
project: projects/{project}
projectAgent: projects/{project}/agent
projectLocationAgent: projects/{project}/locations/{location}/agent

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.v2.Agents'

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.