Google Cloud Dialogflow V2 Client - Class IntentsClient (1.10.2)

Reference documentation and code samples for the Google Cloud Dialogflow V2 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.

This class is currently experimental and may be subject to changes. See Google\Cloud\Dialogflow\V2\IntentsClient for the stable implementation

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.

batchDeleteIntents

Deletes intents in the specified agent.

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

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

The async variant is Google\Cloud\Dialogflow\V2\Client\IntentsClient::batchDeleteIntentsAsync() .

Parameters
Name
Description
request
Google\Cloud\Dialogflow\V2\BatchDeleteIntentsRequest

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

batchUpdateIntents

Updates/Creates multiple intents in the specified agent.

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

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

The async variant is Google\Cloud\Dialogflow\V2\Client\IntentsClient::batchUpdateIntentsAsync() .

Parameters
Name
Description
request
Google\Cloud\Dialogflow\V2\BatchUpdateIntentsRequest

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

createIntent

Creates an intent in the specified agent.

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

The async variant is Google\Cloud\Dialogflow\V2\Client\IntentsClient::createIntentAsync() .

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

deleteIntent

Deletes the specified intent and its direct or indirect followup intents.

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

The async variant is Google\Cloud\Dialogflow\V2\Client\IntentsClient::deleteIntentAsync() .

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

getIntent

Retrieves the specified intent.

The async variant is Google\Cloud\Dialogflow\V2\Client\IntentsClient::getIntentAsync() .

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

listIntents

Returns the list of all intents in the specified agent.

The async variant is Google\Cloud\Dialogflow\V2\Client\IntentsClient::listIntentsAsync() .

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

updateIntent

Updates the specified intent.

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

The async variant is Google\Cloud\Dialogflow\V2\Client\IntentsClient::updateIntentAsync() .

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

getLocation

Gets information about a location.

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

listLocations

Lists information about the supported locations for this service.

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

batchDeleteIntentsAsync

Parameters
Name
Description
optionalArgs = []
array
Returns
Type
Description
GuzzleHttp\Promise\PromiseInterface

batchUpdateIntentsAsync

Parameters
Name
Description
optionalArgs = []
array
Returns
Type
Description
GuzzleHttp\Promise\PromiseInterface

createIntentAsync

Parameters
Name
Description
optionalArgs = []
array
Returns
Type
Description
GuzzleHttp\Promise\PromiseInterface

deleteIntentAsync

Parameters
Name
Description
optionalArgs = []
array
Returns
Type
Description
GuzzleHttp\Promise\PromiseInterface

getIntentAsync

Parameters
Name
Description
optionalArgs = []
array
Returns
Type
Description
GuzzleHttp\Promise\PromiseInterface

listIntentsAsync

Parameters
Name
Description
optionalArgs = []
array
Returns
Type
Description
GuzzleHttp\Promise\PromiseInterface

updateIntentAsync

Parameters
Name
Description
optionalArgs = []
array
Returns
Type
Description
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
Name
Description
optionalArgs = []
array
Returns
Type
Description
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
Name
Description
optionalArgs = []
array
Returns
Type
Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

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

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

static::agentName

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

Parameter
Name
Description
project
string
Returns
Type
Description
string
The formatted agent resource.

static::contextName

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

Parameters
Name
Description
project
string
session
string
context
string
Returns
Type
Description
string
The formatted context resource.

static::intentName

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

Parameters
Name
Description
project
string
intent
string
Returns
Type
Description
string
The formatted intent resource.

static::projectAgentName

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

Parameter
Name
Description
project
string
Returns
Type
Description
string
The formatted project_agent resource.

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

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

Parameters
Name
Description
project
string
environment
string
user
string
session
string
context
string
Returns
Type
Description
string
The formatted project_environment_user_session_context resource.

static::projectIntentName

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

Parameters
Name
Description
project
string
intent
string
Returns
Type
Description
string
The formatted project_intent resource.

static::projectLocationAgentName

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

Parameters
Name
Description
project
string
location
string
Returns
Type
Description
string
The formatted project_location_agent 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::projectLocationEnvironmentUserSessionContextName

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

Parameters
Name
Description
project
string
location
string
environment
string
user
string
session
string
context
string
Returns
Type
Description
string
The formatted project_location_environment_user_session_context resource.

static::projectLocationIntentName

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

Parameters
Name
Description
project
string
location
string
intent
string
Returns
Type
Description
string
The formatted project_location_intent 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::projectLocationSessionContextName

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

Parameters
Name
Description
project
string
location
string
session
string
context
string
Returns
Type
Description
string
The formatted project_location_session_context 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::projectSessionContextName

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

Parameters
Name
Description
project
string
session
string
context
string
Returns
Type
Description
string
The formatted project_session_context 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::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}/agent
  • context: projects/{project}/agent/sessions/{session}/contexts/{context}
  • intent: projects/{project}/agent/intents/{intent}
  • projectAgent: projects/{project}/agent
  • projectEnvironmentUserSession: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
  • projectEnvironmentUserSessionContext: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
  • projectIntent: projects/{project}/agent/intents/{intent}
  • projectLocationAgent: projects/{project}/locations/{location}/agent
  • 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}
  • projectLocationIntent: projects/{project}/locations/{location}/agent/intents/{intent}
  • projectLocationSession: projects/{project}/locations/{location}/agent/sessions/{session}
  • projectLocationSessionContext: projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}
  • projectSession: projects/{project}/agent/sessions/{session}
  • projectSessionContext: projects/{project}/agent/sessions/{session}/contexts/{context}
  • 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.