Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ConversationsClient.
Service Description: Service for managing Conversations .
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.
completeConversation
Completes the specified conversation. Finished conversations are purged from the database after 30 days.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::completeConversationAsync() .
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.
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\BaseClient\self::createConversationAsync() .
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.
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\BaseClient\self::generateStatelessSummaryAsync() .
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.
getConversation
Retrieves the specific conversation.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getConversationAsync() .
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.
listConversations
Returns the list of all conversations in the specified project.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::listConversationsAsync() .
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.
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\BaseClient\self::listMessagesAsync() .
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.
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\BaseClient\self::suggestConversationSummaryAsync() .
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.
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.
completeConversationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createConversationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
generateStatelessSummaryAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getConversationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listConversationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listMessagesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
suggestConversationSummaryAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getLocationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listLocationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
static::agentName
Formats a string containing the fully-qualified path to represent a agent resource.
project
string
string
static::cXSecuritySettingsName
Formats a string containing the fully-qualified path to represent a cx_security_settings resource.
project
string
location
string
securitySettings
string
string
static::conversationName
Formats a string containing the fully-qualified path to represent a conversation resource.
project
string
conversation
string
string
static::conversationModelName
Formats a string containing the fully-qualified path to represent a conversation_model resource.
project
string
location
string
conversationModel
string
string
static::conversationProfileName
Formats a string containing the fully-qualified path to represent a conversation_profile resource.
project
string
conversationProfile
string
string
static::documentName
Formats a string containing the fully-qualified path to represent a document resource.
project
string
knowledgeBase
string
document
string
string
static::knowledgeBaseName
Formats a string containing the fully-qualified path to represent a knowledge_base resource.
project
string
knowledgeBase
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
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::projectName
Formats a string containing the fully-qualified path to represent a project resource.
project
string
string
static::projectAgentName
Formats a string containing the fully-qualified path to represent a project_agent resource.
project
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::projectConversationModelName
Formats a string containing the fully-qualified path to represent a project_conversation_model resource.
project
string
conversationModel
string
string
static::projectConversationProfileName
Formats a string containing the fully-qualified path to represent a project_conversation_profile resource.
project
string
conversationProfile
string
string
static::projectKnowledgeBaseName
Formats a string containing the fully-qualified path to represent a project_knowledge_base resource.
project
string
knowledgeBase
string
string
static::projectKnowledgeBaseDocumentName
Formats a string containing the fully-qualified path to represent a project_knowledge_base_document resource.
project
string
knowledgeBase
string
document
string
string
static::projectLocationAgentName
Formats a string containing the fully-qualified path to represent a project_location_agent resource.
project
string
location
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::projectLocationConversationModelName
Formats a string containing the fully-qualified path to represent a project_location_conversation_model resource.
project
string
location
string
conversationModel
string
string
static::projectLocationConversationProfileName
Formats a string containing the fully-qualified path to represent a project_location_conversation_profile resource.
project
string
location
string
conversationProfile
string
string
static::projectLocationKnowledgeBaseName
Formats a string containing the fully-qualified path to represent a project_location_knowledge_base resource.
project
string
location
string
knowledgeBase
string
string
static::projectLocationKnowledgeBaseDocumentName
Formats a string containing the fully-qualified path to represent a project_location_knowledge_base_document resource.
project
string
location
string
knowledgeBase
string
document
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
- 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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
