Class ConversationsGrpc.ConversationsFutureStub (4.20.0)

public static final class ConversationsGrpc.ConversationsFutureStub extends AbstractFutureStub<ConversationsGrpc.ConversationsFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Conversations.

Service for managing Conversations.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > ConversationsGrpc.ConversationsFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected ConversationsGrpc.ConversationsFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
ConversationsGrpc.ConversationsFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

completeConversation(CompleteConversationRequest request)

public ListenableFuture<Conversation> completeConversation(CompleteConversationRequest request)

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

Parameter
NameDescription
requestCompleteConversationRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Conversation>

createConversation(CreateConversationRequest request)

public ListenableFuture<Conversation> createConversation(CreateConversationRequest request)

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.

Parameter
NameDescription
requestCreateConversationRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Conversation>

getConversation(GetConversationRequest request)

public ListenableFuture<Conversation> getConversation(GetConversationRequest request)

Retrieves the specific conversation.

Parameter
NameDescription
requestGetConversationRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Conversation>

listConversations(ListConversationsRequest request)

public ListenableFuture<ListConversationsResponse> listConversations(ListConversationsRequest request)

Returns the list of all conversations in the specified project.

Parameter
NameDescription
requestListConversationsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListConversationsResponse>

listMessages(ListMessagesRequest request)

public ListenableFuture<ListMessagesResponse> listMessages(ListMessagesRequest request)

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.

Parameter
NameDescription
requestListMessagesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListMessagesResponse>

suggestConversationSummary(SuggestConversationSummaryRequest request)

public ListenableFuture<SuggestConversationSummaryResponse> suggestConversationSummary(SuggestConversationSummaryRequest request)

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.

Parameter
NameDescription
requestSuggestConversationSummaryRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<SuggestConversationSummaryResponse>