Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ConversationsClient.
Service Description: Service for managing Conversations.
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\ConversationsClient for the stable implementation
Namespace
Google \ Cloud \ Dialogflow \ V2 \ ClientMethods
__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 |
↳ 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 |
↳ 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. |
completeConversation
Completes the specified conversation. Finished conversations are purged from the database after 30 days.
The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationsClient::completeConversationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\CompleteConversationRequest
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\Conversation |
createConversation
Creates a new conversation. Conversations are auto-completed after 24 hours.
Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.
For Automated Agent Stage, there will be a dialogflow agent responding to user queries.
For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.
If
Conversation.conversation_profile
is configured for a dialogflow agent, conversation will start from
Automated Agent Stage
, otherwise, it will start from Assist Stage
. And
during Automated Agent Stage
, once an
Intent with
Intent.live_agent_handoff
is triggered, conversation will transfer to Assist Stage.
The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationsClient::createConversationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\CreateConversationRequest
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\Conversation |
generateStatelessSummary
Generates and returns a summary for a conversation that does not have a resource created for it.
The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationsClient::generateStatelessSummaryAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\GenerateStatelessSummaryRequest
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\GenerateStatelessSummaryResponse |
getConversation
Retrieves the specific conversation.
The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationsClient::getConversationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\GetConversationRequest
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\Conversation |
listConversations
Returns the list of all conversations in the specified project.
The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationsClient::listConversationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\ListConversationsRequest
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 |
listMessages
Lists messages that belong to a given conversation.
messages
are ordered by create_time
in descending order. To fetch
updates without duplication, send request with filter
create_time_epoch_microseconds >
[first item's create_time of previous request]
and empty page_token.
The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationsClient::listMessagesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\ListMessagesRequest
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 |
searchKnowledge
Get answers for the given query based on knowledge documents.
The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationsClient::searchKnowledgeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\SearchKnowledgeRequest
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\SearchKnowledgeResponse |
suggestConversationSummary
Suggests summary for a conversation based on specific historical messages.
The range of the messages to be used for summary can be specified in the request.
The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationsClient::suggestConversationSummaryAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\SuggestConversationSummaryRequest
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\SuggestConversationSummaryResponse |
getLocation
Gets information about a location.
The async variant is Google\Cloud\Dialogflow\V2\Client\ConversationsClient::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\ConversationsClient::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 |
completeConversationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\CompleteConversationRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createConversationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\CreateConversationRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
generateStatelessSummaryAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\GenerateStatelessSummaryRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getConversationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\GetConversationRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listConversationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\ListConversationsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listMessagesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\ListMessagesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
searchKnowledgeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\SearchKnowledgeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
suggestConversationSummaryAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\SuggestConversationSummaryRequest
|
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::agentName
Formats a string containing the fully-qualified path to represent a agent resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted agent resource. |
static::cXSecuritySettingsName
Formats a string containing the fully-qualified path to represent a cx_security_settings resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
securitySettings |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted cx_security_settings 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::conversationModelName
Formats a string containing the fully-qualified path to represent a conversation_model resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
conversationModel |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted conversation_model resource. |
static::conversationProfileName
Formats a string containing the fully-qualified path to represent a conversation_profile resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
conversationProfile |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted conversation_profile resource. |
static::documentName
Formats a string containing the fully-qualified path to represent a document resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
knowledgeBase |
string
|
document |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted document resource. |
static::knowledgeBaseName
Formats a string containing the fully-qualified path to represent a knowledge_base resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
knowledgeBase |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted knowledge_base resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted location 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::projectName
Formats a string containing the fully-qualified path to represent a project resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project resource. |
static::projectAgentName
Formats a string containing the fully-qualified path to represent a project_agent resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_agent 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::projectConversationModelName
Formats a string containing the fully-qualified path to represent a project_conversation_model resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
conversationModel |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_conversation_model resource. |
static::projectConversationProfileName
Formats a string containing the fully-qualified path to represent a project_conversation_profile resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
conversationProfile |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_conversation_profile resource. |
static::projectKnowledgeBaseName
Formats a string containing the fully-qualified path to represent a project_knowledge_base resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
knowledgeBase |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_knowledge_base resource. |
static::projectKnowledgeBaseDocumentName
Formats a string containing the fully-qualified path to represent a project_knowledge_base_document resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
knowledgeBase |
string
|
document |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_knowledge_base_document resource. |
static::projectLocationAgentName
Formats a string containing the fully-qualified path to represent a project_location_agent resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_agent 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::projectLocationConversationModelName
Formats a string containing the fully-qualified path to represent a project_location_conversation_model resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
conversationModel |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_conversation_model resource. |
static::projectLocationConversationProfileName
Formats a string containing the fully-qualified path to represent a project_location_conversation_profile resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
conversationProfile |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_conversation_profile resource. |
static::projectLocationKnowledgeBaseName
Formats a string containing the fully-qualified path to represent a project_location_knowledge_base resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
knowledgeBase |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_knowledge_base resource. |
static::projectLocationKnowledgeBaseDocumentName
Formats a string containing the fully-qualified path to represent a project_location_knowledge_base_document resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
knowledgeBase |
string
|
document |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_knowledge_base_document 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
- agent: projects/{project}/agent
- cXSecuritySettings: projects/{project}/locations/{location}/securitySettings/{security_settings}
- conversation: projects/{project}/conversations/{conversation}
- conversationModel: projects/{project}/locations/{location}/conversationModels/{conversation_model}
- conversationProfile: projects/{project}/conversationProfiles/{conversation_profile}
- document: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
- knowledgeBase: projects/{project}/knowledgeBases/{knowledge_base}
- location: projects/{project}/locations/{location}
- message: projects/{project}/conversations/{conversation}/messages/{message}
- project: projects/{project}
- projectAgent: projects/{project}/agent
- projectConversation: projects/{project}/conversations/{conversation}
- projectConversationMessage: projects/{project}/conversations/{conversation}/messages/{message}
- projectConversationModel: projects/{project}/conversationModels/{conversation_model}
- projectConversationProfile: projects/{project}/conversationProfiles/{conversation_profile}
- projectKnowledgeBase: projects/{project}/knowledgeBases/{knowledge_base}
- projectKnowledgeBaseDocument: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
- projectLocationAgent: projects/{project}/locations/{location}/agent
- projectLocationConversation: projects/{project}/locations/{location}/conversations/{conversation}
- projectLocationConversationMessage: projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}
- projectLocationConversationModel: projects/{project}/locations/{location}/conversationModels/{conversation_model}
- projectLocationConversationProfile: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
- projectLocationKnowledgeBase: projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}
- projectLocationKnowledgeBaseDocument: projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}
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. |