Google Cloud Dialogflow V2 Client - Class ParticipantsClient (1.10.2)

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.

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 class is currently experimental and may be subject to changes. See Google\Cloud\Dialogflow\V2\ParticipantsClient for the stable implementation

Namespace

Google \ Cloud \ Dialogflow \ V2 \ Client

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.

The async variant is Google\Cloud\Dialogflow\V2\Client\ParticipantsClient::analyzeContentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\AnalyzeContentRequest` A request to house fields associated with the call.
`callOptions`	`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\AnalyzeContentResponse`

createParticipant

Creates a new participant in a conversation.

The async variant is Google\Cloud\Dialogflow\V2\Client\ParticipantsClient::createParticipantAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\CreateParticipantRequest` A request to house fields associated with the call.
`callOptions`	`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`

getParticipant

Retrieves a conversation participant.

The async variant is Google\Cloud\Dialogflow\V2\Client\ParticipantsClient::getParticipantAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\GetParticipantRequest` A request to house fields associated with the call.
`callOptions`	`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`

listParticipants

Returns the list of all participants in the specified conversation.

The async variant is Google\Cloud\Dialogflow\V2\Client\ParticipantsClient::listParticipantsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ListParticipantsRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\PagedListResponse`

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
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\BidiStream`

suggestArticles

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

The async variant is Google\Cloud\Dialogflow\V2\Client\ParticipantsClient::suggestArticlesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\SuggestArticlesRequest` A request to house fields associated with the call.
`callOptions`	`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\SuggestArticlesResponse`

suggestFaqAnswers

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

The async variant is Google\Cloud\Dialogflow\V2\Client\ParticipantsClient::suggestFaqAnswersAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\SuggestFaqAnswersRequest` A request to house fields associated with the call.
`callOptions`	`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\SuggestFaqAnswersResponse`

suggestSmartReplies

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

The async variant is Google\Cloud\Dialogflow\V2\Client\ParticipantsClient::suggestSmartRepliesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\SuggestSmartRepliesRequest` A request to house fields associated with the call.
`callOptions`	`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\SuggestSmartRepliesResponse`

updateParticipant

Updates the specified participant.

The async variant is Google\Cloud\Dialogflow\V2\Client\ParticipantsClient::updateParticipantAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\UpdateParticipantRequest` A request to house fields associated with the call.
`callOptions`	`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`

getLocation

Gets information about a location.

The async variant is Google\Cloud\Dialogflow\V2\Client\ParticipantsClient::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` A request to house fields associated with the call.
`callOptions`	`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\Location\Location`

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\Dialogflow\V2\Client\ParticipantsClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\PagedListResponse`

analyzeContentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\AnalyzeContentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createParticipantAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\CreateParticipantRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getParticipantAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\GetParticipantRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listParticipantsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ListParticipantsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

suggestArticlesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\SuggestArticlesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

suggestFaqAnswersAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\SuggestFaqAnswersRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

suggestSmartRepliesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\SuggestSmartRepliesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateParticipantAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\UpdateParticipantRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

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.