Google Cloud Dialogflow V2 Client - Class ConversationsClient (1.17.2)

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.

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 \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array

Optional. Options for configuring the service API wrapper.
↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "
↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
↳ logger false|LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

completeConversation

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

The async variant is ConversationsClient::completeConversationAsync() .

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

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\Conversation
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
use Google\Cloud\Dialogflow\V2\CompleteConversationRequest;
use Google\Cloud\Dialogflow\V2\Conversation;

/**
 * @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();

    // Prepare the request message.
    $request = (new CompleteConversationRequest())
        ->setName($formattedName);

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

The async variant is ConversationsClient::createConversationAsync() .

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

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\Conversation
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
use Google\Cloud\Dialogflow\V2\Conversation;
use Google\Cloud\Dialogflow\V2\CreateConversationRequest;

/**
 * @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 the request message.
    $conversation = (new Conversation())
        ->setConversationProfile($formattedConversationConversationProfile);
    $request = (new CreateConversationRequest())
        ->setParent($formattedParent)
        ->setConversation($conversation);

    // Call the API and handle any network failures.
    try {
        /** @var Conversation $response */
        $response = $conversationsClient->createConversation($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 = ConversationsClient::projectName('[PROJECT]');
    $formattedConversationConversationProfile = ConversationsClient::conversationProfileName(
        '[PROJECT]',
        '[CONVERSATION_PROFILE]'
    );

    create_conversation_sample($formattedParent, $formattedConversationConversationProfile);
}

generateStatelessSuggestion

Generates and returns a suggestion for a conversation that does not have a resource created for it.

The async variant is ConversationsClient::generateStatelessSuggestionAsync() .

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

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\GenerateStatelessSuggestionResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
use Google\Cloud\Dialogflow\V2\GenerateStatelessSuggestionRequest;
use Google\Cloud\Dialogflow\V2\GenerateStatelessSuggestionResponse;

/**
 * @param string $formattedParent The parent resource to charge for the Suggestion's generation.
 *                                Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                {@see ConversationsClient::locationName()} for help formatting this field.
 */
function generate_stateless_suggestion_sample(string $formattedParent): void
{
    // Create a client.
    $conversationsClient = new ConversationsClient();

    // Prepare the request message.
    $request = (new GenerateStatelessSuggestionRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var GenerateStatelessSuggestionResponse $response */
        $response = $conversationsClient->generateStatelessSuggestion($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 = ConversationsClient::locationName('[PROJECT]', '[LOCATION]');

    generate_stateless_suggestion_sample($formattedParent);
}

generateStatelessSummary

Generates and returns a summary for a conversation that does not have a resource created for it.

The async variant is ConversationsClient::generateStatelessSummaryAsync() .

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

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\GenerateStatelessSummaryResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\GenerateStatelessSummaryRequest;
use Google\Cloud\Dialogflow\V2\GenerateStatelessSummaryRequest\MinimalConversation;
use Google\Cloud\Dialogflow\V2\GenerateStatelessSummaryResponse;
use Google\Cloud\Dialogflow\V2\Message;

/**
 * @param string $statelessConversationMessagesContent The message content.
 * @param string $formattedStatelessConversationParent The parent resource to charge for the Summary's generation.
 *                                                     Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                                     {@see ConversationsClient::locationName()} for help formatting this field.
 * @param string $conversationProfileDisplayName       Human readable name for this profile. Max length 1024 bytes.
 */
function generate_stateless_summary_sample(
    string $statelessConversationMessagesContent,
    string $formattedStatelessConversationParent,
    string $conversationProfileDisplayName
): void {
    // Create a client.
    $conversationsClient = new ConversationsClient();

    // Prepare the request message.
    $message = (new Message())
        ->setContent($statelessConversationMessagesContent);
    $statelessConversationMessages = [$message,];
    $statelessConversation = (new MinimalConversation())
        ->setMessages($statelessConversationMessages)
        ->setParent($formattedStatelessConversationParent);
    $conversationProfile = (new ConversationProfile())
        ->setDisplayName($conversationProfileDisplayName);
    $request = (new GenerateStatelessSummaryRequest())
        ->setStatelessConversation($statelessConversation)
        ->setConversationProfile($conversationProfile);

    // Call the API and handle any network failures.
    try {
        /** @var GenerateStatelessSummaryResponse $response */
        $response = $conversationsClient->generateStatelessSummary($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
{
    $statelessConversationMessagesContent = '[CONTENT]';
    $formattedStatelessConversationParent = ConversationsClient::locationName(
        '[PROJECT]',
        '[LOCATION]'
    );
    $conversationProfileDisplayName = '[DISPLAY_NAME]';

    generate_stateless_summary_sample(
        $statelessConversationMessagesContent,
        $formattedStatelessConversationParent,
        $conversationProfileDisplayName
    );
}

getConversation

Retrieves the specific conversation.

The async variant is ConversationsClient::getConversationAsync() .

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

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\Conversation
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
use Google\Cloud\Dialogflow\V2\Conversation;
use Google\Cloud\Dialogflow\V2\GetConversationRequest;

/**
 * @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();

    // Prepare the request message.
    $request = (new GetConversationRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Conversation $response */
        $response = $conversationsClient->getConversation($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 = ConversationsClient::conversationName('[PROJECT]', '[CONVERSATION]');

    get_conversation_sample($formattedName);
}

listConversations

Returns the list of all conversations in the specified project.

The async variant is ConversationsClient::listConversationsAsync() .

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

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
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
use Google\Cloud\Dialogflow\V2\Conversation;
use Google\Cloud\Dialogflow\V2\ListConversationsRequest;

/**
 * @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();

    // Prepare the request message.
    $request = (new ListConversationsRequest())
        ->setParent($formattedParent);

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

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

/**
 * 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 = 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.

The async variant is ConversationsClient::listMessagesAsync() .

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

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
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
use Google\Cloud\Dialogflow\V2\ListMessagesRequest;
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();

    // Prepare the request message.
    $request = (new ListMessagesRequest())
        ->setParent($formattedParent);

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

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

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

    list_messages_sample($formattedParent);
}

searchKnowledge

Get answers for the given query based on knowledge documents.

The async variant is ConversationsClient::searchKnowledgeAsync() .

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

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\SearchKnowledgeResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
use Google\Cloud\Dialogflow\V2\SearchKnowledgeRequest;
use Google\Cloud\Dialogflow\V2\SearchKnowledgeResponse;
use Google\Cloud\Dialogflow\V2\TextInput;

/**
 * @param string $queryText                    The UTF-8 encoded natural language text to be processed.
 *                                             Text length must not exceed 256 characters for virtual agent interactions.
 * @param string $queryLanguageCode            The language of this conversational query. See [Language
 *                                             Support](https://cloud.google.com/dialogflow/docs/reference/language)
 *                                             for a list of the currently supported language codes. Note that queries in
 *                                             the same session do not necessarily need to specify the same language.
 * @param string $formattedConversationProfile The conversation profile used to configure the search.
 *                                             Format: `projects/<Project ID>/locations/<Location
 *                                             ID>/conversationProfiles/<Conversation Profile ID>`. Please see
 *                                             {@see ConversationsClient::conversationProfileName()} for help formatting this field.
 */
function search_knowledge_sample(
    string $queryText,
    string $queryLanguageCode,
    string $formattedConversationProfile
): void {
    // Create a client.
    $conversationsClient = new ConversationsClient();

    // Prepare the request message.
    $query = (new TextInput())
        ->setText($queryText)
        ->setLanguageCode($queryLanguageCode);
    $request = (new SearchKnowledgeRequest())
        ->setQuery($query)
        ->setConversationProfile($formattedConversationProfile);

    // Call the API and handle any network failures.
    try {
        /** @var SearchKnowledgeResponse $response */
        $response = $conversationsClient->searchKnowledge($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
{
    $queryText = '[TEXT]';
    $queryLanguageCode = '[LANGUAGE_CODE]';
    $formattedConversationProfile = ConversationsClient::conversationProfileName(
        '[PROJECT]',
        '[CONVERSATION_PROFILE]'
    );

    search_knowledge_sample($queryText, $queryLanguageCode, $formattedConversationProfile);
}

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.

The async variant is ConversationsClient::suggestConversationSummaryAsync() .

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

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\SuggestConversationSummaryResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
use Google\Cloud\Dialogflow\V2\SuggestConversationSummaryRequest;
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();

    // Prepare the request message.
    $request = (new SuggestConversationSummaryRequest())
        ->setConversation($formattedConversation);

    // Call the API and handle any network failures.
    try {
        /** @var SuggestConversationSummaryResponse $response */
        $response = $conversationsClient->suggestConversationSummary($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
{
    $formattedConversation = ConversationsClient::conversationName('[PROJECT]', '[CONVERSATION]');

    suggest_conversation_summary_sample($formattedConversation);
}

getLocation

Gets information about a location.

The async variant is ConversationsClient::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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
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.
    $conversationsClient = new ConversationsClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $conversationsClient->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 ConversationsClient::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
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationsClient;
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.
    $conversationsClient = new ConversationsClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

completeConversationAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\CompleteConversationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\Conversation>

createConversationAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\CreateConversationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\Conversation>

generateStatelessSuggestionAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\GenerateStatelessSuggestionRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\GenerateStatelessSuggestionResponse>

generateStatelessSummaryAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\GenerateStatelessSummaryRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\GenerateStatelessSummaryResponse>

getConversationAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\GetConversationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\Conversation>

listConversationsAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\ListConversationsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listMessagesAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\ListMessagesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

searchKnowledgeAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\SearchKnowledgeRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\SearchKnowledgeResponse>

suggestConversationSummaryAsync

Parameters
Name Description
request Google\Cloud\Dialogflow\V2\SuggestConversationSummaryRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\SuggestConversationSummaryResponse>

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>

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

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

Parameters
Name Description
project string
location string
securitySettings string
Returns
Type Description
string The formatted cx_security_settings resource.

static::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.

static::conversationModelName

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

Parameters
Name Description
project string
location string
conversationModel string
Returns
Type Description
string The formatted conversation_model resource.

static::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.

static::dataStoreName

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

Parameters
Name Description
project string
location string
collection string
dataStore string
Returns
Type Description
string The formatted data_store resource.

static::documentName

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

Parameters
Name Description
project string
knowledgeBase string
document string
Returns
Type Description
string The formatted document resource.

static::generatorName

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

Parameters
Name Description
project string
location string
generator string
Returns
Type Description
string The formatted generator resource.

static::knowledgeBaseName

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

Parameters
Name Description
project string
knowledgeBase string
Returns
Type Description
string The formatted knowledge_base resource.

static::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.

static::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.

static::phraseSetName

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

Parameters
Name Description
project string
location string
phraseSet string
Returns
Type Description
string The formatted phrase_set resource.

static::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.

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

static::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.

static::projectConversationModelName

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

Parameters
Name Description
project string
conversationModel string
Returns
Type Description
string The formatted project_conversation_model resource.

static::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.

static::projectKnowledgeBaseName

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

Parameters
Name Description
project string
knowledgeBase string
Returns
Type Description
string The formatted project_knowledge_base resource.

static::projectKnowledgeBaseDocumentName

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

Parameters
Name Description
project string
knowledgeBase string
document string
Returns
Type Description
string The formatted project_knowledge_base_document 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::projectLocationCollectionDataStoreName

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

Parameters
Name Description
project string
location string
collection string
dataStore string
Returns
Type Description
string The formatted project_location_collection_data_store resource.

static::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.

static::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.

static::projectLocationConversationModelName

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

Parameters
Name Description
project string
location string
conversationModel string
Returns
Type Description
string The formatted project_location_conversation_model resource.

static::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.

static::projectLocationDataStoreName

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

Parameters
Name Description
project string
location string
dataStore string
Returns
Type Description
string The formatted project_location_data_store resource.

static::projectLocationKnowledgeBaseName

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

Parameters
Name Description
project string
location string
knowledgeBase string
Returns
Type Description
string The formatted project_location_knowledge_base resource.

static::projectLocationKnowledgeBaseDocumentName

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

Parameters
Name Description
project string
location string
knowledgeBase string
document string
Returns
Type Description
string The formatted project_location_knowledge_base_document 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
  • cXSecuritySettings: projects/{project}/locations/{location}/securitySettings/{security_settings}
  • conversation: projects/{project}/conversations/{conversation}
  • conversationModel: projects/{project}/locations/{location}/conversationModels/{conversation_model}
  • conversationProfile: projects/{project}/conversationProfiles/{conversation_profile}
  • dataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
  • document: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
  • generator: projects/{project}/locations/{location}/generators/{generator}
  • knowledgeBase: projects/{project}/knowledgeBases/{knowledge_base}
  • location: projects/{project}/locations/{location}
  • message: projects/{project}/conversations/{conversation}/messages/{message}
  • phraseSet: projects/{project}/locations/{location}/phraseSets/{phrase_set}
  • project: projects/{project}
  • projectAgent: projects/{project}/agent
  • projectConversation: projects/{project}/conversations/{conversation}
  • projectConversationMessage: projects/{project}/conversations/{conversation}/messages/{message}
  • projectConversationModel: projects/{project}/conversationModels/{conversation_model}
  • projectConversationProfile: projects/{project}/conversationProfiles/{conversation_profile}
  • projectKnowledgeBase: projects/{project}/knowledgeBases/{knowledge_base}
  • projectKnowledgeBaseDocument: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
  • projectLocationAgent: projects/{project}/locations/{location}/agent
  • projectLocationCollectionDataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
  • projectLocationConversation: projects/{project}/locations/{location}/conversations/{conversation}
  • projectLocationConversationMessage: projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}
  • projectLocationConversationModel: projects/{project}/locations/{location}/conversationModels/{conversation_model}
  • projectLocationConversationProfile: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
  • projectLocationDataStore: projects/{project}/locations/{location}/dataStores/{data_store}
  • projectLocationKnowledgeBase: projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}
  • projectLocationKnowledgeBaseDocument: projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}

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.