Google Cloud Dialogflow v2 API - Class ParticipantsClientImpl (4.5.0)

public sealed class ParticipantsClientImpl : ParticipantsClient

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

Participants client wrapper implementation, for convenient use.

Inheritance

Object > ParticipantsClient > ParticipantsClientImpl

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Remarks

Service for managing [Participants][google.cloud.dialogflow.v2.Participant].

Constructors

ParticipantsClientImpl(Participants.ParticipantsClient, ParticipantsSettings, ILogger)

public ParticipantsClientImpl(Participants.ParticipantsClient grpcClient, ParticipantsSettings settings, ILogger logger)

Constructs a client wrapper for the Participants service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientParticipants.ParticipantsClient

The underlying gRPC client.

settingsParticipantsSettings

The base ParticipantsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override Participants.ParticipantsClient GrpcClient { get; }

The underlying gRPC Participants client

Property Value
TypeDescription
Participants.ParticipantsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

Methods

AnalyzeContent(AnalyzeContentRequest, CallSettings)

public override AnalyzeContentResponse AnalyzeContent(AnalyzeContentRequest request, CallSettings callSettings = null)

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
NameDescription
requestAnalyzeContentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AnalyzeContentResponse

The RPC response.

Overrides

AnalyzeContentAsync(AnalyzeContentRequest, CallSettings)

public override Task<AnalyzeContentResponse> AnalyzeContentAsync(AnalyzeContentRequest request, CallSettings callSettings = null)

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
NameDescription
requestAnalyzeContentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<AnalyzeContentResponse>

A Task containing the RPC response.

Overrides

CreateParticipant(CreateParticipantRequest, CallSettings)

public override Participant CreateParticipant(CreateParticipantRequest request, CallSettings callSettings = null)

Creates a new participant in a conversation.

Parameters
NameDescription
requestCreateParticipantRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Participant

The RPC response.

Overrides

CreateParticipantAsync(CreateParticipantRequest, CallSettings)

public override Task<Participant> CreateParticipantAsync(CreateParticipantRequest request, CallSettings callSettings = null)

Creates a new participant in a conversation.

Parameters
NameDescription
requestCreateParticipantRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Participant>

A Task containing the RPC response.

Overrides

GetParticipant(GetParticipantRequest, CallSettings)

public override Participant GetParticipant(GetParticipantRequest request, CallSettings callSettings = null)

Retrieves a conversation participant.

Parameters
NameDescription
requestGetParticipantRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Participant

The RPC response.

Overrides

GetParticipantAsync(GetParticipantRequest, CallSettings)

public override Task<Participant> GetParticipantAsync(GetParticipantRequest request, CallSettings callSettings = null)

Retrieves a conversation participant.

Parameters
NameDescription
requestGetParticipantRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Participant>

A Task containing the RPC response.

Overrides

ListParticipants(ListParticipantsRequest, CallSettings)

public override PagedEnumerable<ListParticipantsResponse, Participant> ListParticipants(ListParticipantsRequest request, CallSettings callSettings = null)

Returns the list of all participants in the specified conversation.

Parameters
NameDescription
requestListParticipantsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListParticipantsResponse, Participant>

A pageable sequence of Participant resources.

Overrides

ListParticipantsAsync(ListParticipantsRequest, CallSettings)

public override PagedAsyncEnumerable<ListParticipantsResponse, Participant> ListParticipantsAsync(ListParticipantsRequest request, CallSettings callSettings = null)

Returns the list of all participants in the specified conversation.

Parameters
NameDescription
requestListParticipantsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListParticipantsResponse, Participant>

A pageable asynchronous sequence of Participant resources.

Overrides

StreamingAnalyzeContent(CallSettings, BidirectionalStreamingSettings)

public override ParticipantsClient.StreamingAnalyzeContentStream StreamingAnalyzeContent(CallSettings callSettings = null, BidirectionalStreamingSettings streamingSettings = null)

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
NameDescription
callSettingsCallSettings

If not null, applies overrides to this RPC call.

streamingSettingsBidirectionalStreamingSettings

If not null, applies streaming overrides to this RPC call.

Returns
TypeDescription
ParticipantsClient.StreamingAnalyzeContentStream

The client-server stream.

Overrides

SuggestArticles(SuggestArticlesRequest, CallSettings)

public override SuggestArticlesResponse SuggestArticles(SuggestArticlesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSuggestArticlesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SuggestArticlesResponse

The RPC response.

Overrides

SuggestArticlesAsync(SuggestArticlesRequest, CallSettings)

public override Task<SuggestArticlesResponse> SuggestArticlesAsync(SuggestArticlesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSuggestArticlesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SuggestArticlesResponse>

A Task containing the RPC response.

Overrides

SuggestFaqAnswers(SuggestFaqAnswersRequest, CallSettings)

public override SuggestFaqAnswersResponse SuggestFaqAnswers(SuggestFaqAnswersRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSuggestFaqAnswersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SuggestFaqAnswersResponse

The RPC response.

Overrides

SuggestFaqAnswersAsync(SuggestFaqAnswersRequest, CallSettings)

public override Task<SuggestFaqAnswersResponse> SuggestFaqAnswersAsync(SuggestFaqAnswersRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSuggestFaqAnswersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SuggestFaqAnswersResponse>

A Task containing the RPC response.

Overrides

SuggestSmartReplies(SuggestSmartRepliesRequest, CallSettings)

public override SuggestSmartRepliesResponse SuggestSmartReplies(SuggestSmartRepliesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSuggestSmartRepliesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SuggestSmartRepliesResponse

The RPC response.

Overrides

SuggestSmartRepliesAsync(SuggestSmartRepliesRequest, CallSettings)

public override Task<SuggestSmartRepliesResponse> SuggestSmartRepliesAsync(SuggestSmartRepliesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSuggestSmartRepliesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SuggestSmartRepliesResponse>

A Task containing the RPC response.

Overrides

UpdateParticipant(UpdateParticipantRequest, CallSettings)

public override Participant UpdateParticipant(UpdateParticipantRequest request, CallSettings callSettings = null)

Updates the specified participant.

Parameters
NameDescription
requestUpdateParticipantRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Participant

The RPC response.

Overrides

UpdateParticipantAsync(UpdateParticipantRequest, CallSettings)

public override Task<Participant> UpdateParticipantAsync(UpdateParticipantRequest request, CallSettings callSettings = null)

Updates the specified participant.

Parameters
NameDescription
requestUpdateParticipantRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Participant>

A Task containing the RPC response.

Overrides