Class ConversationsGrpc.ConversationsStub (4.61.0)

public static final class ConversationsGrpc.ConversationsStub extends AbstractAsyncStub<ConversationsGrpc.ConversationsStub>

A stub to allow clients to do asynchronous rpc calls to service Conversations.

Service for managing Conversations.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > ConversationsGrpc.ConversationsStub

Inherited Members

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

batchCreateMessages(BatchCreateMessagesRequest request, StreamObserver<BatchCreateMessagesResponse> responseObserver)

public 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>`

build(Channel channel, CallOptions callOptions)

protected ConversationsGrpc.ConversationsStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`ConversationsGrpc.ConversationsStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

completeConversation(CompleteConversationRequest request, StreamObserver<Conversation> responseObserver)

public 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 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>`

generateStatelessSuggestion(GenerateStatelessSuggestionRequest request, StreamObserver<GenerateStatelessSuggestionResponse> responseObserver)

public void generateStatelessSuggestion(GenerateStatelessSuggestionRequest request, StreamObserver<GenerateStatelessSuggestionResponse> responseObserver)

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

Parameters
Name	Description
`request`	`GenerateStatelessSuggestionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<GenerateStatelessSuggestionResponse>`

generateStatelessSummary(GenerateStatelessSummaryRequest request, StreamObserver<GenerateStatelessSummaryResponse> responseObserver)

public 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 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 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 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 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 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>`