Google Cloud Dialogflow v2beta1 API - Class ParticipantsClientImpl (1.0.0-beta23) 

public sealed class ParticipantsClientImpl : ParticipantsClient

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

Participants client wrapper implementation, for convenient use.

Inheritance

object > ParticipantsClient > ParticipantsClientImpl

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Remarks

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

Constructors

ParticipantsClientImpl(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
Name Description
grpcClient ParticipantsParticipantsClient

The underlying gRPC client.
settings ParticipantsSettings

The base ParticipantsSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override Participants.ParticipantsClient GrpcClient { get; }

The underlying gRPC Participants client

Property Value
Type Description
ParticipantsParticipantsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
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
Name Description
request AnalyzeContentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request AnalyzeContentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAnalyzeContentResponse

A Task containing the RPC response.
Overrides

CompileSuggestion(CompileSuggestionRequest, CallSettings)

[Obsolete]
public override CompileSuggestionResponse CompileSuggestion(CompileSuggestionRequest request, CallSettings callSettings = null)

Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead.

Gets suggestions for a participant based on specific historical messages.

Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

Parameters
Name Description
request CompileSuggestionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
CompileSuggestionResponse

The RPC response.
Overrides

CompileSuggestionAsync(CompileSuggestionRequest, CallSettings)

[Obsolete]
public override Task<CompileSuggestionResponse> CompileSuggestionAsync(CompileSuggestionRequest request, CallSettings callSettings = null)

Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead.

Gets suggestions for a participant based on specific historical messages.

Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

Parameters
Name Description
request CompileSuggestionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCompileSuggestionResponse

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
Name Description
request CreateParticipantRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request CreateParticipantRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskParticipant

A Task containing the RPC response.
Overrides

GetParticipant(GetParticipantRequest, CallSettings)

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

Retrieves a conversation participant.

Parameters
Name Description
request GetParticipantRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Participant

The RPC response.
Overrides

GetParticipantAsync(GetParticipantRequest, CallSettings)

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

Retrieves a conversation participant.

Parameters
Name Description
request GetParticipantRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskParticipant

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
Name Description
request ListParticipantsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListParticipantsResponseParticipant

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
Name Description
request ListParticipantsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListParticipantsResponseParticipant

A pageable asynchronous sequence of Participant resources.
Overrides

ListSuggestions(ListSuggestionsRequest, CallSettings)

[Obsolete]
public override PagedEnumerable<ListSuggestionsResponse, Suggestion> ListSuggestions(ListSuggestionsRequest request, CallSettings callSettings = null)

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.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

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListSuggestionsResponseSuggestion

A pageable sequence of Suggestion resources.
Overrides

ListSuggestionsAsync(ListSuggestionsRequest, CallSettings)

[Obsolete]
public override PagedAsyncEnumerable<ListSuggestionsResponse, Suggestion> ListSuggestionsAsync(ListSuggestionsRequest request, CallSettings callSettings = null)

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.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

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListSuggestionsResponseSuggestion

A pageable asynchronous sequence of Suggestion resources.
Overrides

StreamingAnalyzeContent(CallSettings, BidirectionalStreamingSettings)

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

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.

Parameters
Name Description
callSettings CallSettings

If not null, applies overrides to this RPC call.
streamingSettings BidirectionalStreamingSettings

If not null, applies streaming overrides to this RPC call.
Returns
Type Description
ParticipantsClientStreamingAnalyzeContentStream

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.

Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

Parameters
Name Description
request SuggestArticlesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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.

Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

Parameters
Name Description
request SuggestArticlesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSuggestArticlesResponse

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
Name Description
request SuggestFaqAnswersRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request SuggestFaqAnswersRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSuggestFaqAnswersResponse

A Task containing the RPC response.
Overrides

SuggestKnowledgeAssist(SuggestKnowledgeAssistRequest, CallSettings)

public override SuggestKnowledgeAssistResponse SuggestKnowledgeAssist(SuggestKnowledgeAssistRequest request, CallSettings callSettings = null)

Gets knowledge assist suggestions based on historical messages.

Parameters
Name Description
request SuggestKnowledgeAssistRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
SuggestKnowledgeAssistResponse

The RPC response.
Overrides

SuggestKnowledgeAssistAsync(SuggestKnowledgeAssistRequest, CallSettings)

public override Task<SuggestKnowledgeAssistResponse> SuggestKnowledgeAssistAsync(SuggestKnowledgeAssistRequest request, CallSettings callSettings = null)

Gets knowledge assist suggestions based on historical messages.

Parameters
Name Description
request SuggestKnowledgeAssistRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSuggestKnowledgeAssistResponse

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
Name Description
request SuggestSmartRepliesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request SuggestSmartRepliesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSuggestSmartRepliesResponse

A Task containing the RPC response.
Overrides

UpdateParticipant(UpdateParticipantRequest, CallSettings)

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

Updates the specified participant.

Parameters
Name Description
request UpdateParticipantRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Participant

The RPC response.
Overrides

UpdateParticipantAsync(UpdateParticipantRequest, CallSettings)

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

Updates the specified participant.

Parameters
Name Description
request UpdateParticipantRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskParticipant

A Task containing the RPC response.
Overrides