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. Sample code to get started:
$intentsClient = new IntentsClient();
try {
$formattedParent = $intentsClient->agentName('[PROJECT]');
$intents = [];
$operationResponse = $intentsClient->batchDeleteIntents($formattedParent, $intents);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $intentsClient->batchDeleteIntents($formattedParent, $intents);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $intentsClient->resumeOperation($operationName, 'batchDeleteIntents');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$intentsClient->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.
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__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.
batchDeleteIntents
Deletes intents in 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 .
parent
string
Required. The name of the agent to delete all entities types for. Format: projects/<Project ID>/agent
.
intents
array< Google\Cloud\Dialogflow\V2\Intent
>
Required. The collection of intents to delete. Only intent name
must be
filled in.
optionalArgs
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\OperationResponse;
use Google\Cloud\Dialogflow\V2\Intent;
use Google\Cloud\Dialogflow\V2\IntentsClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The name of the agent to delete all entities types for. Format:
* `projects/<Project ID>/agent`. Please see
* {@see IntentsClient::agentName()} for help formatting this field.
* @param string $intentsDisplayName The name of this intent.
*/
function batch_delete_intents_sample(string $formattedParent, string $intentsDisplayName): void
{
// Create a client.
$intentsClient = new IntentsClient();
// Prepare any non-scalar elements to be passed along with the request.
$intent = (new Intent())
->setDisplayName($intentsDisplayName);
$intents = [$intent,];
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $intentsClient->batchDeleteIntents($formattedParent, $intents);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$formattedParent = IntentsClient::agentName('[PROJECT]');
$intentsDisplayName = '[DISPLAY_NAME]';
batch_delete_intents_sample($formattedParent, $intentsDisplayName);
}
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:
-
metadata
: An empty Struct message -
response
: BatchUpdateIntentsResponse
Note: You should always train an agent prior to sending it queries. See the training documentation .
parent
string
Required. The name of the agent to update or create intents in.
Format: projects/<Project ID>/agent
.
optionalArgs
array
Optional.
↳ intentBatchUri
string
The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".
↳ intentBatchInline
IntentBatch
The collection of intents to update or create.
↳ languageCode
string
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data .
↳ updateMask
FieldMask
Optional. The mask to control which fields get updated.
↳ intentView
int
Optional. The resource view to apply to the returned intent. For allowed values, use constants defined on Google\Cloud\Dialogflow\V2\IntentView
↳ 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\OperationResponse;
use Google\Cloud\Dialogflow\V2\BatchUpdateIntentsResponse;
use Google\Cloud\Dialogflow\V2\IntentsClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The name of the agent to update or create intents in.
* Format: `projects/<Project ID>/agent`. Please see
* {@see IntentsClient::agentName()} for help formatting this field.
*/
function batch_update_intents_sample(string $formattedParent): void
{
// Create a client.
$intentsClient = new IntentsClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $intentsClient->batchUpdateIntents($formattedParent);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var BatchUpdateIntentsResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$formattedParent = IntentsClient::agentName('[PROJECT]');
batch_update_intents_sample($formattedParent);
}
createIntent
Creates an intent in the specified agent.
Note: You should always train an agent prior to sending it queries. See the training documentation .
parent
string
Required. The agent to create a intent for.
Format: projects/<Project ID>/agent
.
intent
optionalArgs
array
Optional.
↳ languageCode
string
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data .
↳ intentView
int
Optional. The resource view to apply to the returned intent. For allowed values, use constants defined on Google\Cloud\Dialogflow\V2\IntentView
↳ 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\Intent;
use Google\Cloud\Dialogflow\V2\IntentsClient;
/**
* @param string $formattedParent The agent to create a intent for.
* Format: `projects/<Project ID>/agent`. Please see
* {@see IntentsClient::agentName()} for help formatting this field.
* @param string $intentDisplayName The name of this intent.
*/
function create_intent_sample(string $formattedParent, string $intentDisplayName): void
{
// Create a client.
$intentsClient = new IntentsClient();
// Prepare any non-scalar elements to be passed along with the request.
$intent = (new Intent())
->setDisplayName($intentDisplayName);
// Call the API and handle any network failures.
try {
/** @var Intent $response */
$response = $intentsClient->createIntent($formattedParent, $intent);
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
{
$formattedParent = IntentsClient::agentName('[PROJECT]');
$intentDisplayName = '[DISPLAY_NAME]';
create_intent_sample($formattedParent, $intentDisplayName);
}
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 .
name
string
Required. The name of the intent to delete. If this intent has direct or
indirect followup intents, we also delete them.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
optionalArgs
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\IntentsClient;
/**
* @param string $formattedName The name of the intent to delete. If this intent has direct or
* indirect followup intents, we also delete them.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`. Please see
* {@see IntentsClient::intentName()} for help formatting this field.
*/
function delete_intent_sample(string $formattedName): void
{
// Create a client.
$intentsClient = new IntentsClient();
// Call the API and handle any network failures.
try {
$intentsClient->deleteIntent($formattedName);
printf('Call completed successfully.' . PHP_EOL);
} 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
{
$formattedName = IntentsClient::intentName('[PROJECT]', '[INTENT]');
delete_intent_sample($formattedName);
}
getIntent
Retrieves the specified intent.
name
string
Required. The name of the intent.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
optionalArgs
array
Optional.
↳ languageCode
string
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data .
↳ intentView
int
Optional. The resource view to apply to the returned intent. For allowed values, use constants defined on Google\Cloud\Dialogflow\V2\IntentView
↳ 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\Intent;
use Google\Cloud\Dialogflow\V2\IntentsClient;
/**
* @param string $formattedName The name of the intent.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`. Please see
* {@see IntentsClient::intentName()} for help formatting this field.
*/
function get_intent_sample(string $formattedName): void
{
// Create a client.
$intentsClient = new IntentsClient();
// Call the API and handle any network failures.
try {
/** @var Intent $response */
$response = $intentsClient->getIntent($formattedName);
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
{
$formattedName = IntentsClient::intentName('[PROJECT]', '[INTENT]');
get_intent_sample($formattedName);
}
listIntents
Returns the list of all intents in the specified agent.
parent
string
Required. The agent to list all intents from.
Format: projects/<Project ID>/agent
or projects/<Project
ID>/locations/<Location ID>/agent
.
Alternatively, you can specify the environment to list intents for.
Format: projects/<Project ID>/agent/environments/<Environment ID>
or projects/<Project ID>/locations/<Location
ID>/agent/environments/<Environment ID>
.
Note: training phrases of the intents will not be returned for non-draft
environment.
optionalArgs
array
Optional.
↳ languageCode
string
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data .
↳ intentView
int
Optional. The resource view to apply to the returned intent. For allowed values, use constants defined on Google\Cloud\Dialogflow\V2\IntentView
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Intent;
use Google\Cloud\Dialogflow\V2\IntentsClient;
/**
* @param string $formattedParent The agent to list all intents from.
* Format: `projects/<Project ID>/agent` or `projects/<Project
* ID>/locations/<Location ID>/agent`.
*
* Alternatively, you can specify the environment to list intents for.
* Format: `projects/<Project ID>/agent/environments/<Environment ID>`
* or `projects/<Project ID>/locations/<Location
* ID>/agent/environments/<Environment ID>`.
* Note: training phrases of the intents will not be returned for non-draft
* environment. Please see
* {@see IntentsClient::agentName()} for help formatting this field.
*/
function list_intents_sample(string $formattedParent): void
{
// Create a client.
$intentsClient = new IntentsClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $intentsClient->listIntents($formattedParent);
/** @var Intent $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());
}
}
/**
* 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
{
$formattedParent = IntentsClient::agentName('[PROJECT]');
list_intents_sample($formattedParent);
}
updateIntent
Updates the specified intent.
Note: You should always train an agent prior to sending it queries. See the training documentation .
intent
optionalArgs
array
Optional.
↳ languageCode
string
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data .
↳ updateMask
FieldMask
Optional. The mask to control which fields get updated.
↳ intentView
int
Optional. The resource view to apply to the returned intent. For allowed values, use constants defined on Google\Cloud\Dialogflow\V2\IntentView
↳ 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\Intent;
use Google\Cloud\Dialogflow\V2\IntentsClient;
/**
* @param string $intentDisplayName The name of this intent.
*/
function update_intent_sample(string $intentDisplayName): void
{
// Create a client.
$intentsClient = new IntentsClient();
// Prepare any non-scalar elements to be passed along with the request.
$intent = (new Intent())
->setDisplayName($intentDisplayName);
// Call the API and handle any network failures.
try {
/** @var Intent $response */
$response = $intentsClient->updateIntent($intent);
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
{
$intentDisplayName = '[DISPLAY_NAME]';
update_intent_sample($intentDisplayName);
}
getLocation
Gets information about a location.
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\IntentsClient;
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.
$intentsClient = new IntentsClient();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $intentsClient->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.
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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\IntentsClient;
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.
$intentsClient = new IntentsClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $intentsClient->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());
}
}
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::contextName
Formats a string containing the fully-qualified path to represent a context resource.
project
string
session
string
context
string
string
static::intentName
Formats a string containing the fully-qualified path to represent a intent resource.
project
string
intent
string
string
static::projectAgentName
Formats a string containing the fully-qualified path to represent a project_agent resource.
project
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::projectIntentName
Formats a string containing the fully-qualified path to represent a project_intent resource.
project
string
intent
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::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::projectLocationIntentName
Formats a string containing the fully-qualified path to represent a project_location_intent resource.
project
string
location
string
intent
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::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::sessionName
Formats a string containing the fully-qualified path to represent a session resource.
project
string
session
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
- 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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
Constants
SERVICE_NAME
Value: 'google.cloud.dialogflow.v2.Intents'
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.