Google Cloud Dialogflow V2 Client - Class ConversationsClient (1.2.0)

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

Service Description: Service for managing Conversations.

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:

$conversationsClient = new ConversationsClient();
try {
    $formattedName = $conversationsClient->conversationName('[PROJECT]', '[CONVERSATION]');
    $response = $conversationsClient->completeConversation($formattedName);
} finally {
    $conversationsClient->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.

Methods

conversationName

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

Parameters
Name	Description
`project`	`string`
`conversation`	`string`

Returns
Type	Description
`string`	The formatted conversation resource.

conversationProfileName

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

Parameters
Name	Description
`project`	`string`
`conversationProfile`	`string`

Returns
Type	Description
`string`	The formatted conversation_profile resource.

locationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

messageName

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

Parameters
Name	Description
`project`	`string`
`conversation`	`string`
`message`	`string`

Returns
Type	Description
`string`	The formatted message resource.

projectName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

projectConversationName

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

Parameters
Name	Description
`project`	`string`
`conversation`	`string`

Returns
Type	Description
`string`	The formatted project_conversation resource.

projectConversationMessageName

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

Parameters
Name	Description
`project`	`string`
`conversation`	`string`
`message`	`string`

Returns
Type	Description
`string`	The formatted project_conversation_message resource.

projectConversationProfileName

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

Parameters
Name	Description
`project`	`string`
`conversationProfile`	`string`

Returns
Type	Description
`string`	The formatted project_conversation_profile resource.

projectLocationConversationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`conversation`	`string`

Returns
Type	Description
`string`	The formatted project_location_conversation resource.

projectLocationConversationMessageName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`conversation`	`string`
`message`	`string`

Returns
Type	Description
`string`	The formatted project_location_conversation_message resource.

projectLocationConversationProfileName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`conversationProfile`	`string`

Returns
Type	Description
`string`	The formatted project_location_conversation_profile resource.

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

conversation: projects/{project}/conversations/{conversation}
conversationProfile: projects/{project}/conversationProfiles/{conversation_profile}
location: projects/{project}/locations/{location}
message: projects/{project}/conversations/{conversation}/messages/{message}
project: projects/{project}
projectConversation: projects/{project}/conversations/{conversation}
projectConversationMessage: projects/{project}/conversations/{conversation}/messages/{message}
projectConversationProfile: projects/{project}/conversationProfiles/{conversation_profile}
projectLocationConversation: projects/{project}/locations/{location}/conversations/{conversation}
projectLocationConversationMessage: projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}
projectLocationConversationProfile: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}

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.

__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.

completeConversation

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

Parameters
Name	Description
`name`	`string` Required. Resource identifier of the conversation to close. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation 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.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\Conversation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Conversation;
use Google\Cloud\Dialogflow\V2\ConversationsClient;

/**
 * @param string $formattedName Resource identifier of the conversation to close.
 *                              Format: `projects/<Project ID>/locations/<Location
 *                              ID>/conversations/<Conversation ID>`. Please see
 *                              {@see ConversationsClient::conversationName()} for help formatting this field.
 */
function complete_conversation_sample(string $formattedName): void
{
    // Create a client.
    $conversationsClient = new ConversationsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Conversation $response */
        $response = $conversationsClient->completeConversation($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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 = ConversationsClient::conversationName('[PROJECT]', '[CONVERSATION]');

    complete_conversation_sample($formattedName);
}

createConversation

Creates a new conversation. Conversations are auto-completed after 24 hours.

Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.

For Automated Agent Stage, there will be a dialogflow agent responding to user queries.

For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.

If Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from Automated Agent Stage, otherwise, it will start from Assist Stage. And during Automated Agent Stage, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage.

Parameters
Name	Description
`parent`	`string` Required. Resource identifier of the project creating the conversation. Format: `projects/<Project ID>/locations/<Location ID>`.
`conversation`	`Google\Cloud\Dialogflow\V2\Conversation` Required. The conversation to create.
`optionalArgs`	`array` Optional.
`↳ conversationId`	`string` Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula "[a-zA-Z][a-zA-Z0-9_-]*" with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
`↳ 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\Conversation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Conversation;
use Google\Cloud\Dialogflow\V2\ConversationsClient;

/**
 * @param string $formattedParent                          Resource identifier of the project creating the conversation.
 *                                                         Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                                         {@see ConversationsClient::projectName()} for help formatting this field.
 * @param string $formattedConversationConversationProfile The Conversation Profile to be used to configure this
 *                                                         Conversation. This field cannot be updated.
 *                                                         Format: `projects/<Project ID>/locations/<Location
 *                                                         ID>/conversationProfiles/<Conversation Profile ID>`. Please see
 *                                                         {@see ConversationsClient::conversationProfileName()} for help formatting this field.
 */
function create_conversation_sample(
    string $formattedParent,
    string $formattedConversationConversationProfile
): void {
    // Create a client.
    $conversationsClient = new ConversationsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $conversation = (new Conversation())
        ->setConversationProfile($formattedConversationConversationProfile);

    // Call the API and handle any network failures.
    try {
        /** @var Conversation $response */
        $response = $conversationsClient->createConversation($formattedParent, $conversation);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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 = ConversationsClient::projectName('[PROJECT]');
    $formattedConversationConversationProfile = ConversationsClient::conversationProfileName(
        '[PROJECT]',
        '[CONVERSATION_PROFILE]'
    );

    create_conversation_sample($formattedParent, $formattedConversationConversationProfile);
}

getConversation

Retrieves the specific conversation.

Parameters
Name	Description
`name`	`string` Required. The name of the conversation. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation 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.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\Conversation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Conversation;
use Google\Cloud\Dialogflow\V2\ConversationsClient;

/**
 * @param string $formattedName The name of the conversation. Format:
 *                              `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation
 *                              ID>`. Please see
 *                              {@see ConversationsClient::conversationName()} for help formatting this field.
 */
function get_conversation_sample(string $formattedName): void
{
    // Create a client.
    $conversationsClient = new ConversationsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Conversation $response */
        $response = $conversationsClient->getConversation($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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 = ConversationsClient::conversationName('[PROJECT]', '[CONVERSATION]');

    get_conversation_sample($formattedName);
}

listConversations

Returns the list of all conversations in the specified project.

Parameters
Name	Description
`parent`	`string` Required. The project from which to list all conversation. Format: `projects/<Project ID>/locations/<Location ID>`.
`optionalArgs`	`array` Optional.
`↳ 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.
`↳ filter`	`string` A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: The value must be a string, a number, or a boolean. The comparison operator must be either `=`,`!=`, `>`, or `<`. To filter on multiple expressions, separate the expressions with `AND` or `OR` (omitting both implies `AND`). For clarity, expressions can be enclosed in parentheses. Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `COMPLETED` conversations: `lifecycle_state = "COMPLETED"` For more information about filtering, see API Filtering.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Conversation;
use Google\Cloud\Dialogflow\V2\ConversationsClient;

/**
 * @param string $formattedParent The project from which to list all conversation.
 *                                Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                {@see ConversationsClient::projectName()} for help formatting this field.
 */
function list_conversations_sample(string $formattedParent): void
{
    // Create a client.
    $conversationsClient = new ConversationsClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $conversationsClient->listConversations($formattedParent);

        /** @var Conversation $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());
    }
}

/**
 * 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 = ConversationsClient::projectName('[PROJECT]');

    list_conversations_sample($formattedParent);
}

listMessages

Lists messages that belong to a given conversation.

messages are ordered by create_time in descending order. To fetch updates without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token.

Parameters
Name	Description
`parent`	`string` Required. The name of the conversation to list messages for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`
`optionalArgs`	`array` Optional.
`↳ filter`	`string` Optional. Filter on message fields. Currently predicates on `create_time` and `create_time_epoch_microseconds` are supported. `create_time` only support milliseconds accuracy. E.g., `create_time_epoch_microseconds > 1551790877964485` or `create_time > 2017-01-15T01:30:15.01Z`. For more information about filtering, see API Filtering.
`↳ 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.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\ConversationsClient;
use Google\Cloud\Dialogflow\V2\Message;

/**
 * @param string $formattedParent The name of the conversation to list messages for.
 *                                Format: `projects/<Project ID>/locations/<Location
 *                                ID>/conversations/<Conversation ID>`
 *                                Please see {@see ConversationsClient::conversationName()} for help formatting this field.
 */
function list_messages_sample(string $formattedParent): void
{
    // Create a client.
    $conversationsClient = new ConversationsClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $conversationsClient->listMessages($formattedParent);

        /** @var Message $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());
    }
}

/**
 * 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 = ConversationsClient::conversationName('[PROJECT]', '[CONVERSATION]');

    list_messages_sample($formattedParent);
}

suggestConversationSummary

Suggests summary for a conversation based on specific historical messages.

The range of the messages to be used for summary can be specified in the request.

Parameters
Name	Description
`conversation`	`string` Required. The conversation to fetch suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`.
`optionalArgs`	`array` Optional.
`↳ latestMessage`	`string` The name of the latest conversation message used as context for compiling suggestion. If empty, the latest message of the conversation will be used. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>`.
`↳ contextSize`	`int` Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000.
`↳ assistQueryParams`	`AssistQueryParameters` Parameters for a human assist query.
`↳ 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\SuggestConversationSummaryResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ConversationsClient;
use Google\Cloud\Dialogflow\V2\SuggestConversationSummaryResponse;

/**
 * @param string $formattedConversation The conversation to fetch suggestion for.
 *                                      Format: `projects/<Project ID>/locations/<Location
 *                                      ID>/conversations/<Conversation ID>`. Please see
 *                                      {@see ConversationsClient::conversationName()} for help formatting this field.
 */
function suggest_conversation_summary_sample(string $formattedConversation): void
{
    // Create a client.
    $conversationsClient = new ConversationsClient();

    // Call the API and handle any network failures.
    try {
        /** @var SuggestConversationSummaryResponse $response */
        $response = $conversationsClient->suggestConversationSummary($formattedConversation);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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
{
    $formattedConversation = ConversationsClient::conversationName('[PROJECT]', '[CONVERSATION]');

    suggest_conversation_summary_sample($formattedConversation);
}

getLocation

Gets information about a location.

Parameters
Name	Description
`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.

Returns
Type	Description
`Google\Cloud\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ConversationsClient;
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.
    $conversationsClient = new ConversationsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $conversationsClient->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.

Parameters
Name	Description
`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.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\ConversationsClient;
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.
    $conversationsClient = new ConversationsClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $conversationsClient->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());
    }
}

Constants

SERVICE_NAME

Value: 'google.cloud.dialogflow.v2.Conversations'

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.