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.
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 \ V2 \ ClientMethods
__construct
Constructor.
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 .
The async variant is Google\Cloud\Dialogflow\V2\Client\SessionsClient::detectIntentAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\SessionsClient;
use Google\Cloud\Dialogflow\V2\DetectIntentRequest;
use Google\Cloud\Dialogflow\V2\DetectIntentResponse;
use Google\Cloud\Dialogflow\V2\QueryInput;
/**
* @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 the request message.
$queryInput = new QueryInput();
$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]', '[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 .
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Dialogflow\V2\Client\SessionsClient;
use Google\Cloud\Dialogflow\V2\QueryInput;
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 the request message.
$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());
}
}
/**
* 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]', '[SESSION]');
streaming_detect_intent_sample($formattedSession);
}
getLocation
Gets information about a location.
The async variant is Google\Cloud\Dialogflow\V2\Client\SessionsClient::getLocationAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\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\V2\Client\SessionsClient::listLocationsAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\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
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getLocationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listLocationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
static::contextName
Formats a string containing the fully-qualified path to represent a context resource.
project
string
session
string
context
string
string
static::projectEnvironmentUserSessionName
Formats a string containing the fully-qualified path to represent a project_environment_user_session resource.
project
string
environment
string
user
string
session
string
string
static::projectEnvironmentUserSessionContextName
Formats a string containing the fully-qualified path to represent a project_environment_user_session_context resource.
project
string
environment
string
user
string
session
string
context
string
string
static::projectEnvironmentUserSessionEntityTypeName
Formats a string containing the fully-qualified path to represent a project_environment_user_session_entity_type resource.
project
string
environment
string
user
string
session
string
entityType
string
string
static::projectLocationEnvironmentUserSessionName
Formats a string containing the fully-qualified path to represent a project_location_environment_user_session resource.
project
string
location
string
environment
string
user
string
session
string
string
static::projectLocationEnvironmentUserSessionContextName
Formats a string containing the fully-qualified path to represent a project_location_environment_user_session_context resource.
project
string
location
string
environment
string
user
string
session
string
context
string
string
static::projectLocationEnvironmentUserSessionEntityTypeName
Formats a string containing the fully-qualified path to represent a project_location_environment_user_session_entity_type resource.
project
string
location
string
environment
string
user
string
session
string
entityType
string
string
static::projectLocationSessionName
Formats a string containing the fully-qualified path to represent a project_location_session resource.
project
string
location
string
session
string
string
static::projectLocationSessionContextName
Formats a string containing the fully-qualified path to represent a project_location_session_context resource.
project
string
location
string
session
string
context
string
string
static::projectLocationSessionEntityTypeName
Formats a string containing the fully-qualified path to represent a project_location_session_entity_type resource.
project
string
location
string
session
string
entityType
string
string
static::projectSessionName
Formats a string containing the fully-qualified path to represent a project_session resource.
project
string
session
string
string
static::projectSessionContextName
Formats a string containing the fully-qualified path to represent a project_session_context resource.
project
string
session
string
context
string
string
static::projectSessionEntityTypeName
Formats a string containing the fully-qualified path to represent a project_session_entity_type resource.
project
string
session
string
entityType
string
string
static::sessionName
Formats a string containing the fully-qualified path to represent a session resource.
project
string
session
string
string
static::sessionEntityTypeName
Formats a string containing the fully-qualified path to represent a session_entity_type resource.
project
string
session
string
entityType
string
string
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
- context: projects/{project}/agent/sessions/{session}/contexts/{context}
- projectEnvironmentUserSession: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
- projectEnvironmentUserSessionContext: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
- projectEnvironmentUserSessionEntityType: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
- projectLocationEnvironmentUserSession: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}
- projectLocationEnvironmentUserSessionContext: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
- projectLocationEnvironmentUserSessionEntityType: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
- projectLocationSession: projects/{project}/locations/{location}/agent/sessions/{session}
- projectLocationSessionContext: projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}
- projectLocationSessionEntityType: projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}
- projectSession: projects/{project}/agent/sessions/{session}
- projectSessionContext: projects/{project}/agent/sessions/{session}/contexts/{context}
- projectSessionEntityType: projects/{project}/agent/sessions/{session}/entityTypes/{entity_type}
- session: projects/{project}/agent/sessions/{session}
- sessionEntityType: projects/{project}/agent/sessions/{session}/entityTypes/{entity_type}
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array