Google Cloud Dialogflow V2 Client - Class ParticipantsClient (1.8.0)

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\AnalyzeContentResponse;
use Google\Cloud\Dialogflow\V2\ParticipantsClient;

/**
 * @param string $formattedParticipant The name of the participant this text comes from.
 *                                     Format: `projects/<Project ID>/locations/<Location
 *                                     ID>/conversations/<Conversation ID>/participants/<Participant ID>`. Please see
 *                                     {@see ParticipantsClient::participantName()} for help formatting this field.
 */
function analyze_content_sample(string $formattedParticipant): void
{
    // Create a client.
    $participantsClient = new ParticipantsClient();

    // Call the API and handle any network failures.
    try {
        /** @var AnalyzeContentResponse $response */
        $response = $participantsClient->analyzeContent($formattedParticipant);
        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
{
    $formattedParticipant = ParticipantsClient::participantName(
        '[PROJECT]',
        '[CONVERSATION]',
        '[PARTICIPANT]'
    );

    analyze_content_sample($formattedParticipant);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Participant;
use Google\Cloud\Dialogflow\V2\ParticipantsClient;

/**
 * @param string $formattedParent Resource identifier of the conversation adding the participant.
 *                                Format: `projects/<Project ID>/locations/<Location
 *                                ID>/conversations/<Conversation ID>`. Please see
 *                                {@see ParticipantsClient::conversationName()} for help formatting this field.
 */
function create_participant_sample(string $formattedParent): void
{
    // Create a client.
    $participantsClient = new ParticipantsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $participant = new Participant();

    // Call the API and handle any network failures.
    try {
        /** @var Participant $response */
        $response = $participantsClient->createParticipant($formattedParent, $participant);
        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 = ParticipantsClient::conversationName('[PROJECT]', '[CONVERSATION]');

    create_participant_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Participant;
use Google\Cloud\Dialogflow\V2\ParticipantsClient;

/**
 * @param string $formattedName The name of the participant. Format:
 *                              `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation
 *                              ID>/participants/<Participant ID>`. Please see
 *                              {@see ParticipantsClient::participantName()} for help formatting this field.
 */
function get_participant_sample(string $formattedName): void
{
    // Create a client.
    $participantsClient = new ParticipantsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Participant $response */
        $response = $participantsClient->getParticipant($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 = ParticipantsClient::participantName(
        '[PROJECT]',
        '[CONVERSATION]',
        '[PARTICIPANT]'
    );

    get_participant_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Participant;
use Google\Cloud\Dialogflow\V2\ParticipantsClient;

/**
 * @param string $formattedParent The conversation to list all participants from.
 *                                Format: `projects/<Project ID>/locations/<Location
 *                                ID>/conversations/<Conversation ID>`. Please see
 *                                {@see ParticipantsClient::conversationName()} for help formatting this field.
 */
function list_participants_sample(string $formattedParent): void
{
    // Create a client.
    $participantsClient = new ParticipantsClient();

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

        /** @var Participant $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 = ParticipantsClient::conversationName('[PROJECT]', '[CONVERSATION]');

    list_participants_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Dialogflow\V2\ParticipantsClient;
use Google\Cloud\Dialogflow\V2\StreamingAnalyzeContentRequest;
use Google\Cloud\Dialogflow\V2\StreamingAnalyzeContentResponse;

/**
 * @param string $formattedParticipant The name of the participant this text comes from.
 *                                     Format: `projects/<Project ID>/locations/<Location
 *                                     ID>/conversations/<Conversation ID>/participants/<Participant ID>`. Please see
 *                                     {@see ParticipantsClient::participantName()} for help formatting this field.
 */
function streaming_analyze_content_sample(string $formattedParticipant): void
{
    // Create a client.
    $participantsClient = new ParticipantsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $request = (new StreamingAnalyzeContentRequest())
        ->setParticipant($formattedParticipant);

    // Call the API and handle any network failures.
    try {
        /** @var BidiStream $stream */
        $stream = $participantsClient->streamingAnalyzeContent();
        $stream->writeAll([$request,]);

        /** @var StreamingAnalyzeContentResponse $element */
        foreach ($stream->closeWriteAndReadAll() 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
{
    $formattedParticipant = ParticipantsClient::participantName(
        '[PROJECT]',
        '[CONVERSATION]',
        '[PARTICIPANT]'
    );

    streaming_analyze_content_sample($formattedParticipant);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ParticipantsClient;
use Google\Cloud\Dialogflow\V2\SuggestArticlesResponse;

/**
 * @param string $formattedParent The name of the participant to fetch suggestion for.
 *                                Format: `projects/<Project ID>/locations/<Location
 *                                ID>/conversations/<Conversation ID>/participants/<Participant ID>`. Please see
 *                                {@see ParticipantsClient::participantName()} for help formatting this field.
 */
function suggest_articles_sample(string $formattedParent): void
{
    // Create a client.
    $participantsClient = new ParticipantsClient();

    // Call the API and handle any network failures.
    try {
        /** @var SuggestArticlesResponse $response */
        $response = $participantsClient->suggestArticles($formattedParent);
        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 = ParticipantsClient::participantName(
        '[PROJECT]',
        '[CONVERSATION]',
        '[PARTICIPANT]'
    );

    suggest_articles_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ParticipantsClient;
use Google\Cloud\Dialogflow\V2\SuggestFaqAnswersResponse;

/**
 * @param string $formattedParent The name of the participant to fetch suggestion for.
 *                                Format: `projects/<Project ID>/locations/<Location
 *                                ID>/conversations/<Conversation ID>/participants/<Participant ID>`. Please see
 *                                {@see ParticipantsClient::participantName()} for help formatting this field.
 */
function suggest_faq_answers_sample(string $formattedParent): void
{
    // Create a client.
    $participantsClient = new ParticipantsClient();

    // Call the API and handle any network failures.
    try {
        /** @var SuggestFaqAnswersResponse $response */
        $response = $participantsClient->suggestFaqAnswers($formattedParent);
        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 = ParticipantsClient::participantName(
        '[PROJECT]',
        '[CONVERSATION]',
        '[PARTICIPANT]'
    );

    suggest_faq_answers_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\ParticipantsClient;
use Google\Cloud\Dialogflow\V2\SuggestSmartRepliesResponse;

/**
 * @param string $formattedParent The name of the participant to fetch suggestion for.
 *                                Format: `projects/<Project ID>/locations/<Location
 *                                ID>/conversations/<Conversation ID>/participants/<Participant ID>`. Please see
 *                                {@see ParticipantsClient::participantName()} for help formatting this field.
 */
function suggest_smart_replies_sample(string $formattedParent): void
{
    // Create a client.
    $participantsClient = new ParticipantsClient();

    // Call the API and handle any network failures.
    try {
        /** @var SuggestSmartRepliesResponse $response */
        $response = $participantsClient->suggestSmartReplies($formattedParent);
        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 = ParticipantsClient::participantName(
        '[PROJECT]',
        '[CONVERSATION]',
        '[PARTICIPANT]'
    );

    suggest_smart_replies_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Participant;
use Google\Cloud\Dialogflow\V2\ParticipantsClient;
use Google\Protobuf\FieldMask;

/**
 * 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 update_participant_sample(): void
{
    // Create a client.
    $participantsClient = new ParticipantsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $participant = new Participant();
    $updateMask = new FieldMask();

    // Call the API and handle any network failures.
    try {
        /** @var Participant $response */
        $response = $participantsClient->updateParticipant($participant, $updateMask);
        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\Cloud\Dialogflow\V2\ParticipantsClient;
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.
    $participantsClient = new ParticipantsClient();

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

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