Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ParticipantsClient.
Service Description: Service for managing Participants .
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Dialogflow \ V2 \ ClientMethods
__construct
Constructor.
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\BaseClient\self::analyzeContentAsync() .
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.
createParticipant
Creates a new participant in a conversation.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::createParticipantAsync() .
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.
getParticipant
Retrieves a conversation participant.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getParticipantAsync() .
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.
listParticipants
Returns the list of all participants in the specified conversation.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::listParticipantsAsync() .
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.
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 .
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
suggestArticles
Gets suggested articles for a participant based on specific historical messages.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::suggestArticlesAsync() .
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.
suggestFaqAnswers
Gets suggested faq answers for a participant based on specific historical messages.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::suggestFaqAnswersAsync() .
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.
suggestSmartReplies
Gets smart replies for a participant based on specific historical messages.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::suggestSmartRepliesAsync() .
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.
updateParticipant
Updates the specified participant.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::updateParticipantAsync() .
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.
getLocation
Gets information about a location.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getLocationAsync() .
request
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.
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::listLocationsAsync() .
request
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.
analyzeContentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createParticipantAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getParticipantAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listParticipantsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
suggestArticlesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
suggestFaqAnswersAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
suggestSmartRepliesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateParticipantAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getLocationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listLocationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
static::contextName
Formats a string containing the fully-qualified path to represent a context resource.
project
string
session
string
context
string
string
static::conversationName
Formats a string containing the fully-qualified path to represent a conversation resource.
project
string
conversation
string
string
static::messageName
Formats a string containing the fully-qualified path to represent a message resource.
project
string
conversation
string
message
string
string
static::participantName
Formats a string containing the fully-qualified path to represent a participant resource.
project
string
conversation
string
participant
string
string
static::projectConversationName
Formats a string containing the fully-qualified path to represent a project_conversation resource.
project
string
conversation
string
string
static::projectConversationMessageName
Formats a string containing the fully-qualified path to represent a project_conversation_message resource.
project
string
conversation
string
message
string
string
static::projectConversationParticipantName
Formats a string containing the fully-qualified path to represent a project_conversation_participant resource.
project
string
conversation
string
participant
string
string
static::projectEnvironmentUserSessionName
Formats a string containing the fully-qualified path to represent a project_environment_user_session resource.
project
string
environment
string
user
string
session
string
string
static::projectEnvironmentUserSessionContextName
Formats a string containing the fully-qualified path to represent a project_environment_user_session_context resource.
project
string
environment
string
user
string
session
string
context
string
string
static::projectEnvironmentUserSessionEntityTypeName
Formats a string containing the fully-qualified path to represent a project_environment_user_session_entity_type resource.
project
string
environment
string
user
string
session
string
entityType
string
string
static::projectLocationConversationName
Formats a string containing the fully-qualified path to represent a project_location_conversation resource.
project
string
location
string
conversation
string
string
static::projectLocationConversationMessageName
Formats a string containing the fully-qualified path to represent a project_location_conversation_message resource.
project
string
location
string
conversation
string
message
string
string
static::projectLocationConversationParticipantName
Formats a string containing the fully-qualified path to represent a project_location_conversation_participant resource.
project
string
location
string
conversation
string
participant
string
string
static::projectLocationEnvironmentUserSessionName
Formats a string containing the fully-qualified path to represent a project_location_environment_user_session resource.
project
string
location
string
environment
string
user
string
session
string
string
static::projectLocationEnvironmentUserSessionContextName
Formats a string containing the fully-qualified path to represent a project_location_environment_user_session_context resource.
project
string
location
string
environment
string
user
string
session
string
context
string
string
static::projectLocationEnvironmentUserSessionEntityTypeName
Formats a string containing the fully-qualified path to represent a project_location_environment_user_session_entity_type resource.
project
string
location
string
environment
string
user
string
session
string
entityType
string
string
static::projectLocationSessionName
Formats a string containing the fully-qualified path to represent a project_location_session resource.
project
string
location
string
session
string
string
static::projectLocationSessionContextName
Formats a string containing the fully-qualified path to represent a project_location_session_context resource.
project
string
location
string
session
string
context
string
string
static::projectLocationSessionEntityTypeName
Formats a string containing the fully-qualified path to represent a project_location_session_entity_type resource.
project
string
location
string
session
string
entityType
string
string
static::projectSessionName
Formats a string containing the fully-qualified path to represent a project_session resource.
project
string
session
string
string
static::projectSessionContextName
Formats a string containing the fully-qualified path to represent a project_session_context resource.
project
string
session
string
context
string
string
static::projectSessionEntityTypeName
Formats a string containing the fully-qualified path to represent a project_session_entity_type resource.
project
string
session
string
entityType
string
string
static::sessionName
Formats a string containing the fully-qualified path to represent a session resource.
project
string
session
string
string
static::sessionEntityTypeName
Formats a string containing the fully-qualified path to represent a session_entity_type resource.
project
string
session
string
entityType
string
string
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array