Class ParticipantsGrpc.ParticipantsBlockingStub (4.43.0)

public static final class ParticipantsGrpc.ParticipantsBlockingStub extends AbstractBlockingStub<ParticipantsGrpc.ParticipantsBlockingStub>

A stub to allow clients to do synchronous rpc calls to service Participants.

Service for managing Participants.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > ParticipantsGrpc.ParticipantsBlockingStub

Methods

analyzeContent(AnalyzeContentRequest request)

public AnalyzeContentResponse analyzeContent(AnalyzeContentRequest request)

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameter
NameDescription
requestAnalyzeContentRequest
Returns
TypeDescription
AnalyzeContentResponse

build(Channel channel, CallOptions callOptions)

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

compileSuggestion(CompileSuggestionRequest request) (deprecated)

public CompileSuggestionResponse compileSuggestion(CompileSuggestionRequest request)

Deprecated. use SuggestArticles and SuggestFaqAnswers instead. Gets suggestions for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Parameter
NameDescription
requestCompileSuggestionRequest
Returns
TypeDescription
CompileSuggestionResponse

createParticipant(CreateParticipantRequest request)

public Participant createParticipant(CreateParticipantRequest request)

Creates a new participant in a conversation.

Parameter
NameDescription
requestCreateParticipantRequest
Returns
TypeDescription
Participant

getParticipant(GetParticipantRequest request)

public Participant getParticipant(GetParticipantRequest request)

Retrieves a conversation participant.

Parameter
NameDescription
requestGetParticipantRequest
Returns
TypeDescription
Participant

listParticipants(ListParticipantsRequest request)

public ListParticipantsResponse listParticipants(ListParticipantsRequest request)

Returns the list of all participants in the specified conversation.

Parameter
NameDescription
requestListParticipantsRequest
Returns
TypeDescription
ListParticipantsResponse

listSuggestions(ListSuggestionsRequest request) (deprecated)

public ListSuggestionsResponse listSuggestions(ListSuggestionsRequest request)

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01. Retrieves suggestions for live agents. This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the list pagination design pattern. The client app should use the next_page_token field to fetch the next batch of suggestions. suggestions are sorted by create_time in descending order. To fetch latest suggestion, just set page_size to 1. To fetch new suggestions without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token.

Parameter
NameDescription
requestListSuggestionsRequest
Returns
TypeDescription
ListSuggestionsResponse

suggestArticles(SuggestArticlesRequest request)

public SuggestArticlesResponse suggestArticles(SuggestArticlesRequest request)

Gets suggested articles for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Parameter
NameDescription
requestSuggestArticlesRequest
Returns
TypeDescription
SuggestArticlesResponse

suggestFaqAnswers(SuggestFaqAnswersRequest request)

public SuggestFaqAnswersResponse suggestFaqAnswers(SuggestFaqAnswersRequest request)

Gets suggested faq answers for a participant based on specific historical messages.

Parameter
NameDescription
requestSuggestFaqAnswersRequest
Returns
TypeDescription
SuggestFaqAnswersResponse

suggestSmartReplies(SuggestSmartRepliesRequest request)

public SuggestSmartRepliesResponse suggestSmartReplies(SuggestSmartRepliesRequest request)

Gets smart replies for a participant based on specific historical messages.

Parameter
NameDescription
requestSuggestSmartRepliesRequest
Returns
TypeDescription
SuggestSmartRepliesResponse

updateParticipant(UpdateParticipantRequest request)

public Participant updateParticipant(UpdateParticipantRequest request)

Updates the specified participant.

Parameter
NameDescription
requestUpdateParticipantRequest
Returns
TypeDescription
Participant