Class ConversationsGrpc.ConversationsBlockingStub (4.17.0)

public static final class ConversationsGrpc.ConversationsBlockingStub extends AbstractBlockingStub<ConversationsGrpc.ConversationsBlockingStub>

Service for managing Conversations.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > ConversationsGrpc.ConversationsBlockingStub

Inherited Members

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

io.grpc.stub.AbstractBlockingStub.<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(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.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)

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

build(Channel channel, CallOptions callOptions)

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

Parameters

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

Returns

Type	Description
`ConversationsGrpc.ConversationsBlockingStub`

Overrides

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

completeConversation(CompleteConversationRequest request)

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

createConversation(CreateConversationRequest request)

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

getConversation(GetConversationRequest request)

public Conversation getConversation(GetConversationRequest request)

Retrieves the specific conversation.

Parameter

Name	Description
`request`	`GetConversationRequest`

Returns

Type	Description
`Conversation`

listConversations(ListConversationsRequest request)

public ListConversationsResponse listConversations(ListConversationsRequest request)

Returns the list of all conversations in the specified project.

Parameter

Name	Description
`request`	`ListConversationsRequest`

Returns

Type	Description
`ListConversationsResponse`

listMessages(ListMessagesRequest request)

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

suggestConversationSummary(SuggestConversationSummaryRequest request)

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