public static interface ParticipantsGrpc.AsyncServiceService for managing Participants.
Methods
analyzeContent(AnalyzeContentRequest request, StreamObserver<AnalyzeContentResponse> responseObserver)
public default void analyzeContent(AnalyzeContentRequest request, StreamObserver<AnalyzeContentResponse> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request | AnalyzeContentRequest |
responseObserver | io.grpc.stub.StreamObserver<AnalyzeContentResponse> |
compileSuggestion(CompileSuggestionRequest request, StreamObserver<CompileSuggestionResponse> responseObserver)
public default void compileSuggestion(CompileSuggestionRequest request, StreamObserver<CompileSuggestionResponse> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request | CompileSuggestionRequest |
responseObserver | io.grpc.stub.StreamObserver<CompileSuggestionResponse> |
createParticipant(CreateParticipantRequest request, StreamObserver<Participant> responseObserver)
public default void createParticipant(CreateParticipantRequest request, StreamObserver<Participant> responseObserver)Creates a new participant in a conversation.
| Parameters | |
|---|---|
| Name | Description |
request | CreateParticipantRequest |
responseObserver | io.grpc.stub.StreamObserver<Participant> |
getParticipant(GetParticipantRequest request, StreamObserver<Participant> responseObserver)
public default void getParticipant(GetParticipantRequest request, StreamObserver<Participant> responseObserver)Retrieves a conversation participant.
| Parameters | |
|---|---|
| Name | Description |
request | GetParticipantRequest |
responseObserver | io.grpc.stub.StreamObserver<Participant> |
listParticipants(ListParticipantsRequest request, StreamObserver<ListParticipantsResponse> responseObserver)
public default void listParticipants(ListParticipantsRequest request, StreamObserver<ListParticipantsResponse> responseObserver)Returns the list of all participants in the specified conversation.
| Parameters | |
|---|---|
| Name | Description |
request | ListParticipantsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListParticipantsResponse> |
listSuggestions(ListSuggestionsRequest request, StreamObserver<ListSuggestionsResponse> responseObserver)
public default void listSuggestions(ListSuggestionsRequest request, StreamObserver<ListSuggestionsResponse> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request | ListSuggestionsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListSuggestionsResponse> |
streamingAnalyzeContent(StreamObserver<StreamingAnalyzeContentResponse> responseObserver)
public default StreamObserver<StreamingAnalyzeContentRequest> streamingAnalyzeContent(StreamObserver<StreamingAnalyzeContentResponse> responseObserver) Adds a text (e.g., chat) or audio (e.g., phone recording) message from a
participant into the conversation.
Note: This method is only available through the gRPC API (not REST).
The top-level message sent to the client by the server is
StreamingAnalyzeContentResponse. Multiple response messages can be
returned in order. The first one or more messages contain the
recognition_result field. Each result represents a more complete
transcript of what the user said. The next message contains the
reply_text field, and potentially the reply_audio and/or the
automated_agent_reply fields.
Note: Always use agent versions for production traffic
sent to virtual agents. See Versions and
environments.
| Parameter | |
|---|---|
| Name | Description |
responseObserver | io.grpc.stub.StreamObserver<StreamingAnalyzeContentResponse> |
| Returns | |
|---|---|
| Type | Description |
io.grpc.stub.StreamObserver<StreamingAnalyzeContentRequest> | |
suggestArticles(SuggestArticlesRequest request, StreamObserver<SuggestArticlesResponse> responseObserver)
public default void suggestArticles(SuggestArticlesRequest request, StreamObserver<SuggestArticlesResponse> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request | SuggestArticlesRequest |
responseObserver | io.grpc.stub.StreamObserver<SuggestArticlesResponse> |
suggestFaqAnswers(SuggestFaqAnswersRequest request, StreamObserver<SuggestFaqAnswersResponse> responseObserver)
public default void suggestFaqAnswers(SuggestFaqAnswersRequest request, StreamObserver<SuggestFaqAnswersResponse> responseObserver)Gets suggested faq answers for a participant based on specific historical messages.
| Parameters | |
|---|---|
| Name | Description |
request | SuggestFaqAnswersRequest |
responseObserver | io.grpc.stub.StreamObserver<SuggestFaqAnswersResponse> |
suggestSmartReplies(SuggestSmartRepliesRequest request, StreamObserver<SuggestSmartRepliesResponse> responseObserver)
public default void suggestSmartReplies(SuggestSmartRepliesRequest request, StreamObserver<SuggestSmartRepliesResponse> responseObserver)Gets smart replies for a participant based on specific historical messages.
| Parameters | |
|---|---|
| Name | Description |
request | SuggestSmartRepliesRequest |
responseObserver | io.grpc.stub.StreamObserver<SuggestSmartRepliesResponse> |
updateParticipant(UpdateParticipantRequest request, StreamObserver<Participant> responseObserver)
public default void updateParticipant(UpdateParticipantRequest request, StreamObserver<Participant> responseObserver)Updates the specified participant.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateParticipantRequest |
responseObserver | io.grpc.stub.StreamObserver<Participant> |