Class ConversationsGrpc.ConversationsFutureStub (4.58.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

batchCreateMessages(BatchCreateMessagesRequest request)

public ListenableFuture<BatchCreateMessagesResponse> batchCreateMessages(BatchCreateMessagesRequest request)

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

Parameter
Name Description
request BatchCreateMessagesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<BatchCreateMessagesResponse>

build(Channel channel, CallOptions callOptions)

protected ConversationsGrpc.ConversationsFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
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
Name Description
request CompleteConversationRequest
Returns
Type Description
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
Name Description
request CreateConversationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Conversation>

generateStatelessSuggestion(GenerateStatelessSuggestionRequest request)

public ListenableFuture<GenerateStatelessSuggestionResponse> generateStatelessSuggestion(GenerateStatelessSuggestionRequest request)

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

Parameter
Name Description
request GenerateStatelessSuggestionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GenerateStatelessSuggestionResponse>

generateStatelessSummary(GenerateStatelessSummaryRequest request)

public ListenableFuture<GenerateStatelessSummaryResponse> generateStatelessSummary(GenerateStatelessSummaryRequest request)

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

Parameter
Name Description
request GenerateStatelessSummaryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GenerateStatelessSummaryResponse>

getConversation(GetConversationRequest request)

public ListenableFuture<Conversation> getConversation(GetConversationRequest request)

Retrieves the specific conversation.

Parameter
Name Description
request GetConversationRequest
Returns
Type Description
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
Name Description
request ListConversationsRequest
Returns
Type Description
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
Name Description
request ListMessagesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListMessagesResponse>

searchKnowledge(SearchKnowledgeRequest request)

public ListenableFuture<SearchKnowledgeResponse> searchKnowledge(SearchKnowledgeRequest request)

Get answers for the given query based on knowledge documents.

Parameter
Name Description
request SearchKnowledgeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchKnowledgeResponse>

suggestConversationSummary(SuggestConversationSummaryRequest request)

public ListenableFuture<SuggestConversationSummaryResponse> suggestConversationSummary(SuggestConversationSummaryRequest request)

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.

Parameter
Name Description
request SuggestConversationSummaryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SuggestConversationSummaryResponse>