Google Cloud Dialogflow V2 Client - Class ConversationProfilesClient (1.4.0)

$conversationProfilesClient = new ConversationProfilesClient();
try {
    $conversationProfile = 'conversation_profile';
    $participantRole = Role::ROLE_UNSPECIFIED;
    $suggestionFeatureType = Type::TYPE_UNSPECIFIED;
    $operationResponse = $conversationProfilesClient->clearSuggestionFeatureConfig($conversationProfile, $participantRole, $suggestionFeatureType);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $conversationProfilesClient->clearSuggestionFeatureConfig($conversationProfile, $participantRole, $suggestionFeatureType);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $conversationProfilesClient->resumeOperation($operationName, 'clearSuggestionFeatureConfig');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $conversationProfilesClient->close();
}

Methods

agentName

cXSecuritySettingsName

conversationModelName

conversationProfileName

documentName

knowledgeBaseName

locationName

projectName

projectAgentName

projectConversationModelName

projectConversationProfileName

projectKnowledgeBaseName

projectKnowledgeBaseDocumentName

projectLocationAgentName

projectLocationConversationModelName

projectLocationConversationProfileName

projectLocationKnowledgeBaseName

projectLocationKnowledgeBaseDocumentName

parseName

getOperationsClient

resumeOperation

__construct

clearSuggestionFeatureConfig

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\ConversationProfilesClient;
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();

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

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

createConversationProfile

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

/**
 * @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 any non-scalar elements to be passed along with the request.
    $conversationProfile = (new ConversationProfile())
        ->setDisplayName($conversationProfileDisplayName);

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

    create_conversation_profile_sample($formattedParent, $conversationProfileDisplayName);
}

deleteConversationProfile

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

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

    // Call the API and handle any network failures.
    try {
        $conversationProfilesClient->deleteConversationProfile($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = ConversationProfilesClient::conversationProfileName(
        '[PROJECT]',
        '[CONVERSATION_PROFILE]'
    );

    delete_conversation_profile_sample($formattedName);
}

getConversationProfile

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

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

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

    get_conversation_profile_sample($formattedName);
}

listConversationProfiles

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

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

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

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

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

setSuggestionFeatureConfig

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\ConversationProfilesClient;
use Google\Cloud\Dialogflow\V2\HumanAgentAssistantConfig\SuggestionFeatureConfig;
use Google\Cloud\Dialogflow\V2\Participant\Role;
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 any non-scalar elements to be passed along with the request.
    $suggestionFeatureConfig = new SuggestionFeatureConfig();

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

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

updateConversationProfile

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ConversationProfile;
use Google\Cloud\Dialogflow\V2\ConversationProfilesClient;
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 any non-scalar elements to be passed along with the request.
    $conversationProfile = (new ConversationProfile())
        ->setDisplayName($conversationProfileDisplayName);
    $updateMask = new FieldMask();

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

    update_conversation_profile_sample($conversationProfileDisplayName);
}

getLocation

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ConversationProfilesClient;
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();

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

listLocations

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

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

SERVICE_ADDRESS

Value: 'dialogflow.googleapis.com'

DEFAULT_SERVICE_PORT

Value: 443

CODEGEN_NAME

Value: 'gapic'