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.
Namespace
Google \ Cloud \ Dialogflow \ V2 \ ClientMethods
__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 |
↳ 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 |
↳ 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 messageresponse
: An Empty message
Note: You should always train an agent prior to sending it queries. See the training documentation.
The async variant is 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 |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\BatchDeleteIntentsRequest;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\Intent;
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 the request message.
$intent = (new Intent())
->setDisplayName($intentsDisplayName);
$intents = [$intent,];
$request = (new BatchDeleteIntentsRequest())
->setParent($formattedParent)
->setIntents($intents);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $intentsClient->batchDeleteIntents($request);
$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 messageresponse
: BatchUpdateIntentsResponse
Note: You should always train an agent prior to sending it queries. See the training documentation.
The async variant is 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 |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\BatchUpdateIntentsRequest;
use Google\Cloud\Dialogflow\V2\BatchUpdateIntentsResponse;
use Google\Cloud\Dialogflow\V2\Client\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();
// Prepare the request message.
$request = (new BatchUpdateIntentsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $intentsClient->batchUpdateIntents($request);
$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.
The async variant is 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 |
Google\Cloud\Dialogflow\V2\Intent |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\CreateIntentRequest;
use Google\Cloud\Dialogflow\V2\Intent;
/**
* @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 the request message.
$intent = (new Intent())
->setDisplayName($intentDisplayName);
$request = (new CreateIntentRequest())
->setParent($formattedParent)
->setIntent($intent);
// Call the API and handle any network failures.
try {
/** @var Intent $response */
$response = $intentsClient->createIntent($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
{
$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.
The async variant is 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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\DeleteIntentRequest;
/**
* @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();
// Prepare the request message.
$request = (new DeleteIntentRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$intentsClient->deleteIntent($request);
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.
The async variant is 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 |
Google\Cloud\Dialogflow\V2\Intent |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\GetIntentRequest;
use Google\Cloud\Dialogflow\V2\Intent;
/**
* @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();
// Prepare the request message.
$request = (new GetIntentRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Intent $response */
$response = $intentsClient->getIntent($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
{
$formattedName = IntentsClient::intentName('[PROJECT]', '[INTENT]');
get_intent_sample($formattedName);
}
listIntents
Returns the list of all intents in the specified agent.
The async variant is 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 |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\Intent;
use Google\Cloud\Dialogflow\V2\ListIntentsRequest;
/**
* @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();
// Prepare the request message.
$request = (new ListIntentsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $intentsClient->listIntents($request);
/** @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.
The async variant is 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 |
Google\Cloud\Dialogflow\V2\Intent |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
use Google\Cloud\Dialogflow\V2\Intent;
use Google\Cloud\Dialogflow\V2\UpdateIntentRequest;
/**
* @param string $intentDisplayName The name of this intent.
*/
function update_intent_sample(string $intentDisplayName): void
{
// Create a client.
$intentsClient = new IntentsClient();
// Prepare the request message.
$intent = (new Intent())
->setDisplayName($intentDisplayName);
$request = (new UpdateIntentRequest())
->setIntent($intent);
// Call the API and handle any network failures.
try {
/** @var Intent $response */
$response = $intentsClient->updateIntent($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
{
$intentDisplayName = '[DISPLAY_NAME]';
update_intent_sample($intentDisplayName);
}
getLocation
Gets information about a location.
The async variant is 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 |
Google\Cloud\Location\Location |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
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.
$intentsClient = new IntentsClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $intentsClient->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 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 |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\IntentsClient;
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.
$intentsClient = new IntentsClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $intentsClient->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());
}
}
batchDeleteIntentsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\BatchDeleteIntentsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
batchUpdateIntentsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\BatchUpdateIntentsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
createIntentAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\CreateIntentRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\Intent> |
deleteIntentAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\DeleteIntentRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
getIntentAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\GetIntentRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\Intent> |
listIntentsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\ListIntentsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
updateIntentAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\UpdateIntentRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\Intent> |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\OperationsClient |
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 |
Google\ApiCore\OperationResponse |
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. |