Google Cloud Dialogflow V2 Client - Class ConversationsClient (1.9.0)

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

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

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

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

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\ConversationsClient;
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 any non-scalar elements to be passed along with the request.
    $message = (new Message())
        ->setContent($statelessConversationMessagesContent);
    $statelessConversationMessages = [$message,];
    $statelessConversation = (new MinimalConversation())
        ->setMessages($statelessConversationMessages)
        ->setParent($formattedStatelessConversationParent);
    $conversationProfile = (new ConversationProfile())
        ->setDisplayName($conversationProfileDisplayName);

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

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

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

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

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

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

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

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ConversationsClient;
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 any non-scalar elements to be passed along with the request.
    $query = (new TextInput())
        ->setText($queryText)
        ->setLanguageCode($queryLanguageCode);

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

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

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

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

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