Google Cloud Dialogflow Cx V3 Client - Class IntentsClient (0.5.0)

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

Service Description: Service for managing Intents.

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.

createIntent

Creates an intent in the specified agent.

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

The async variant is IntentsClient::createIntentAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\CreateIntentRequest

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\Intent
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\IntentsClient;
use Google\Cloud\Dialogflow\Cx\V3\CreateIntentRequest;
use Google\Cloud\Dialogflow\Cx\V3\Intent;

/**
 * @param string $formattedParent   The agent to create an intent for.
 *                                  Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                  {@see IntentsClient::agentName()} for help formatting this field.
 * @param string $intentDisplayName The human-readable name of the intent, unique within the agent.
 */
function create_intent_sample(string $formattedParent, string $intentDisplayName): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

    // Prepare the request message.
    $intent = (new Intent())
        ->setDisplayName($intentDisplayName);
    $request = (new CreateIntentRequest())
        ->setParent($formattedParent)
        ->setIntent($intent);

    // Call the API and handle any network failures.
    try {
        /** @var Intent $response */
        $response = $intentsClient->createIntent($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 = IntentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $intentDisplayName = '[DISPLAY_NAME]';

    create_intent_sample($formattedParent, $intentDisplayName);
}

deleteIntent

Deletes the specified intent.

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

The async variant is IntentsClient::deleteIntentAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\DeleteIntentRequest

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\IntentsClient;
use Google\Cloud\Dialogflow\Cx\V3\DeleteIntentRequest;

/**
 * @param string $formattedName The name of the intent to delete.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`. Please see
 *                              {@see IntentsClient::intentName()} for help formatting this field.
 */
function delete_intent_sample(string $formattedName): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

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

    // Call the API and handle any network failures.
    try {
        $intentsClient->deleteIntent($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 = IntentsClient::intentName('[PROJECT]', '[LOCATION]', '[AGENT]', '[INTENT]');

    delete_intent_sample($formattedName);
}

exportIntents

Exports the selected intents.

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

The async variant is IntentsClient::exportIntentsAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\ExportIntentsRequest

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\IntentsClient;
use Google\Cloud\Dialogflow\Cx\V3\ExportIntentsRequest;
use Google\Cloud\Dialogflow\Cx\V3\ExportIntentsResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The name of the parent agent to export intents.
 *                                Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                {@see IntentsClient::agentName()} for help formatting this field.
 * @param string $intentsElement  The name of the intents to export.
 *                                Format:
 *                                `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
 */
function export_intents_sample(string $formattedParent, string $intentsElement): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

    // Prepare the request message.
    $intents = [$intentsElement,];
    $request = (new ExportIntentsRequest())
        ->setParent($formattedParent)
        ->setIntents($intents);

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

        if ($response->operationSucceeded()) {
            /** @var ExportIntentsResponse $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 = IntentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $intentsElement = '[INTENTS]';

    export_intents_sample($formattedParent, $intentsElement);
}

getIntent

Retrieves the specified intent.

The async variant is IntentsClient::getIntentAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\GetIntentRequest

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\Intent
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\IntentsClient;
use Google\Cloud\Dialogflow\Cx\V3\GetIntentRequest;
use Google\Cloud\Dialogflow\Cx\V3\Intent;

/**
 * @param string $formattedName The name of the intent.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`. Please see
 *                              {@see IntentsClient::intentName()} for help formatting this field.
 */
function get_intent_sample(string $formattedName): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Intent $response */
        $response = $intentsClient->getIntent($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 = IntentsClient::intentName('[PROJECT]', '[LOCATION]', '[AGENT]', '[INTENT]');

    get_intent_sample($formattedName);
}

importIntents

Imports the specified intents into the agent.

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

The async variant is IntentsClient::importIntentsAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\ImportIntentsRequest

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\IntentsClient;
use Google\Cloud\Dialogflow\Cx\V3\ImportIntentsRequest;
use Google\Cloud\Dialogflow\Cx\V3\ImportIntentsResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The agent to import the intents into.
 *                                Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                {@see IntentsClient::agentName()} for help formatting this field.
 */
function import_intents_sample(string $formattedParent): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var ImportIntentsResponse $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 = IntentsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    import_intents_sample($formattedParent);
}

listIntents

Returns the list of all intents in the specified agent.

The async variant is IntentsClient::listIntentsAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\ListIntentsRequest

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\IntentsClient;
use Google\Cloud\Dialogflow\Cx\V3\Intent;
use Google\Cloud\Dialogflow\Cx\V3\ListIntentsRequest;

/**
 * @param string $formattedParent The agent to list all intents for.
 *                                Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                {@see IntentsClient::agentName()} for help formatting this field.
 */
function list_intents_sample(string $formattedParent): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

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

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

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

    list_intents_sample($formattedParent);
}

updateIntent

Updates the specified intent.

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

The async variant is IntentsClient::updateIntentAsync() .

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\UpdateIntentRequest

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\Intent
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\IntentsClient;
use Google\Cloud\Dialogflow\Cx\V3\Intent;
use Google\Cloud\Dialogflow\Cx\V3\UpdateIntentRequest;

/**
 * @param string $intentDisplayName The human-readable name of the intent, unique within the agent.
 */
function update_intent_sample(string $intentDisplayName): void
{
    // Create a client.
    $intentsClient = new IntentsClient();

    // Prepare the request message.
    $intent = (new Intent())
        ->setDisplayName($intentDisplayName);
    $request = (new UpdateIntentRequest())
        ->setIntent($intent);

    // Call the API and handle any network failures.
    try {
        /** @var Intent $response */
        $response = $intentsClient->updateIntent($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
{
    $intentDisplayName = '[DISPLAY_NAME]';

    update_intent_sample($intentDisplayName);
}

getLocation

Gets information about a location.

The async variant is IntentsClient::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\IntentsClient;
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.
    $intentsClient = new IntentsClient();

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

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

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

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

createIntentAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\CreateIntentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\Cx\V3\Intent>

deleteIntentAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\DeleteIntentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<void>

exportIntentsAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\ExportIntentsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getIntentAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\GetIntentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\Cx\V3\Intent>

importIntentsAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\ImportIntentsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

listIntentsAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\ListIntentsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

updateIntentAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\Cx\V3\UpdateIntentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\Cx\V3\Intent>

getLocationAsync

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>

listLocationsAsync

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

getOperationsClient

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

Returns
Type Description
Google\LongRunning\Client\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name Description
operationName string

The name of the long running operation
methodName string

The name of the method used to start the operation
Returns
Type Description
Google\ApiCore\OperationResponse

static::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::entityTypeName

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

Parameters
Name Description
project string
location string
agent string
entityType string
Returns
Type Description
string The formatted entity_type resource.

static::intentName

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

Parameters
Name Description
project string
location string
agent string
intent string
Returns
Type Description
string The formatted intent 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}
  • entityType: projects/{project}/locations/{location}/agents/{agent}/entityTypes/{entity_type}
  • intent: projects/{project}/locations/{location}/agents/{agent}/intents/{intent}

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.