Google Cloud Dialogflow V2 Client - Class SessionsClient (1.2.0)

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

Service Description: A service used for session interactions.

For more information, see the API interactions guide.

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

$sessionsClient = new SessionsClient();
try {
    $formattedSession = $sessionsClient->sessionName('[PROJECT]', '[SESSION]');
    $queryInput = new QueryInput();
    $response = $sessionsClient->detectIntent($formattedSession, $queryInput);
} finally {
    $sessionsClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Methods

projectEnvironmentUserSessionName

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

Parameters
Name	Description
`project`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted project_environment_user_session resource.

projectLocationEnvironmentUserSessionName

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

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

Returns
Type	Description
`string`	The formatted project_location_environment_user_session resource.

projectLocationSessionName

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

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

Returns
Type	Description
`string`	The formatted project_location_session resource.

projectSessionName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted project_session resource.

sessionName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted session resource.

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

projectEnvironmentUserSession: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
projectLocationEnvironmentUserSession: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}
projectLocationSession: projects/{project}/locations/{location}/agent/sessions/{session}
projectSession: projects/{project}/agent/sessions/{session}
session: projects/{project}/agent/sessions/{session}

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.

__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 contexts and session entity types to be updated, which in turn might affect results of future queries.

If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of DetectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products.

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

Parameters
Name	Description
`session`	`string` Required. The name of the session this query is sent to. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment (`Environment ID` might be referred to as environment name at some places). If `User ID` is not specified, we are using "-". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the API interactions guide. Note: Always use agent versions for production traffic. See Versions and environments.
`queryInput`	`Google\Cloud\Dialogflow\V2\QueryInput` Required. The input specification. It can be set to: an audio config which instructs the speech recognizer how to process the speech audio, a conversational query in the form of text, or an event that specifies which intent to trigger.
`optionalArgs`	`array` Optional.
`↳ queryParams`	`QueryParameters` The parameters of this query.
`↳ outputAudioConfig`	`OutputAudioConfig` Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.
`↳ outputAudioConfigMask`	`FieldMask` Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level. If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.
`↳ inputAudio`	`string` The natural language speech audio to be processed. This field should be populated iff `query_input` is set to an input audio config. A single request can contain up to 1 minute of speech audio data.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\DetectIntentResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\DetectIntentResponse;
use Google\Cloud\Dialogflow\V2\QueryInput;
use Google\Cloud\Dialogflow\V2\SessionsClient;

/**
 * @param string $formattedSession The name of the session this query is sent to. Format:
 *                                 `projects/<Project ID>/agent/sessions/<Session ID>`, or
 *                                 `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 *                                 ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume
 *                                 default 'draft' environment (`Environment ID` might be referred to as
 *                                 environment name at some places). If `User ID` is not specified, we are
 *                                 using "-". It's up to the API caller to choose an appropriate `Session ID`
 *                                 and `User Id`. They can be a random number or some type of user and session
 *                                 identifiers (preferably hashed). The length of the `Session ID` and
 *                                 `User ID` must not exceed 36 characters.
 *
 *                                 For more information, see the [API interactions
 *                                 guide](https://cloud.google.com/dialogflow/docs/api-overview).
 *
 *                                 Note: Always use agent versions for production traffic.
 *                                 See [Versions and
 *                                 environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). Please see
 *                                 {@see SessionsClient::sessionName()} for help formatting this field.
 */
function detect_intent_sample(string $formattedSession): void
{
    // Create a client.
    $sessionsClient = new SessionsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $queryInput = new QueryInput();

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

/**
 * 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]', '[SESSION]');

    detect_intent_sample($formattedSession);
}

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

If you might use Agent Assist or other CCAI products now or in the future, consider using StreamingAnalyzeContent instead of StreamingDetectIntent. StreamingAnalyzeContent has additional functionality for Agent Assist and other CCAI products.

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

Parameters
Name	Description
`optionalArgs`	`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\V2\QueryInput;
use Google\Cloud\Dialogflow\V2\SessionsClient;
use Google\Cloud\Dialogflow\V2\StreamingDetectIntentRequest;
use Google\Cloud\Dialogflow\V2\StreamingDetectIntentResponse;

/**
 * @param string $formattedSession The name of the session the query is sent to.
 *                                 Format of the session name:
 *                                 `projects/<Project ID>/agent/sessions/<Session ID>`, or
 *                                 `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 *                                 ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume
 *                                 default 'draft' environment. If `User ID` is not specified, we are using
 *                                 "-". It's up to the API caller to choose an appropriate `Session ID` and
 *                                 `User Id`. They can be a random number or some type of user and session
 *                                 identifiers (preferably hashed). The length of the `Session ID` and
 *                                 `User ID` must not exceed 36 characters.
 *
 *                                 For more information, see the [API interactions
 *                                 guide](https://cloud.google.com/dialogflow/docs/api-overview).
 *
 *                                 Note: Always use agent versions for production traffic.
 *                                 See [Versions and
 *                                 environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). Please see
 *                                 {@see SessionsClient::sessionName()} for help formatting this field.
 */
function streaming_detect_intent_sample(string $formattedSession): void
{
    // Create a client.
    $sessionsClient = new SessionsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $queryInput = new QueryInput();
    $request = (new StreamingDetectIntentRequest())
        ->setSession($formattedSession)
        ->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());
    }
}

/**
 * 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]', '[SESSION]');

    streaming_detect_intent_sample($formattedSession);
}

getLocation

Gets information about a location.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` Resource name for the location.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\SessionsClient;
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();

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

listLocations

Lists information about the supported locations for this service.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` The resource that owns the locations collection, if applicable.
`↳ filter`	`string` The standard list filter.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\SessionsClient;
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();

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

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

Constants

SERVICE_NAME

Value: 'google.cloud.dialogflow.v2.Sessions'

The name of the service.

SERVICE_ADDRESS

Value: 'dialogflow.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

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