Class ParticipantsGrpc.ParticipantsBlockingStub (4.54.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
Name Description
request AnalyzeContentRequest
Returns
Type Description
AnalyzeContentResponse

build(Channel channel, CallOptions callOptions)

protected ParticipantsGrpc.ParticipantsBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
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
Name Description
request CompileSuggestionRequest
Returns
Type Description
CompileSuggestionResponse

createParticipant(CreateParticipantRequest request)

public Participant createParticipant(CreateParticipantRequest request)

Creates a new participant in a conversation.

Parameter
Name Description
request CreateParticipantRequest
Returns
Type Description
Participant

getParticipant(GetParticipantRequest request)

public Participant getParticipant(GetParticipantRequest request)

Retrieves a conversation participant.

Parameter
Name Description
request GetParticipantRequest
Returns
Type Description
Participant

listParticipants(ListParticipantsRequest request)

public ListParticipantsResponse listParticipants(ListParticipantsRequest request)

Returns the list of all participants in the specified conversation.

Parameter
Name Description
request ListParticipantsRequest
Returns
Type Description
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
Name Description
request ListSuggestionsRequest
Returns
Type Description
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
Name Description
request SuggestArticlesRequest
Returns
Type Description
SuggestArticlesResponse

suggestFaqAnswers(SuggestFaqAnswersRequest request)

public SuggestFaqAnswersResponse suggestFaqAnswers(SuggestFaqAnswersRequest request)

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

Parameter
Name Description
request SuggestFaqAnswersRequest
Returns
Type Description
SuggestFaqAnswersResponse

suggestKnowledgeAssist(SuggestKnowledgeAssistRequest request)

public SuggestKnowledgeAssistResponse suggestKnowledgeAssist(SuggestKnowledgeAssistRequest request)

Gets knowledge assist suggestions based on historical messages.

Parameter
Name Description
request SuggestKnowledgeAssistRequest
Returns
Type Description
SuggestKnowledgeAssistResponse

suggestSmartReplies(SuggestSmartRepliesRequest request)

public SuggestSmartRepliesResponse suggestSmartReplies(SuggestSmartRepliesRequest request)

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

Parameter
Name Description
request SuggestSmartRepliesRequest
Returns
Type Description
SuggestSmartRepliesResponse

updateParticipant(UpdateParticipantRequest request)

public Participant updateParticipant(UpdateParticipantRequest request)

Updates the specified participant.

Parameter
Name Description
request UpdateParticipantRequest
Returns
Type Description
Participant