Class ConversationsClient (2.18.0)

Version 2.18.0

• 2.31.0-rc (latest)
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Service for managing Conversations.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ConversationsClient(ConversationsClient const &)

Copy and move support

Parameter
Name	Description
	ConversationsClient const &

ConversationsClient(ConversationsClient &&)

Copy and move support

Parameter
Name	Description
	ConversationsClient &&

ConversationsClient(std::shared_ptr< ConversationsConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< ConversationsConnection >
opts	Options

Operators

operator=(ConversationsClient const &)

Copy and move support

Parameter
Name	Description
	ConversationsClient const &

Returns
Type	Description
ConversationsClient &

operator=(ConversationsClient &&)

Copy and move support

Parameter
Name	Description
	ConversationsClient &&

Returns
Type	Description
ConversationsClient &

Functions

CreateConversation(std::string const &, google::cloud::dialogflow::v2::Conversation const &, Options)

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.

Parameters
Name	Description
parent	std::string const & Required. Resource identifier of the project creating the conversation. Format: projects/<ProjectID>/locations/<LocationID>.
conversation	google::cloud::dialogflow::v2::Conversation const & Required. The conversation to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::v2::Conversation >	the result of the RPC. The response message type (google.cloud.dialogflow.v2.Conversation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateConversation(google::cloud::dialogflow::v2::CreateConversationRequest const &, Options)

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.

Parameters
Name	Description
request	google::cloud::dialogflow::v2::CreateConversationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.CreateConversationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::v2::Conversation >	the result of the RPC. The response message type (google.cloud.dialogflow.v2.Conversation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListConversations(std::string const &, Options)

Returns the list of all conversations in the specified project.

Parameters
Name	Description
parent	std::string const & Required. The project from which to list all conversation. Format: projects/<ProjectID>/locations/<LocationID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::v2::Conversation >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.Conversation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListConversations(google::cloud::dialogflow::v2::ListConversationsRequest, Options)

Returns the list of all conversations in the specified project.

Parameters
Name	Description
request	google::cloud::dialogflow::v2::ListConversationsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.ListConversationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::v2::Conversation >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.Conversation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetConversation(std::string const &, Options)

Retrieves the specific conversation.

Parameters
Name	Description
name	std::string const & Required. The name of the conversation. Format: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::v2::Conversation >	the result of the RPC. The response message type (google.cloud.dialogflow.v2.Conversation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetConversation(google::cloud::dialogflow::v2::GetConversationRequest const &, Options)

Retrieves the specific conversation.

Parameters
Name	Description
request	google::cloud::dialogflow::v2::GetConversationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.GetConversationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::v2::Conversation >	the result of the RPC. The response message type (google.cloud.dialogflow.v2.Conversation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CompleteConversation(std::string const &, Options)

Completes the specified conversation.

Finished conversations are purged from the database after 30 days.

Parameters
Name	Description
name	std::string const & Required. Resource identifier of the conversation to close. Format: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::v2::Conversation >	the result of the RPC. The response message type (google.cloud.dialogflow.v2.Conversation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CompleteConversation(google::cloud::dialogflow::v2::CompleteConversationRequest const &, Options)

Completes the specified conversation.

Finished conversations are purged from the database after 30 days.

Parameters
Name	Description
request	google::cloud::dialogflow::v2::CompleteConversationRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.CompleteConversationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::v2::Conversation >	the result of the RPC. The response message type (google.cloud.dialogflow.v2.Conversation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListMessages(std::string const &, Options)

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
parent	std::string const & Required. The name of the conversation to list messages for. Format: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::v2::Message >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.Message, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMessages(google::cloud::dialogflow::v2::ListMessagesRequest, Options)

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	google::cloud::dialogflow::v2::ListMessagesRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.ListMessagesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::v2::Message >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.Message, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SuggestConversationSummary(std::string const &, Options)

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.

Parameters
Name	Description
conversation	std::string const & Required. The conversation to fetch suggestion for. Format: projects/<ProjectID>/locations/<LocationID>/conversations/<Conversation ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::v2::SuggestConversationSummaryResponse >	the result of the RPC. The response message type (google.cloud.dialogflow.v2.SuggestConversationSummaryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SuggestConversationSummary(google::cloud::dialogflow::v2::SuggestConversationSummaryRequest const &, Options)

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.

Parameters
Name	Description
request	google::cloud::dialogflow::v2::SuggestConversationSummaryRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.SuggestConversationSummaryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::v2::SuggestConversationSummaryResponse >	the result of the RPC. The response message type (google.cloud.dialogflow.v2.SuggestConversationSummaryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GenerateStatelessSummary(google::cloud::dialogflow::v2::GenerateStatelessSummaryRequest const &, Options)

Generates and returns a summary for a conversation that does not have a resource created for it.

Parameters
Name	Description
request	google::cloud::dialogflow::v2::GenerateStatelessSummaryRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.GenerateStatelessSummaryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::v2::GenerateStatelessSummaryResponse >	the result of the RPC. The response message type (google.cloud.dialogflow.v2.GenerateStatelessSummaryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SearchKnowledge(google::cloud::dialogflow::v2::SearchKnowledgeRequest const &, Options)

Get answers for the given query based on knowledge documents.

Parameters
Name	Description
request	google::cloud::dialogflow::v2::SearchKnowledgeRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.SearchKnowledgeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::v2::SearchKnowledgeResponse >	the result of the RPC. The response message type (google.cloud.dialogflow.v2.SearchKnowledgeResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.