Google Cloud Dialogflow V2 Client - Class SessionEntityTypesClient (1.6.0)

Version 1.6.0

• 1.12.2 (latest)
• 1.12.1
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.0
• 1.7.2
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Service Description: Service for managing SessionEntityTypes.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Dialogflow \ V2 \ 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.

createSessionEntityType

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::createSessionEntityTypeAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\CreateSessionEntityTypeRequest 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\V2\SessionEntityType

deleteSessionEntityType

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::deleteSessionEntityTypeAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\DeleteSessionEntityTypeRequest 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.

getSessionEntityType

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getSessionEntityTypeAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\GetSessionEntityTypeRequest 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\V2\SessionEntityType

listSessionEntityTypes

Returns the list of all session entity types in the specified session.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::listSessionEntityTypesAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\ListSessionEntityTypesRequest 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

updateSessionEntityType

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::updateSessionEntityTypeAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\UpdateSessionEntityTypeRequest 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\V2\SessionEntityType

getLocation

Gets information about a location.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::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

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::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

createSessionEntityTypeAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\CreateSessionEntityTypeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteSessionEntityTypeAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\DeleteSessionEntityTypeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getSessionEntityTypeAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\GetSessionEntityTypeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listSessionEntityTypesAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\ListSessionEntityTypesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateSessionEntityTypeAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\UpdateSessionEntityTypeRequest
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::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.

static::projectEnvironmentUserSessionEntityTypeName

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

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

Returns
Type	Description
string	The formatted project_environment_user_session_entity_type resource.

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

static::projectLocationEnvironmentUserSessionEntityTypeName

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

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

Returns
Type	Description
string	The formatted project_location_environment_user_session_entity_type resource.

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

static::projectLocationSessionEntityTypeName

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

Parameters
Name	Description
project	string
location	string
session	string
entityType	string

Returns
Type	Description
string	The formatted project_location_session_entity_type resource.

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

static::projectSessionEntityTypeName

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

Parameters
Name	Description
project	string
session	string
entityType	string

Returns
Type	Description
string	The formatted project_session_entity_type resource.

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

static::sessionEntityTypeName

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

Parameters
Name	Description
project	string
session	string
entityType	string

Returns
Type	Description
string	The formatted session_entity_type 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

• projectEnvironmentUserSession: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
• 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}
• projectLocationEnvironmentUserSessionEntityType: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
• projectLocationSession: projects/{project}/locations/{location}/agent/sessions/{session}
• projectLocationSessionEntityType: projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}
• projectSession: projects/{project}/agent/sessions/{session}
• 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.

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.