ConversationsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.services.conversations.transports.base.ConversationsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Service for managing Conversations.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
ConversationsTransport | The transport used by the client instance. |
Methods
ConversationsClient
ConversationsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.services.conversations.transports.base.ConversationsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the conversations client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, ConversationsTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
complete_conversation
complete_conversation(request: Optional[Union[google.cloud.dialogflow_v2.types.conversation.CompleteConversationRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Completes the specified conversation. Finished conversations are purged from the database after 30 days.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.CompleteConversationRequest, dict]
The request object. The request message for Conversations.CompleteConversation. |
name |
str
Required. Resource identifier of the conversation to close. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dialogflow_v2.types.Conversation | Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions. |
conversation_path
conversation_path(project: str, conversation: str)Returns a fully-qualified conversation string.
conversation_profile_path
conversation_profile_path(project: str, conversation_profile: str)Returns a fully-qualified conversation_profile string.
create_conversation
create_conversation(request: Optional[Union[google.cloud.dialogflow_v2.types.conversation.CreateConversationRequest, dict]] = None, *, parent: Optional[str] = None, conversation: Optional[google.cloud.dialogflow_v2.types.conversation.Conversation] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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
xref_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
xref_Intent with
xref_Intent.live_agent_handoff
is triggered, conversation will transfer to Assist Stage.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.CreateConversationRequest, dict]
The request object. The request message for Conversations.CreateConversation. |
parent |
str
Required. Resource identifier of the project creating the conversation. Format: |
conversation |
google.cloud.dialogflow_v2.types.Conversation
Required. The conversation to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dialogflow_v2.types.Conversation | Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
ConversationsClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
ConversationsClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
ConversationsClient | The constructed client. |
get_conversation
get_conversation(request: Optional[Union[google.cloud.dialogflow_v2.types.conversation.GetConversationRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Retrieves the specific conversation.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.GetConversationRequest, dict]
The request object. The request message for Conversations.GetConversation. |
name |
str
Required. The name of the conversation. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dialogflow_v2.types.Conversation | Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions. |
list_conversations
list_conversations(request: Optional[Union[google.cloud.dialogflow_v2.types.conversation.ListConversationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns the list of all conversations in the specified project.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.ListConversationsRequest, dict]
The request object. The request message for Conversations.ListConversations. |
parent |
str
Required. The project from which to list all conversation. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dialogflow_v2.services.conversations.pagers.ListConversationsPager | The response message for Conversations.ListConversations. Iterating over this object will yield results and resolve additional pages automatically. |
list_messages
list_messages(request: Optional[Union[google.cloud.dialogflow_v2.types.conversation.ListMessagesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.ListMessagesRequest, dict]
The request object. The request message for Conversations.ListMessages. |
parent |
str
Required. The name of the conversation to list messages for. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dialogflow_v2.services.conversations.pagers.ListMessagesPager | The response message for Conversations.ListMessages. Iterating over this object will yield results and resolve additional pages automatically. |
message_path
message_path(project: str, conversation: str, message: str)Returns a fully-qualified message string.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_conversation_path
parse_conversation_path(path: str)Parses a conversation path into its component segments.
parse_conversation_profile_path
parse_conversation_profile_path(path: str)Parses a conversation_profile path into its component segments.
parse_message_path
parse_message_path(path: str)Parses a message path into its component segments.