Interface ParticipantsGrpc.AsyncService (4.49.0)

public static interface ParticipantsGrpc.AsyncService

Service 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>

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>

streamingAnalyzeContent(StreamObserver<StreamingAnalyzeContentResponse> responseObserver)

public default StreamObserver<StreamingAnalyzeContentRequest> streamingAnalyzeContent(StreamObserver<StreamingAnalyzeContentResponse> responseObserver)

Adds a text (chat, for example), or audio (phone recording, for example) 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 field. The message can also contain the automated_agent_reply field. 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.

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>