Google Cloud Dialogflow V2 Client - Class ParticipantsClient (1.8.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ParticipantsClient.

Service Description: Service for managing Participants.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$participantsClient = new ParticipantsClient();
try {
    $formattedParticipant = $participantsClient->participantName('[PROJECT]', '[CONVERSATION]', '[PARTICIPANT]');
    $response = $participantsClient->analyzeContent($formattedParticipant);
} finally {
    $participantsClient->close();
}

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.

This service has a new (beta) implementation. See Google\Cloud\Dialogflow\V2\Client\ParticipantsClient to use the new surface.

Namespace

Google \ Cloud \ Dialogflow \ V2

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.

analyzeContent

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameters
Name	Description
`participant`	`string` Required. The name of the participant this text comes from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
`optionalArgs`	`array` Optional.
`↳ textInput`	`TextInput` The natural language text to be processed.
`↳ eventInput`	`EventInput` An input event to send to Dialogflow.
`↳ replyAudioConfig`	`OutputAudioConfig` Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.
`↳ queryParams`	`QueryParameters` Parameters for a Dialogflow virtual-agent query.
`↳ assistQueryParams`	`AssistQueryParameters` Parameters for a human assist query.
`↳ cxParameters`	`Struct` Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Note: this field should only be used if you are connecting to a Dialogflow CX agent.
`↳ requestId`	`string` A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.
`↳ 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\AnalyzeContentResponse`

Example

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

createParticipant

Creates a new participant in a conversation.

Parameters
Name	Description
`parent`	`string` Required. Resource identifier of the conversation adding the participant. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`.
`participant`	`Google\Cloud\Dialogflow\V2\Participant` Required. The participant to create.
`optionalArgs`	`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\Participant`

Example

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

getParticipant

Retrieves a conversation participant.

Parameters
Name	Description
`name`	`string` Required. The name of the participant. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
`optionalArgs`	`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\Participant`

Example

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

listParticipants

Returns the list of all participants in the specified conversation.

Parameters
Name	Description
`parent`	`string` Required. The conversation to list all participants from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`.
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ 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\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);
}

streamingAnalyzeContent

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: This method is only available through the gRPC API (not REST).

The top-level message sent to the client by the server is StreamingAnalyzeContentResponse. Multiple response messages can be returned in order. The first one or more messages contain the recognition_result field. Each result represents a more complete transcript of what the user said. The next message contains the reply_text field and potentially the reply_audio field. The message can also contain the automated_agent_reply field.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\BidiStream`

Example

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

suggestArticles

Gets suggested articles for a participant based on specific historical messages.

Parameters
Name	Description
`parent`	`string` Required. The name of the participant to fetch suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
`optionalArgs`	`array` Optional.
`↳ latestMessage`	`string` Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>`.
`↳ contextSize`	`int` Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. By default 20 and at most 50.
`↳ assistQueryParams`	`AssistQueryParameters` Parameters for a human assist query.
`↳ 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\SuggestArticlesResponse`

Example

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

suggestFaqAnswers

Gets suggested faq answers for a participant based on specific historical messages.

Parameters
Name	Description
`parent`	`string` Required. The name of the participant to fetch suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
`optionalArgs`	`array` Optional.
`↳ latestMessage`	`string` Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>`.
`↳ contextSize`	`int` Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50.
`↳ assistQueryParams`	`AssistQueryParameters` Parameters for a human assist query.
`↳ 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\SuggestFaqAnswersResponse`

Example

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

suggestSmartReplies

Gets smart replies for a participant based on specific historical messages.

Parameters
Name	Description
`parent`	`string` Required. The name of the participant to fetch suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
`optionalArgs`	`array` Optional.
`↳ currentTextInput`	`TextInput` The current natural language text segment to compile suggestion for. This provides a way for user to get follow up smart reply suggestion after a smart reply selection, without sending a text message.
`↳ latestMessage`	`string` The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>`.
`↳ contextSize`	`int` Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50.
`↳ 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\SuggestSmartRepliesResponse`

Example

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

updateParticipant

Updates the specified participant.

Parameters
Name	Description
`participant`	`Google\Cloud\Dialogflow\V2\Participant` Required. The participant to update.
`updateMask`	`Google\Protobuf\FieldMask` Required. The mask to specify which fields to update.
`optionalArgs`	`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\Participant`

Example

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

getLocation

Gets information about a location.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` Resource name for the location.
`↳ 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\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());
    }
}

listLocations

Lists information about the supported locations for this service.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` The resource that owns the locations collection, if applicable.
`↳ filter`	`string` The standard list filter.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ 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\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());
    }
}

static::contextName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`
`context`	`string`

Returns
Type	Description
`string`	The formatted context 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::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::participantName

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

Parameters
Name	Description
`project`	`string`
`conversation`	`string`
`participant`	`string`

Returns
Type	Description
`string`	The formatted participant 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::projectConversationParticipantName

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

Parameters
Name	Description
`project`	`string`
`conversation`	`string`
`participant`	`string`

Returns
Type	Description
`string`	The formatted project_conversation_participant resource.

static::projectEnvironmentUserSessionName

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

Parameters
Name	Description
`project`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted project_environment_user_session resource.

static::projectEnvironmentUserSessionContextName

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

Parameters
Name	Description
`project`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`
`context`	`string`

Returns
Type	Description
`string`	The formatted project_environment_user_session_context resource.

static::projectEnvironmentUserSessionEntityTypeName

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

Parameters
Name	Description
`project`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	The formatted project_environment_user_session_entity_type 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::projectLocationConversationParticipantName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`conversation`	`string`
`participant`	`string`

Returns
Type	Description
`string`	The formatted project_location_conversation_participant resource.

static::projectLocationEnvironmentUserSessionName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted project_location_environment_user_session resource.

static::projectLocationEnvironmentUserSessionContextName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`
`context`	`string`

Returns
Type	Description
`string`	The formatted project_location_environment_user_session_context resource.

static::projectLocationEnvironmentUserSessionEntityTypeName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	The formatted project_location_environment_user_session_entity_type resource.

static::projectLocationSessionName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted project_location_session resource.

static::projectLocationSessionContextName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`session`	`string`
`context`	`string`

Returns
Type	Description
`string`	The formatted project_location_session_context resource.

static::projectLocationSessionEntityTypeName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	The formatted project_location_session_entity_type resource.

static::projectSessionName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted project_session resource.

static::projectSessionContextName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`
`context`	`string`

Returns
Type	Description
`string`	The formatted project_session_context resource.

static::projectSessionEntityTypeName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	The formatted project_session_entity_type resource.

static::sessionName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted session resource.

static::sessionEntityTypeName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	The formatted session_entity_type 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

context: projects/{project}/agent/sessions/{session}/contexts/{context}
conversation: projects/{project}/conversations/{conversation}
message: projects/{project}/conversations/{conversation}/messages/{message}
participant: projects/{project}/conversations/{conversation}/participants/{participant}
projectConversation: projects/{project}/conversations/{conversation}
projectConversationMessage: projects/{project}/conversations/{conversation}/messages/{message}
projectConversationParticipant: projects/{project}/conversations/{conversation}/participants/{participant}
projectEnvironmentUserSession: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
projectEnvironmentUserSessionContext: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
projectEnvironmentUserSessionEntityType: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
projectLocationConversation: projects/{project}/locations/{location}/conversations/{conversation}
projectLocationConversationMessage: projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}
projectLocationConversationParticipant: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
projectLocationEnvironmentUserSession: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}
projectLocationEnvironmentUserSessionContext: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
projectLocationEnvironmentUserSessionEntityType: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
projectLocationSession: projects/{project}/locations/{location}/agent/sessions/{session}
projectLocationSessionContext: projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}
projectLocationSessionEntityType: projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}
projectSession: projects/{project}/agent/sessions/{session}
projectSessionContext: projects/{project}/agent/sessions/{session}/contexts/{context}
projectSessionEntityType: projects/{project}/agent/sessions/{session}/entityTypes/{entity_type}
session: projects/{project}/agent/sessions/{session}
sessionEntityType: projects/{project}/agent/sessions/{session}/entityTypes/{entity_type}

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.

Constants

SERVICE_NAME

Value: 'google.cloud.dialogflow.v2.Participants'

The name of the service.

SERVICE_ADDRESS

Value: 'dialogflow.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.