Google Cloud Dialogflow v2 API - Class Participants.ParticipantsBase (4.9.0)

[BindServiceMethod(typeof(Participants), "BindService")]
public abstract class Participants.ParticipantsBase

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class Participants.ParticipantsBase.

Base class for server-side implementations of Participants

Inheritance

object > Participants.ParticipantsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google CloudGoogle.Cloud.DialogflowV2

Assembly

Google.Cloud.Dialogflow.V2.dll

Methods

AnalyzeContent(AnalyzeContentRequest, ServerCallContext)

public virtual Task<AnalyzeContentResponse> AnalyzeContent(AnalyzeContentRequest request, ServerCallContext context)

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` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskAnalyzeContentResponse`	The response to send back to the client (wrapped by a task).

CreateParticipant(CreateParticipantRequest, ServerCallContext)

public virtual Task<Participant> CreateParticipant(CreateParticipantRequest request, ServerCallContext context)

Creates a new participant in a conversation.

Parameters
Name	Description
`request`	`CreateParticipantRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskParticipant`	The response to send back to the client (wrapped by a task).

GetParticipant(GetParticipantRequest, ServerCallContext)

public virtual Task<Participant> GetParticipant(GetParticipantRequest request, ServerCallContext context)

Retrieves a conversation participant.

Parameters
Name	Description
`request`	`GetParticipantRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskParticipant`	The response to send back to the client (wrapped by a task).

ListParticipants(ListParticipantsRequest, ServerCallContext)

public virtual Task<ListParticipantsResponse> ListParticipants(ListParticipantsRequest request, ServerCallContext context)

Returns the list of all participants in the specified conversation.

Parameters
Name	Description
`request`	`ListParticipantsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListParticipantsResponse`	The response to send back to the client (wrapped by a task).

StreamingAnalyzeContent(IAsyncStreamReader<StreamingAnalyzeContentRequest>, IServerStreamWriter<StreamingAnalyzeContentResponse>, ServerCallContext)

public virtual Task StreamingAnalyzeContent(IAsyncStreamReader<StreamingAnalyzeContentRequest> requestStream, IServerStreamWriter<StreamingAnalyzeContentResponse> responseStream, ServerCallContext context)

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.

Parameters
Name	Description
`requestStream`	`IAsyncStreamReaderStreamingAnalyzeContentRequest` Used for reading requests from the client.
`responseStream`	`IServerStreamWriterStreamingAnalyzeContentResponse` Used for sending responses back to the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task`	A task indicating completion of the handler.

SuggestArticles(SuggestArticlesRequest, ServerCallContext)

public virtual Task<SuggestArticlesResponse> SuggestArticles(SuggestArticlesRequest request, ServerCallContext context)

Gets suggested articles for a participant based on specific historical messages.

Parameters
Name	Description
`request`	`SuggestArticlesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSuggestArticlesResponse`	The response to send back to the client (wrapped by a task).

SuggestFaqAnswers(SuggestFaqAnswersRequest, ServerCallContext)

public virtual Task<SuggestFaqAnswersResponse> SuggestFaqAnswers(SuggestFaqAnswersRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`SuggestFaqAnswersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSuggestFaqAnswersResponse`	The response to send back to the client (wrapped by a task).

SuggestSmartReplies(SuggestSmartRepliesRequest, ServerCallContext)

public virtual Task<SuggestSmartRepliesResponse> SuggestSmartReplies(SuggestSmartRepliesRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`SuggestSmartRepliesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSuggestSmartRepliesResponse`	The response to send back to the client (wrapped by a task).

UpdateParticipant(UpdateParticipantRequest, ServerCallContext)

public virtual Task<Participant> UpdateParticipant(UpdateParticipantRequest request, ServerCallContext context)

Updates the specified participant.

Parameters
Name	Description
`request`	`UpdateParticipantRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskParticipant`	The response to send back to the client (wrapped by a task).