Google Cloud Dialogflow v2beta1 API - Class Conversations.ConversationsBase (1.0.0-beta15)

[BindServiceMethod(typeof(Conversations), "BindService")]
public abstract class Conversations.ConversationsBase

Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class Conversations.ConversationsBase.

Base class for server-side implementations of Conversations

Inheritance

object > Conversations.ConversationsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Methods

BatchCreateMessages(BatchCreateMessagesRequest, ServerCallContext)

public virtual Task<BatchCreateMessagesResponse> BatchCreateMessages(BatchCreateMessagesRequest request, ServerCallContext context)

Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.

Parameters
Name	Description
`request`	`BatchCreateMessagesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBatchCreateMessagesResponse`	The response to send back to the client (wrapped by a task).

CompleteConversation(CompleteConversationRequest, ServerCallContext)

public virtual Task<Conversation> CompleteConversation(CompleteConversationRequest request, ServerCallContext context)

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

Parameters
Name	Description
`request`	`CompleteConversationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskConversation`	The response to send back to the client (wrapped by a task).

CreateConversation(CreateConversationRequest, ServerCallContext)

public virtual Task<Conversation> CreateConversation(CreateConversationRequest request, ServerCallContext context)

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][google.cloud.dialogflow.v2beta1.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][google.cloud.dialogflow.v2beta1.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2beta1.Intent.live_agent_handoff] is triggered, conversation will transfer to Assist Stage.

Parameters
Name	Description
`request`	`CreateConversationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskConversation`	The response to send back to the client (wrapped by a task).

GenerateStatelessSummary(GenerateStatelessSummaryRequest, ServerCallContext)

public virtual Task<GenerateStatelessSummaryResponse> GenerateStatelessSummary(GenerateStatelessSummaryRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`GenerateStatelessSummaryRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskGenerateStatelessSummaryResponse`	The response to send back to the client (wrapped by a task).

GetConversation(GetConversationRequest, ServerCallContext)

public virtual Task<Conversation> GetConversation(GetConversationRequest request, ServerCallContext context)

Retrieves the specific conversation.

Parameters
Name	Description
`request`	`GetConversationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskConversation`	The response to send back to the client (wrapped by a task).

ListConversations(ListConversationsRequest, ServerCallContext)

public virtual Task<ListConversationsResponse> ListConversations(ListConversationsRequest request, ServerCallContext context)

Returns the list of all conversations in the specified project.

Parameters
Name	Description
`request`	`ListConversationsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListConversationsResponse`	The response to send back to the client (wrapped by a task).

ListMessages(ListMessagesRequest, ServerCallContext)

public virtual Task<ListMessagesResponse> ListMessages(ListMessagesRequest request, ServerCallContext context)

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`	`ListMessagesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListMessagesResponse`	The response to send back to the client (wrapped by a task).

SearchKnowledge(SearchKnowledgeRequest, ServerCallContext)

public virtual Task<SearchKnowledgeResponse> SearchKnowledge(SearchKnowledgeRequest request, ServerCallContext context)

Get answers for the given query based on knowledge documents.

Parameters
Name	Description
`request`	`SearchKnowledgeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSearchKnowledgeResponse`	The response to send back to the client (wrapped by a task).

SuggestConversationSummary(SuggestConversationSummaryRequest, ServerCallContext)

public virtual Task<SuggestConversationSummaryResponse> SuggestConversationSummary(SuggestConversationSummaryRequest request, ServerCallContext context)

Suggest 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`	`SuggestConversationSummaryRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSuggestConversationSummaryResponse`	The response to send back to the client (wrapped by a task).