Google Cloud Dialogflow V2 Client - Class ConversationProfilesClient (1.15.1)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\ClearSuggestionFeatureConfigRequest;
use Google\Cloud\Dialogflow\V2\Client\ConversationProfilesClient;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\Participant\Role;
use Google\Cloud\Dialogflow\V2\SuggestionFeature\Type;
use Google\Rpc\Status;

/**
 * @param string $conversationProfile   The Conversation Profile to add or update the suggestion feature
 *                                      config. Format: `projects/<Project ID>/locations/<Location
 *                                      ID>/conversationProfiles/<Conversation Profile ID>`.
 * @param int    $participantRole       The participant role to remove the suggestion feature
 *                                      config. Only HUMAN_AGENT or END_USER can be used.
 * @param int    $suggestionFeatureType The type of the suggestion feature to remove.
 */
function clear_suggestion_feature_config_sample(
    string $conversationProfile,
    int $participantRole,
    int $suggestionFeatureType
): void {
    // Create a client.
    $conversationProfilesClient = new ConversationProfilesClient();

    // Prepare the request message.
    $request = (new ClearSuggestionFeatureConfigRequest())
        ->setConversationProfile($conversationProfile)
        ->setParticipantRole($participantRole)
        ->setSuggestionFeatureType($suggestionFeatureType);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $conversationProfilesClient->clearSuggestionFeatureConfig($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ConversationProfile $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $conversationProfile = '[CONVERSATION_PROFILE]';
    $participantRole = Role::ROLE_UNSPECIFIED;
    $suggestionFeatureType = Type::TYPE_UNSPECIFIED;

    clear_suggestion_feature_config_sample(
        $conversationProfile,
        $participantRole,
        $suggestionFeatureType
    );
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationProfilesClient;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\CreateConversationProfileRequest;

/**
 * @param string $formattedParent                The project to create a conversation profile for.
 *                                               Format: `projects/<Project ID>/locations/<Location ID>`. Please see
 *                                               {@see ConversationProfilesClient::projectName()} for help formatting this field.
 * @param string $conversationProfileDisplayName Human readable name for this profile. Max length 1024 bytes.
 */
function create_conversation_profile_sample(
    string $formattedParent,
    string $conversationProfileDisplayName
): void {
    // Create a client.
    $conversationProfilesClient = new ConversationProfilesClient();

    // Prepare the request message.
    $conversationProfile = (new ConversationProfile())
        ->setDisplayName($conversationProfileDisplayName);
    $request = (new CreateConversationProfileRequest())
        ->setParent($formattedParent)
        ->setConversationProfile($conversationProfile);

    // Call the API and handle any network failures.
    try {
        /** @var ConversationProfile $response */
        $response = $conversationProfilesClient->createConversationProfile($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 = ConversationProfilesClient::projectName('[PROJECT]');
    $conversationProfileDisplayName = '[DISPLAY_NAME]';

    create_conversation_profile_sample($formattedParent, $conversationProfileDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationProfilesClient;
use Google\Cloud\Dialogflow\V2\DeleteConversationProfileRequest;

/**
 * @param string $formattedName The name of the conversation profile to delete.
 *                              Format: `projects/<Project ID>/locations/<Location
 *                              ID>/conversationProfiles/<Conversation Profile ID>`. Please see
 *                              {@see ConversationProfilesClient::conversationProfileName()} for help formatting this field.
 */
function delete_conversation_profile_sample(string $formattedName): void
{
    // Create a client.
    $conversationProfilesClient = new ConversationProfilesClient();

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

    // Call the API and handle any network failures.
    try {
        $conversationProfilesClient->deleteConversationProfile($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ConversationProfilesClient::conversationProfileName(
        '[PROJECT]',
        '[CONVERSATION_PROFILE]'
    );

    delete_conversation_profile_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationProfilesClient;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\GetConversationProfileRequest;

/**
 * @param string $formattedName The resource name of the conversation profile.
 *                              Format: `projects/<Project ID>/locations/<Location
 *                              ID>/conversationProfiles/<Conversation Profile ID>`. Please see
 *                              {@see ConversationProfilesClient::conversationProfileName()} for help formatting this field.
 */
function get_conversation_profile_sample(string $formattedName): void
{
    // Create a client.
    $conversationProfilesClient = new ConversationProfilesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ConversationProfile $response */
        $response = $conversationProfilesClient->getConversationProfile($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 = ConversationProfilesClient::conversationProfileName(
        '[PROJECT]',
        '[CONVERSATION_PROFILE]'
    );

    get_conversation_profile_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationProfilesClient;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\ListConversationProfilesRequest;

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

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

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

        /** @var ConversationProfile $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 = ConversationProfilesClient::projectName('[PROJECT]');

    list_conversation_profiles_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\Client\ConversationProfilesClient;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\HumanAgentAssistantConfig\SuggestionFeatureConfig;
use Google\Cloud\Dialogflow\V2\Participant\Role;
use Google\Cloud\Dialogflow\V2\SetSuggestionFeatureConfigRequest;
use Google\Rpc\Status;

/**
 * @param string $conversationProfile The Conversation Profile to add or update the suggestion feature
 *                                    config. Format: `projects/<Project ID>/locations/<Location
 *                                    ID>/conversationProfiles/<Conversation Profile ID>`.
 * @param int    $participantRole     The participant role to add or update the suggestion feature
 *                                    config. Only HUMAN_AGENT or END_USER can be used.
 */
function set_suggestion_feature_config_sample(
    string $conversationProfile,
    int $participantRole
): void {
    // Create a client.
    $conversationProfilesClient = new ConversationProfilesClient();

    // Prepare the request message.
    $suggestionFeatureConfig = new SuggestionFeatureConfig();
    $request = (new SetSuggestionFeatureConfigRequest())
        ->setConversationProfile($conversationProfile)
        ->setParticipantRole($participantRole)
        ->setSuggestionFeatureConfig($suggestionFeatureConfig);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $conversationProfilesClient->setSuggestionFeatureConfig($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ConversationProfile $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $conversationProfile = '[CONVERSATION_PROFILE]';
    $participantRole = Role::ROLE_UNSPECIFIED;

    set_suggestion_feature_config_sample($conversationProfile, $participantRole);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ConversationProfilesClient;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\UpdateConversationProfileRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $conversationProfileDisplayName Human readable name for this profile. Max length 1024 bytes.
 */
function update_conversation_profile_sample(string $conversationProfileDisplayName): void
{
    // Create a client.
    $conversationProfilesClient = new ConversationProfilesClient();

    // Prepare the request message.
    $conversationProfile = (new ConversationProfile())
        ->setDisplayName($conversationProfileDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdateConversationProfileRequest())
        ->setConversationProfile($conversationProfile)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var ConversationProfile $response */
        $response = $conversationProfilesClient->updateConversationProfile($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
{
    $conversationProfileDisplayName = '[DISPLAY_NAME]';

    update_conversation_profile_sample($conversationProfileDisplayName);
}

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

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $conversationProfilesClient->getLocation($request);
        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\Client\ConversationProfilesClient;
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.
    $conversationProfilesClient = new ConversationProfilesClient();

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

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