Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class AgentsClient.
Service Description: Service for managing Agents .
This class is currently experimental and may be subject to changes.
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.
deleteAgent
Deletes the specified agent.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::deleteAgentAsync() .
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.
exportAgent
Exports the specified agent to a ZIP file.
This method is a long-running
operation
.
The returned Operation
type has the following method-specific fields:
-
metadata: An empty Struct message -
response: ExportAgentResponse
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::exportAgentAsync() .
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.
getAgent
Retrieves the specified agent.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getAgentAsync() .
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.
getValidationResult
Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getValidationResultAsync() .
request
Google\Cloud\Dialogflow\V2\GetValidationResultRequest
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.
importAgent
Imports the specified agent from a ZIP file.
Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest . After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.
This method is a long-running
operation
.
The returned Operation
type has the following method-specific fields:
-
metadata: An empty Struct message -
response: An Empty message
The operation only tracks when importing is complete, not when it is done training.
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\BaseClient\self::importAgentAsync() .
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.
restoreAgent
Restores the specified agent from a ZIP file.
Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.
This method is a long-running
operation
.
The returned Operation
type has the following method-specific fields:
-
metadata: An empty Struct message -
response: An Empty message
The operation only tracks when restoring is complete, not when it is done training.
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\BaseClient\self::restoreAgentAsync() .
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.
searchAgents
Returns the list of agents.
Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections .
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::searchAgentsAsync() .
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.
setAgent
Creates/updates 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\BaseClient\self::setAgentAsync() .
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.
trainAgent
Trains the specified agent.
This method is a long-running
operation
.
The returned Operation
type has the following method-specific fields:
-
metadata: An empty Struct message -
response: An Empty message
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\BaseClient\self::trainAgentAsync() .
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.
getLocation
Gets information about a location.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::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.
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::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.
deleteAgentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
exportAgentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getAgentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getValidationResultAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
importAgentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
restoreAgentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
searchAgentsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setAgentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
trainAgentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getLocationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listLocationsAsync
optionalArgs = []
array
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::agentName
Formats a string containing the fully-qualified path to represent a agent resource.
project
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
project
string
string
static::projectAgentName
Formats a string containing the fully-qualified path to represent a project_agent resource.
project
string
string
static::projectLocationAgentName
Formats a string containing the fully-qualified path to represent a project_location_agent resource.
project
string
location
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
- agent: projects/{project}/agent
- location: projects/{project}/locations/{location}
- project: projects/{project}
- projectAgent: projects/{project}/agent
- projectLocationAgent: projects/{project}/locations/{location}/agent
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
