public static interface ConversationsGrpc.AsyncService
Service for managing Conversations.
Methods
batchCreateMessages(BatchCreateMessagesRequest request, StreamObserver<BatchCreateMessagesResponse> responseObserver)
public default void batchCreateMessages(BatchCreateMessagesRequest request, StreamObserver<BatchCreateMessagesResponse> responseObserver)
Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.
Parameters | |
---|---|
Name | Description |
request | BatchCreateMessagesRequest |
responseObserver | io.grpc.stub.StreamObserver<BatchCreateMessagesResponse> |
completeConversation(CompleteConversationRequest request, StreamObserver<Conversation> responseObserver)
public default void completeConversation(CompleteConversationRequest request, StreamObserver<Conversation> responseObserver)
Completes the specified conversation. Finished conversations are purged from the database after 30 days.
Parameters | |
---|---|
Name | Description |
request | CompleteConversationRequest |
responseObserver | io.grpc.stub.StreamObserver<Conversation> |
createConversation(CreateConversationRequest request, StreamObserver<Conversation> responseObserver)
public default void createConversation(CreateConversationRequest request, StreamObserver<Conversation> responseObserver)
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 | CreateConversationRequest |
responseObserver | io.grpc.stub.StreamObserver<Conversation> |
generateStatelessSummary(GenerateStatelessSummaryRequest request, StreamObserver<GenerateStatelessSummaryResponse> responseObserver)
public default void generateStatelessSummary(GenerateStatelessSummaryRequest request, StreamObserver<GenerateStatelessSummaryResponse> responseObserver)
Generates and returns a summary for a conversation that does not have a resource created for it.
Parameters | |
---|---|
Name | Description |
request | GenerateStatelessSummaryRequest |
responseObserver | io.grpc.stub.StreamObserver<GenerateStatelessSummaryResponse> |
getConversation(GetConversationRequest request, StreamObserver<Conversation> responseObserver)
public default void getConversation(GetConversationRequest request, StreamObserver<Conversation> responseObserver)
Retrieves the specific conversation.
Parameters | |
---|---|
Name | Description |
request | GetConversationRequest |
responseObserver | io.grpc.stub.StreamObserver<Conversation> |
listConversations(ListConversationsRequest request, StreamObserver<ListConversationsResponse> responseObserver)
public default void listConversations(ListConversationsRequest request, StreamObserver<ListConversationsResponse> responseObserver)
Returns the list of all conversations in the specified project.
Parameters | |
---|---|
Name | Description |
request | ListConversationsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListConversationsResponse> |
listMessages(ListMessagesRequest request, StreamObserver<ListMessagesResponse> responseObserver)
public default void listMessages(ListMessagesRequest request, StreamObserver<ListMessagesResponse> responseObserver)
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 |
responseObserver | io.grpc.stub.StreamObserver<ListMessagesResponse> |
searchKnowledge(SearchKnowledgeRequest request, StreamObserver<SearchKnowledgeResponse> responseObserver)
public default void searchKnowledge(SearchKnowledgeRequest request, StreamObserver<SearchKnowledgeResponse> responseObserver)
Get answers for the given query based on knowledge documents.
Parameters | |
---|---|
Name | Description |
request | SearchKnowledgeRequest |
responseObserver | io.grpc.stub.StreamObserver<SearchKnowledgeResponse> |
suggestConversationSummary(SuggestConversationSummaryRequest request, StreamObserver<SuggestConversationSummaryResponse> responseObserver)
public default void suggestConversationSummary(SuggestConversationSummaryRequest request, StreamObserver<SuggestConversationSummaryResponse> responseObserver)
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 |
responseObserver | io.grpc.stub.StreamObserver<SuggestConversationSummaryResponse> |