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

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

Service Description: A session represents an interaction with a user. You retrieve user input and pass it to the DetectIntent method to determine user intent and respond.

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.

detectIntent

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.

Note: Always use agent versions for production traffic. See Versions and environments.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\SessionsClient::detectIntentAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\SessionsClient;
use Google\Cloud\Dialogflow\Cx\V3\DetectIntentRequest;
use Google\Cloud\Dialogflow\Cx\V3\DetectIntentResponse;
use Google\Cloud\Dialogflow\Cx\V3\QueryInput;

/**
 * @param string $formattedSession       The name of the session this query is sent to.
 *                                       Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                                       ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
 *                                       ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
 *                                       If `Environment ID` is not specified, we assume default 'draft'
 *                                       environment.
 *                                       It's up to the API caller to choose an appropriate `Session ID`. It can be
 *                                       a random number or some type of session identifiers (preferably hashed).
 *                                       The length of the `Session ID` must not exceed 36 characters.
 *
 *                                       For more information, see the [sessions
 *                                       guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
 *
 *                                       Note: Always use agent versions for production traffic.
 *                                       See [Versions and
 *                                       environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). Please see
 *                                       {@see SessionsClient::sessionName()} for help formatting this field.
 * @param string $queryInputLanguageCode The language of the input. See [Language
 *                                       Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 *                                       for a list of the currently supported language codes. Note that queries in
 *                                       the same session do not necessarily need to specify the same language.
 */
function detect_intent_sample(string $formattedSession, string $queryInputLanguageCode): void
{
    // Create a client.
    $sessionsClient = new SessionsClient();

    // Prepare the request message.
    $queryInput = (new QueryInput())
        ->setLanguageCode($queryInputLanguageCode);
    $request = (new DetectIntentRequest())
        ->setSession($formattedSession)
        ->setQueryInput($queryInput);

    // Call the API and handle any network failures.
    try {
        /** @var DetectIntentResponse $response */
        $response = $sessionsClient->detectIntent($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
{
    $formattedSession = SessionsClient::sessionName('[PROJECT]', '[LOCATION]', '[AGENT]', '[SESSION]');
    $queryInputLanguageCode = '[LANGUAGE_CODE]';

    detect_intent_sample($formattedSession, $queryInputLanguageCode);
}

fulfillIntent

Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse.

Otherwise, the behavior is undefined.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\SessionsClient::fulfillIntentAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\SessionsClient;
use Google\Cloud\Dialogflow\Cx\V3\FulfillIntentRequest;
use Google\Cloud\Dialogflow\Cx\V3\FulfillIntentResponse;

/**
 * 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 fulfill_intent_sample(): void
{
    // Create a client.
    $sessionsClient = new SessionsClient();

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

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

matchIntent

Returns preliminary intent match results, doesn't change the session status.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\SessionsClient::matchIntentAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\SessionsClient;
use Google\Cloud\Dialogflow\Cx\V3\MatchIntentRequest;
use Google\Cloud\Dialogflow\Cx\V3\MatchIntentResponse;
use Google\Cloud\Dialogflow\Cx\V3\QueryInput;

/**
 * @param string $formattedSession       The name of the session this query is sent to.
 *                                       Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                                       ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
 *                                       ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
 *                                       If `Environment ID` is not specified, we assume default 'draft'
 *                                       environment.
 *                                       It's up to the API caller to choose an appropriate `Session ID`. It can be
 *                                       a random number or some type of session identifiers (preferably hashed).
 *                                       The length of the `Session ID` must not exceed 36 characters.
 *
 *                                       For more information, see the [sessions
 *                                       guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Please see
 *                                       {@see SessionsClient::sessionName()} for help formatting this field.
 * @param string $queryInputLanguageCode The language of the input. See [Language
 *                                       Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 *                                       for a list of the currently supported language codes. Note that queries in
 *                                       the same session do not necessarily need to specify the same language.
 */
function match_intent_sample(string $formattedSession, string $queryInputLanguageCode): void
{
    // Create a client.
    $sessionsClient = new SessionsClient();

    // Prepare the request message.
    $queryInput = (new QueryInput())
        ->setLanguageCode($queryInputLanguageCode);
    $request = (new MatchIntentRequest())
        ->setSession($formattedSession)
        ->setQueryInput($queryInput);

    // Call the API and handle any network failures.
    try {
        /** @var MatchIntentResponse $response */
        $response = $sessionsClient->matchIntent($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
{
    $formattedSession = SessionsClient::sessionName('[PROJECT]', '[LOCATION]', '[AGENT]', '[SESSION]');
    $queryInputLanguageCode = '[LANGUAGE_CODE]';

    match_intent_sample($formattedSession, $queryInputLanguageCode);
}

streamingDetectIntent

Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

Note: Always use agent versions for production traffic. See Versions and environments.

Parameters
Name	Description
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\BidiStream`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Dialogflow\Cx\V3\Client\SessionsClient;
use Google\Cloud\Dialogflow\Cx\V3\QueryInput;
use Google\Cloud\Dialogflow\Cx\V3\StreamingDetectIntentRequest;
use Google\Cloud\Dialogflow\Cx\V3\StreamingDetectIntentResponse;

/**
 * @param string $queryInputLanguageCode The language of the input. See [Language
 *                                       Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 *                                       for a list of the currently supported language codes. Note that queries in
 *                                       the same session do not necessarily need to specify the same language.
 */
function streaming_detect_intent_sample(string $queryInputLanguageCode): void
{
    // Create a client.
    $sessionsClient = new SessionsClient();

    // Prepare the request message.
    $queryInput = (new QueryInput())
        ->setLanguageCode($queryInputLanguageCode);
    $request = (new StreamingDetectIntentRequest())
        ->setQueryInput($queryInput);

    // Call the API and handle any network failures.
    try {
        /** @var BidiStream $stream */
        $stream = $sessionsClient->streamingDetectIntent();
        $stream->writeAll([$request,]);

        /** @var StreamingDetectIntentResponse $element */
        foreach ($stream->closeWriteAndReadAll() 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
{
    $queryInputLanguageCode = '[LANGUAGE_CODE]';

    streaming_detect_intent_sample($queryInputLanguageCode);
}

submitAnswerFeedback

Updates the feedback received from the user for a single turn of the bot response.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\SessionsClient::submitAnswerFeedbackAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\AnswerFeedback;
use Google\Cloud\Dialogflow\Cx\V3\Client\SessionsClient;
use Google\Cloud\Dialogflow\Cx\V3\SubmitAnswerFeedbackRequest;

/**
 * @param string $formattedSession The name of the session the feedback was sent to. Please see
 *                                 {@see SessionsClient::sessionName()} for help formatting this field.
 * @param string $responseId       ID of the response to update its feedback. This is the same as
 *                                 DetectIntentResponse.response_id.
 */
function submit_answer_feedback_sample(string $formattedSession, string $responseId): void
{
    // Create a client.
    $sessionsClient = new SessionsClient();

    // Prepare the request message.
    $answerFeedback = new AnswerFeedback();
    $request = (new SubmitAnswerFeedbackRequest())
        ->setSession($formattedSession)
        ->setResponseId($responseId)
        ->setAnswerFeedback($answerFeedback);

    // Call the API and handle any network failures.
    try {
        /** @var AnswerFeedback $response */
        $response = $sessionsClient->submitAnswerFeedback($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
{
    $formattedSession = SessionsClient::sessionName('[PROJECT]', '[LOCATION]', '[AGENT]', '[SESSION]');
    $responseId = '[RESPONSE_ID]';

    submit_answer_feedback_sample($formattedSession, $responseId);
}

getLocation

Gets information about a location.

The async variant is Google\Cloud\Dialogflow\Cx\V3\Client\SessionsClient::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\SessionsClient;
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.
    $sessionsClient = new SessionsClient();

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

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

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

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

detectIntentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

fulfillIntentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

matchIntentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

submitAnswerFeedbackAsync

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

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

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

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

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

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

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

Returns
Type	Description
`string`	The formatted page resource.

static::projectLocationAgentEnvironmentSessionName

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

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

Returns
Type	Description
`string`	The formatted project_location_agent_environment_session resource.

static::projectLocationAgentEnvironmentSessionEntityTypeName

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

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

Returns
Type	Description
`string`	The formatted project_location_agent_environment_session_entity_type resource.

static::projectLocationAgentSessionName

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

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

Returns
Type	Description
`string`	The formatted project_location_agent_session resource.

static::projectLocationAgentSessionEntityTypeName

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

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

Returns
Type	Description
`string`	The formatted project_location_agent_session_entity_type resource.

static::projectLocationCollectionDataStoreName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`

Returns
Type	Description
`string`	The formatted project_location_collection_data_store resource.

static::projectLocationDataStoreName

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

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

Returns
Type	Description
`string`	The formatted project_location_data_store resource.

static::sessionName

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

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

Returns
Type	Description
`string`	The formatted session resource.

static::sessionEntityTypeName

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

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

Returns
Type	Description
`string`	The formatted session_entity_type resource.

static::versionName

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

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

Returns
Type	Description
`string`	The formatted version 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}
dataStore: projects/{project}/locations/{location}/dataStores/{data_store}
entityType: projects/{project}/locations/{location}/agents/{agent}/entityTypes/{entity_type}
intent: projects/{project}/locations/{location}/agents/{agent}/intents/{intent}
page: projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/pages/{page}
projectLocationAgentEnvironmentSession: projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}
projectLocationAgentEnvironmentSessionEntityType: projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type}
projectLocationAgentSession: projects/{project}/locations/{location}/agents/{agent}/sessions/{session}
projectLocationAgentSessionEntityType: projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}
projectLocationCollectionDataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
projectLocationDataStore: projects/{project}/locations/{location}/dataStores/{data_store}
session: projects/{project}/locations/{location}/agents/{agent}/sessions/{session}
sessionEntityType: projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}
version: projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/versions/{version}

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.