Google Cloud Dialogflow Cx V3 Client - Class AgentsClient (0.2.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 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.

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 \ 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.

createAgent

Creates an agent in the specified location.

Note: You should always train flows prior to sending them queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::createAgentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\CreateAgentRequest` 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\Dialogflow\Cx\V3\Agent`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Agent;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\CreateAgentRequest;

/**
 * @param string $formattedParent          The location to create a agent for.
 *                                         Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                         {@see AgentsClient::locationName()} for help formatting this field.
 * @param string $agentDisplayName         The human-readable name of the agent, unique within the location.
 * @param string $agentDefaultLanguageCode Immutable. The default language of the agent as a language tag.
 *                                         See [Language
 *                                         Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 *                                         for a list of the currently supported language codes.
 *                                         This field cannot be set by the
 *                                         [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 *                                         method.
 * @param string $agentTimeZone            The time zone of the agent from the [time zone
 *                                         database](https://www.iana.org/time-zones), e.g., America/New_York,
 *                                         Europe/Paris.
 */
function create_agent_sample(
    string $formattedParent,
    string $agentDisplayName,
    string $agentDefaultLanguageCode,
    string $agentTimeZone
): void {
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare the request message.
    $agent = (new Agent())
        ->setDisplayName($agentDisplayName)
        ->setDefaultLanguageCode($agentDefaultLanguageCode)
        ->setTimeZone($agentTimeZone);
    $request = (new CreateAgentRequest())
        ->setParent($formattedParent)
        ->setAgent($agent);

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

    create_agent_sample($formattedParent, $agentDisplayName, $agentDefaultLanguageCode, $agentTimeZone);
}

deleteAgent

Deletes the specified agent.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::deleteAgentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\DeleteAgentRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\DeleteAgentRequest;

/**
 * @param string $formattedName The name of the agent to delete.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                              {@see AgentsClient::agentName()} for help formatting this field.
 */
function delete_agent_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare the request message.
    $request = (new DeleteAgentRequest())
        ->setName($formattedName);

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

    delete_agent_sample($formattedName);
}

exportAgent

Exports the specified agent to a binary 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

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::exportAgentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ExportAgentRequest` 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\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\ExportAgentRequest;
use Google\Cloud\Dialogflow\Cx\V3\ExportAgentResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the agent to export.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                              {@see AgentsClient::agentName()} for help formatting this field.
 */
function export_agent_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare the request message.
    $request = (new ExportAgentRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $agentsClient->exportAgent($request);
        $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
{
    $formattedName = AgentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    export_agent_sample($formattedName);
}

getAgent

Retrieves the specified agent.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::getAgentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\GetAgentRequest` 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\Dialogflow\Cx\V3\Agent`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Agent;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\GetAgentRequest;

/**
 * @param string $formattedName The name of the agent.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                              {@see AgentsClient::agentName()} for help formatting this field.
 */
function get_agent_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare the request message.
    $request = (new GetAgentRequest())
        ->setName($formattedName);

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

    get_agent_sample($formattedName);
}

getAgentValidationResult

Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::getAgentValidationResultAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\GetAgentValidationResultRequest` 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\Dialogflow\Cx\V3\AgentValidationResult`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\AgentValidationResult;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\GetAgentValidationResultRequest;

/**
 * @param string $formattedName The agent name.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/validationResult`. Please see
 *                              {@see AgentsClient::agentValidationResultName()} for help formatting this field.
 */
function get_agent_validation_result_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare the request message.
    $request = (new GetAgentValidationResultRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var AgentValidationResult $response */
        $response = $agentsClient->getAgentValidationResult($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
{
    $formattedName = AgentsClient::agentValidationResultName('[PROJECT]', '[LOCATION]', '[AGENT]');

    get_agent_validation_result_sample($formattedName);
}

getGenerativeSettings

Gets the generative settings for the agent.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::getGenerativeSettingsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\GetGenerativeSettingsRequest` 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\Dialogflow\Cx\V3\GenerativeSettings`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\GenerativeSettings;
use Google\Cloud\Dialogflow\Cx\V3\GetGenerativeSettingsRequest;

/**
 * @param string $formattedName Format: `projects/<Project ID>/locations/<Location
 *                              ID>/agents/<Agent ID>/generativeSettings`. Please see
 *                              {@see AgentsClient::agentGenerativeSettingsName()} for help formatting this field.
 * @param string $languageCode  Language code of the generative settings.
 */
function get_generative_settings_sample(string $formattedName, string $languageCode): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare the request message.
    $request = (new GetGenerativeSettingsRequest())
        ->setName($formattedName)
        ->setLanguageCode($languageCode);

    // Call the API and handle any network failures.
    try {
        /** @var GenerativeSettings $response */
        $response = $agentsClient->getGenerativeSettings($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
{
    $formattedName = AgentsClient::agentGenerativeSettingsName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $languageCode = '[LANGUAGE_CODE]';

    get_generative_settings_sample($formattedName, $languageCode);
}

listAgents

Returns the list of all agents in the specified location.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::listAgentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ListAgentsRequest` 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\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Agent;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\ListAgentsRequest;

/**
 * @param string $formattedParent The location to list all agents for.
 *                                Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                {@see AgentsClient::locationName()} for help formatting this field.
 */
function list_agents_sample(string $formattedParent): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

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

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

        /** @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::locationName('[PROJECT]', '[LOCATION]');

    list_agents_sample($formattedParent);
}

restoreAgent

Restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

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 flows prior to sending them queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::restoreAgentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\RestoreAgentRequest` 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\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\RestoreAgentRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the agent to restore into.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                              {@see AgentsClient::agentName()} for help formatting this field.
 */
function restore_agent_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare the request message.
    $request = (new RestoreAgentRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $agentsClient->restoreAgent($request);
        $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
{
    $formattedName = AgentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    restore_agent_sample($formattedName);
}

updateAgent

Updates the specified agent.

Note: You should always train flows prior to sending them queries. See the training documentation.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::updateAgentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\UpdateAgentRequest` 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\Dialogflow\Cx\V3\Agent`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Agent;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\UpdateAgentRequest;

/**
 * @param string $agentDisplayName         The human-readable name of the agent, unique within the location.
 * @param string $agentDefaultLanguageCode Immutable. The default language of the agent as a language tag.
 *                                         See [Language
 *                                         Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 *                                         for a list of the currently supported language codes.
 *                                         This field cannot be set by the
 *                                         [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 *                                         method.
 * @param string $agentTimeZone            The time zone of the agent from the [time zone
 *                                         database](https://www.iana.org/time-zones), e.g., America/New_York,
 *                                         Europe/Paris.
 */
function update_agent_sample(
    string $agentDisplayName,
    string $agentDefaultLanguageCode,
    string $agentTimeZone
): void {
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare the request message.
    $agent = (new Agent())
        ->setDisplayName($agentDisplayName)
        ->setDefaultLanguageCode($agentDefaultLanguageCode)
        ->setTimeZone($agentTimeZone);
    $request = (new UpdateAgentRequest())
        ->setAgent($agent);

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

    update_agent_sample($agentDisplayName, $agentDefaultLanguageCode, $agentTimeZone);
}

updateGenerativeSettings

Updates the generative settings for the agent.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::updateGenerativeSettingsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\UpdateGenerativeSettingsRequest` 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\Dialogflow\Cx\V3\GenerativeSettings`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\GenerativeSettings;
use Google\Cloud\Dialogflow\Cx\V3\UpdateGenerativeSettingsRequest;

/**
 * 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 update_generative_settings_sample(): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare the request message.
    $generativeSettings = new GenerativeSettings();
    $request = (new UpdateGenerativeSettingsRequest())
        ->setGenerativeSettings($generativeSettings);

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

validateAgent

Validates the specified agent and creates or updates validation results.

The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::validateAgentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ValidateAgentRequest` 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\Dialogflow\Cx\V3\AgentValidationResult`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\AgentValidationResult;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Dialogflow\Cx\V3\ValidateAgentRequest;

/**
 * @param string $formattedName The agent to validate.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                              {@see AgentsClient::agentName()} for help formatting this field.
 */
function validate_agent_sample(string $formattedName): void
{
    // Create a client.
    $agentsClient = new AgentsClient();

    // Prepare the request message.
    $request = (new ValidateAgentRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var AgentValidationResult $response */
        $response = $agentsClient->validateAgent($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
{
    $formattedName = AgentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    validate_agent_sample($formattedName);
}

getLocation

Gets information about a location.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` 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\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Location\GetLocationRequest;
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();

    // Prepare the request message.
    $request = new GetLocationRequest();

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

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` 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\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\AgentsClient;
use Google\Cloud\Location\ListLocationsRequest;
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();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

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

createAgentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\CreateAgentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteAgentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\DeleteAgentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

exportAgentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ExportAgentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAgentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\GetAgentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAgentValidationResultAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\GetAgentValidationResultRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getGenerativeSettingsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\GetGenerativeSettingsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listAgentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ListAgentsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

restoreAgentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\RestoreAgentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateAgentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\UpdateAgentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateGenerativeSettingsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\UpdateGenerativeSettingsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

validateAgentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ValidateAgentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`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::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::agentGenerativeSettingsName

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

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

Returns
Type	Description
`string`	The formatted agent_generative_settings resource.

static::agentValidationResultName

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

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

Returns
Type	Description
`string`	The formatted agent_validation_result resource.

static::environmentName

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

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

Returns
Type	Description
`string`	The formatted environment resource.

static::flowName

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

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

Returns
Type	Description
`string`	The formatted flow 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::securitySettingsName

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

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

Returns
Type	Description
`string`	The formatted security_settings 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}
agentGenerativeSettings: projects/{project}/locations/{location}/agents/{agent}/generativeSettings
agentValidationResult: projects/{project}/locations/{location}/agents/{agent}/validationResult
environment: projects/{project}/locations/{location}/agents/{agent}/environments/{environment}
flow: projects/{project}/locations/{location}/agents/{agent}/flows/{flow}
location: projects/{project}/locations/{location}
securitySettings: projects/{project}/locations/{location}/securitySettings/{security_settings}

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.